Table of Contents

Class JwtClaimTypes

Namespace
Fdyay.IdentityServer
Assembly
Fdyay.IdentityServer.Core.dll

Well-known JWT and OpenID Connect claim type names.

public static class JwtClaimTypes
Inheritance
JwtClaimTypes
Inherited Members

Fields

AccessTokenHash

OpenID Connect Core 1.0 §3.1.3.6: the left half of the hash of the access token issued with the identity token, base64url-encoded.

public const string AccessTokenHash = "at_hash"

Field Value

string

Actor

RFC 8693 §4.1: who is acting for the subject, and — nested — who acted before them.

public const string Actor = "act"

Field Value

string

Address

OpenID Connect Core 1.0 §5.1: the user's postal address, as a JSON object (§5.1.1).

public const string Address = "address"

Field Value

string

Audience

RFC 7519 §4.1.3: the recipients the token is intended for.

public const string Audience = "aud"

Field Value

string

AuthenticationContextClassReference

OpenID Connect Core 1.0 §2: the authentication context class the user's authentication satisfied.

public const string AuthenticationContextClassReference = "acr"

Field Value

string

AuthenticationMethod

OpenID Connect Core 1.0 §2: the methods the user authenticated with, such as pwd or mfa (values registered by RFC 8176).

public const string AuthenticationMethod = "amr"

Field Value

string

AuthenticationRequestId

CIBA Core §10.3.1: the request a pushed identity token answers.

public const string AuthenticationRequestId = "urn:openid:params:jwt:claim:auth_req_id"

Field Value

string

AuthenticationTime

OpenID Connect Core 1.0 §2: when the user authenticated, in seconds since the Unix epoch.

public const string AuthenticationTime = "auth_time"

Field Value

string

AuthorizationCodeHash

OpenID Connect Core 1.0 §3.3.2.11: the left half of the hash of the authorization code issued with the identity token, base64url-encoded.

public const string AuthorizationCodeHash = "c_hash"

Field Value

string

AuthorizedParty

OpenID Connect Core 1.0 §2: the client the token was issued to.

public const string AuthorizedParty = "azp"

Field Value

string

BirthDate

OpenID Connect Core 1.0 §5.1: the user's birthday, as an ISO 8601 YYYY-MM-DD date (or YYYY, or 0000-MM-DD).

public const string BirthDate = "birthdate"

Field Value

string

ClientId

RFC 8693 §4.3: the client the token was issued to.

public const string ClientId = "client_id"

Field Value

string

Confirmation

RFC 7800: the proof-of-possession key the token is bound to.

public const string Confirmation = "cnf"

Field Value

string

DPoPAccessTokenHash

RFC 9449 §4.2: the hash of the access token a DPoP proof was made for.

public const string DPoPAccessTokenHash = "ath"

Field Value

string

DPoPHttpMethod

RFC 9449 §4.2: the HTTP method of the request a DPoP proof was made for.

public const string DPoPHttpMethod = "htm"

Field Value

string

DPoPHttpUrl

RFC 9449 §4.2: the URL of the request a DPoP proof was made for.

public const string DPoPHttpUrl = "htu"

Field Value

string

Email

OpenID Connect Core 1.0 §5.1: the user's preferred e-mail address.

public const string Email = "email"

Field Value

string

EmailVerified

OpenID Connect Core 1.0 §5.1: whether the user's e-mail address has been verified; a boolean.

public const string EmailVerified = "email_verified"

Field Value

string

Events

RFC 8417 §2.2: the events a Security Event Token reports; in a logout token, the back-channel logout event (OpenID Connect Back-Channel Logout 1.0 §2.4).

public const string Events = "events"

Field Value

string

Expiration

RFC 7519 §4.1.4: the time at or after which the token must not be accepted, in seconds since the Unix epoch.

public const string Expiration = "exp"

Field Value

string

FamilyName

OpenID Connect Core 1.0 §5.1: the user's family name (surname).

public const string FamilyName = "family_name"

Field Value

string

Gender

OpenID Connect Core 1.0 §5.1: the user's gender.

public const string Gender = "gender"

Field Value

string

GivenName

OpenID Connect Core 1.0 §5.1: the user's given (first) name.

