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

    Class MfaWebAuthnEnrollmentSuccess

    MfaWebAuthnEnrollmentSuccess

    Hierarchy

    • BaseContext
      • MfaWebAuthnEnrollmentSuccess

    Implements

    Index

    Constructors

    • Initializes a new instance of the MfaWebAuthnEnrollmentSuccess class. It retrieves the necessary context (screen, transaction, etc.) from the global universal_login_context and sets up screen-specific properties via ScreenOverride.

      Returns MfaWebAuthnEnrollmentSuccess

      If the Universal Login Context is not available or if the screen name in the context does not match MfaWebAuthnEnrollmentSuccess.screenIdentifier.

    Properties

    screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_ENROLLMENT_SUCCESS

    static

    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

    • Allows the user to continue the authentication flow after a successful WebAuthn enrollment. This method sends a POST request to the /u/mfa-webauthn-enrollment-success endpoint with the action set to "default", indicating the user is proceeding from this success screen.

      Parameters

      • Optionalpayload: Screens.WebAuthnEnrollSuccessContinueOptions

        Optional. An object for CustomOptions if any additional parameters need to be sent with the request. These custom parameters will be included in the form data.

      Returns Promise<void>

      A promise that resolves when the continue action is successfully submitted. On successful submission, the Auth0 server will typically redirect the user to the next appropriate step in the authentication flow.

      Throws an error if the form submission fails (e.g., due to network issues, an invalid transaction state, or other server-side validation errors). If an error occurs, details might be available in this.transaction.errors if the page re-renders.

      // Assuming 'sdk' is an instance of MfaWebAuthnEnrollmentSuccess
      async function handleContinueClick() {
      try {
      await sdk.continue();
      // User will be redirected by Auth0.
      } catch (error) {
      console.error("Error continuing after WebAuthn enrollment success:", error);
      // Display error message to the user, potentially from sdk.transaction.errors
      }
      }