JsonWebTokenHandler.DecryptToken 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.

Decrypts a JWE and returns the clear text.

public string DecryptToken (Microsoft.IdentityModel.JsonWebTokens.JsonWebToken jwtToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);

member this.DecryptToken : Microsoft.IdentityModel.JsonWebTokens.JsonWebToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> string

Public Function DecryptToken (jwtToken As JsonWebToken, validationParameters As TokenValidationParameters) As String

Parameters

jwtToken: JsonWebToken

The JWE that contains the cypher text.

validationParameters: TokenValidationParameters

The TokenValidationParameters to be used for validating the token.

Returns

String

The decoded / cleartext contents of the JWE.

Exceptions

ArgumentNullException

Thrown if validationParameters is null.

SecurityTokenException

Thrown if Enc is null or empty.

SecurityTokenDecompressionFailedException

Thrown if the decompression failed.

SecurityTokenEncryptionKeyNotFoundException

Thrown if Kid is not null AND the decryption fails.

SecurityTokenDecryptionFailedException

Thrown if the JWE was not able to be decrypted.

Applies to

Share via