JwtSecurityTokenHandler.ValidateToken Method (String)

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 _
) As ClaimsPrincipal
public virtual ClaimsPrincipal ValidateToken(
    string jwtEncodedString
)
public:
virtual ClaimsPrincipal^ ValidateToken(
    String^ jwtEncodedString
)
abstract ValidateToken : 
        jwtEncodedString:string -> ClaimsPrincipal  
override ValidateToken : 
        jwtEncodedString:string -> ClaimsPrincipal
public function ValidateToken(
    jwtEncodedString : String
) : 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).

Return Value

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

Exceptions

Exception Condition
ArgumentNullException

'jwtEncodedString' is null.

Remarks

Calls ValidateToken.

To obtain the JwtSecurityToken, ReadToken is called.

.NET Framework Security

See Also

Reference

JwtSecurityTokenHandler Class

ValidateToken Overload

System.IdentityModel.Tokens Namespace