JsonWebTokenHandler.ReadToken(String) Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.JsonWebTokens

Assembly:: Microsoft.IdentityModel.JsonWebTokens.dll

Package:: Microsoft.IdentityModel.JsonWebTokens v8.2.0

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.

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

SecurityToken

A JsonWebToken.

Exceptions

ArgumentNullException

Thrown if token is null or empty.

ArgumentException

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

Delen via