Type Alias: MfaPollingOptions

Example

type MfaPollingOptions = {
  intervalMs?: number;
  onCompleted?: () => void;
  onError?: (error: Error) => void;
}

MfaPollingOptions

object

Configuration options for managing an MFA push-notification polling process.Supply these options when starting a polling session to control how often the challenge endpoint is queried and how success or failure is handled.

Show properties

intervalMs

number

Optional interval, in milliseconds, between consecutive polling requests.

If omitted, the SDK’s internal default interval is used (typically 5000 ms).
Choose a value that balances responsiveness with rate-limit considerations.

Default Value

Implementation-specific (commonly 5000 ms)

onCompleted

() => void

Optional callback executed once the MFA push challenge is successfully approved and polling completes.

Called exactly once, after which polling stops automatically.
Useful for advancing the login flow (e.g., calling continue()).

onError

(error: Error) => void

Optional callback invoked if an error occurs while polling.Receives an ULError object containing:

status — the HTTP status code from the failed request
responseText — the raw response body, if available
Called once per error event; polling may retry depending on error type.
Use to surface error messages or trigger custom retry/abort logic.

Properties

error

Error

An error object containing the HTTP status code and raw response body from the failed polling request.

auth0-acul-js

auth0-acul-react

Type Alias: MfaPollingOptions