Skip to main content

UserInfo

@authgear/capacitor

@authgear/capacitor / 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.

Properties​

address?​

optional address: object

country?​

optional country: string

formatted?​

optional formatted: string

locality?​

optional locality: string

postalCode?​

optional postalCode: string

region?​

optional region: string

streetAddress?​

optional streetAddress: string

authenticators?​

optional authenticators: Authenticator[]

birthdate?​

optional birthdate: string

canReauthenticate​

canReauthenticate: boolean

customAttributes​

customAttributes: Record<string, unknown>

email?​

optional email: string

emailVerified?​

optional emailVerified: boolean

familyName?​

optional familyName: string

gender?​

optional gender: string

givenName?​

optional givenName: string

identities?​

optional identities: Identity[]

isAnonymous​

isAnonymous: boolean

isVerified​

isVerified: boolean

locale?​

optional locale: string

middleName?​

optional middleName: string

name?​

optional name: string

nickname?​

optional nickname: string

phoneNumber?​

optional phoneNumber: string

phoneNumberVerified?​

optional phoneNumberVerified: boolean

picture?​

optional picture: string

preferredUsername?​

optional preferredUsername: string

profile?​

optional profile: string

raw​

raw: Record<string, unknown>

recoveryCodeEnabled?​

optional recoveryCodeEnabled: boolean

roles?​

optional roles: string[]

sub​

sub: string

website?​

optional website: string

zoneinfo?​

optional zoneinfo: string