CognitoIdToken extension

Standard OIDC and Cognito-specific ID token claims.

References:

on

Properties

address → String?
The user's preferred postal address.
no setter
birthdate → String?
The user's birthday, represented as an ISO 8601 YYYY-MM-DD format.
no setter
customAttributes → Map<CognitoUserAttributeKey, Object>
Custom Cognito user pool attributes.
no setter
email → String?
The user's preferred e-mail address.
no setter
emailVerified → bool?
Whether the user's preferred e-mail address has been verified.
no setter
familyName → String?
Surname(s) or last name(s) of the user.
no setter
gender → String?
The user's gender.
no setter
givenName → String?
Given name(s) or first name(s) of the user.
no setter
locale → String?
The user's locale, represented as a BCP47 language tag, e.g. en-US.
no setter
middleName → String?
Middle name(s) of the user.
no setter
name → String?
The user's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the user's locale and preferences.
no setter
nickname → String?
Casual name of the user that may or may not be the same as their given name.
no setter
nonce → String?
The nonce claim comes from a parameter of the same name that you can add to requests to your OAuth 2.0 authorize endpoint. When you add the parameter, the nonce claim is included in the ID token that Amazon Cognito issues, and you can use it to guard against replay attacks.
no setter
phoneNumber → String?
The user's preferred telephone number.
no setter
phoneNumberVerified → bool?
Whether the user's preferred telephone number has been verified.
no setter
picture → String?
URL of the user's profile picture.
no setter
preferredUsername → String?
The username by which the user wishes to be referred to.
no setter
profile → String?
URL of the user's profile page.
no setter
standardAttributes → Map<CognitoUserAttributeKey, Object>
Standard Cognito user pool attributes.
no setter
updatedAt → DateTime?
The time the user's information was last updated.
no setter
username → String
The Cognito username.
no setter
website → String?
URL of the user's Web page or blog.
no setter
zoneinfo → String?
A string from the zoneinfo time zone database representing the user's time zone, e.g. America/Los_Angeles.
no setter