JwtSecurityTokenHandler.CreateEncodedJwt Méthode

Définition

Espace de noms:: System.IdentityModel.Tokens.Jwt

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

Package:: System.IdentityModel.Tokens.Jwt v8.23.0

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Surcharges

Nom	Description
CreateEncodedJwt(SecurityTokenDescriptor)	Retourne un jeton web Json (JWT).
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)	Crée un JWT au format « Compact Serialization Format ».
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)	Crée un JWT au format « Compact Serialization Format ».
CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)	Crée un JWT au format « Compact Serialization Format ».

CreateEncodedJwt(SecurityTokenDescriptor)

Retourne un jeton web Json (JWT).

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

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

Public Overridable Function CreateEncodedJwt (tokenDescriptor As SecurityTokenDescriptor) As String

Paramètres

tokenDescriptor: SecurityTokenDescriptor

Qui SecurityTokenDescriptor contient les détails du contenu du jeton.

Retours

String

Remarques

Un JWS et JWE peuvent être retournés.

S’il EncryptingCredentialsest fourni, un JWE est créé.

S’il SigningCredentials est fourni, un JWS est créé.

Si les deux sont fournis, une JWE avec un JWS incorporé est créée.

S’applique à

CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)

Crée un JWT au format « Compact Serialization Format ».

public virtual string CreateEncodedJwt(string issuer, string audience, System.Security.Claims.ClaimsIdentity subject, DateTime? notBefore, DateTime? expires, DateTime? issuedAt, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials);

abstract member CreateEncodedJwt : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials -> string
override this.CreateEncodedJwt : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials -> string

Public Overridable Function CreateEncodedJwt (issuer As String, audience As String, subject As ClaimsIdentity, notBefore As Nullable(Of DateTime), expires As Nullable(Of DateTime), issuedAt As Nullable(Of DateTime), signingCredentials As SigningCredentials) As String

Paramètres

issuer: String

L’émetteur du jeton.

audience: String

Public pour ce jeton.

subject: ClaimsIdentity

Source du Claim(s) de ce jeton.

notBefore: Nullable<DateTime>

Notbefore time for this token.

expires: Nullable<DateTime>

Heure d’expiration de ce jeton.

issuedAt: Nullable<DateTime>

Heure du problème pour ce jeton.

signingCredentials: SigningCredentials

Contient des documents de chiffrement pour générer une signature.

Retours

String

Chaîne Base64UrlEncoded dans « Format de sérialisation compact ».

Remarques

S’il Actor n’est pas null, une revendication { actort, 'value' } sera ajoutée à la charge utile. Pour CreateActorValue(ClaimsIdentity) plus d’informations sur la création de la valeur.

Consultez seealso <cref="T :System.IdentityModel.Tokens.Jwt.JwtHeader"></seealso> pour plus d’informations sur la façon dont les HeaderParameters sont ajoutés à l’en-tête.

Consultez <seealso cref="T :System.IdentityModel.Tokens.Jwt.JwtPayload"></seealso> pour plus d’informations sur la façon dont les valeurs sont ajoutées à la charge utile.

Chacun Claim d’eux subject est mappé Type en appliquant OutboundClaimTypeMap. La modification OutboundClaimTypeMap peut modifier le JWT sortant.

S’il SigningCredentials est fourni, un JWS est créé.

S’applique à

CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)

Crée un JWT au format « Compact Serialization Format ».

public virtual string CreateEncodedJwt(string issuer, string audience, System.Security.Claims.ClaimsIdentity subject, DateTime? notBefore, DateTime? expires, DateTime? issuedAt, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);

abstract member CreateEncodedJwt : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string
override this.CreateEncodedJwt : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> string

Public Overridable Function CreateEncodedJwt (issuer As String, audience As String, subject As ClaimsIdentity, notBefore As Nullable(Of DateTime), expires As Nullable(Of DateTime), issuedAt As Nullable(Of DateTime), signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials) As String

Paramètres

issuer: String

L’émetteur du jeton.

