ResetPassword

Describes all the hooks and methods available to customize the Universal Login reset-password screen.

The reset-password screen allows users to set a new password after a password reset request. It is presented during the password reset flow and requires the user to enter and confirm their new password.

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

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

function ResetPasswordForm() {
  const { resetPassword } = useResetPassword();
  return (
    <button onClick={() => resetPassword({ 'password-reset': 'newSecret', 're-enter-password': 'newSecret' })}>
      Reset Password
    </button>
  );
}

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

import { useClient } from '@auth0/auth0-acul-react/reset-password';
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';
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';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnResetPassword

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

Example

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

useTransaction · () => TransactionMembersOnResetPassword

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/reset-password';
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';
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';
function UserProfile() {
  const user = useUser();
}

useResetPassword · ResetPasswordMembers

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

Methods

resetPassword · Promise<void>

This method submits the user’s new password to complete the password reset flow.

Example

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

function ResetPasswordForm() {
  const { resetPassword } = useResetPassword();
  return (
    <button onClick={() => resetPassword({ 'password-reset': 'newSecret', 're-enter-password': 'newSecret' })}>
      Reset Password
    </button>
  );
}

Method Parameters

Show Parameters

options

ResetPasswordOptions.

password-reset · string · required

The new password for the account.

re-enter-password · string · required

Confirmation of the new password. Must match password-reset.

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.

usePasswordValidation · Hooks

This hook validates the user’s password against the tenant’s password policy requirements.