JwtSecurityTokenHandler.ReadToken Method

Definition

Namespace:

System.IdentityModel.Tokens.Jwt

Assembly:

System.IdentityModel.Tokens.Jwt.dll

Package:

System.IdentityModel.Tokens.Jwt v8.2.1

Overloads

ReadToken(String)	Converts a string into an instance of JwtSecurityToken.
ReadToken(XmlReader, TokenValidationParameters)	Deserializes token with the provided TokenValidationParameters.

ReadToken(String)

Converts a string into an instance of JwtSecurityToken.

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 JwtSecurityToken

Exceptions

ArgumentNullException

token is null or empty.

ArgumentException

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.

ReadToken(XmlReader, TokenValidationParameters)

Deserializes token with the provided TokenValidationParameters.

public override Microsoft.IdentityModel.Tokens.SecurityToken ReadToken (System.Xml.XmlReader reader, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);

override this.ReadToken : System.Xml.XmlReader * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> Microsoft.IdentityModel.Tokens.SecurityToken

Public Overrides Function ReadToken (reader As XmlReader, validationParameters As TokenValidationParameters) As SecurityToken

Parameters

reader

XmlReader

XmlReader.

validationParameters

TokenValidationParameters

The TokenValidationParameters to be used for validating the token.

Returns

SecurityToken

The SecurityToken

Remarks

This method is not current supported.