JsonWebTokenHandler.CreateToken 方法

定義

命名空間:: Microsoft.IdentityModel.JsonWebTokens

組件:: Microsoft.IdentityModel.JsonWebTokens.dll

套件:: Microsoft.IdentityModel.JsonWebTokens v8.19.1

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

多載

名稱	Description
CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>)	建立 JSON 網頁加密（JWE）。
CreateToken(String, SigningCredentials, EncryptingCredentials, String)	建立 JSON 網頁加密（JWE）。
CreateToken(String, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	建立 JSON 網頁加密（JWE）。
CreateToken(String, SigningCredentials, IDictionary<String,Object>)	建立 JSON 網頁簽章（JWS）。
CreateToken(String, SigningCredentials, EncryptingCredentials)	建立 JSON 網頁加密（JWE）。
CreateToken(String, EncryptingCredentials, String)	建立 JSON 網頁加密（JWE）。
CreateToken(String, SigningCredentials)	建立 JSON 網頁簽章（JWS）。
CreateToken(String, IDictionary<String,Object>)	建立一個未簽署的 JSON 網頁簽章（JWS）。
CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>, IDictionary<String,Object>)	建立 JSON 網頁加密（JWE）。
CreateToken(String, EncryptingCredentials)	建立 JSON 網頁加密（JWE）。
CreateToken(String)	建立一個未簽署的 JSON 網頁簽章（JWS）。
CreateToken(SecurityTokenDescriptor)	建立一個可以是 JWS 或 JWE。
CreateToken(String, EncryptingCredentials, IDictionary<String,Object>)	建立 JSON 網頁加密（JWE）。

CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>)

建立 JSON 網頁加密（JWE）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> -> string

Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String, additionalHeaderClaims As IDictionary(Of String, Object)) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

signingCredentials: SigningCredentials

定義用於簽署JWT的安全金鑰與演算法。

encryptingCredentials: EncryptingCredentials

定義用於加密 JWT 的安全金鑰與演算法。

compressionAlgorithm: String

定義將用於壓縮 JWT 標記有效載荷的壓縮演算法。

additionalHeaderClaims: IDictionary<String,Object>

定義字典，包含任何需要加入外部 JWT 標記標頭的自訂標頭聲明。

傳回

String

一個以緊湊序列化格式呈現的 JWE。

例外狀況

ArgumentNullException

如果 additionalHeaderClaims 是空，則擲出。

SecurityTokenException

若 Alg、、 Kid Enc X5t和/或 Zip 都位於內additionalHeaderClaims，則擲出。

適用於

CreateToken(String, SigningCredentials, EncryptingCredentials, String)

建立 JSON 網頁加密（JWE）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string

Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

signingCredentials: SigningCredentials

定義用於簽署JWT的安全金鑰與演算法。

encryptingCredentials: EncryptingCredentials

定義用於加密 JWT 的安全金鑰與演算法。

compressionAlgorithm: String

定義將用於壓縮 JWT 標記有效載荷的壓縮演算法。

傳回

String

一個以緊湊序列化格式呈現的 JWE。

例外狀況

ArgumentNullException

如果 compressionAlgorithm 是空，則擲出。

適用於

CreateToken(String, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)

建立 JSON 網頁加密（JWE）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string

Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

signingCredentials: SigningCredentials

定義用於簽署JWT的安全金鑰與演算法。

encryptingCredentials: EncryptingCredentials

定義用於加密 JWT 的安全金鑰與演算法。

additionalHeaderClaims: IDictionary<String,Object>

定義字典，包含任何需要加入外部 JWT 標記標頭的自訂標頭聲明。

傳回

String

一個以緊湊序列化格式呈現的 JWE。

例外狀況

ArgumentNullException

如果 additionalHeaderClaims 是空，則擲出。

SecurityTokenException

若 Alg、、 Kid Enc X5t和/或 Zip 都位於內additionalHeaderClaims，則擲出。

適用於

CreateToken(String, SigningCredentials, IDictionary<String,Object>)

建立 JSON 網頁簽章（JWS）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * System.Collections.Generic.IDictionary<string, obj> -> string

Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

signingCredentials: SigningCredentials

定義用於簽署JWS的安全金鑰與演算法。

additionalHeaderClaims: IDictionary<String,Object>

定義字典，包含任何需要加入 JWT 標記標頭的自訂標頭聲明。

傳回

String

一個以緊湊序列化格式呈現的 JWS。

例外狀況

ArgumentNullException

如果 additionalHeaderClaims 是空，則擲出。

SecurityTokenException

若 Alg、、 Kid Enc X5t和/或 Zip 都位於內additionalHeaderClaims，則擲出。

適用於

CreateToken(String, SigningCredentials, EncryptingCredentials)

建立 JSON 網頁加密（JWE）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string

Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

signingCredentials: SigningCredentials

定義用於簽署JWT的安全金鑰與演算法。

encryptingCredentials: EncryptingCredentials

定義用於加密 JWT 的安全金鑰與演算法。

傳回

String

一個以緊湊序列化格式呈現的 JWE。

例外狀況

ArgumentNullException

如果 encryptingCredentials 是空，則擲出。

適用於

CreateToken(String, EncryptingCredentials, String)

建立 JSON 網頁加密（JWE）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string -> string

