Validators.ValidateTokenType Method

Definition

Namespace:

Microsoft.IdentityModel.Tokens

Assembly:

Microsoft.IdentityModel.Tokens.dll

Package:

Microsoft.IdentityModel.Tokens v7.5.1

Validates the type of the token.

public static string ValidateTokenType (string type, Microsoft.IdentityModel.Tokens.SecurityToken securityToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);

static member ValidateTokenType : string * Microsoft.IdentityModel.Tokens.SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> string

Public Shared Function ValidateTokenType (type As String, securityToken As SecurityToken, validationParameters As TokenValidationParameters) As String

Parameters

type

String

The token type or null if it couldn't be resolved (e.g from the 'typ' header for a JWT).

securityToken

SecurityToken

The SecurityToken that is being validated.

validationParameters

TokenValidationParameters

TokenValidationParameters required for validation.

Returns

String

The actual token type, that may be the same as type or a different value if the token type was resolved from a different location.

Exceptions

ArgumentNullException

If securityToken is null.

SecurityTokenInvalidTypeException

If type failed to match ValidTypes.

Remarks

An EXACT match is required. Ordinal (case sensitive) is used for comparing type against ValidTypes.