@auth0/auth0-acul-js - v1.0.0
    Preparing search index...

    Class MfaRecoveryCodeEnrollment

    Class implementing the Mfa Recovery Code Enrollment screen functionality. This screen is displayed when the user needs to enroll with a recovery code for MFA.

    Hierarchy

    • BaseContext
      • MfaRecoveryCodeEnrollment

    Implements

    Index

    Constructors

    Properties

    screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_ENROLLMENT

    Methods - Language

    • Utility Feature

      Changes the language/locale for the current authentication flow.

      This method triggers a language change by submitting the new locale preference to the server with the 'change-language' action. The language change will cause the current screen to re-render with the new locale.

      Parameters

      • options: Screens.LanguageChangeOptions

        Language change options including the target language code

        Options for changing the language/locale during the authentication flow

        • [key: string]: string | number | boolean | undefined

          Additional custom fields to be submitted along with the language change. Custom fields should be prefixed with 'ulp-'.

        • language: string

          Short language name (locale code) to be set (e.g., 'en', 'fr', 'es').

        • Optionalpersist?: "session"

          Defines persistence scope for the language preference. Currently only 'session' is supported.

          'session'
          

      Returns Promise<void>

      A promise that resolves when the form submission is complete

      import LoginId from "@auth0/auth0-acul-js/login-id";

      const loginManager = new LoginId();

      // Change language to French
      await loginManager.changeLanguage({
      language: 'fr',
      persist: 'session'
      });
      import LoginPassword from "@auth0/auth0-acul-js/login-password";

      const loginPasswordManager = new LoginPassword();

      // Change language to Spanish with additional custom data
      await loginPasswordManager.changeLanguage({
      language: 'es',
      persist: 'session',
      'ulp-custom-field': 'custom-value'
      });
      • This method is available on all screen instances that extend BaseContext
      • The language must be one of the enabled locales configured in your Auth0 tenant
      • The screen will automatically re-render with the new language after submission
      • Custom fields can be included and will be accessible in the Post Login Trigger

    Methods - Other

    • Declares that the user saved the recovery code. This action is triggered when the user declares that they have saved the recovery code. It redirects to the next screen in the authentication flow.

      Parameters

      Returns Promise<void>

      A promise that resolves when the action is successfully submitted.

      import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment';
      const mfaRecoveryCodeEnrollmentManager = new MfaRecoveryCodeEnrollment();
      const continueEnrollment = async (payload) => {
      try {
      await mfaRecoveryCodeEnrollmentManager.continue(payload);
      console.log('Enrollment continued successfully.');
      } catch (error) {
      console.error('Error continuing enrollment:', error);
      }
      };

      Rejects with an error if the submission fails.