Skip to content

Get Password Policy

GET
/auth/password-policy
curl --request GET \
--url https://example.com/auth/password-policy

Get current password policy configuration

Successful Response

Media typeapplication/json
PasswordPolicyResponse
object
min_length
required
Min Length
integer
require_uppercase
required
Require Uppercase
boolean
require_lowercase
required
Require Lowercase
boolean
require_numbers
required
Require Numbers
boolean
require_special
required
Require Special
boolean
history_size
required
History Size
integer
expiry_days
required
Expiry Days
integer
Examplegenerated
{
"min_length": 1,
"require_uppercase": true,
"require_lowercase": true,
"require_numbers": true,
"require_special": true,
"history_size": 1,
"expiry_days": 1
}