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

    Class BruteForceProtectionUnblock

    Represents the BruteForceProtectionUnblock screen. This class provides methods to interact with the brute-force protection unblock screen, such as submitting the unblock request.

    Hierarchy

    • BaseContext
      • BruteForceProtectionUnblock

    Implements

    Index

    Constructors

    Properties

    screenIdentifier: string = ''

    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 unblock request. This method sends a request to unblock the account associated with the current transaction.

      Parameters

      • Optionalpayload: Screens.CustomOptions

        Optional payload to include with the unblock request. This can include additional data required by the server.

      Returns Promise<void>

      A promise that resolves when the unblock request is successfully submitted.

      import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock';

      const unblockScreen = new BruteForceProtectionUnblock();
      unblockScreen.unblockAccount({}).then(() => {
      console.log('Account unblock request submitted successfully.');
      }).catch((error) => {
      console.error('Failed to submit account unblock request:', error);
      });