MfaPushEnrollmentQr

Class implementing the mfa-push-enrollment-qr screen functionality

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

Constructors

MfaPushEnrollmentQr · Constructor

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

getErrors

Retrieves the array of transaction errors from the context, or an empty array if none exist.

An array of error objects from the transaction context.

pickAuthenticator · Promise<void>

Navigates to the authenticator selection screen.

Example

import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

Show Parameters

payload?

Optional custom options to include with the request

pollingManager

Utility Feature

Starts and manages polling for an MFA push challenge.

Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided onCompleted callback is invoked and polling stops automatically.

Use the returned MfaPushPollingControl to start, stop, or check the status of the polling process at any time.

A MfaPushPollingControl instance exposing:

• startPolling() — Starts or resumes polling.
• stopPolling() — Cancels polling immediately.
• isRunning() — Indicates whether polling is currently active.

Example

// Start polling every 5 seconds until the push challenge is approved
const control = mfaPushChallengePush.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushChallengePush.continue(),
  onError: (error) => console.error('Polling error:', error),
});

// Later, cancel polling if needed
control.stopPolling();

Remarks

• HTTP 429 (rate limit) responses are handled internally: polling automatically waits until the rate limit resets before retrying.
• Safe to call startPolling() multiple times; it has no effect if already running.

Show Parameters

options

Properties

MfaPollingOptions · object

intervalMs? · number

onCompleted()? · () => void

onError()? · (error) => void

code · string

field? · string

message · string