Skip to main content

Interface: OIDCProfile

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

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: auth/src/auth/OIDCStrategy.ts:26

The alias or display name of the user.

avatar?​

optional avatar?: string

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

The URL of the user's avatar image.

birthdate?​

optional birthdate?: string

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

The birthdate of the user.

email?​

optional email?: string

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

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

email_verified?​

optional email_verified?: boolean

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

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

familyName?​

optional familyName?: string

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

The real surname name of the user.

givenName?​

optional givenName?: string

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

The real given name of the user.

id​

id: string

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

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

locale?​

optional locale?: string

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

The user's chosen language option.

phone?​

optional phone?: string

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

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

phone_verified?​

optional phone_verified?: boolean

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

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

provider​

provider: string

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

The unique name of the provider.

username?​

optional username?: string

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

The unique name of the user.