Share via


JsonWebTokenHandler.ReadToken(String) Method

Definition

Converts a string into an instance of JsonWebToken.

public override Microsoft.IdentityModel.Tokens.SecurityToken ReadToken (string token);
override this.ReadToken : string -> Microsoft.IdentityModel.Tokens.SecurityToken
Public Overrides Function ReadToken (token As String) As SecurityToken

Parameters

token
String

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

Returns

A JsonWebToken.

Exceptions

Thrown if token is null or empty.

Thrown if the length of token is greater than MaximumTokenSizeInBytes.

Remarks

The token is NOT validated and no security decisions should be made about the contents.

Use ValidateToken(String, TokenValidationParameters) or ValidateTokenAsync(String, TokenValidationParameters) to ensure the token is acceptable.

Applies to