Interface: UserIdentity
server.UserIdentity
Information about an authenticated user.
The only fields guaranteed to be present are tokenIdentifier and issuer. All remaining fields may or may not be present depending on the information given by the identity provider.
See the OpenID Connect specification for more information on these fields.
Properties
tokenIdentifier
• Readonly
tokenIdentifier: string
A stable and globally unique string for this identity (i.e. no other user, even from a different identity provider, will have the same string.)
Defined in
subject
• Readonly
subject: string
Identifier for the end-user from the identity provider, not necessarily unique across different providers.
Defined in
issuer
• Readonly
issuer: string
The hostname of the identity provider used to authenticate this user.
Defined in
name
• Optional
Readonly
name: string
Defined in
givenName
• Optional
Readonly
givenName: string
Defined in
familyName
• Optional
Readonly
familyName: string
Defined in
nickname
• Optional
Readonly
nickname: string
Defined in
preferredUsername
• Optional
Readonly
preferredUsername: string
Defined in
profileUrl
• Optional
Readonly
profileUrl: string
Defined in
pictureUrl
• Optional
Readonly
pictureUrl: string
Defined in
email
• Optional
Readonly
email: string
Defined in
emailVerified
• Optional
Readonly
emailVerified: boolean
Defined in
gender
• Optional
Readonly
gender: string
Defined in
birthday
• Optional
Readonly
birthday: string
Defined in
timezone
• Optional
Readonly
timezone: string
Defined in
language
• Optional
Readonly
language: string
Defined in
phoneNumber
• Optional
Readonly
phoneNumber: string
Defined in
phoneNumberVerified
• Optional
Readonly
phoneNumberVerified: boolean
Defined in
address
• Optional
Readonly
address: string
Defined in
updatedAt
• Optional
Readonly
updatedAt: string