TokenValidationParameters 類別

定義

命名空間:

Microsoft.IdentityModel.Tokens

組件:

Microsoft.IdentityModel.Tokens.dll

套件:

Microsoft.IdentityModel.Tokens v8.19.1

包含一組參數，這些參數在驗證 SecurityTokenHandler時會被 SecurityToken 使用 。

public class TokenValidationParameters

type TokenValidationParameters = class

Public Class TokenValidationParameters

繼承

Object

TokenValidationParameters

建構函式

名稱	Description
TokenValidationParameters()	初始化 TokenValidationParameters 類別的新執行個體。
TokenValidationParameters(TokenValidationParameters)	複製 為 TokenValidationParameters的建構子。

欄位

名稱	Description
DefaultAuthenticationType	這是建立 AuthenticationType時的ClaimsIdentity預設值。 值為 "AuthenticationTypes.Federation"。 要更改這個值，請設定 AuthenticationType 為不同的值。
DefaultClockSkew	預設是因為時鐘偏移。
DefaultMaximumTokenSizeInBytes	預設最大代幣大小。

屬性

名稱	Description
ActorValidationParameters	得或定。TokenValidationParameters
AlgorithmValidator	取得或設定一個代理，用於驗證所使用的密碼演算法。
AudienceValidator	指定或指定一個代表，用來驗證受眾。
AuthenticationType	ClaimsIdentity建立 .
ClockSkew	在驗證時間時，設定或設定時鐘偏移。
ConfigurationManager	若設定此特性，將用於取得與 的 Issuer元資料端點相關的發行者與簽署金鑰。 取得的發行者與簽署金鑰將與 TokenValidationParameters 上的金鑰一同用於驗證入令牌。
CryptoProviderFactory	使用者可以用此屬性覆蓋預設 CryptoProviderFactory 值。 該工廠將用於建立簽名服務提供者。
DebugId	它會取得或設定一個字串，幫助在除錯時設定斷點。
IgnoreTrailingSlashWhenValidatingAudience	會取得或設定一個布林值，控制 '/' 在受眾結尾是否具有重要性。 預設值為 true。
IncludeTokenOnFailedValidation	取得或設定一個旗標，指示驗證失敗時是否包含 。SecurityToken
InstancePropertyBag	得到 IDictionary<TKey,TValue> 的是這個案例中獨有的那個。 呼叫 Clone() 會產生新的 IDictionary 實例。
IsClone	會獲得一個值，表示是否 Clone() 被呼叫以取得此實例。
IssuerSigningKey	取得或設定 SecurityKey 是用於簽章驗證的 。
IssuerSigningKeyResolver	取得或設定一個代理，將被呼叫以取得 SecurityKey 用於簽名驗證的使用資料。
IssuerSigningKeyResolverUsingConfiguration	取得或設定一個代理，將被呼叫以取得SecurityKey用於簽章驗證的 使用值，使用TokenValidationParametersBaseConfiguration且 。
IssuerSigningKeys	取得或設定 並 IEnumerable<T> 用於簽章驗證。
IssuerSigningKeyValidator	取得或設定一個代理來驗證 SecurityKey 簽署該代幣的
IssuerSigningKeyValidatorUsingConfiguration	取得或設定一個代理來驗證 SecurityKey 簽署該代幣的
IssuerValidator	取得或設定一個代表，用來驗證代幣發行者。
IssuerValidatorUsingConfiguration	取得或設定一個代表，用來驗證代幣發行者。
LifetimeValidator	取得或設定一個代理，用來驗證代幣的存續期
LogTokenId	取得或設定一個 Boolean ，決定是否需要記錄該憑證識別憑證。 預設值為 true。
LogValidationExceptions	取得或設定 ， Boolean 決定驗證失敗是否需要被記錄為錯誤。 預設值是 true 行為向後相容的值。 若設為 false，驗證失敗會被記錄為 Information 並拋出。
NameClaimType	得到或設定 ，String定義了 。NameClaimType
NameClaimTypeRetriever	取得或設定一個代理，驗證標記後會被呼叫來設定該屬性 NameClaimType 。
PropertyBag	取得或設定 IDictionary<TKey,TValue> 包含一組自訂鍵值對的 。 這允許新增可用於自訂令牌驗證情境的參數。
RefreshBeforeValidation	取得或設定一個布林值，以控制是否需要在憑證驗證前重新整理設定。
RequireAudience	取得或設定一個值，指示 SAML 或 JWT 代幣必須至少有一個 AudienceRestriction。 預設值為 true。
RequireExpirationTime	取得或設定一個值，表示代幣是否必須有「到期」值。 預設值為 true。
RequireSignedTokens	取得或設定一個值，表示若未簽名 a SecurityToken 是否可視為有效。 預設值為 true。
RoleClaimType	得到或設定 ，String定義了 。RoleClaimType
RoleClaimTypeRetriever	取得或設定一個代理，驗證標記後會被呼叫來設定該屬性 RoleClaimType 。
SaveSigninToken	取得或設定一個布林值，以控制安全權杖驗證後是否應該儲存原始權杖。
SignatureValidator	取得或設定一個代理，用來驗證該代幣的簽名。
SignatureValidatorUsingConfiguration	取得或設定一個代理，用來驗證憑證的簽名，使用與 TokenValidationParametersBaseConfiguration。
TokenDecryptionKey	取得或設定 SecurityKey 該 將用於解密。
TokenDecryptionKeyResolver	取得或設定一個代理，將被呼叫以取得 SecurityKey 用於解密的使用資料。
TokenDecryptionKeys	取得或設定 IEnumerable<T> a 要用於解密入站的標記。
TokenReader	取得或設定一個代理，用於讀取標記。
TokenReplayCache	取得或設定 ITokenReplayCache 可以檢查的代幣，以協助偵測代幣重播。
TokenReplayValidator	取得或設定一個代理，用來驗證該代幣的重播
TransformBeforeSignatureValidation	取得或設定一個代理，將被呼叫將代幣轉換為支援格式，然後再進行驗證。
TryAllDecryptionKeys	取得或設定一個值，指示在解密時，當金鑰未與標記「kid」匹配，或標記「kid」為空時，是否 TokenDecryptionKeys 應全部嘗試。 預設值為 true。
TryAllIssuerSigningKeys	取得或設定一個值，指示在簽章驗證時，當 IssuerSigningKeys 金鑰未與標記「kid」匹配時，或標記「kid」為空，是否應全部嘗試。 預設值為 true。
TryReadJwtClaim	取得或設定在讀取 JSON Web Token 標頭和有效載荷聲明時會被呼叫的代理。
TypeValidator	取得或設定一個代理，用來驗證代幣的類型。 若無法驗證該標記類型，代理必須拋出例外。 注意：若無法從其慣常位置擷取，該「型別」參數可能是空的。 需要從不同位置解析的實作可以使用「token」參數。
ValidAlgorithms	取得或設定有效的密碼學運算演算法。
ValidateActor	取得或設定一個值，指示若偵測到演員標記，是否應該驗證。 預設值為 false。
ValidateAudience	取得或設定一個布林值，以控制在令牌驗證期間是否會驗證受眾。
ValidateIssuer	取得或設定一個布林值來控制發行者在代幣驗證期間是否會被驗證。
ValidateIssuerSigningKey	取得或設定一個布林值，控制是否 SecurityKey 呼叫簽署的安全令牌驗證。
ValidateLifetime	取得或設定一個布林值，以控制在代幣驗證時是否會驗證壽命。
ValidateSignatureLast	取得或設定一個布林值，控制憑證驗證期間有效載體與簽名的驗證順序。
ValidateTokenReplay	取得或設定一個布林值來控制代幣重播在代幣驗證時是否會被驗證。
ValidateWithLKG	取得或設定一個布林值來控制是否使用 LKG 配置進行令牌驗證。
ValidAudience	取得或設定一個字串，代表一個有效的受眾，用來與該代幣的受眾進行檢查。 預設值為 null。
ValidAudiences	取得或設定 IEnumerable<T> 包含有效受眾的 ，這些受眾將用於與該代幣的受眾進行檢查。 預設值為 null。
ValidIssuer	取得或設定一個代表有效發行者的 a String ，用來與該代幣的發行者進行比對。 預設值為 null。
ValidIssuers	取得或設定 IEnumerable<T> 包含有效發行者的 ，這些發行者將用來與該代幣的發行者進行比對。 預設值為 null。
ValidTypes	取得或設定 IEnumerable<T> ，包含有效型別，用來檢查 JWT 標頭的「typ」聲明。 若未設定此屬性，『typ』標頭聲明將不會被驗證，所有類型都會被接受。 以 JWE 為例，這個特性只會適用於內部的標記標頭。 預設值為 null。

方法

名稱	Description
Clone()	回傳一個新的實例， TokenValidationParameters 值是從此物件複製而來。
CreateClaimsIdentity(SecurityToken, String)	創造一個 ClaimsIdentity 用途： AuthenticationType 'NameClaimType'：如果 NameClaimTypeRetriever 已設定，呼叫 delegate，否則呼叫 NameClaimType。 如果結果是空字串，則使用 DefaultNameClaimType 。 'RoleClaimType'：若 RoleClaimTypeRetriever 已設定，呼叫 delegate，否則呼叫 RoleClaimType。 如果結果是空字串，則使用 DefaultRoleClaimType 。

擴充方法

名稱	Description
EnableAadSigningKeyIssuerValidation(TokenValidationParameters)	允許對 Microsoft 身分識別平台（AAD）所使用的簽署金鑰的發行者與令牌發行者進行驗證。
EnableEntraIdSigningKeyCloudInstanceValidation(TokenValidationParameters)	啟用 Microsoft Entra ID 令牌簽名金鑰的雲端實例驗證。