Skip to main content
GET
/
identity
/
password-policy
Get Password Policy
curl --request GET \
  --url http://{host}:{port}/{contextPath}/identity/password-policy \
  --header 'Authorization: Basic <encoded-value>'
{
  "rules": [
    {
      "placeholder": "PASSWORD_POLICY_USER_DATA",
      "parameter": null
    },
    {
      "placeholder": "PASSWORD_POLICY_LENGTH",
      "parameter": {
        "minLength": "10"
      }
    },
    {
      "placeholder": "PASSWORD_POLICY_LOWERCASE",
      "parameter": {
        "minLowerCase": "1"
      }
    },
    {
      "placeholder": "PASSWORD_POLICY_UPPERCASE",
      "parameter": {
        "minUpperCase": "1"
      }
    },
    {
      "placeholder": "PASSWORD_POLICY_DIGIT",
      "parameter": {
        "minDigit": "1"
      }
    },
    {
      "placeholder": "PASSWORD_POLICY_SPECIAL",
      "parameter": {
        "minSpecial": "1"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Response

Request successful. This example uses the built-in password policy that enforces a minimum password length, and some complexity rules.

​
rules
object[] | null

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