Interface MfaWebAuthnErrorMembers

screen

noThanks

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

  Allows the user to refuse adding a device or completing the WebAuthn step, effectively declining the current WebAuthn flow. This action is typically used in enrollment scenarios where the user decides not to proceed.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  A promise that resolves when the action is successfully submitted.

  Throws

  Throws an error if the submission fails.

  Example

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

tryAgain

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

  Allows the user to attempt the previous WebAuthn operation again. This typically redirects the user back to the screen where the WebAuthn operation was initiated.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  A promise that resolves when the action is successfully submitted.

  Throws

  Throws an error if the submission fails.

  Example

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

tryAnotherMethod

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

  Allows the user to select a different MFA method if other factors are enrolled or available. This navigates the user to an authenticator selection screen.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  A promise that resolves when the action is successfully submitted.

  Throws

  Throws an error if the submission fails.

  Example

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

usePassword

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

  Allows the user to opt for password-based authentication as an alternative, if configured. This is typically available if the primary authentication or a previous step involved a password.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  A promise that resolves when the action is successfully submitted.

  Throws

  Throws an error if the submission fails.

  Example

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