Update cluster password policy
The ServiceProviderAPI (Service Provider API) Api-Token scope is required to update the cluster password policy configuration using the Dynatrace API.
Endpoint
/api/v1.0/onpremise/passwordPolicy
Parameter
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | PasswordPolicy |
The JSON body of the request. Contains parameters of password policy configuration. |
body | optional |
Body format
The PasswordPolicy object
Password policy configuration.
| Element | Type | Description | Required |
|---|---|---|---|
| realmId | string | optional | |
| minPasswordLength | integer |
Minimum password length |
required |
| minNumberOfUppercaseChars | integer |
Minimum number of uppercase characters |
required |
| minNumberOfLowercaseChars | integer |
Minimum number of lowercase characters |
required |
| minNumberOfDigits | integer |
Minimum number of digits |
required |
| minNumberOfNonAlphanumericChars | integer |
Minimum number of non-alphanumeric characters |
required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"realmId": "string",
"minPasswordLength": 0,
"minNumberOfUppercaseChars": 0,
"minNumberOfLowercaseChars": 0,
"minNumberOfDigits": 0,
"minNumberOfNonAlphanumericChars": 0
}
Response
Response codes
| Code | Description |
|---|---|
| 204 | Successfully updated. Response doesn't have a body. |
| 400 | Failed. The input is invalid. |
| 404 | Realm not found |
Response body
A successful request doesn't return any content.
Example
In this example, you update the password policy for your managed deployment (myManaged.cluster.com). You define:
- Minimum password length
- Minimum number of uppercase characters
- Minimum number of lowercase characters
- Minimum number of digits
- Minimum number of non-alphanumeric characters
In return you receive a response code 204 indicating that the password policy was updated successfully.
Curl
curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/passwordPolicy" -H "accept: */*" -H "Content-Type: application/json" -d "{\"realmId\":\"string\",\"minPasswordLength\":16,\"minNumberOfUppercaseChars\":2,\"minNumberOfLowercaseChars\":4,\"minNumberOfDigits\":2,\"minNumberOfNonAlphanumericChars\":4}"
Request URL
https://myManaged.cluster.com/api/v1.0/onpremise/passwordPolicy
Response body
Successfully updated. Response doesn't have a body.
Response code
204