JsonWebTokenHandler.EncryptToken メソッド

定義

名前空間:: Microsoft.IdentityModel.JsonWebTokens

アセンブリ:: Microsoft.IdentityModel.JsonWebTokens.dll

パッケージ:: Microsoft.IdentityModel.JsonWebTokens v8.19.1

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

名前	説明
EncryptToken(String, EncryptingCredentials)	JWS を暗号化します。
EncryptToken(String, EncryptingCredentials, IDictionary<String,Object>)	JWS を暗号化します。
EncryptToken(String, EncryptingCredentials, String)	JWS を暗号化します。
EncryptToken(String, EncryptingCredentials, String, IDictionary<String,Object>)	JWS を暗号化します。

EncryptToken(String, EncryptingCredentials)

JWS を暗号化します。

public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);

member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string

Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials) As String

パラメーター

innerJwt: String

JWS Compact シリアル化形式の JSON Web トークン (JWT)。

encryptingCredentials: EncryptingCredentials

innerJwtの暗号化に使用されるセキュリティキーとアルゴリズムを定義します。

返品

String

例外

ArgumentNullException

encryptingCredentialsが null の場合にスローされます。

ArgumentException

CryptoProviderFactoryとKeyの両方が null の場合にスローされます。

SecurityTokenEncryptionFailedException

サポートされているコンテンツ暗号化キー (CEK) アルゴリズムの 1 つ (128、384、または 512 AesCbcHmac) を使用していない場合にスローされます (これは、直接暗号化ではなく、キーラップのみの場合に適用されます)。

適用対象

EncryptToken(String, EncryptingCredentials, IDictionary<String,Object>)

JWS を暗号化します。

public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);

member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string

Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String

パラメーター

innerJwt: String

JWS Compact シリアル化形式の JSON Web トークン (JWT)。

encryptingCredentials: EncryptingCredentials

innerJwtの暗号化に使用されるセキュリティキーとアルゴリズムを定義します。

additionalHeaderClaims: IDictionary<String,Object>

外部 JWT トークンヘッダーに追加する必要があるカスタムヘッダー要求を含むディクショナリを定義します。

返品

String

例外

ArgumentNullException

additionalHeaderClaimsが null の場合にスローされます。

ArgumentException

CryptoProviderFactoryとKeyの両方が null の場合にスローされます。

SecurityTokenEncryptionFailedException

適用対象

EncryptToken(String, EncryptingCredentials, String)

JWS を暗号化します。

public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm);

member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string

Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, algorithm As String) As String

パラメーター

innerJwt: String

JWS Compact シリアル化形式の JSON Web トークン (JWT)。

encryptingCredentials: EncryptingCredentials

innerJwtの暗号化に使用されるセキュリティキーとアルゴリズムを定義します。

algorithm: String

innerJwtの圧縮に使用する圧縮アルゴリズムを定義します。

返品

String

例外

ArgumentNullException

algorithmが null または空の場合にスローされます。

ArgumentException

CryptoProviderFactoryとKeyの両方が null の場合にスローされます。

SecurityTokenEncryptionFailedException

SecurityTokenCompressionFailedException

algorithmを使用した圧縮が失敗した場合にスローされます。

適用対象

EncryptToken(String, EncryptingCredentials, String, IDictionary<String,Object>)

JWS を暗号化します。

public string EncryptToken(string innerJwt, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string algorithm, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);

member this.EncryptToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> -> string

Public Function EncryptToken (innerJwt As String, encryptingCredentials As EncryptingCredentials, algorithm As String, additionalHeaderClaims As IDictionary(Of String, Object)) As String