Skip to main content

JWTClaim

List of registered and public claims.

Index

Enumeration Members

accessTokenHash

accessTokenHash: number

Access Token hash value

aceProfile

aceProfile: number

"The ACE profile a token is supposed to be used with."

actor

actor: number

Actor

address

address: number

Preferred postal address

attestationLevel

attestationLevel: number

Attestation level as defined in SHAKEN framework

audience

audience: number

Audience

authContextClassReference

authContextClassReference: number

Authentication Context Class Reference

authMethodsReference

authMethodsReference: number

Authentication Methods References

authTime

authTime: number

Time when the authentication occurred

authorizedActor

authorizedActor: number

"Authorized Actor - the party that is authorized to become the actor"

authorizedParty

authorizedParty: number

Authorized party - the party to which the ID Token was issued

birthdate

birthdate: number

Birthday

clientId

clientId: number

Client Identifier

clientNonce

clientNonce: number

A nonce previously provided to the AS by the RS via the client. Used to verify token freshness when the RS cannot synchronize its clock with the AS."

codeHash

codeHash: number

Code hash value

confirmation

confirmation: number

Confirmation

custom

custom: number

Custom claim with the given name

destinationIdentity

destinationIdentity: number

Destination Identity String

divertedTarget

divertedTarget: number

Diverted Target of a Call

email

email: number

Preferred e-mail address

emailVerified

emailVerified: number

True if the e-mail address has been verified; otherwise false

entitlements

entitlements: number

Entitlements

events

events: number

Security Events

expirationTime

expirationTime: number

Expiration Time

expiresIn

expiresIn: number

"Expires in. Lifetime of the token in seconds from the time the RS first sees it. Used to implement a weaker from of token expiration for devices that cannot synchronize their internal clocks."

familyName

familyName: number

Surname(s) or last name(s)

gender

gender: number

Gender

givenName

givenName: number

Given name(s) or first name(s)

groups

groups: number

Groups

identityProvider

identityProvider: number

isPrivateEmail

isPrivateEmail: number

Indicates if the email address provided is a proxied address. Used predominantly by Sign In With Apple.

issuedAt

issuedAt: number

Issued At

issuer

issuer: iss

Issuer

jcardData

jcardData: number

jCard data

jwtId

jwtId: number

JWT ID

locale

locale: number

Locale

maxAPIRequestCount

maxAPIRequestCount: number

Number of API requests for which the access token can be used

mediaKeyFingerprint

mediaKeyFingerprint: number

Media Key Fingerprint String

middleName

middleName: number

Middle name(s)

name

name: number

Full name

nickname

nickname: number

Casual name

nonce

nonce: number

Value used to associate a Client session with an ID Token

nonceSupported

nonceSupported: number

Indicates whether the transaction is on a nonce-supported platform. If you sent a nonce in the authorization request but do not see the nonce claim in the ID token, check this claim to determine how to proceed. Used predominantly by Sign In With Apple.

notBefore

notBefore: number

Not Before

originalPassport

originalPassport: number

Original PASSporT (in Full Form)

originatingId

originatingId: number

Originating Identifier as defined in SHAKEN framework

originatingIdentity

originatingIdentity: number

Originating Identity String

phoneNumber

phoneNumber: number

Preferred telephone number

phoneNumberVerified

phoneNumberVerified: number

True if the phone number has been verified; otherwise false

picture

picture: number

Profile picture URL

preferredUsername

preferredUsername: number

Shorthand name by which the End-User wishes to be referred to

profile

profile: number

Profile page URL

realUserStatus

realUserStatus: number

Indicates the liklihood of whether or not this appears to be a real user. Used predominantly by Sign In With Apple.

resourcePriorityHeader

resourcePriorityHeader: number

Resource Priority Header Authorization

roles

roles: number

Roles

scope

scope: number

Scope Values

sessionId

sessionId: number

Session ID

sipCSeqNum

sipCSeqNum: number

SIP CSeq numeric header field parameter value

sipCallId

sipCallId: number

SIP Call-Id header field value

sipDate

sipDate: number

SIP Date header field value

sipFromTag

sipFromTag: number

SIP From tag header field parameter value

sipPriorityHeader

sipPriorityHeader: number

SIP Priority header field

sipViaBranch

sipViaBranch: number

SIP Via branch header field parameter value

subject

subject: number

Subject

subjectPublicKey

subjectPublicKey: number

Public key used to check the signature of an ID Token

timeOfEvent

timeOfEvent: number

Time of Event

tokenIntrospection

tokenIntrospection: number

Token introspection response

transactionId

transactionId: number

Transaction Identifier

transferSubject

transferSubject: number

Identifier used when transfering subjects. Used predominantly by Sign In With Apple.

updatedAt

updatedAt: number

Time the information was last updated

userId

userId: number

vectorOfTrust

vectorOfTrust: number

Vector of Trust value

vectorOfTrustMark

vectorOfTrustMark: number

Vector of Trust trustmark URL

verifiableCredential

verifiableCredential: number

Verifiable Credential as specified in the W3C Recommendation

verifiablePresentation

verifiablePresentation: number

Verifiable Presentation as specified in the W3C Recommendation

version

version: number

website

website: number

Web page or blog URL

zoneinfo

zoneinfo: number

Time zone