Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0.com/llms.txt

Use this file to discover all available pages before exploring further.

MfaWebAuthnErrorMembers
Example
export interface MfaWebAuthnErrorMembers extends BaseMembers {
  /**
   * The screen object with MFA WebAuthn Error specific data structure.
   */
  screen: ScreenMembersOnMfaWebAuthnError;
  
  /**
   * 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.
   *
   * @param {CustomOptions} [payload] - Optional custom options to include with the request.
   * @returns {Promise<void>} A promise that resolves when the action is successfully submitted.
   * @throws {Error} Throws an error if the submission fails.
   * @example
   * ```typescript
   * // Assuming 'sdk' is an instance of MfaWebAuthnError
   * await sdk.tryAgain();
   * ```
   */
  tryAgain(payload?: 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.
   *
   * @param {CustomOptions} [payload] - Optional custom options to include with the request.
   * @returns {Promise<void>} A promise that resolves when the action is successfully submitted.
   * @throws {Error} Throws an error if the submission fails.
   * @example
   * ```typescript
   * // Assuming 'sdk' is an instance of MfaWebAuthnError
   * await sdk.usePassword();
   * ```
   */
  usePassword(payload?: 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.
   *
   * @param {CustomOptions} [payload] - Optional custom options to include with the request.
   * @returns {Promise<void>} A promise that resolves when the action is successfully submitted.
   * @throws {Error} Throws an error if the submission fails.
   * @example
   * ```typescript
   * // Assuming 'sdk' is an instance of MfaWebAuthnError
   * await sdk.tryAnotherMethod();
   * ```
   */
  tryAnotherMethod(payload?: 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.
   *
   * @param {CustomOptions} [payload] - Optional custom options to include with the request.
   * @returns {Promise<void>} A promise that resolves when the action is successfully submitted.
   * @throws {Error} Throws an error if the submission fails.
   * @example
   * ```typescript
   * // Assuming 'sdk' is an instance of MfaWebAuthnError
   * await sdk.noThanks();
   * ```
   */
  noThanks(payload?: CustomOptions): Promise<void>;
}

Properties

The screen object with MFA WebAuthn Error specific data structure.

Methods

noThanks
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.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();
tryAgain
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.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();
tryAnotherMethod
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.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();
usePassword
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.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();