ResetPasswordRequest

The reset-password-request screen is displayed at the start of the password reset flow. It prompts the user to enter their username or email address to receive a password reset link.

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

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

function ResetPasswordRequestScreen() {
  const { resetPassword } = useResetPasswordRequest();
  return (
    <button onClick={() => resetPassword({ username: 'user@example.com' })}>
      Send Reset Link
    </button>
  );
}

Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the reset-password-request screen. Import them from @auth0/auth0-acul-react/reset-password-request.

useBranding

() => BrandingMembers

This hook provides branding configurations, such as logo, colors, and theme settings displayed on the reset-password-request screen.

Example

import { useBranding } from '@auth0/auth0-acul-react/reset-password-request';
function CustomTheme() {
  const branding = useBranding();
}

useClient

() => ClientMembers

This hook provides client-related configurations, such as id, name, and logoUrl, for the reset-password-request screen.

Example

import { useClient } from '@auth0/auth0-acul-react/reset-password-request';
function AppInfo() {
  const client = useClient();
}

useOrganization

() => OrganizationMembers

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-request';
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/reset-password-request';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen

() => ScreenMembersOnResetPasswordRequest

This hook contains details specific to the reset-password-request screen, including its configuration and context.

Example

import { useScreen } from '@auth0/auth0-acul-react/reset-password-request';
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/reset-password-request';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction

() => TransactionMembersOnResetPasswordRequest

This hook provides transaction-specific data for the reset-password-request screen, such as active connections and current flow state.

Example

import { useTransaction } from '@auth0/auth0-acul-react/reset-password-request';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData

() => UntrustedDataMembers

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-request';
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/reset-password-request';
function UserProfile() {
  const user = useUser();
}

useResetPasswordRequest

ResetPasswordRequestMembers

This hook returns all methods and context available on the reset-password-request screen.

Methods

This method navigates the user back to the login screen, cancelling the password reset flow.

Example

import { useResetPasswordRequest } from '@auth0/auth0-acul-react/reset-password-request';

function BackToLoginButton() {
  const { backToLogin } = useResetPasswordRequest();
  return (
    <button onClick={() => backToLogin()}>
      Back to Login
    </button>
  );
}

resetPassword

Promise<void>

This method submits the username or email to initiate the password reset process.

Example

import { useResetPasswordRequest } from '@auth0/auth0-acul-react/reset-password-request';

function ResetPasswordForm() {
  const { resetPassword } = useResetPasswordRequest();
  return (
    <button onClick={() => resetPassword({ username: 'user@example.com' })}>
      Send Reset Link
    </button>
  );
}

Method Parameters

Show Parameters

options

ResetPasswordRequestOptions.

username

string

required

The username or email address of the account to reset.

captcha?

string

The CAPTCHA response token, required when CAPTCHA is enabled for the tenant.

Common/Utility Hooks

useLoginIdentifiers

Hooks

This hook returns the login identifier types (email, username, phone) configured for the current connection.

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.

​Import

​Context Hooks

​Methods

​Common/Utility Hooks

Import

Context Hooks

Methods

Common/Utility Hooks