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

    Class MfaWebAuthnChangeKeyNickname

    MfaWebAuthnChangeKeyNicknameMembers

    Hierarchy

    • BaseContext
      • MfaWebAuthnChangeKeyNickname

    Implements

    Index

    Constructors

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

      Returns MfaWebAuthnChangeKeyNickname

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

    Properties

    Holds the specific screen data and properties for this screen, processed by ScreenOverride. This includes the current nickname of the key.

    screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_CHANGE_KEY_NICKNAME

    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

    • Submits the new nickname provided by the user for their WebAuthn security key. This method prepares and posts the form data, including the new nickname and the required action: "default", to the /u/mfa-webauthn-change-key-nickname endpoint.

      Parameters

      Returns Promise<void>

      A promise that resolves once the form submission is initiated. Typically, a successful submission leads to a server-side redirect. If the nickname is invalid or another error occurs, the page will re-render, and this.transaction.errors will be populated with details.

      If payload.nickname is missing or not a string. It can also throw if FormHandler encounters an unrecoverable issue during submission (e.g., network error). Auth0 validation errors (e.g., "nickname-too-long") are not thrown as JS errors but are made available in this.transaction.errors post-operation.