MfaPushEnrollmentQrMembers

Interface defining the available methods and properties for the mfa-push-enrollment-qr screen

Example

export interface MfaPushEnrollmentQrMembers extends BaseMembers {
  screen: ScreenMembersOnMfaPushEnrollmentQr;
  /**
   * Navigates to the authenticator selection screen.
   * @param payload Optional custom options to include with the request
   */
  pickAuthenticator(payload?: CustomOptions): Promise<void>;

  pollingManager(options: MfaPollingOptions): MfaPushPollingControl;
  
}

Properties

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnMfaPushEnrollmentQr

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Methods

pickAuthenticator · Promise<void>

Navigates to the authenticator selection screen.

Show Parameters

payload? · CustomOptions

Optional custom options to include with the request

pollingManager · MfaPushPollingControl

Show Parameters

options · MfaPollingOptions

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.

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()? · 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

Properties

code · string

field? · string

message · string

rules? · PasswordComplexityRule[]