TokenValidationParameters クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
SecurityTokenを検証するときにSecurityTokenHandlerによって使用されるパラメーターのセットを格納します。
public class TokenValidationParameters
type TokenValidationParameters = class
Public Class TokenValidationParameters
- 継承
-
TokenValidationParameters
コンストラクター
| 名前 | 説明 |
|---|---|
| TokenValidationParameters() |
TokenValidationParameters クラスの新しいインスタンスを初期化します。 |
| TokenValidationParameters(TokenValidationParameters) |
TokenValidationParametersのコピー コンストラクター。 |
フィールド
| 名前 | 説明 |
|---|---|
| DefaultAuthenticationType |
これは、AuthenticationTypeを作成するときにClaimsIdentityの既定値です。
値は |
| DefaultClockSkew |
クロック スキューの既定値。 |
| DefaultMaximumTokenSizeInBytes |
最大トークン サイズの既定値。 |
プロパティ
| 名前 | 説明 |
|---|---|
| ActorValidationParameters |
TokenValidationParametersを取得または設定します。 |
| AlgorithmValidator |
使用される暗号化アルゴリズムの検証に使用されるデリゲートを取得または設定します。 |
| AudienceValidator |
対象ユーザーの検証に使用されるデリゲートを取得または設定します。 |
| AuthenticationType |
ClaimsIdentityの作成時に AuthenticationType を取得または設定します。 |
| ClockSkew |
時刻を検証するときに適用するクロック スキューを取得または設定します。 |
| ConfigurationManager |
設定した場合、このプロパティは、 Issuerのメタデータ エンドポイントに関連付けられている発行者と署名キーを取得するために使用されます。 取得した発行者と署名キーは、受信トークンの検証に TokenValidationParameters に存在するキーと共に使用されます。 |
| CryptoProviderFactory |
ユーザーは、このプロパティを使用して既定の CryptoProviderFactory をオーバーライドできます。 このファクトリは、署名プロバイダーの作成に使用されます。 |
| DebugId |
デバッグ時にブレークポイントを設定するのに役立つ文字列を取得または設定します。 |
| IgnoreTrailingSlashWhenValidatingAudience |
対象ユーザーの末尾に '/' が重要かどうかを制御するブール値を取得または設定します。
既定値は |
| IncludeTokenOnFailedValidation |
検証が失敗したときに SecurityToken を含めるかどうかを示すフラグを取得または設定します。 |
| InstancePropertyBag |
このインスタンスに固有の IDictionary<TKey,TValue> を取得します。 Clone()を呼び出すと、この IDictionary の新しいインスタンスが生成されます。 |
| IsClone |
このインスタンスを取得するために Clone() が呼び出されたかどうかを示す値を取得します。 |
| IssuerSigningKey |
署名の検証に使用する SecurityKey を取得または設定します。 |
| IssuerSigningKeyResolver |
署名の検証に使用される SecurityKey を取得するために呼び出されるデリゲートを取得または設定します。 |
| IssuerSigningKeyResolverUsingConfiguration |
TokenValidationParametersとBaseConfigurationを使用して署名の検証に使用されるSecurityKeyを取得するために呼び出されるデリゲートを取得または設定します。 |
| IssuerSigningKeys |
署名の検証に使用する IEnumerable<T> を取得または設定します。 |
| IssuerSigningKeyValidator |
トークンに署名した SecurityKey を検証するためのデリゲートを取得または設定します。 |
| IssuerSigningKeyValidatorUsingConfiguration |
トークンに署名した SecurityKey を検証するためのデリゲートを取得または設定します。 |
| IssuerValidator |
トークンの発行者の検証に使用されるデリゲートを取得または設定します。 |
| IssuerValidatorUsingConfiguration |
トークンの発行者の検証に使用されるデリゲートを取得または設定します。 |
| LifetimeValidator |
トークンの有効期間の検証に使用されるデリゲートを取得または設定します。 |
| LogTokenId |
トークン識別子要求をログに記録する必要があるかどうかを決定する Boolean を取得または設定します。
既定値は、 |
| LogValidationExceptions |
検証エラーをエラーとしてログに記録する必要があるかどうかを決定する Boolean を取得または設定します。
既定値は、動作の下位互換性のために |
| NameClaimType |
Stringを定義するNameClaimTypeを取得または設定します。 |
| NameClaimTypeRetriever |
トークンの検証後にプロパティ NameClaimType を設定するために呼び出されるデリゲートを取得または設定します。 |
| PropertyBag |
カスタム キーと値のペアのコレクションを含む IDictionary<TKey,TValue> を取得または設定します。 これにより、カスタム トークン検証シナリオで使用できるパラメーターを追加できます。 |
| RefreshBeforeValidation |
トークン検証の前に構成を更新する必要があるかどうかを制御するブール値を取得または設定します。 |
| RequireAudience |
SAML トークンまたは JWT トークンに少なくとも 1 つの AudienceRestriction が必要かどうかを示す値を取得または設定します。
既定値は |
| RequireExpirationTime |
トークンに 'expiration' 値が必要かどうかを示す値を取得または設定します。
既定値は |
| RequireSignedTokens |
署名されていない場合に SecurityToken を有効と見なすことができるかどうかを示す値を取得または設定します。
既定値は |
| RoleClaimType |
Stringを定義するRoleClaimTypeを取得または設定します。 |
| RoleClaimTypeRetriever |
トークンの検証後にプロパティ RoleClaimType を設定するために呼び出されるデリゲートを取得または設定します。 |
| SaveSigninToken |
セキュリティ トークンの検証後に元のトークンを保存するかどうかを制御するブール値を取得または設定します。 |
| SignatureValidator |
トークンの署名の検証に使用されるデリゲートを取得または設定します。 |
| SignatureValidatorUsingConfiguration |
TokenValidationParametersとBaseConfigurationを使用してトークンの署名を検証するために使用されるデリゲートを取得または設定します。 |
| TokenDecryptionKey |
復号化に使用する SecurityKey を取得または設定します。 |
| TokenDecryptionKeyResolver |
復号化に使用される SecurityKey を取得するために呼び出されるデリゲートを取得または設定します。 |
| TokenDecryptionKeys |
受信トークンの復号化に使用する IEnumerable<T> を取得または設定します。 |
| TokenReader |
トークンの読み取りに使用されるデリゲートを取得または設定します。 |
| TokenReplayCache |
トークンの再生を検出するために確認できるトークンを格納する ITokenReplayCache を取得または設定します。 |
| TokenReplayValidator |
トークンのトークン再生の検証に使用されるデリゲートを取得または設定します。 |
| TransformBeforeSignatureValidation |
検証の前にトークンをサポートされている形式に変換するために呼び出されるデリゲートを取得または設定します。 |
| TryAllDecryptionKeys |
キーがトークン 'kid' と一致しない場合、またはトークン 'kid' が空の場合に、トークンの暗号化解除中にすべての TokenDecryptionKeys を試す必要があるかどうかを示す値を取得または設定します。
既定値は |
| TryAllIssuerSigningKeys |
キーがトークン 'kid' と一致しない場合、またはトークン 'kid' が空の場合に、署名検証中にすべての IssuerSigningKeys を試す必要があるかどうかを示す値を取得または設定します。
既定値は |
| TryReadJwtClaim |
JSON Web トークン ヘッダーとペイロード要求を読み取るときに呼び出されるデリゲートを取得または設定します。 |
| TypeValidator |
トークンの型の検証に使用されるデリゲートを取得または設定します。 トークンの種類を検証できない場合は、デリゲートによって例外がスローされる必要があります。 注: 'type' パラメーターは、通常の場所から抽出できなかった場合は null になる可能性があります。 別の場所から解決する必要がある実装では、'token' パラメーターを使用できます。 |
| ValidAlgorithms |
暗号化操作の有効なアルゴリズムを取得または設定します。 |
| ValidateActor |
アクター トークンが検出されたかどうかを示す値を取得または設定します。検証する必要があるかどうかを示します。
既定値は |
| ValidateAudience |
トークンの検証中に対象ユーザーを検証するかどうかを制御するブール値を取得または設定します。 |
| ValidateIssuer |
トークンの検証中に発行者を検証するかどうかを制御するブール値を取得または設定します。 |
| ValidateIssuerSigningKey |
securityToken に署名した SecurityKey の検証が呼び出されるかどうかを制御するブール値を取得または設定します。 |
| ValidateLifetime |
トークンの検証中に有効期間を検証するかどうかを制御するブール値を取得または設定します。 |
| ValidateSignatureLast |
トークンの検証中にペイロードと署名の検証順序を制御するブール値を取得または設定します。 |
| ValidateTokenReplay |
トークンの検証中にトークンの再生を検証するかどうかを制御するブール値を取得または設定します。 |
| ValidateWithLKG |
トークンの検証に LKG 構成を使用するかどうかを制御するブール値を取得または設定します。 |
| ValidAudience |
トークンの対象ユーザーに対するチェックに使用される有効な対象ユーザーを表す文字列を取得または設定します。
既定値は |
| ValidAudiences |
トークンの対象ユーザーに対するチェックに使用される有効な対象ユーザーを含む IEnumerable<T> を取得または設定します。
既定値は |
| ValidIssuer |
トークンの発行者に対するチェックに使用される有効な発行者を表す String を取得または設定します。
既定値は |
| ValidIssuers |
トークンの発行者に対するチェックに使用される有効な発行者を含む IEnumerable<T> を取得または設定します。
既定値は |
| ValidTypes |
JWT ヘッダーの 'typ' 要求に対するチェックに使用される有効な型を含む IEnumerable<T> を取得または設定します。
このプロパティが設定されていない場合、'typ' ヘッダー要求は検証されず、すべての型が受け入れられます。
JWE の場合、このプロパティは内部トークン ヘッダーにのみ適用されます。
既定値は |
メソッド
| 名前 | 説明 |
|---|---|
| Clone() |
このオブジェクトからコピーされた値を持つ TokenValidationParameters の新しいインスタンスを返します。 |
| CreateClaimsIdentity(SecurityToken, String) |
次を使用して ClaimsIdentity を作成します。 'NameClaimType': NameClaimTypeRetriever が設定されている場合はデリゲートを呼び出し、それ以外の場合は NameClaimType を呼び出します。 結果が null または空の文字列の場合は、次の値を使用します。 DefaultNameClaimType .'RoleClaimType': RoleClaimTypeRetriever が設定されている場合はデリゲートを呼び出し、それ以外の場合は RoleClaimType を呼び出します。 結果が null または空の文字列の場合は、次の値を使用します。 DefaultRoleClaimType . |
拡張メソッド
| 名前 | 説明 |
|---|---|
| EnableAadSigningKeyIssuerValidation(TokenValidationParameters) |
トークンの発行者に対して、Microsoft ID プラットフォーム (AAD) によって使用される署名キーの発行者の検証を有効にします。 |
| EnableEntraIdSigningKeyCloudInstanceValidation(TokenValidationParameters) |
Microsoft Entra ID トークン署名キーのクラウド インスタンスの検証を有効にします。 |