Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt

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

The reset-password-error screen is displayed when an error occurs during the password reset flow, such as an expired or invalid reset link. It informs the user of the issue and provides guidance on next steps.
ACUL reset password error

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 { useResetPasswordError } from '@auth0/auth0-acul-react';

// partial import
import {
  useResetPasswordError,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
} from '@auth0/auth0-acul-react/reset-password-error';

function ResetPasswordErrorScreen() {
  const screen = useScreen();
  return <p>{screen.name}</p>;
}

Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the reset-password-error screen. Import them from @auth0/auth0-acul-react/reset-password-error.
useBranding
This hook provides branding configurations, such as logo, colors, and theme settings displayed on the reset-password-error screen.
Example
import { useBranding } from '@auth0/auth0-acul-react/reset-password-error';
function CustomTheme() {
  const branding = useBranding();
}
useClient
This hook provides client-related configurations, such as id, name, and logoUrl, for the reset-password-error screen.
Example
import { useClient } from '@auth0/auth0-acul-react/reset-password-error';
function AppInfo() {
  const client = useClient();
}
useOrganization
This hook provides information about the user’s Organization if the password reset is Organization-scoped. Returns null when no Organization context is present.
Example
import { useOrganization } from '@auth0/auth0-acul-react/reset-password-error';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}
usePrompt
This hook contains data about the current prompt in the authentication flow.
Example
import { usePrompt } from '@auth0/auth0-acul-react/reset-password-error';
function FlowInfo() {
  const prompt = usePrompt();
}
This hook contains details specific to the reset-password-error screen, including its configuration and context.
Example
import { useScreen } from '@auth0/auth0-acul-react/reset-password-error';
function ScreenDebug() {
  const screen = useScreen();
}
useTenant
This hook contains data related to the tenant, such as id and associated metadata.
Example
import { useTenant } from '@auth0/auth0-acul-react/reset-password-error';
function TenantInfo() {
  const tenant = useTenant();
}
useTransaction
This hook provides transaction-specific data for the reset-password-error screen, such as active connections and current flow state.
Example
import { useTransaction } from '@auth0/auth0-acul-react/reset-password-error';
function TransactionInfo() {
  const transaction = useTransaction();
}
useUntrustedData
This hook handles untrusted data passed to the screen, such as a prefilled email or username from URL parameters.
Example
import { useUntrustedData } from '@auth0/auth0-acul-react/reset-password-error';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}
useUser
This hook provides details of the active user, including username, email, and available authentication methods.
Example
import { useUser } from '@auth0/auth0-acul-react/reset-password-error';
function UserProfile() {
  const user = useUser();
}
useResetPasswordError
This hook returns all methods and context available on the reset-password-error screen.

Common/Utility Hooks

This hook gets the current theme options with flattened configuration from branding context.
This hook returns a function for changing the display language on the current ACUL screen.
This hook gets the current screen context and state.
This hook reads and manages server, client, and developer errors on the screen.