ValidationParameters Class

Definition

Namespace:: Microsoft.IdentityModel.Tokens.Experimental

Assembly:: Microsoft.IdentityModel.Tokens.dll

Package:: Microsoft.IdentityModel.Tokens v8.13.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains a set of parameters that are used by a SecurityTokenHandler when validating a SecurityToken.

public class ValidationParameters

type ValidationParameters = class

Public Class ValidationParameters

Inheritance: Object
ValidationParameters

Constructors

ValidationParameters()	Initializes a new instance of the ValidationParameters class.
ValidationParameters(ValidationParameters)	Copy constructor for ValidationParameters.

Fields

DefaultAuthenticationType	This is the default value of AuthenticationType when creating a ClaimsIdentity. The value is `"AuthenticationTypes.Federation"`. To change the value, set AuthenticationType to a different value.
DefaultClockSkew	Default for the clock skew.
DefaultMaximumTokenSizeInBytes	Default for the maximum token size.

Properties

ActorValidationParameters	Gets or sets ValidationParameters.
AlgorithmValidator	Allows overriding the delegate used to validate the cryptographic algorithm used.
AudienceValidator	Allows overriding the delegate that will be used to validate the audience.
AuthenticationType	Gets or sets the AuthenticationType when creating a ClaimsIdentity.
ClockSkew	Gets or sets the clock skew to apply when validating a time.
ConfigurationManager	If set, this property will be used to obtain the issuer and signing keys associated with the metadata endpoint of Issuer. The obtained issuer and signing keys will then be used along with those present on the ValidationParameters for validation of the incoming token.
CryptoProviderFactory	Users can override the default CryptoProviderFactory with this property. This factory will be used for creating signature providers.
DebugId	Gets or sets a string that helps with setting breakpoints when debugging.
IgnoreTrailingSlashWhenValidatingAudience	Gets or sets a boolean that controls if a '/' is significant at the end of the audience. The default is `true`.
IncludeTokenOnFailedValidation	Gets or sets the flag that indicates whether to include the SecurityToken when the validation fails.
InstancePropertyBag	Gets a IDictionary<TKey,TValue> that is unique to this instance. Calling Clone() will result in a new instance of this IDictionary.
IsClone	Gets a value indicating if Clone() was called to obtain this instance.
IssuerSigningKeyResolver	Gets or sets a delegate that will be called to retrieve a SecurityKey used for signature validation.
IssuerSigningKeys	Gets the IList<T> used for signature validation.
IssuerSigningKeyValidator	Gets or sets a delegate for validating the SecurityKey that signed the token.
IssuerValidatorAsync	Allows overriding the delegate that will be used to validate the issuer of the token.
LifetimeValidator	Allows overriding the delegate that will be used to validate the lifetime of the token
LogTokenId	Gets or sets a Boolean that will decide if the token identifier claim needs to be logged. Default value is `true`.
NameClaimType	Gets or sets a String that defines the NameClaimType.
NameClaimTypeRetriever	Gets or sets a delegate that will be called to set the property NameClaimType after validating a token.
PropertyBag	Gets or sets the IDictionary<TKey,TValue> that contains a collection of custom key/value pairs. This allows addition of parameters that could be used in custom token validation scenarios.
RefreshBeforeValidation	A boolean to control whether configuration should be refreshed before validating a token.
RoleClaimType	Gets or sets the String that defines the RoleClaimType.
RoleClaimTypeRetriever	Gets or sets a delegate that will be called to set the property RoleClaimType after validating a token.
SaveSigninToken	Gets or sets a boolean to control if the original token should be saved after the security token is validated.
SignatureValidator	Gets or sets a delegate that will be used to validate the signature of the token.
TokenDecryptionKeys	Gets the IList<T> that is to be used for decrypting inbound tokens.
TokenReplayCache	Gets or set the ITokenReplayCache that store tokens that can be checked to help detect token replay.
TokenReplayValidator	Allows overriding the delegate that will be used to validate the token replay of the token.
TokenTypeValidator	Allows overriding the delegate that will be used to validate the type of the token. If the token type cannot be validated, a ValidationResult<TResult,TError> MUST be returned by the delegate. Note: the 'type' parameter may be null if it couldn't be extracted from its usual location. Implementations that need to resolve it from a different location can use the 'token' parameter.
TryAllDecryptionKeys	Gets or sets a value indicating whether all TokenDecryptionKeys should be tried during token decryption when a key is not matched to token 'kid' or if token 'kid' is empty. The default is `true`.
TryAllIssuerSigningKeys	If the IssuerSigningKeyResolver is unable to resolve the key when validating the signature of the SecurityToken, all available keys will be tried.
ValidAlgorithms	Gets or sets the valid algorithms for cryptographic operations.
ValidateActor	Gets or sets a boolean that controls if the actor claim should be validated.
ValidateWithLKG	Gets or sets a boolean to control if the LKG configuration will be used for token validation.
ValidAudiences	Gets the IList<T> that contains valid audiences that will be used to check against the token's audience. The default is an empty collection.
ValidIssuers	Gets the IList<T> that contains valid issuers that will be used to check against the token's issuer. The default is an empty collection.
ValidTypes	Gets the IList<T> that contains valid types that will be used to check against the JWT header's 'typ' claim. If this property is not set, the 'typ' header claim will not be validated and all types will be accepted. In the case of a JWE, this property will ONLY apply to the inner token header. The default is an empty collection.

Methods

Clone()

Returns a new instance of ValidationParameters with values copied from this object.

CreateClaimsIdentity(SecurityToken, String)

Creates a ClaimsIdentity using:

AuthenticationType

'NameClaimType': If NameClaimTypeRetriever is set, call delegate, else call NameClaimType. If the result is a null or empty string, use DefaultNameClaimType

'RoleClaimType': If RoleClaimTypeRetriever is set, call delegate, else call RoleClaimType. If the result is a null or empty string, use DefaultRoleClaimType

Applies to