Skip to main content
The MfaPushEnrollmentQr class implements the mfa-push-enrollment-qr screen functionality.
MfaPushEnrollmentQr

​
Constructors

Create an instance of MfaPushEnrollmentQr screen
Example
import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

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

​
Properties

​
branding
Provides branding-related configurations, such as branding theme and settings.
​
client
Provides client-related configurations, such as id, name, and logoUrl.
​
organization
Provides information about the user’s organization, such as organization id and name.
​
prompt
Contains data about the current prompt in the authentication flow.
​
screen
Contains details specific to the mfa-push-enrollment-qr screen, including its configuration and context.
​
tenant
Contains data related to the tenant, such as id and associated metadata.
​
transaction
Provides transaction-specific data, such as active identifiers and flow states.
​
untrustedData
Handles untrusted data passed to the SDK, such as user input during login.
​
user
Details of the active user, including username, email, and roles.

​
Methods

​
getErrors
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
pickAuthenticator
(options ?)
This method 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();
​
options
OPTIONAL
Optional custom options to include with the request.
​
pollingManager
This method 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.Returns an 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.
​
options
OPTIONAL
Configuration options for managing an MFA push-notification polling process.