Skip to main content
MfaPhoneChallengeMembers
Example
export interface MfaPhoneChallengeMembers extends BaseMembers {
  /**
   * @property {ScreenMembersOnMfaPhoneChallenge} screen - Specific screen information for the MFA Phone Challenge.
   */
  screen: ScreenMembersOnMfaPhoneChallenge;

  /**
   * continue
   * Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge.
   * This will trigger sending the verification code to the user's phone.
   *
   * @param {ContinueOptions} payload - The options specifying the delivery type ('sms' or 'voice').
   * @returns {Promise<void>} A promise that resolves when the action is submitted.
   * @throws {Error} Throws an error if the submission fails.
   * @example
   * ```typescript
   * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';
   *
   * const mfaPhoneChallenge = new MfaPhoneChallenge();
   *
   * // To send the code via SMS
   * await mfaPhoneChallenge.continue({ type: 'sms' });
   *
   * // To send the code via Voice Call
   * await mfaPhoneChallenge.continue({ type: 'voice' });
   * ```
   */
  continue(payload: ContinueOptions): Promise<void>;

  /**
   * pickPhone
   * Initiates the action to pick a different phone number.
   * This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable.
   *
   * @param {PickPhoneOptions} [payload] - Optional custom options to include with the request.
   * @returns {Promise<void>} A promise that resolves when the action is submitted.
   * @throws {Error} Throws an error if the submission fails.
   * @example
   * ```typescript
   * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';
   *
   * const mfaPhoneChallenge = new MfaPhoneChallenge();
   * await mfaPhoneChallenge.pickPhone();
   * ```
   */
  pickPhone(payload?: PickPhoneOptions): Promise<void>;

  /**
   * tryAnotherMethod
   * Initiates the action to select a different MFA factor/authenticator.
   * This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code).
   *
   * @param {PickAuthenticatorOptions} [payload] - Optional custom options to include with the request.
   * @returns {Promise<void>} A promise that resolves when the action is submitted.
   * @throws {Error} Throws an error if the submission fails.
   * @example
   * ```typescript
   * import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';
   *
   * const mfaPhoneChallenge = new MfaPhoneChallenge();
   * await mfaPhoneChallenge.tryAnotherMethod();
   * ```
   */
  tryAnotherMethod(payload?: PickAuthenticatorOptions): Promise<void>;
}

Properties

branding
client
organization
prompt
screen
tenant
transaction
untrustedData
user

Methods

continue
Promise<void>
continue Submits the choice of MFA delivery method (SMS or Voice) to proceed with the challenge. This will trigger sending the verification code to the user’s phone.A promise that resolves when the action is submitted.

Throws

Throws an error if the submission fails.
Example
import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();

// To send the code via SMS
await mfaPhoneChallenge.continue({ type: 'sms' });

// To send the code via Voice Call
await mfaPhoneChallenge.continue({ type: 'voice' });
pickPhone
Promise<void>
Initiates the action to pick a different phone number. This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable.A promise that resolves when the action is submitted.

Throws

Throws an error if the submission fails.
Example
import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.pickPhone();
tryAnotherMethod
Promise<void>
Initiates the action to select a different MFA factor/authenticator. This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code).A promise that resolves when the action is submitted.

Throws

Throws an error if the submission fails.
Example
import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.tryAnotherMethod();