Skip to main content
POST
Validate Password

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
password
string | null

The candidate password to be check against the password policy.

profile
object

Response

Request successful. This example uses the built-in password policy that enforces a minimum password length, and some complexity rules. The checked password is myPassword which is not complex enough to match all of the policy rules.

valid
boolean | null

true if the password is compliant with the policy, otherwise false.

rules
object[] | null

An array of password policy rules. Each element of the array is representing one rule of the policy.