Skip to main content

Interface: OIDCProfile

Defined in: src/auth/OIDCStrategy.ts:19

Describes an authenticated user profile as converted by an OAuth/OpenID provider that is ready to be used by the system to create a local User and/or Profile.

Properties​

alias?​

optional alias?: string

Defined in: src/auth/OIDCStrategy.ts:25

The alias or display name of the user.

avatar?​

optional avatar?: string

Defined in: src/auth/OIDCStrategy.ts:27

The URL of the user's avatar image.

birthdate?​

optional birthdate?: string

Defined in: src/auth/OIDCStrategy.ts:29

The birthdate of the user.

email?​

optional email?: string

Defined in: src/auth/OIDCStrategy.ts:31

The email address that the user registered their account with the provider.

email_verified?​

optional email_verified?: boolean

Defined in: src/auth/OIDCStrategy.ts:33

Indicates if the user email address has been verified by the provider.

familyName?​

optional familyName?: string

Defined in: src/auth/OIDCStrategy.ts:35

The real surname name of the user.

givenName?​

optional givenName?: string

Defined in: src/auth/OIDCStrategy.ts:37

The real given name of the user.

id​

id: string

Defined in: src/auth/OIDCStrategy.ts:21

The unique identifier of the user as registered with the provider.

locale?​

optional locale?: string

Defined in: src/auth/OIDCStrategy.ts:39

The user's chosen language option.

phone?​

optional phone?: string

Defined in: src/auth/OIDCStrategy.ts:41

The phone number that the user registered their account with the provider.

phone_verified?​

optional phone_verified?: boolean

Defined in: src/auth/OIDCStrategy.ts:43

Indicates if the user phone number has been verified by the provider.

provider​

provider: string

Defined in: src/auth/OIDCStrategy.ts:23

The unique name of the provider.

username?​

optional username?: string

Defined in: src/auth/OIDCStrategy.ts:45

The unique name of the user.