> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev.auth0-mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintlify.s3.us-west-1.amazonaws.com/docs-dev/docs/images/cdy7uua7fh8z/ACUL/brute-force-protection-unblock-success.png" alt="ACUL Brute Force Protection Unblock Success" />
</Frame>

## 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.

```jsx Import Example theme={null}
// 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`.

<ParamField body="useBranding" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}>
  This hook provides branding configurations, such as logo, colors, and theme settings displayed on the `brute-force-protection-unblock-success` screen.

  ```jsx Example theme={null}
  import { useBranding } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function CustomTheme() {
    const branding = useBranding();
  }
  ```
</ParamField>

<ParamField body="useClient" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}>
  This hook provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `brute-force-protection-unblock-success` screen.

  ```jsx Example theme={null}
  import { useClient } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function AppInfo() {
    const client = useClient();
  }
  ```
</ParamField>

<ParamField body="useOrganization" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
  This hook provides information about the user's Organization if the unblock flow is Organization scoped. Returns `null` when no Organization context is present.

  ```jsx Example theme={null}
  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>;
    }
  }
  ```
</ParamField>

<ParamField body="usePrompt" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}>
  This hook contains data about the current prompt in the authentication flow.

  ```jsx Example theme={null}
  import { usePrompt } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function FlowInfo() {
    const prompt = usePrompt();
  }
  ```
</ParamField>

<ParamField body="useScreen" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnBruteForceProtectionUnblockSuccess">ScreenMembersOnBruteForceProtectionUnblockSuccess</a></span>}>
  This hook contains details specific to the `brute-force-protection-unblock-success` screen, including its configuration and context.

  ```jsx Example theme={null}
  import { useScreen } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function ScreenDebug() {
    const screen = useScreen();
  }
  ```
</ParamField>

<ParamField body="useTenant" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}>
  This hook contains data related to the tenant, such as `id` and associated metadata.

  ```jsx Example theme={null}
  import { useTenant } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function TenantInfo() {
    const tenant = useTenant();
  }
  ```
</ParamField>

<ParamField body="useTransaction" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}>
  This hook provides transaction-specific data for the `brute-force-protection-unblock-success` screen, such as active connections and current flow state.

  ```jsx Example theme={null}
  import { useTransaction } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function TransactionInfo() {
    const transaction = useTransaction();
  }
  ```
</ParamField>

<ParamField body="useUntrustedData" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
  This hook handles untrusted data passed to the screen, such as a prefilled username from URL parameters.

  ```jsx Example theme={null}
  import { useUntrustedData } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function PrefilledForm() {
    const untrustedData = useUntrustedData();
  }
  ```
</ParamField>

<ParamField body="useUser" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}>
  This hook provides details of the active user, including `username`, `email`, and available authentication methods.

  ```jsx Example theme={null}
  import { useUser } from '@auth0/auth0-acul-react/brute-force-protection-unblock-success';
  function UserProfile() {
    const user = useUser();
  }
  ```
</ParamField>

<ParamField body="useBruteForceProtectionUnblockSuccess" type={<a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/BruteForceProtectionUnblockSuccessMembers">BruteForceProtectionUnblockSuccessMembers</a>}>
  This hook returns all methods and context available on the `brute-force-protection-unblock-success` screen.
</ParamField>

## Common/Utility Hooks

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useAuth0Themes">useAuth0Themes</a>} type="Hooks">
  This hook gets the current theme options with flattened configuration from branding context.
</ParamField>

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useChangeLanguage">useChangeLanguage</a>} type="Hooks">
  This hook returns a function for changing the display language on the current ACUL screen.
</ParamField>

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useCurrentScreen">useCurrentScreen</a>} type="Hooks">
  This hook gets the current screen context and state.
</ParamField>

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useErrors">useErrors</a>} type="Hooks">
  This hook reads and manages server, client, and developer errors on the screen.
</ParamField>
