JwtPayload Constructors

Definition

Namespace:

System.IdentityModel.Tokens.Jwt

Assembly:

System.IdentityModel.Tokens.Jwt.dll

Package:

System.IdentityModel.Tokens.Jwt v7.5.2

Overloads

JwtPayload()	Initializes a new instance of the JwtPayload class with no claims. Default string comparer Ordinal. Creates a empty JwtPayload
JwtPayload(IEnumerable<Claim>)	Initializes a new instance of the JwtPayload class with IEnumerable<T>. Default string comparer Ordinal.
JwtPayload(String, String, IEnumerable<Claim>, Nullable<DateTime>, Nullable<DateTime>)	Initializes a new instance of the JwtPayload class with claims added for each parameter specified. Default string comparer Ordinal.
JwtPayload(String, String, IEnumerable<Claim>, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>)	Initializes a new instance of the JwtPayload class with claims added for each parameter specified. Default string comparer Ordinal.
JwtPayload(String, String, IEnumerable<Claim>, IDictionary<String,Object>, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>)	Initializes a new instance of the JwtPayload class with claims added for each parameter specified. Default string comparer Ordinal.

JwtPayload()

Initializes a new instance of the JwtPayload class with no claims. Default string comparer Ordinal. Creates a empty JwtPayload

public JwtPayload ();

Public Sub New ()

JwtPayload(IEnumerable<Claim>)

Initializes a new instance of the JwtPayload class with IEnumerable<T>. Default string comparer Ordinal.

public JwtPayload (System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> claims);

new System.IdentityModel.Tokens.Jwt.JwtPayload : seq<System.Security.Claims.Claim> -> System.IdentityModel.Tokens.Jwt.JwtPayload

Public Sub New (claims As IEnumerable(Of Claim))

Parameters

claims

IEnumerable<Claim>

JwtPayload(String, String, IEnumerable<Claim>, Nullable<DateTime>, Nullable<DateTime>)

Initializes a new instance of the JwtPayload class with claims added for each parameter specified. Default string comparer Ordinal.

public JwtPayload (string issuer, string audience, System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> claims, DateTime? notBefore, DateTime? expires);

new System.IdentityModel.Tokens.Jwt.JwtPayload : string * string * seq<System.Security.Claims.Claim> * Nullable<DateTime> * Nullable<DateTime> -> System.IdentityModel.Tokens.Jwt.JwtPayload

Public Sub New (issuer As String, audience As String, claims As IEnumerable(Of Claim), notBefore As Nullable(Of DateTime), expires As Nullable(Of DateTime))

Parameters

issuer

String

If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' if present.

audience

String

If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' if present.

claims

IEnumerable<Claim>

If this value is not null then for each Claim a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values.

notBefore

Nullable<DateTime>

If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' if present.

expires

Nullable<DateTime>

If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' if present.

JwtPayload(String, String, IEnumerable<Claim>, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>)

Initializes a new instance of the JwtPayload class with claims added for each parameter specified. Default string comparer Ordinal.

public JwtPayload (string issuer, string audience, System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> claims, DateTime? notBefore, DateTime? expires, DateTime? issuedAt);

new System.IdentityModel.Tokens.Jwt.JwtPayload : string * string * seq<System.Security.Claims.Claim> * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> -> System.IdentityModel.Tokens.Jwt.JwtPayload

Public Sub New (issuer As String, audience As String, claims As IEnumerable(Of Claim), notBefore As Nullable(Of DateTime), expires As Nullable(Of DateTime), issuedAt As Nullable(Of DateTime))

Parameters

issuer

String

If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' if present.

audience

String

If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' if present.

claims

IEnumerable<Claim>

If this value is not null then for each Claim a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values.

notBefore

Nullable<DateTime>

If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' if present.

expires

Nullable<DateTime>

If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' if present.

issuedAt

Nullable<DateTime>

If issuedAt.HasValue is 'true' a { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' if present.

Exceptions

ArgumentException

If 'expires' <= 'notbefore'.

Remarks

Comparison is set to Ordinal

The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over Claim(s) in 'claims'. The values will be overridden.

JwtPayload(String, String, IEnumerable<Claim>, IDictionary<String,Object>, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>)

Initializes a new instance of the JwtPayload class with claims added for each parameter specified. Default string comparer Ordinal.

public JwtPayload (string issuer, string audience, System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> claims, System.Collections.Generic.IDictionary<string,object> claimsCollection, DateTime? notBefore, DateTime? expires, DateTime? issuedAt);

new System.IdentityModel.Tokens.Jwt.JwtPayload : string * string * seq<System.Security.Claims.Claim> * System.Collections.Generic.IDictionary<string, obj> * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> -> System.IdentityModel.Tokens.Jwt.JwtPayload

Public Sub New (issuer As String, audience As String, claims As IEnumerable(Of Claim), claimsCollection As IDictionary(Of String, Object), notBefore As Nullable(Of DateTime), expires As Nullable(Of DateTime), issuedAt As Nullable(Of DateTime))

Parameters

issuer

String

If this value is not null, a { iss, 'issuer' } claim will be added, overwriting any 'iss' claim in 'claims' and 'claimCollection' if present.

audience

String

If this value is not null, a { aud, 'audience' } claim will be added, appending to any 'aud' claims in 'claims' or 'claimCollection' if present.

claims

IEnumerable<Claim>

If this value is not null then for each Claim a { 'Claim.Type', 'Claim.Value' } is added. If duplicate claims are found then a { 'Claim.Type', List<object> } will be created to contain the duplicate values.

claimsCollection

IDictionary<String,Object>

If both claims and claimsCollection are not null then the values in claims will be combined with the values in claimsCollection. The values found in claimCollection take precedence over those found in claims, so any duplicate values will be overridden.

notBefore

Nullable<DateTime>

If notbefore.HasValue a { nbf, 'value' } claim is added, overwriting any 'nbf' claim in 'claims' and 'claimcollection' if present.

expires

Nullable<DateTime>

If expires.HasValue a { exp, 'value' } claim is added, overwriting any 'exp' claim in 'claims' and 'claimcollection' if present.

issuedAt

Nullable<DateTime>

If issuedAt.HasValue is 'true' a { iat, 'value' } claim is added, overwriting any 'iat' claim in 'claims' and 'claimcollection' if present.

Exceptions

ArgumentException

If 'expires' <= 'notbefore'.

Remarks

Comparison is set to Ordinal

The 4 parameters: 'issuer', 'audience', 'notBefore', 'expires' take precedence over Claim(s) in 'claims' and 'claimcollection'. The values will be overridden.