Get Password Policy

A password policy consists of a list of rules that new passwords must follow to be policy compliant. This end point returns a JSON representation of the list of policy rules.

More information on password policies in Camunda can be found in the password policy user guide and in the security instructions.

Method

GET /identity/password-policy

Result

A JSON object corresponding to the PasswordPolicy interface in the engine. Its properties are as follows:

Name Value Description
rules Array A JSON array of password policy rules. Each element of the array is a JSON object representing one rule of the policy.
Name Value Description
placeholder String A placeholder string that can be used to display an internationalized message to the user.
parameter Object A map of parameters that can be used to display a parameterized message to the user.

Response Codes

Code Media Type Description
200 application/json Request successful.
404 application/json No password policy was found.

Example

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

Request

GET /identity/password-policy

Response

{
    "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"}
        }
    ]
}

On this Page: