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

    Class MfaRecoveryCodeChallengeNewCode

    MfaRecoveryCodeChallengeNewCode

    Hierarchy

    • BaseContext
      • MfaRecoveryCodeChallengeNewCode

    Implements

    Index

    Constructors

    Properties

    Holds the specific screen data and properties, processed by ScreenOverride.

    screenIdentifier: string = ScreenIds.MFA_RECOVERY_CODE_CHALLENGE_NEW_CODE

    The unique identifier for this screen, used internally and for telemetry.

    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

    • Confirms that the user has saved the new recovery code and continues the authentication flow. This method sends a POST request to the /u/mfa-recovery-code-challenge-new-code endpoint with the required state, action, and saved parameters.

      Parameters

      Returns Promise<void>

      A promise that resolves when the confirmation is successfully submitted. On success, the browser will typically be redirected to the next step.

      Throws an error if the form submission fails (e.g., network issue, invalid state, or if the server responds with a 400 error like 'no-confirmation').

      const screenManager = new MfaRecoveryCodeChallengeNewCode();
      // Assuming a checkbox 'confirmSaved' is checked by the user
      if (confirmSaved) {
      try {
      await screenManager.continue({ customData: 'optionalValue' });
      } catch (err) {
      // Handle errors, potentially check screenManager.transaction.errors
      console.error("Confirmation failed:", err);
      }
      } else {
      // Prompt user to confirm saving the code
      }