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

    Class MfaWebAuthnError

    MfaWebAuthnError

    Hierarchy

    • BaseContext
      • MfaWebAuthnError

    Implements

    Index

    Constructors

    constructor

    Properties

    branding client organization prompt screen tenant transaction untrustedData user screenIdentifier

    Methods - Language

    changeLanguage

    Methods - Other

    getErrors noThanks tryAgain tryAnotherMethod usePassword

    Constructors

    • Initializes a new instance of the MfaWebAuthnError class. It retrieves the necessary context (screen, transaction, etc.) from the global universal_login_context.

      Returns MfaWebAuthnError

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

    Properties

    branding: Screens.BrandingMembers
    client: Screens.ClientMembers
    organization: Screens.OrganizationMembers
    prompt: Screens.PromptMembers
    screen: Screens.ScreenMembersOnMfaWebAuthnError
    tenant: Screens.TenantMembers
    transaction: Screens.TransactionMembers
    untrustedData: Screens.UntrustedDataMembers
    user: Screens.UserMembers
    screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_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 decline the current WebAuthn operation (e.g., refuse to add a device during enrollment). This action signifies the user's choice not to proceed with the WebAuthn step at this time.

      Parameters

      Returns Promise<void>

      A promise that resolves upon successful submission of the 'refuse-add-device' action.

      Throws an error if the form submission fails.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.noThanks();

    • Allows the user to retry the previous WebAuthn operation. This action typically redirects the user to the screen where the WebAuthn process was initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn).

      Parameters

      Returns Promise<void>

      A promise that resolves upon successful submission of the 'tryagain' action.

      Throws an error if the form submission fails.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.tryAgain();

    • Allows the user to choose a different Multi-Factor Authentication method. This action navigates the user to a screen where they can select 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.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.tryAnotherMethod();

    • Allows the user to attempt authentication using their password, if this alternative is configured and appropriate for the current flow (e.g., if password was a prior authentication step or is a valid MFA bypass).

      Parameters

      Returns Promise<void>

      A promise that resolves upon successful submission of the 'use-password' action.

      Throws an error if the form submission fails.

      // Assuming 'sdk' is an instance of MfaWebAuthnError
      await sdk.usePassword();

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods - Language
    Methods - Other