UserMembers

Example

export interface UserMembers {
  id: string | null;
  email: string | null;
  username: string | null;
  phoneNumber: string | null;
  picture: string | null;
  enrolledFactors: Array<string> | null;
  enrolledEmails: Array<EnrolledEmail> | null;
  enrolledPhoneNumbers: Array<EnrolledPhoneNumber> | null;
  enrolledDevices: Array<EnrolledDevice> | null;
  organizations: Organizations[] | null; // OPT-IN 
  userMetadata: { [key: string]: string } | null; // OPT-IN
  appMetadata: { [key: string]: string } | null; // OPT-IN
}

• OPT-IN: You must explicitly configure these properties to make them available to the screen. To learn more, read Configure ACUL.

• When the Auth0 server is not aware of the current user, the user properties are not available in the following screens:

Screens	Screens	Screens	Screens
Login screens	MFA OTP screens	Accept Invitation screens	InterstitialCaptcha screens
Signup screens	MFA Phone screens	Device Code screens	Reset Password screens
Passkey screens	MFA Push screens	Email Verification screens	MFA Country Codes screens
Challenge screens	MFA Recovery Code screens	Logout Aborted screens	MFA Detect Browser Capabilities screens
Email Identifier screens	MFA WebAuthn screens	Logout Complete screens	MFA Enroll screens
Phone Identifier screens	Accept Invitation screens	Brute Force Protection screens

Properties

appMetadata · Optional | {[key: string]: string; }

Show Parameters

[key] · string

email · string

enrolledDevices · EnrolledDevice

Show Parameters

id · number

device · string

enrolledEmails · EnrolledEmail

Show Parameters

id · number

email · string

enrolledFactors · string[]

enrolledPhoneNumbers · EnrolledPhoneNumber

Show Parameters

id · number

phoneNumber · string

id · string

organizations · Organizations

phoneNumber · string

picture · string

userMetadata · Optional | {[key: string]: string; }

Show Parameters

[key] · string

username · string