JwtBearerOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.JwtBearer

組件:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

套件:

Microsoft.AspNetCore.Authentication.JwtBearer v8.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 權杖的單一有效物件值。 如果此屬性是空的，這個值會傳遞至 TokenValidationParameters.ValidAudience。
Authority	取得或設定呼叫 OpenIdConnect 時使用的 Authority。
AutomaticRefreshInterval	取得或設定自動中繼資料重新整理應該發生的頻率。
Backchannel	用來擷取中繼資料的 Backchannel。
BackchannelHttpHandler	用來擷取中繼資料的 HttpMessageHandler。 此屬性不能與 BackchannelCertificateValidator 同時設定，除非此值為 WebRequestHandler。
BackchannelTimeout	取得或設定使用 backchannel 來呼叫 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	取得或設定 MapInboundClaims SecurityTokenValidators 或 JsonWebTokenHandler TokenHandlers 中預設實例 JwtSecurityTokenHandler 上的 屬性，在判斷驗證 或 JsonWebToken 時是否對應所擷取的宣告類型。 JwtSecurityToken 如果此值設定為 true，則宣告類型會在使用此對應進行翻譯之後，設定為 JSON 宣告 'name'。 否則，不會發生任何對應。 預設值為 true。
MetadataAddress	取得或設定探索端點以取得中繼資料
RefreshInterval	取得或設定擷取、擷取失敗或明確要求重新整理之間的最短時間。
RefreshOnIssuerKeyNotFound	取得或設定在發生 SecurityTokenSignatureKeyNotFoundException 之後是否應該嘗試重新整理中繼資料。 這允許在簽章金鑰變換時自動復原。 此選項預設為啟用狀態。
RequireHttpsMetadata	取得或設定中繼資料位址或授權單位是否需要 HTTPS。 預設值是 true。 這應該只在開發環境中停用。
SaveToken	定義在成功授權之後，持有人權杖是否應該儲存在 AuthenticationProperties 中。
SecurityTokenValidators	已淘汰. 取得用來驗證存取權杖的 ISecurityTokenValidator 已排序清單。
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)
TokenHandlers	取得用來驗證存取權杖的 TokenHandler 已排序清單。
TokenValidationParameters	取得或設定用來驗證身分識別權杖的參數。
UseSecurityTokenValidators	取得或設定是否 TokenHandlersSecurityTokenValidators 要用來驗證輸入權杖。

方法

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