JwtSecurityTokenHandler.CreateJwtSecurityToken Method
Definition
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.
Overloads
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials, IDictionary<String,Object>)
Creates a JwtSecurityToken
public virtual System.IdentityModel.Tokens.Jwt.JwtSecurityToken CreateJwtSecurityToken (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 CreateJwtSecurityToken : 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> -> System.IdentityModel.Tokens.Jwt.JwtSecurityToken
override this.CreateJwtSecurityToken : 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> -> System.IdentityModel.Tokens.Jwt.JwtSecurityTokenPublic Overridable Function CreateJwtSecurityToken (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 JwtSecurityTokenParameters
- issuer
- String
The issuer of the token.
- audience
- String
The audience for this token.
- subject
- ClaimsIdentity
The source of the Claim(s) for this token.
- signingCredentials
- SigningCredentials
Contains cryptographic material for generating a signature.
- encryptingCredentials
- EncryptingCredentials
Contains cryptographic material for encrypting the token.
- claimCollection
- IDictionary<String,Object>
A collection of (key,value) pairs representing Claim(s) for this token.
Returns
Exceptions
If expires <= notBefore.
Remarks
If Actor is not null, then a claim { actort, 'value' } will be added to the payload. CreateActorValue(ClaimsIdentity) for details on how the value is created.
See for details on how the HeaderParameters are added to the header.
See for details on how the values are added to the payload.
Each Claim on the subject added will have Type translated according to the mapping found in OutboundClaimTypeMap. Adding and removing to OutboundClaimTypeMap will affect the name component of the Json claim.
SigningCredentials(SecurityKey, String) is used to sign RawData.
EncryptingCredentials(SecurityKey, String, String) is used to encrypt RawData or RawPayload .
Applies to
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials, EncryptingCredentials)
Creates a JwtSecurityToken
public virtual System.IdentityModel.Tokens.Jwt.JwtSecurityToken CreateJwtSecurityToken (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 CreateJwtSecurityToken : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.Jwt.JwtSecurityToken
override this.CreateJwtSecurityToken : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials * Microsoft.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.Jwt.JwtSecurityTokenPublic Overridable Function CreateJwtSecurityToken (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 JwtSecurityTokenParameters
- issuer
- String
The issuer of the token.
- audience
- String
The audience for this token.
- subject
- ClaimsIdentity
The source of the Claim(s) for this token.
- signingCredentials
- SigningCredentials
Contains cryptographic material for generating a signature.
- encryptingCredentials
- EncryptingCredentials
Contains cryptographic material for encrypting the token.
Returns
Exceptions
If expires <= notBefore.
Remarks
If Actor is not null, then a claim { actort, 'value' } will be added to the payload. CreateActorValue(ClaimsIdentity) for details on how the value is created.
See for details on how the HeaderParameters are added to the header.
See for details on how the values are added to the payload.
Each Claim on the subject added will have Type translated according to the mapping found in OutboundClaimTypeMap. Adding and removing to OutboundClaimTypeMap will affect the name component of the Json claim.
SigningCredentials(SecurityKey, String) is used to sign RawData.
EncryptingCredentials(SecurityKey, String, String) is used to encrypt RawData or RawPayload .
Applies to
CreateJwtSecurityToken(SecurityTokenDescriptor)
Creates a Json Web Token (JWT).
public virtual System.IdentityModel.Tokens.Jwt.JwtSecurityToken CreateJwtSecurityToken (Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor tokenDescriptor);abstract member CreateJwtSecurityToken : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> System.IdentityModel.Tokens.Jwt.JwtSecurityToken
override this.CreateJwtSecurityToken : Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor -> System.IdentityModel.Tokens.Jwt.JwtSecurityTokenPublic Overridable Function CreateJwtSecurityToken (tokenDescriptor As SecurityTokenDescriptor) As JwtSecurityTokenParameters
- tokenDescriptor
- SecurityTokenDescriptor
A SecurityTokenDescriptor that contains details of contents of the token.
Returns
Remarks
SigningCredentials is used to sign RawData.
Applies to
CreateJwtSecurityToken(String, String, ClaimsIdentity, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>, SigningCredentials)
Creates a JwtSecurityToken
public virtual System.IdentityModel.Tokens.Jwt.JwtSecurityToken CreateJwtSecurityToken (string issuer = default, string audience = default, System.Security.Claims.ClaimsIdentity subject = default, DateTime? notBefore = default, DateTime? expires = default, DateTime? issuedAt = default, Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials = default);abstract member CreateJwtSecurityToken : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials -> System.IdentityModel.Tokens.Jwt.JwtSecurityToken
override this.CreateJwtSecurityToken : string * string * System.Security.Claims.ClaimsIdentity * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> * Microsoft.IdentityModel.Tokens.SigningCredentials -> System.IdentityModel.Tokens.Jwt.JwtSecurityTokenPublic Overridable Function CreateJwtSecurityToken (Optional issuer As String = Nothing, Optional audience As String = Nothing, Optional subject As ClaimsIdentity = Nothing, Optional notBefore As Nullable(Of DateTime) = Nothing, Optional expires As Nullable(Of DateTime) = Nothing, Optional issuedAt As Nullable(Of DateTime) = Nothing, Optional signingCredentials As SigningCredentials = Nothing) As JwtSecurityTokenParameters
- issuer
- String
The issuer of the token.
- audience
- String
The audience for this token.
- subject
- ClaimsIdentity
The source of the Claim(s) for this token.
- signingCredentials
- SigningCredentials
Contains cryptographic material for generating a signature.
Returns
Exceptions
If expires <= notBefore.
Remarks
If Actor is not null, then a claim { actort, 'value' } will be added to the payload. CreateActorValue(ClaimsIdentity) for details on how the value is created.
See for details on how the HeaderParameters are added to the header.
See for details on how the values are added to the payload.
Each Claim on the subject added will have Type translated according to the mapping found in OutboundClaimTypeMap. Adding and removing to OutboundClaimTypeMap will affect the name component of the Json claim.
SigningCredentials(SecurityKey, String) is used to sign RawData.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for