@auth0/auth0-acul-js - v0.1.0-beta.5
    Preparing search index...

    Interface MfaPhoneChallengeMembers

    MfaPhoneChallengeMembers

    interface MfaPhoneChallengeMembers {
        branding: Classes.BrandingMembers;
        client: Classes.ClientMembers;
        organization: Classes.OrganizationMembers;
        prompt: Classes.PromptMembers;
        screen: Classes.ScreenMembersOnMfaPhoneChallenge;
        tenant: Classes.TenantMembers;
        transaction: Classes.TransactionMembers;
        untrustedData: Classes.UntrustedDataMembers;
        user: Classes.UserMembers;
        continue(payload: Classes.MfaPhoneChallengeContinueOptions): Promise<void>;
        pickPhone(
            payload?: Classes.MfaPhoneChallengePickPhoneOptions,
        ): Promise<void>;
        tryAnotherMethod(
            payload?: Classes.MfaPhoneChallengePickAuthenticatorOptions,
        ): Promise<void>;
    }

    Hierarchy

    • BaseMembers
      • MfaPhoneChallengeMembers

    Implemented by

    Index

    Properties

    Methods

    • 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

      Returns Promise<void>

      A promise that resolves when the action is submitted.

      Throws an error if the submission fails.

      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 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

      Returns Promise<void>

      A promise that resolves when the action is submitted.

      Throws an error if the submission fails.

      import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

      const mfaPhoneChallenge = new MfaPhoneChallenge();
      await mfaPhoneChallenge.pickPhone();
    • 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

      Returns Promise<void>

      A promise that resolves when the action is submitted.

      Throws an error if the submission fails.

      import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

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