Class MfaPushEnrollmentQr

constructor

• new MfaPushEnrollmentQr(): MfaPushEnrollmentQr

  Returns MfaPushEnrollmentQr

screen

StaticscreenIdentifier

pickAuthenticator

• pickAuthenticator(payload?: Screens.CustomOptions): Promise<void>

  Navigates to the authenticator selection screen.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom options to include with the request

  Returns Promise<void>

  Example

  import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';
  
  const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
  await mfaPushEnrollmentQr.pickAuthenticator();
  Copy

pollingManager

• pollingManager(
      options: Screens.MfaPollingOptions,
  ): Screens.MfaPushPollingControl
  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.

  Parameters

  • options: Screens.MfaPollingOptions

    Configuration options for the polling process:

    • intervalMs — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms).
    • onCompleted — Optional callback fired when the MFA push is successfully approved.
    • onError — Optional callback fired when a polling error occurs, receiving an ULError.

  Returns Screens.MfaPushPollingControl

  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();
  Copy

  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.