JsonWebTokenHandler.ValidateTokenAsync Method
Definition
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.
Overloads
| ValidateTokenAsync(SecurityToken, TokenValidationParameters) |
Validates a token. On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property. Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result. |
| ValidateTokenAsync(String, TokenValidationParameters) |
Validates a token. On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property. Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result. |
ValidateTokenAsync(SecurityToken, TokenValidationParameters)
Validates a token. On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property. Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result.
public override System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult> ValidateTokenAsync (Microsoft.IdentityModel.Tokens.SecurityToken token, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);override this.ValidateTokenAsync : Microsoft.IdentityModel.Tokens.SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult>Public Overrides Function ValidateTokenAsync (token As SecurityToken, validationParameters As TokenValidationParameters) As Task(Of TokenValidationResult)Parameters
- token
- SecurityToken
The SecurityToken to be validated.
- validationParameters
- TokenValidationParameters
The TokenValidationParameters to be used for validating the token.
Returns
Applies to
ValidateTokenAsync(String, TokenValidationParameters)
Validates a token. On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property. Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result.
public override System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult> ValidateTokenAsync (string token, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);override this.ValidateTokenAsync : string * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult>Public Overrides Function ValidateTokenAsync (token As String, validationParameters As TokenValidationParameters) As Task(Of TokenValidationResult)Parameters
- token
- String
The token to be validated.
- validationParameters
- TokenValidationParameters
The TokenValidationParameters to be used for validating the token.
Returns
Exceptions
Thrown if validationParameters is null.
Thrown if 'token.Length' is greater than MaximumTokenSizeInBytes.
Thrown if the validationParameters.TokenReader delegate is not able to parse/read the token as a valid JsonWebToken, Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)
Remarks
TokenValidationResult.Exception will be set to one of the following exceptions if the token is invalid.