Class MfaSmsEnrollment

constructor

• new MfaSmsEnrollment(): MfaSmsEnrollment

  Initializes a new instance of the MfaSmsEnrollment class.

  Returns MfaSmsEnrollment

screen

StaticscreenIdentifier

continueEnrollment

• continueEnrollment(payload: Screens.MfaSmsEnrollmentOptions): Promise<void>

  Continues the SMS enrollment process with the provided phone number.

  Parameters

  • payload: Screens.MfaSmsEnrollmentOptions

    The phone number to use for enrollment.

  Returns Promise<void>

  A promise that resolves when the enrollment process is complete.

  Throws

  If the phone number is missing.

  Example

  import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';
  
  const mfaSmsEnrollment = new MfaSmsEnrollment();
  await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });
  Copy

pickCountryCode

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

  Handles the action to pick a country code for SMS enrollment.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom options to include in the request.

  Returns Promise<void>

  A promise that resolves when the action is complete.

  Example

  import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';
  
  const mfaSmsEnrollment = new MfaSmsEnrollment();
  await mfaSmsEnrollment.pickCountryCode();
  Copy

tryAnotherMethod

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

  Handles the action to try another method for MFA.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom options to include in the request.

  Returns Promise<void>

  A promise that resolves when the action is complete.

  Example

  import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';
  
  const mfaSmsEnrollment = new MfaSmsEnrollment();
  await mfaSmsEnrollment.tryAnotherMethod();
  Copy