RequiredScopeAttribute コンストラクター

定義

名前空間:
Microsoft.Identity.Web.Resource
アセンブリ:
Microsoft.Identity.Web.dll
パッケージ:
Microsoft.Identity.Web v4.10.0

オーバーロード

名前 説明
RequiredScopeAttribute()

既定のコンストラクター
RequiredScopeAttribute(String[])

Web API が適切なスコープで呼び出されていることを確認します。 この API に対して取得されたトークンがそのスコープ要求にこれらの acceptedScopes を持っていない場合、メソッドは状態コード 403 (Forbidden) を提供する HTTP 応答を更新し、トークンで必要なスコープを示すメッセージを応答本文に書き込みます。

RequiredScopeAttribute()

既定のコンストラクター

public RequiredScopeAttribute();
Public Sub New ()

例

[RequiredScope(RequiredScopesConfigurationKey="AzureAD:Scope")]
class Controller : BaseController
{
}

適用対象

RequiredScopeAttribute(String[])

Web API が適切なスコープで呼び出されていることを確認します。 この API に対して取得されたトークンがそのスコープ要求にこれらの acceptedScopes を持っていない場合、メソッドは状態コード 403 (Forbidden) を提供する HTTP 応答を更新し、トークンで必要なスコープを示すメッセージを応答本文に書き込みます。

public RequiredScopeAttribute(params string[] acceptedScopes);
new Microsoft.Identity.Web.Resource.RequiredScopeAttribute : string[] -> Microsoft.Identity.Web.Resource.RequiredScopeAttribute
Public Sub New (ParamArray acceptedScopes As String())

パラメーター

acceptedScopes
String[]

この Web API で受け入れられるスコープ。

例

保護するコントローラー/ページ/アクションに次の属性を追加します。

[RequiredScope("access_as_user")]

注釈

スコープが一致しない場合、応答は 403 (禁止) になります。これは、ユーザーが認証 (したがって 401 ではない) が承認されていないためです。

こちらもご覧ください

  • <xref:RequiredScopeAttribute()>

適用対象