Skip to main content

@authgear/web / UserInfo

Interface: UserInfo

UserInfo is the result of fetchUserInfo. It contains sub which is the User ID, as well as OIDC standard claims like email, see https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims.

In addition to these standard claims, it may include custom claims defined by Authgear to support additional functionality like isVerified.

Table of contents​

Properties​

Properties​

address​

• Optional address: Object

Type declaration​

NameType
country?string
formatted?string
locality?string
postalCode?string
region?string
streetAddress?string

Defined in​

packages/authgear-web/index.d.ts:393

birthdate​

• Optional birthdate: string

Defined in​

packages/authgear-web/index.d.ts:390

canReauthenticate​

• canReauthenticate: boolean

Defined in​

packages/authgear-web/index.d.ts:372

customAttributes​

• customAttributes: Record<string, unknown>

Defined in​

packages/authgear-web/index.d.ts:375

email​

• Optional email: string

Defined in​

packages/authgear-web/index.d.ts:376

emailVerified​

• Optional emailVerified: boolean

Defined in​

packages/authgear-web/index.d.ts:377

familyName​

• Optional familyName: string

Defined in​

packages/authgear-web/index.d.ts:381

gender​

• Optional gender: string

Defined in​

packages/authgear-web/index.d.ts:389

givenName​

• Optional givenName: string

Defined in​

packages/authgear-web/index.d.ts:382

isAnonymous​

• isAnonymous: boolean

Defined in​

packages/authgear-web/index.d.ts:371

isVerified​

• isVerified: boolean

Defined in​

packages/authgear-web/index.d.ts:370

locale​

• Optional locale: string

Defined in​

packages/authgear-web/index.d.ts:392

middleName​

• Optional middleName: string

Defined in​

packages/authgear-web/index.d.ts:383

name​

• Optional name: string

Defined in​

packages/authgear-web/index.d.ts:384

nickname​

• Optional nickname: string

Defined in​

packages/authgear-web/index.d.ts:385

phoneNumber​

• Optional phoneNumber: string

Defined in​

packages/authgear-web/index.d.ts:378

phoneNumberVerified​

• Optional phoneNumberVerified: boolean

Defined in​

packages/authgear-web/index.d.ts:379

picture​

• Optional picture: string

Defined in​

packages/authgear-web/index.d.ts:386

preferredUsername​

• Optional preferredUsername: string

Defined in​

packages/authgear-web/index.d.ts:380

profile​

• Optional profile: string

Defined in​

packages/authgear-web/index.d.ts:387

raw​

• raw: Record<string, unknown>

Defined in​

packages/authgear-web/index.d.ts:374

roles​

• Optional roles: string[]

Defined in​

packages/authgear-web/index.d.ts:373

sub​

• sub: string

Defined in​

packages/authgear-web/index.d.ts:369

website​

• Optional website: string

Defined in​

packages/authgear-web/index.d.ts:388

zoneinfo​

• Optional zoneinfo: string

Defined in​

packages/authgear-web/index.d.ts:391

  • Table of contents
  • Properties
    • address
    • birthdate
    • canReauthenticate
    • customAttributes
    • email
    • emailVerified
    • familyName
    • gender
    • givenName
    • isAnonymous
    • isVerified
    • locale
    • middleName
    • name
    • nickname
    • phoneNumber
    • phoneNumberVerified
    • picture
    • preferredUsername
    • profile
    • raw
    • roles
    • sub
    • website
    • zoneinfo