JwtHeader Constructors
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
| JwtHeader() |
Initializes a new instance of the JwtHeader class. Default string comparer Ordinal. |
| JwtHeader(EncryptingCredentials) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, EncryptingCredentials.Alg }, { enc, EncryptingCredentials.Enc } } |
| JwtHeader(SigningCredentials) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, SigningCredentials.Algorithm } } |
| JwtHeader(EncryptingCredentials, IDictionary<String,String>) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, EncryptingCredentials.Algorithm } } |
| JwtHeader(SigningCredentials, IDictionary<String,String>) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, SigningCredentials.Algorithm } } |
| JwtHeader(EncryptingCredentials, IDictionary<String,String>, String) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, EncryptingCredentials.Algorithm } } |
| JwtHeader(SigningCredentials, IDictionary<String,String>, String) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, SigningCredentials.Algorithm } } |
| JwtHeader(EncryptingCredentials, IDictionary<String,String>, String, IDictionary<String,Object>) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, EncryptingCredentials.Algorithm } } |
| JwtHeader(SigningCredentials, IDictionary<String,String>, String, IDictionary<String,Object>) |
Initializes a new instance of JwtHeader. With the Header Parameters: { { typ, JWT }, { alg, SigningCredentials.Algorithm } } |
JwtHeader()
JwtHeader(EncryptingCredentials)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, EncryptingCredentials.Alg }, { enc, EncryptingCredentials.Enc } }
public JwtHeader (Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (encryptingCredentials As EncryptingCredentials)Parameters
- encryptingCredentials
- EncryptingCredentials
EncryptingCredentials used creating a JWE Compact JSON.
Exceptions
If 'encryptingCredentials' is null.
Applies to
JwtHeader(SigningCredentials)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, SigningCredentials.Algorithm } }
public JwtHeader (Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.SigningCredentials -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (signingCredentials As SigningCredentials)Parameters
- signingCredentials
- SigningCredentials
SigningCredentials used creating a JWS Compact JSON.
Applies to
JwtHeader(EncryptingCredentials, IDictionary<String,String>)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, EncryptingCredentials.Algorithm } }
public JwtHeader (Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,string> outboundAlgorithmMap);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, string> -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (encryptingCredentials As EncryptingCredentials, outboundAlgorithmMap As IDictionary(Of String, String))Parameters
- encryptingCredentials
- EncryptingCredentials
EncryptingCredentials used when creating a JWS Compact JSON.
- outboundAlgorithmMap
- IDictionary<String,String>
provides a mapping for the 'alg' value so that values are within the JWT namespace.
Exceptions
If 'encryptingCredentials' is null.
Applies to
JwtHeader(SigningCredentials, IDictionary<String,String>)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, SigningCredentials.Algorithm } }
public JwtHeader (Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, System.Collections.Generic.IDictionary<string,string> outboundAlgorithmMap);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.SigningCredentials * System.Collections.Generic.IDictionary<string, string> -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (signingCredentials As SigningCredentials, outboundAlgorithmMap As IDictionary(Of String, String))Parameters
- signingCredentials
- SigningCredentials
SigningCredentials used when creating a JWS Compact JSON.
- outboundAlgorithmMap
- IDictionary<String,String>
provides a mapping for the 'alg' value so that values are within the JWT namespace.
Applies to
JwtHeader(EncryptingCredentials, IDictionary<String,String>, String)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, EncryptingCredentials.Algorithm } }
public JwtHeader (Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,string> outboundAlgorithmMap, string tokenType);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, string> * string -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (encryptingCredentials As EncryptingCredentials, outboundAlgorithmMap As IDictionary(Of String, String), tokenType As String)Parameters
- encryptingCredentials
- EncryptingCredentials
EncryptingCredentials used when creating a JWS Compact JSON.
- outboundAlgorithmMap
- IDictionary<String,String>
provides a mapping for the 'alg' value so that values are within the JWT namespace.
- tokenType
- String
provides the token type
Exceptions
If 'encryptingCredentials' is null.
Applies to
JwtHeader(SigningCredentials, IDictionary<String,String>, String)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, SigningCredentials.Algorithm } }
public JwtHeader (Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, System.Collections.Generic.IDictionary<string,string> outboundAlgorithmMap, string tokenType);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.SigningCredentials * System.Collections.Generic.IDictionary<string, string> * string -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (signingCredentials As SigningCredentials, outboundAlgorithmMap As IDictionary(Of String, String), tokenType As String)Parameters
- signingCredentials
- SigningCredentials
SigningCredentials used when creating a JWS Compact JSON.
- outboundAlgorithmMap
- IDictionary<String,String>
provides a mapping for the 'alg' value so that values are within the JWT namespace.
- tokenType
- String
will be added as the value for the 'typ' claim in the header. If it is null or empty HeaderType will be used as token type
Applies to
JwtHeader(EncryptingCredentials, IDictionary<String,String>, String, IDictionary<String,Object>)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, EncryptingCredentials.Algorithm } }
public JwtHeader (Microsoft.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials, System.Collections.Generic.IDictionary<string,string> outboundAlgorithmMap, string tokenType, System.Collections.Generic.IDictionary<string,object> additionalHeaderClaims);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.EncryptingCredentials * System.Collections.Generic.IDictionary<string, string> * string * System.Collections.Generic.IDictionary<string, obj> -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (encryptingCredentials As EncryptingCredentials, outboundAlgorithmMap As IDictionary(Of String, String), tokenType As String, additionalHeaderClaims As IDictionary(Of String, Object))Parameters
- encryptingCredentials
- EncryptingCredentials
EncryptingCredentials used when creating a JWS Compact JSON.
- outboundAlgorithmMap
- IDictionary<String,String>
provides a mapping for the 'alg' value so that values are within the JWT namespace.
- tokenType
- String
provides the token type
- additionalHeaderClaims
- IDictionary<String,Object>
Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.
Exceptions
If 'encryptingCredentials' is null.
Applies to
JwtHeader(SigningCredentials, IDictionary<String,String>, String, IDictionary<String,Object>)
Initializes a new instance of JwtHeader. With the Header Parameters:
{ { typ, JWT }, { alg, SigningCredentials.Algorithm } }
public JwtHeader (Microsoft.IdentityModel.Tokens.SigningCredentials signingCredentials, System.Collections.Generic.IDictionary<string,string> outboundAlgorithmMap, string tokenType, System.Collections.Generic.IDictionary<string,object> additionalInnerHeaderClaims);new System.IdentityModel.Tokens.Jwt.JwtHeader : Microsoft.IdentityModel.Tokens.SigningCredentials * System.Collections.Generic.IDictionary<string, string> * string * System.Collections.Generic.IDictionary<string, obj> -> System.IdentityModel.Tokens.Jwt.JwtHeaderPublic Sub New (signingCredentials As SigningCredentials, outboundAlgorithmMap As IDictionary(Of String, String), tokenType As String, additionalInnerHeaderClaims As IDictionary(Of String, Object))Parameters
- signingCredentials
- SigningCredentials
SigningCredentials used when creating a JWS Compact JSON.
- outboundAlgorithmMap
- IDictionary<String,String>
provides a mapping for the 'alg' value so that values are within the JWT namespace.
- tokenType
- String
will be added as the value for the 'typ' claim in the header. If it is null or empty HeaderType will be used as token type
- additionalInnerHeaderClaims
- IDictionary<String,Object>
Defines the dictionary containing any custom header claims that need to be added to the inner JWT token header.
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