JwtBearerOptions クラス

定義

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
継承

コンストラクター

JwtBearerOptions()

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

プロパティ

Audience

受信した OpenIdConnect トークンの 1 つの有効な対象ユーザー値を取得または設定します。 このプロパティが空の場合、この値は TokenValidationParameters.ValidAudience に渡されます。

Authority

OpenIdConnect を呼び出す際に使用する Authority を取得または設定します。

AutomaticRefreshInterval

1 日は、その後、新しい構成を取得 ConfigurationManager する既定の時間間隔です。

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("ForwardLengeValue");転送を無効にし、通常の処理を許可するには、ターゲットを現在のスキームに設定します。

(継承元 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 ハンドラーからエラーとエラーが返error_descriptionヘッダーにWWW-Authenticateできます。

MapInboundClaims

MapInboundClaimsSecurityTokenValidators の の既定のインスタンスの プロパティを取得または設定します。これは、 の検証時に抽出されるクレームの種類をマップするかどうかを決定するときに使用 JwtSecurityTokenHandler されます JwtSecurityToken

これが true に設定されている場合、このマッピングを使用して変換した後、要求の種類は JSON 要求 'name' に設定されます。 それ以外の場合、マッピングは行われません。

既定値は、true です。

MetadataAddress

メタデータを取得するための検出エンドポイントを取得または設定します。

RefreshInterval

取得が失敗した場合、または更新が明示的に要求された場合の、取得間の ConfigurationManager 最小時間。 既定値は 30 秒です。

RefreshOnIssuerKeyNotFound

SecurityTokenSignatureKeyNotFoundException の後、メタデータの更新を試行する必要があるかどうかを示す値を取得または設定します。 これにより、署名キー ロールオーバー発生時の自動復旧が可能となります。 この機能は、既定では有効になっています。

RequireHttpsMetadata

メタデータ アドレスまたは機関に HTTPS が必要な場合は、 を取得または設定します。 既定値は true です。 これは、開発環境でのみ無効にする必要があります。

SaveToken

承認が成功した後にベアラー トークンを に格納 AuthenticationProperties するかどうかを定義します。

SecurityTokenValidators

アクセス トークンの検証に使用される ISecurityTokenValidator の順序付きリストを取得します。

TokenValidationParameters

ID トークンの検証に使用するパラメーターを取得または設定します。

メソッド

Validate()

オプションが有効か確認します。 問題なければ例外をスローする必要があります。

(継承元 AuthenticationSchemeOptions)
Validate(String)

オプションが特定のスキームに対して有効か確認します

(継承元 AuthenticationSchemeOptions)

適用対象