public const string GivenName = "given_name"

Field Value

string

IdentityProvider

The identity provider the user signed in with: an external scheme's name, or LocalIdentityProvider for this server's own sign-in. Not a registered claim.

public const string IdentityProvider = "idp"

Field Value

string

IssuedAt

RFC 7519 §4.1.6: when the token was issued, in seconds since the Unix epoch.

public const string IssuedAt = "iat"

Field Value

string

Issuer

RFC 7519 §4.1.1: the authority that issued the token.

public const string Issuer = "iss"

Field Value

string

JwtId

RFC 7519 §4.1.7: a unique identifier for the token.

public const string JwtId = "jti"

Field Value

string

Locale

OpenID Connect Core 1.0 §5.1: the user's locale, as a BCP 47 language tag such as en-US.

public const string Locale = "locale"

Field Value

string

MiddleName

OpenID Connect Core 1.0 §5.1: the user's middle name.

public const string MiddleName = "middle_name"

Field Value

string

Name

OpenID Connect Core 1.0 §5.1: the user's full name, in displayable form.

public const string Name = "name"

Field Value

string

NickName

OpenID Connect Core 1.0 §5.1: the casual name the user goes by.

public const string NickName = "nickname"

Field Value

string

Nonce

OpenID Connect Core 1.0 §2: the nonce from the authentication request, echoed back so the client can detect a replayed identity token.

public const string Nonce = "nonce"

Field Value

string

NotBefore

RFC 7519 §4.1.5: the time before which the token must not be accepted, in seconds since the Unix epoch.

public const string NotBefore = "nbf"

Field Value

string

PhoneNumber

OpenID Connect Core 1.0 §5.1: the user's preferred telephone number.

public const string PhoneNumber = "phone_number"

Field Value

string

PhoneNumberVerified

OpenID Connect Core 1.0 §5.1: whether the user's telephone number has been verified; a boolean.

public const string PhoneNumberVerified = "phone_number_verified"

Field Value

string

Picture

OpenID Connect Core 1.0 §5.1: the URL of the user's profile picture.

public const string Picture = "picture"

Field Value

string

PreferredUserName

OpenID Connect Core 1.0 §5.1: the short name the user prefers to be referred to by; not guaranteed unique.

public const string PreferredUserName = "preferred_username"

Field Value

string

Profile

OpenID Connect Core 1.0 §5.1: the URL of the user's profile page.

public const string Profile = "profile"

Field Value

string

ReferenceTokenId

The reference-token id Duende's introspection carries. Never written here; filtered from what a profile service contributes.

public const string ReferenceTokenId = "reference_token_id"

Field Value

string

RefreshTokenHash

CIBA Core §10.3.1: the hash of the refresh token pushed beside the identity token.

public const string RefreshTokenHash = "urn:openid:params:jwt:claim:rt_hash"

Field Value

string

Role

A role the user holds, one claim per role. Not a registered claim; the role claim type of the principals this server builds.

public const string Role = "role"

Field Value

string

Scope

RFC 8693 §4.2: the scopes the access token grants. A space-separated string in this server's JWTs, or an array when EmitScopesAsSpaceDelimitedStringInJwt is off.

public const string Scope = "scope"

Field Value

string

SessionId

The identifier of the user's session at this server, which a logout notification names (OpenID Connect Front-Channel Logout 1.0 §3, Back-Channel Logout 1.0 §2.4).

public const string SessionId = "sid"

Field Value

string

Subject

RFC 7519 §4.1.2: the identifier of the user the token is about.

public const string Subject = "sub"

Field Value

string

Tenant

The tenant a session belongs to, compared with a request's tenant: hint.

public const string Tenant = "tenant"

Field Value

string

UpdatedAt

OpenID Connect Core 1.0 §5.1: when the user's information was last updated, in seconds since the Unix epoch.

public const string UpdatedAt = "updated_at"

Field Value

string

WebSite

OpenID Connect Core 1.0 §5.1: the URL of the user's web page or blog.

public const string WebSite = "website"

Field Value

string

ZoneInfo

OpenID Connect Core 1.0 §5.1: the user's time zone, as a tz database name such as Europe/Paris.

public const string ZoneInfo = "zoneinfo"

Field Value

string