BruteForceProtectionUnblockSuccess

Describes all the hooks and methods available to customize the Universal Login brute-force-protection-unblock-success screen.

The brute-force-protection-unblock-success screen is displayed after a user has successfully unblocked their account following a brute-force protection lockout.

Import

Each screen has its own set of hooks and methods. The SDK supports partial import and root import for each screen.

• Using partial import allows you to include only the code you need for your specific use case.
• Using root import allows you to load all screens from a single bundle, which is useful when you want a unified build to handle all possible screens.

Import Example

// root import
import { useBruteForceProtectionUnblockSuccess } from '@auth0/auth0-acul-react';

// partial import
import {
  useBruteForceProtectionUnblockSuccess,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
} from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';

function UnblockSuccessScreen() {
  const screen = useBruteForceProtectionUnblockSuccess();
  return <p>Your account has been successfully unblocked.</p>;
}

Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the brute-force-protection-unblock-success screen. Import them from @auth0/auth0-acul-react/brute-force-protection-unblock-success.

useBranding · () => BrandingMembers

This hook provides branding configurations, such as logo, colors, and theme settings displayed on the brute-force-protection-unblock-success screen.

Example

import { useBranding } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

This hook provides client-related configurations, such as id, name, and logoUrl, for the brute-force-protection-unblock-success screen.

Example

import { useClient } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

This hook provides information about the user’s Organization if the unblock flow is Organization scoped. Returns null when no Organization context is present.

Example

import { useOrganization } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

This hook contains data about the current prompt in the authentication flow.

Example

import { usePrompt } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnBruteForceProtectionUnblockSuccess

This hook contains details specific to the brute-force-protection-unblock-success screen, including its configuration and context.

Example

import { useScreen } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

This hook contains data related to the tenant, such as id and associated metadata.

Example

import { useTenant } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

This hook provides transaction-specific data for the brute-force-protection-unblock-success screen, such as active connections and current flow state.

Example

import { useTransaction } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

This hook handles untrusted data passed to the screen, such as a prefilled username from URL parameters.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

This hook provides details of the active user, including username, email, and available authentication methods.

Example

import { useUser } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
function UserProfile() {
  const user = useUser();
}

useBruteForceProtectionUnblockSuccess · BruteForceProtectionUnblockSuccessMembers

This hook returns all methods and context available on the brute-force-protection-unblock-success screen.

Common/Utility Hooks

useAuth0Themes · Hooks

This hook gets the current theme options with flattened configuration from branding context.

useChangeLanguage · Hooks

This hook returns a function for changing the display language on the current ACUL screen.

useCurrentScreen · Hooks

This hook gets the current screen context and state.

useErrors · Hooks

This hook reads and manages server, client, and developer errors on the screen.