Class MfaWebAuthnError

constructor

• new MfaWebAuthnError(): MfaWebAuthnError

  Initializes a new instance of the MfaWebAuthnError class. It retrieves the necessary context (screen, transaction, etc.) from the global universal_login_context.

  Returns MfaWebAuthnError

  Throws

  If the Universal Login Context is not available or if the screen name in the context does not match MfaWebAuthnError.screenIdentifier.

screen

StaticscreenIdentifier

noThanks

• noThanks(payload?: Classes.CustomOptions): Promise<void>

  Allows the user to decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). This action signifies the user's choice not to proceed with the WebAuthn step at this time.

  Parameters

  • Optionalpayload: Classes.CustomOptions

    Optional custom parameters to be sent with the request.

  Returns Promise<void>

  A promise that resolves upon successful submission of the 'refuse-add-device' action.

  Throws

  Throws an error if the form submission fails.

  Example

  // Assuming 'sdk' is an instance of MfaWebAuthnError
  await sdk.noThanks();
  Copy

tryAgain

• tryAgain(payload?: Classes.CustomOptions): Promise<void>

  Allows the user to retry the previous WebAuthn operation. This action typically redirects the user to the screen where the WebAuthn process was initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn).

  Parameters

  • Optionalpayload: Classes.CustomOptions

    Optional custom parameters to be sent with the request.

  Returns Promise<void>

  A promise that resolves upon successful submission of the 'tryagain' action.

  Throws

  Throws an error if the form submission fails.

  Example

  // Assuming 'sdk' is an instance of MfaWebAuthnError
  await sdk.tryAgain();
  Copy

tryAnotherMethod

• tryAnotherMethod(payload?: Classes.CustomOptions): Promise<void>

  Allows the user to choose a different Multi-Factor Authentication method. This action navigates the user to a screen where they can select from other available/enrolled MFA factors.

  Parameters

  • Optionalpayload: Classes.CustomOptions

    Optional custom parameters to be sent with the request.

  Returns Promise<void>

  A promise that resolves upon successful submission of the 'pick-authenticator' action.

  Throws

  Throws an error if the form submission fails.

  Example

  // Assuming 'sdk' is an instance of MfaWebAuthnError
  await sdk.tryAnotherMethod();
  Copy

usePassword

• usePassword(payload?: Classes.CustomOptions): Promise<void>

  Allows the user to attempt authentication using their password, if this alternative is configured and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass).

  Parameters

  • Optionalpayload: Classes.CustomOptions

    Optional custom parameters to be sent with the request.

  Returns Promise<void>

  A promise that resolves upon successful submission of the 'use-password' action.

  Throws

  Throws an error if the form submission fails.

  Example

  // Assuming 'sdk' is an instance of MfaWebAuthnError
  await sdk.usePassword();
  Copy