Skip to main content
PasswordValidationResult
​
usePasswordValidation
PasswordValidationResult
This React hook validates a password against the current Auth0 password policy and returns a structured result describing whether the password satisfies each rule.Optionally, it can send the validation results to the global error manager so that form error components can update automatically.

​
Key Features

  • Policy-aware validation — checks the password against the tenant’s configured Auth0 password policy rules.
  • Error manager integration — optionally surfaces validation failures to form error components automatically.

​
Parameters

​
password
string
The password to validate.
​
options
{ includeInErrors?: boolean }
Optional configuration for the hook.

​
Returns

PasswordValidationResultA PasswordValidationResult object containing:
  • isValid — true if the password satisfies all configured rules.
  • results — an array of per-rule results with code, label, status, and isValid.

​
Supported Screens

  • signup
  • signup-password
  • reset-password
Example
import { usePasswordValidation } from '@auth0/auth0-acul-react/signup';

const { isValid, results} = usePasswordValidation(password, { includeInErrors: true });

if (!isValid) {
  console.log(results);
}

​
Remarks

  • Call usePasswordValidation at the top level of your component; do not call it conditionally or inside event handlers.
  • The import path must match the screen — use signup, signup-password, or reset-password accordingly.