Type Alias JWTPayload
aud: string | string[];
birthdate?: string;
email?: string;
email_verified?: boolean;
exp: never;
family_name?: string;
gender?: "male" | "female" | string;
given_name?: string;
iat: number;
iss: never;
jti: never;
middle_name?: string;
name?: string;
nbf: number;
nickname?: string;
picture?: string;
preferred_username?: string;
profile?: string;
sub: string;
website?: string;
[key: string]: any;
}
Indexable
- [key: string]: any
Properties
aud
Optionalbirthdate
Optionalemail
End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
Optionalemail_
True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
exp
Optionalfamily_
Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
Optionalgender
End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
Optionalgiven_
Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
iat
iss
jti
Optionalmiddle_
Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
Optionalname
End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
nbf
Optionalnickname
Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
Optionalpicture
URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
Optionalpreferred_
Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
Optionalprofile
URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
sub
Optionalwebsite
URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
End-User's birthday, represented as an ISO 8601-1 [ISO8601‑1] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.