Public Overridable Function CreateToken (payload As String, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

encryptingCredentials: EncryptingCredentials

這是用來加密JWT的安全金鑰與演算法。

compressionAlgorithm: String

將用於壓縮 JWT 令牌有效載荷的壓縮演算法。

傳回

String

一個以緊湊序列化格式呈現的 JWE。

例外狀況

ArgumentNullException

如果 compressionAlgorithm 是空或空，則會拋出。

適用於

CreateToken(String, SigningCredentials)

建立 JSON 網頁簽章（JWS）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials -> string

Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

signingCredentials: SigningCredentials

定義用於簽署JWS的安全金鑰與演算法。

傳回

String

一個以緊湊序列化格式呈現的 JWS。

例外狀況

ArgumentNullException

如果 signingCredentials 是空，則擲出。

適用於

CreateToken(String, IDictionary<String,Object>)

建立一個未簽署的 JSON 網頁簽章（JWS）。

public virtual string CreateToken(string payload, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);

abstract member CreateToken : string * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * System.Collections.Generic.IDictionary<string, obj> -> string

Public Overridable Function CreateToken (payload As String, additionalHeaderClaims As IDictionary(Of String, Object)) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

additionalHeaderClaims: IDictionary<String,Object>

定義字典，包含任何需要加入 JWT 標記標頭的自訂標頭聲明。

傳回

String

一個以緊湊序列化格式呈現的 JWS。

例外狀況

ArgumentNullException

如果 additionalHeaderClaims 是空，則擲出。

適用於

CreateToken(String, SigningCredentials, EncryptingCredentials, String, IDictionary<String,Object>, IDictionary<String,Object>)

建立 JSON 網頁加密（JWE）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, string compressionAlgorithm, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims, System.Collections.Generic.IDictionary<string,object> additionalInnerHeaderClaims);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * string * System.Collections.Generic.IDictionary<string, obj> * System.Collections.Generic.IDictionary<string, obj> -> string

Public Overridable Function CreateToken (payload As String, signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, compressionAlgorithm As String, additionalHeaderClaims As IDictionary(Of String, Object), additionalInnerHeaderClaims As IDictionary(Of String, Object)) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

signingCredentials: SigningCredentials

定義用於簽署JWT的安全金鑰與演算法。

encryptingCredentials: EncryptingCredentials

定義用於加密 JWT 的安全金鑰與演算法。

compressionAlgorithm: String

定義將用於壓縮 JWT 標記有效載荷的壓縮演算法。

additionalHeaderClaims: IDictionary<String,Object>

定義字典，包含任何需要加入外部 JWT 標記標頭的自訂標頭聲明。

additionalInnerHeaderClaims: IDictionary<String,Object>

定義字典，包含任何需要加入內部 JWT 標記標頭的自訂標頭聲明。

傳回

String

一個以緊湊序列化格式呈現的 JWE。

例外狀況

ArgumentNullException

如果 additionalHeaderClaims 是空，則擲出。

SecurityTokenException

若 Alg、、 Kid Enc X5t和/或 Zip 都位於內additionalHeaderClaims，則擲出。

適用於

CreateToken(String, EncryptingCredentials)

建立 JSON 網頁加密（JWE）。

public virtual string CreateToken(string payload, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);

abstract member CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string
override this.CreateToken : string * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string

Public Overridable Function CreateToken (payload As String, encryptingCredentials As EncryptingCredentials) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

encryptingCredentials: EncryptingCredentials

定義用於加密 JWT 的安全金鑰與演算法。

傳回

String

一個以緊湊序列化格式呈現的 JWE。

適用於

CreateToken(String)

建立一個未簽署的 JSON 網頁簽章（JWS）。

public virtual string CreateToken(string payload);

abstract member CreateToken : string -> string
override this.CreateToken : string -> string

Public Overridable Function CreateToken (payload As String) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

傳回

String

一個以緊湊序列化格式呈現的 JWS。

例外狀況

ArgumentNullException

如果 payload 是空，則擲出。

適用於

CreateToken(SecurityTokenDescriptor)

建立一個可以是 JWS 或 JWE。

public virtual string CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor tokenDescriptor);

abstract member CreateToken : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> string
override this.CreateToken : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> string

Public Overridable Function CreateToken (tokenDescriptor As SecurityTokenDescriptor) As String

參數

tokenDescriptor: SecurityTokenDescriptor

SecurityTokenDescriptor A 包含代幣內容的詳細資訊。

傳回

String

一個以緊湊序列化格式呈現的 JWT。

適用於

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

建立 JSON 網頁加密（JWE）。

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

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

Public Overridable Function CreateToken (payload As String, encryptingCredentials As EncryptingCredentials, additionalHeaderClaims As IDictionary(Of String, Object)) As String

參數

payload: String

一個包含 JSON 的字串，代表 JWT token 有效載荷。

encryptingCredentials: EncryptingCredentials

定義用於加密 JWT 的安全金鑰與演算法。

additionalHeaderClaims: IDictionary<String,Object>

定義字典，包含任何需要加入外部 JWT 標記標頭的自訂標頭聲明。

傳回

String

一個以緊湊序列化格式呈現的 JWS。

例外狀況

ArgumentNullException

如果 additionalHeaderClaims 是空，則擲出。

SecurityTokenException

若 Alg、、 Kid Enc X5t和/或 Zip 都位於內additionalHeaderClaims，則擲出。

適用於

意見反應

此頁面對您有幫助嗎？