JwtBearerOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Authentication.JwtBearer

アセンブリ:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

パッケージ:

Microsoft.AspNetCore.Authentication.JwtBearer v9.0.0

ソース:

JwtBearerOptions.cs

Options クラスは、ベアラー認証ハンドラーの動作を制御するために必要な情報を提供します

public ref class JwtBearerOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions

public class JwtBearerOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type JwtBearerOptions = class
    inherit AuthenticationSchemeOptions

Public Class JwtBearerOptions
Inherits AuthenticationSchemeOptions

継承

Object

AuthenticationSchemeOptions

JwtBearerOptions

コンストラクター

JwtBearerOptions()

JwtBearerOptions の新しいインスタンスを初期化します。

プロパティ

Audience	受信した OpenIdConnect トークンの 1 つの有効な対象ユーザー値を取得または設定します。 このプロパティが空の場合、この値は TokenValidationParameters.ValidAudience に渡されます。
Authority	OpenIdConnect を呼び出す際に使用する Authority を取得または設定します。
AutomaticRefreshInterval	メタデータの自動更新を実行する頻度を取得または設定します。
Backchannel	メタデータの取得に使用される Backchannel。
BackchannelHttpHandler	メタデータを取得するための HttpMessageHandler。 値が WebRequestHandler の場合以外、これを BackchannelCertificateValidator と同時に設定することはできません。
BackchannelTimeout	バックチャネルを使用して http 呼び出しを行うときに使用するタイムアウトを取得または設定します。
Challenge	"WWW-Authenticate" ヘッダーに配置するチャレンジを取得または設定します。
ClaimsIssuer	作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationSchemeOptions)
Configuration	開発者によって直接指定された構成。 指定された場合、MetadataAddress プロパティと Backchannel プロパティは使用されません。 要求の処理中は、この情報を更新しないでください。
ConfigurationManager	メタデータからの構成の取得、キャッシュ、更新を行います。 指定されなかった場合、MetadataAddress プロパティと Backchannel プロパティを使用して作成されます。
Events	ベアラー認証ハンドラーによって発生したイベントを処理するためにアプリケーションによって提供される オブジェクト。 アプリケーションは、インターフェイスを完全に実装するか、JwtBearerEvents のインスタンスを作成し、処理するイベントにのみデリゲートを割り当てることができます。
EventsType	が設定されている場合は、 プロパティの代わりに Events インスタンスを取得するためのサービスの種類として が使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardAuthenticate	設定されている場合、このスキームで AuthenticateAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardChallenge	設定されている場合、このスキームで ChallengeAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardDefault	設定されている場合、認証ハンドラーが既定ですべての認証操作を に転送する既定のスキームを指定します。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初にチェックされ、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardDefaultSelector	認証ハンドラーが既定ですべての認証操作をに転送する必要がある現在の要求の既定のスキームを選択するために使用されます。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初にチェックされ、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardForbid	設定されている場合、このスキームで ForbidAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardSignIn	設定されている場合、このスキームで SignInAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardSignOut	設定されている場合、このスキームで SignOutAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
IncludeErrorDetails	トークン検証エラーを呼び出し元に返す必要があるかどうかを定義します。 既定では、このオプションを無効にして、JWT ハンドラーがエラーと WWW-Authenticate ヘッダーのerror_descriptionを返さないようにすることができます。
MapInboundClaims	SecurityTokenValidators または JsonWebTokenHandler TokenHandlers の既定のJwtSecurityTokenHandlerインスタンスの プロパティを取得または設定MapInboundClaimsします。これは、 または JsonWebTokenを検証JwtSecurityTokenするときに抽出される要求の種類をマップするかどうかを判断するときに使用されます。 これが true に設定されている場合、このマッピングを使用して変換した後、要求の種類は JSON 要求 'name' に設定されます。 それ以外の場合、マッピングは行われません。 既定値は、true です。
MetadataAddress	メタデータを取得するための検出エンドポイントを取得または設定します。
RefreshInterval	取得に失敗した場合、または更新が明示的に要求された場合に、取得までの最小時間を取得または設定します。
RefreshOnIssuerKeyNotFound	SecurityTokenSignatureKeyNotFoundException の後、メタデータの更新を試行する必要があるかどうかを示す値を取得または設定します。 これにより、署名キー ロールオーバー発生時の自動復旧が可能となります。 この機能は、既定では有効になっています。
RequireHttpsMetadata	メタデータ アドレスまたは機関に HTTPS が必要かどうかを取得または設定します。 既定値は true です。 これは開発環境でのみ無効にする必要があります。
SaveToken	承認が成功した後にベアラー トークンを AuthenticationProperties に格納するかどうかを定義します。
SecurityTokenValidators	古い. アクセス トークンの検証に使用される の ISecurityTokenValidator 順序付きリストを取得します。
TimeProvider	テストに使用されます。 (継承元 AuthenticationSchemeOptions)
TokenHandlers	アクセス トークンの検証に使用される の TokenHandler 順序付きリストを取得します。
TokenValidationParameters	ID トークンの検証に使用されるパラメーターを取得または設定します。
UseSecurityTokenValidators	受信トークンの検証に使用するかどうかを TokenHandlers 取得または SecurityTokenValidators 設定します。

メソッド

Validate()	オプションが有効であることを確認します。 問題がなければ例外をスローする必要があります。 (継承元 AuthenticationSchemeOptions)
Validate(String)	オプションが特定のスキームに対して有効であることを確認します (継承元 AuthenticationSchemeOptions)