IdTokenClaimAccessor mixin

The claims of an ID token: who issued it, for whom, until when, and the nonce.

Spring (Java): IdTokenClaimAccessor.

Superclass constraints

Properties

accessTokenHash → String?
at_hash.
no setter
address → Map<String, Object?>?
address: a JSON object (street_address, locality, ...).
no setterinherited
audience → List<String>
aud: the clients the token is for; it must name this one.
no setter
authenticatedAt → DateTime?
auth_time: when the user last entered credentials (UTC).
no setter
authenticationContextClass → String?
acr.
no setter
authenticationMethods → List<String>?
amr.
no setter
authorizationCodeHash → String?
c_hash.
no setter
authorizedParty → String?
azp: the client the token was issued to.
no setter
birthdate → String?
birthdate, as written (YYYY-MM-DD, or a year alone).
no setterinherited
claims → Map<String, Object?>
The claims, by name; cannot be modified.
no setterinherited
email → String?
email.
no setterinherited
emailVerified → bool?
email_verified: whether the provider checked the email.
no setterinherited
expiresAt → DateTime?
exp: when the token expires (UTC).
no setter
familyName → String?
family_name.
no setterinherited
fullName → String?
name: the full name.
no setterinherited
gender → String?
gender.
no setterinherited
givenName → String?
given_name.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
issuedAt → DateTime?
iat: when the token was issued (UTC).
no setter
issuer → String?
iss: the provider that issued the token.
no setter
locale → String?
locale, such as en-US.
no setterinherited
middleName → String?
middle_name.
no setterinherited
nickName → String?
nickname.
no setterinherited
nonce → String?
nonce: what the client sent in the authorization request (here, its SHA-256 hash).
no setter
phoneNumber → String?
phone_number.
no setterinherited
phoneNumberVerified → bool?
phone_number_verified.
no setterinherited
picture → String?
picture: the URL of the picture.
no setterinherited
preferredUsername → String?
preferred_username: the name the user goes by, not unique.
no setterinherited
profile → String?
profile: the URL of the profile page.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subject → String?
sub: the user's id at the provider; never changes for one user.
no setterinherited
updatedAt → DateTime?
updated_at: when the profile last changed.
no setterinherited
website → String?
website.
no setterinherited
zoneInfo → String?
zoneinfo: the time zone, such as Europe/Paris.
no setterinherited

Methods

getClaimAsBoolean(String name) → bool?
The claim name as a boolean: true / false or the strings "true" / "false"; null when absent or anything else.
inherited
getClaimAsInstant(String name) → DateTime?
The claim name as a time: seconds since 1970 (a NumericDate), in UTC; null when absent or not a number.
inherited
getClaimAsMap(String name) → Map<String, Object?>?
The claim name as a JSON object; null when absent or not an object.
inherited
getClaimAsString(String name) → String?
The claim name as text (toString() of a number); null when absent.
inherited
getClaimAsStringList(String name) → List<String>?
The claim name as a list of text: a single string gives a list of one; null when absent.
inherited
hasClaim(String name) → bool
Whether the claim name is present (even with a null value).
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited