BearerTokenOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Authentication.BearerToken

アセンブリ:

Microsoft.AspNetCore.Authentication.BearerToken.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

ソース:

BearerTokenOptions.cs

不透明なベアラー トークンを使用して認証するために使用されるオプションが含まれています。

public sealed class BearerTokenOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type BearerTokenOptions = class
    inherit AuthenticationSchemeOptions

Public NotInheritable Class BearerTokenOptions
Inherits AuthenticationSchemeOptions

継承

Object

AuthenticationSchemeOptions

BearerTokenOptions

コンストラクター

BearerTokenOptions()

不透明なベアラー トークンを使用して認証するために使用されるオプションを構築します。

プロパティ

BearerTokenExpiration	ベアラー トークンが作成された時点から有効なままになる時間を制御します。 有効期限情報は、保護されたトークンに格納されます。 そのため、期限切れのトークンは、クライアントが消去した後にサーバーに渡された場合でも拒否されます。
BearerTokenProtector	設定されている場合、 は、 BearerTokenProtector ベアラー トークンに格納されている ID やその他のプロパティを保護および保護解除するために使用されます。 指定されていない場合は、 と を使用してTicketDataFormatIDataProtectionProviderアプリケーションIServiceProviderから 作成されます。
ClaimsIssuer	作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationSchemeOptions)
Events	ベアラー トークン認証ハンドラーによって発生したイベントを処理するためにアプリケーションによって提供される オブジェクト。 アプリケーションは、インターフェイスを完全に実装するか、 の BearerTokenEvents インスタンスを作成して、処理するイベントにのみデリゲートを割り当てることができます。
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)
RefreshTokenExpiration	更新トークンが作成された時点から有効な状態を維持する時間を制御します。 有効期限情報は、保護されたトークンに格納されます。
RefreshTokenProtector	が設定されている場合、 は、 RefreshTokenProtector 更新トークンに格納されている ID やその他のプロパティを保護および保護解除するために使用されます。 指定されていない場合は、 と を使用してTicketDataFormatIDataProtectionProviderアプリケーションIServiceProviderから 作成されます。
TimeProvider	テストに使用されます。 (継承元 AuthenticationSchemeOptions)

メソッド

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