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

Defined in

server/authentication.ts:19


subject

Readonly subject: string

Identifier for the end-user from the identity provider, not necessarily unique across different providers.

Defined in

server/authentication.ts:25


issuer

Readonly issuer: string

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

Defined in

server/authentication.ts:30


name

Optional Readonly name: string

Defined in

server/authentication.ts:31


givenName

Optional Readonly givenName: string

Defined in

server/authentication.ts:32


familyName

Optional Readonly familyName: string

Defined in

server/authentication.ts:33


nickname

Optional Readonly nickname: string

Defined in

server/authentication.ts:34


preferredUsername

Optional Readonly preferredUsername: string

Defined in

server/authentication.ts:35


profileUrl

Optional Readonly profileUrl: string

Defined in

server/authentication.ts:36


pictureUrl

Optional Readonly pictureUrl: string

Defined in

server/authentication.ts:37


email

Optional Readonly email: string

Defined in

server/authentication.ts:38


emailVerified

Optional Readonly emailVerified: boolean

Defined in

server/authentication.ts:39


gender

Optional Readonly gender: string

Defined in

server/authentication.ts:40


birthday

Optional Readonly birthday: string

Defined in

server/authentication.ts:41


timezone

Optional Readonly timezone: string

Defined in

server/authentication.ts:42


language

Optional Readonly language: string

Defined in

server/authentication.ts:43


phoneNumber

Optional Readonly phoneNumber: string

Defined in

server/authentication.ts:44


phoneNumberVerified

Optional Readonly phoneNumberVerified: boolean

Defined in

server/authentication.ts:45


address

Optional Readonly address: string

Defined in

server/authentication.ts:46


updatedAt

Optional Readonly updatedAt: string

Defined in

server/authentication.ts:47