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

    Class MfaWebAuthnPlatformChallenge

    MfaWebAuthnPlatformChallenge

    Hierarchy

    • BaseContext
      • MfaWebAuthnPlatformChallenge

    Implements

    Index

    Constructors

    Properties

    screenIdentifier: string = ScreenIds.MFA_WEBAUTHN_PLATFORM_CHALLENGE

    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

    • Initiates the WebAuthn platform authenticator challenge. Internally, this method retrieves the challenge options from this.screen.publicKey, calls navigator.credentials.get() (via the getPasskeyCredentials utility), and then submits the resulting credential assertion to the Auth0 server.

      Parameters

      • Optionaloptions: Screens.VerifyPlatformAuthenticatorOptions

        Optional parameters for the verification. This can include rememberDevice if this.screen.data.showRememberDevice is true, and any other custom key-value pairs to be sent in the form submission.

      Returns Promise<void>

      A promise that resolves when the credential submission is initiated. A successful operation typically results in a server-side redirect.

      Throws an error if this.screen.publicKey is not available (indicating missing challenge options), if getPasskeyCredentials (and thus navigator.credentials.get()) fails (e.g., user cancellation, no authenticator found, hardware error), or if the final form submission to Auth0 fails. It's crucial to catch errors from this method. WebAuthn API errors (like NotAllowedError) should ideally be reported using this.reportBrowserError().