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 用來保護並解除保護儲存在持有人權杖中的身分識別和其他屬性。 如果未提供，則會使用 TicketDataFormat ，並從 IDataProtectionProvider 應用程式 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 用來保護並取消保護儲存在重新整理權杖中的身分識別和其他屬性。 如果未提供，則會使用 TicketDataFormat ，並從 IDataProtectionProvider 應用程式 IServiceProvider 建立一個 。
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)

方法

Validate()	檢查選項是否有效。 如果專案不正常，應該擲回例外狀況。 (繼承來源 AuthenticationSchemeOptions)
Validate(String)	檢查選項是否對特定配置有效 (繼承來源 AuthenticationSchemeOptions)