Interface MfaPhoneChallengeMembers

screen

continue

• continue(payload: Screens.MfaPhoneChallengeContinueOptions): 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.

  Parameters

  • payload: Screens.MfaPhoneChallengeContinueOptions

    The options specifying the delivery type ('sms' or 'voice').

  Returns Promise<void>

  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' });
  Copy

pickPhone

• pickPhone(payload?: Screens.MfaPhoneChallengePickPhoneOptions): 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.

  Parameters

  • Optionalpayload: Screens.MfaPhoneChallengePickPhoneOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  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();
  Copy

tryAnotherMethod

• tryAnotherMethod(
      payload?: Screens.MfaPhoneChallengePickAuthenticatorOptions,
  ): 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).

  Parameters

  • Optionalpayload: Screens.MfaPhoneChallengePickAuthenticatorOptions

    Optional custom options to include with the request.

  Returns Promise<void>

  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();
  Copy