Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0.com/llms.txt

Use this file to discover all available pages before exploring further.

The BruteForceProtectionUnblock class implements the brute-force-protection-unblock screen functionality. This screen is displayed when a user’s account has been blocked due to multiple failed login attempts and they need to submit an unblock request.
ACUL Brute Force Protection Unblock

​
Constructors

Create an instance of BruteForceProtectionUnblock screen manager:
Example
import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock';
const bruteForceProtectionUnblockManager = new BruteForceProtectionUnblock();
await bruteForceProtectionUnblockManager.unblockAccount();

​
Properties

​
branding
BrandingMembers
Provides branding-related configurations, such as branding theme and settings.
​
client
ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the brute-force-protection-unblock screen.
​
organization
OrganizationMembers
Provides information about the user’s Organization, such as id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembers
Contains details specific to the brute-force-protection-unblock screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembers
Provides transaction-specific data for the brute-force-protection-unblock screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during the account unblock flow.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
changeLanguage
Promise<void>
This method changes the display language of the Universal Login page.
Example
import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock';
const bruteForceProtectionUnblockManager = new BruteForceProtectionUnblock();
bruteForceProtectionUnblockManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
unblockAccount
Promise<void>
This method submits the account unblock request.
Example
import BruteForceProtectionUnblock from '@auth0/auth0-acul-js/brute-force-protection-unblock';
const bruteForceProtectionUnblockManager = new BruteForceProtectionUnblock();
await bruteForceProtectionUnblockManager.unblockAccount();
Method Parameters