JwtSecurityTokenHandler.ReadJwtToken(String) Method

Definition

Namespace:

System.IdentityModel.Tokens.Jwt

Assembly:

System.IdentityModel.Tokens.Jwt.dll

Package:

System.IdentityModel.Tokens.Jwt v8.2.1

Converts a string into an instance of JwtSecurityToken.

public System.IdentityModel.Tokens.Jwt.JwtSecurityToken ReadJwtToken (string token);

member this.ReadJwtToken : string -> System.IdentityModel.Tokens.Jwt.JwtSecurityToken

Public Function ReadJwtToken (token As String) As JwtSecurityToken

Parameters

token

String

A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.

Returns

JwtSecurityToken

A JwtSecurityToken

Exceptions

ArgumentNullException

token is null or empty.

ArgumentException

'token.Length' is greater than MaximumTokenSizeInBytes.

SecurityTokenMalformedException

CanReadToken(String)

Remarks

If the token is in JWE Compact Serialization format, only the protected header will be deserialized. This method is unable to decrypt the payload. Use ValidateToken(String, TokenValidationParameters, SecurityToken)to obtain the payload.

The token is NOT validated and no security decisions should be made about the contents. Use ValidateTokenAsync(String, TokenValidationParameters) to ensure the token is acceptable.