JwtSecurityTokenHandler.ValidateToken Method (String, TokenValidationParameters)

Reads and validates a token encoded in JSON Compact serialized format.

Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel.Tokens.Jwt (in System.IdentityModel.Tokens.Jwt.dll)

Syntax

'Declaration
Public Overridable Function ValidateToken ( _
    jwtEncodedString As String, _
    validationParameters As TokenValidationParameters _
) As ClaimsPrincipal

public virtual ClaimsPrincipal ValidateToken(
    string jwtEncodedString,
    TokenValidationParameters validationParameters
)

public:
virtual ClaimsPrincipal^ ValidateToken(
    String^ jwtEncodedString, 
    TokenValidationParameters^ validationParameters
)

abstract ValidateToken : 
        jwtEncodedString:string * 
        validationParameters:TokenValidationParameters -> ClaimsPrincipal  
override ValidateToken : 
        jwtEncodedString:string * 
        validationParameters:TokenValidationParameters -> ClaimsPrincipal

public function ValidateToken(
    jwtEncodedString : String, 
    validationParameters : TokenValidationParameters
) : ClaimsPrincipal

Parameters

• jwtEncodedString
  Type: System.String

  A 'JSON Web Token' (JWT) that has been encoded as a JSON object. May be signed using 'JSON Web Signature' (JWS).

• validationParameters
  Type: System.IdentityModel.Tokens.TokenValidationParameters

  Contains validation parameters for the JwtSecurityToken.

Return Value

Type: System.Security.Claims.ClaimsPrincipal
Returns ClaimsPrincipal.

Exceptions

Exception	Condition
ArgumentNullException	'jwtEncodedString' is null. -or- 'validationParameters' is null.

Remarks

Calls ValidateToken.

To obtain the JwtSecurityToken, ReadToken is called.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

JwtSecurityTokenHandler Class

ValidateToken Overload

System.IdentityModel.Tokens Namespace