audience: String

Public pour ce jeton.

subject: ClaimsIdentity

Source du Claim(s) de ce jeton.

notBefore: Nullable<DateTime>

Traduit en « époque temporelle » et affecté à « nbf ».

expires: Nullable<DateTime>

Traduit en « heure de l’époque » et affecté à « exp ».

issuedAt: Nullable<DateTime>

Traduit en « temps d’époque » et affecté à « iat ».

signingCredentials: SigningCredentials

Contient des documents de chiffrement pour la signature.

encryptingCredentials: EncryptingCredentials

Contient du matériel de chiffrement pour le chiffrement.

Retours

String

Chaîne Base64UrlEncoded dans « Format de sérialisation compact ».

Exceptions

ArgumentException

Si 'expire' <= 'notBefore'.

Remarques

S’il Actor n’est pas null, une revendication { actort, 'value' } sera ajoutée à la charge utile. CreateActorValue(ClaimsIdentity) pour plus d’informations sur la façon dont la valeur est créée.

Consultez seealso <cref="T :System.IdentityModel.Tokens.Jwt.JwtHeader"></seealso> pour plus d’informations sur la façon dont les HeaderParameters sont ajoutés à l’en-tête.

Consultez <seealso cref="T :System.IdentityModel.Tokens.Jwt.JwtPayload"></seealso> pour plus d’informations sur la façon dont les valeurs sont ajoutées à la charge utile.

Chacun Claim d’eux subject est mappé Type en appliquant OutboundClaimTypeMap. La modification OutboundClaimTypeMap peut modifier le JWT sortant.

S’applique à

CreateEncodedJwt(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)

Crée un JWT au format « Compact Serialization Format ».

public virtual string CreateEncodedJwt(string issuer, string audience, System.Security.Claims.ClaimsIdentity subject, DateTime? notBefore, DateTime? expires, DateTime? issuedAt, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,object> claimCollection);

abstract member CreateEncodedJwt : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string
override this.CreateEncodedJwt : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, obj> -> string

Public Overridable Function CreateEncodedJwt (issuer As String, audience As String, subject As ClaimsIdentity, notBefore As Nullable(Of DateTime), expires As Nullable(Of DateTime), issuedAt As Nullable(Of DateTime), signingCredentials As SigningCredentials, encryptingCredentials As EncryptingCredentials, claimCollection As IDictionary(Of String, Object)) As String

Paramètres

issuer: String

L’émetteur du jeton.

audience: String

Public pour ce jeton.

subject: ClaimsIdentity

Source du Claim(s) de ce jeton.

notBefore: Nullable<DateTime>

Traduit en « époque temporelle » et affecté à « nbf ».

expires: Nullable<DateTime>

Traduit en « heure de l’époque » et affecté à « exp ».

issuedAt: Nullable<DateTime>

Traduit en « temps d’époque » et affecté à « iat ».

signingCredentials: SigningCredentials

Contient des documents de chiffrement pour la signature.

encryptingCredentials: EncryptingCredentials

Contient du matériel de chiffrement pour le chiffrement.

claimCollection: IDictionary<String,Object>

Collection de paires (clé,valeur) représentant Claim(s) pour ce jeton.

Retours

String

Chaîne Base64UrlEncoded dans « Format de sérialisation compact ».

Exceptions

ArgumentException

Si 'expire' <= 'notBefore'.

Remarques

Consultez seealso <cref="T :System.IdentityModel.Tokens.Jwt.JwtHeader"></seealso> pour plus d’informations sur la façon dont les HeaderParameters sont ajoutés à l’en-tête.

Consultez <seealso cref="T :System.IdentityModel.Tokens.Jwt.JwtPayload"></seealso> pour plus d’informations sur la façon dont les valeurs sont ajoutées à la charge utile.

Chacun Claim d’eux subject est mappé Type en appliquant OutboundClaimTypeMap. La modification OutboundClaimTypeMap peut modifier le JWT sortant.

S’applique à

Commentaires

Cette page a-t-elle été utile ?