Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0.com/llms.txt

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

Represents a single evaluated password complexity rule. Returned as part of PasswordValidationResult by usePasswordValidation. Supports hierarchical rule composition via the optional items array. 
export interface PasswordComplexityRule {
  code: string;
  label: string;
  status: "valid" | "error";
  isValid: boolean;
  args?: {
    count: number;
    total?: number;
    example?: string;
  };
  items?: PasswordComplexityRule[];
}

​
Properties

​
code
string
required
A machine-readable identifier for this complexity rule. Example: "lengthAtLeast", "containsAtLeast".
​
label
string
required
A human-readable display name for the rule, suitable for rendering in a password strength indicator.
​
status
"valid" | "error"
required
The validation outcome for this rule. "valid" if the rule passed, "error" if it failed.
​
isValid
boolean
required
Boolean representation of the rule outcome. true when status is "valid".
​
args
object
Additional parameters used to describe the rule’s threshold or provide context for the error message.
​
items
PasswordComplexityRule[]
Nested complexity rules for composite rule groups. Allows hierarchical rule composition where a parent rule aggregates multiple child rules.