JwtSecurityTokenHandler.DecryptToken Method

Reference

Definition

Namespace:: System.IdentityModel.Tokens.Jwt

Assembly:: System.IdentityModel.Tokens.Jwt.dll

Package:: System.IdentityModel.Tokens.Jwt v7.5.1

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

protected string DecryptToken (System.IdentityModel.Tokens.Jwt.JwtSecurityToken jwtToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);

member this.DecryptToken : System.IdentityModel.Tokens.Jwt.JwtSecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> string

Protected Function DecryptToken (jwtToken As JwtSecurityToken, validationParameters As TokenValidationParameters) As String

Parameters

jwtToken: JwtSecurityToken

the JWE that contains the cypher text.

validationParameters: TokenValidationParameters

contains crypto material.

Returns

String

the decoded / cleartext contents of the JWE.

Exceptions

ArgumentNullException

if validationParameters is null.

SecurityTokenException

if 'jwtToken.Header.enc' is null or empty.

SecurityTokenEncryptionKeyNotFoundException

if 'jwtToken.Header.kid' is not null AND decryption fails.

SecurityTokenDecryptionFailedException

if the JWE was not able to be decrypted.

Applies to