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

    Class MfaWebAuthnNotAvailableError

    MfaWebAuthnNotAvailableError

    Hierarchy

    • BaseContext
      • MfaWebAuthnNotAvailableError

    Implements

    Index

    Constructors

    Properties

    screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_NOT_AVAILABLE_ERROR

    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 select a different Multi-Factor Authentication method because WebAuthn is not available or supported on their current device/browser. This action navigates the user to a screen where they can choose from other available/enrolled MFA factors.

      Parameters

      Returns Promise<void>

      A promise that resolves upon successful submission of the 'pick-authenticator' action.

      Throws an error if the form submission fails (e.g., network issues, server-side validation errors).

      // Assuming 'sdk' is an instance of MfaWebAuthnNotAvailableError
      try {
      await sdk.tryAnotherMethod();
      // On success, Auth0 typically handles redirection to the MFA factor selection screen.
      } catch (error) {
      console.error('Failed to initiate "try another method":', error);
      // Update UI to inform the user about the failure to switch methods.
      }