Skip to main content
​
usePasswordValidation(password, options?)
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.

​
Parameters

​
password
string
The password to validate.
​
options?
​
includeInErrors?
boolean
If true, validation errors are stored in the global error manager under the password field. Defaults to false.

​
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);
   }