Skip to main content

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.)

issuer​

• Readonly issuer: string

The hostname of the identity provider used to authenticate this user.

name​

• Optional Readonly name: string

givenName​

• Optional Readonly givenName: string

familyName​

• Optional Readonly familyName: string

nickname​

• Optional Readonly nickname: string

preferredUsername​

• Optional Readonly preferredUsername: string

profileUrl​

• Optional Readonly profileUrl: string

pictureUrl​

• Optional Readonly pictureUrl: string

email​

• Optional Readonly email: string

emailVerified​

• Optional Readonly emailVerified: boolean

gender​

• Optional Readonly gender: string

birthday​

• Optional Readonly birthday: string

timezone​

• Optional Readonly timezone: string

language​

• Optional Readonly language: string

phoneNumber​

• Optional Readonly phoneNumber: string

phoneNumberVerified​

• Optional Readonly phoneNumberVerified: boolean

address​

• Optional Readonly address: string

updatedAt​

• Optional Readonly updatedAt: Date