Get cluster password policy

This API call retrieves a cluster password policy.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/v1.0/onpremise/passwordPolicy

Parameter

The request doesn't provide any configurable parameters.

Response

Response codes

Code	Type	Description
200	PasswordPolicy	Success
404		Realm not found

Response body objects

The `PasswordPolicy` object

Password policy configuration.

Element	Type	Description
minPasswordLength	integer	Minimum password length
minNumberOfUppercaseChars	integer	Minimum number of uppercase characters
minNumberOfLowercaseChars	integer	Minimum number of lowercase characters
minNumberOfDigits	integer	Minimum number of digits
minNumberOfNonAlphanumericChars	integer	Minimum number of non-alphanumeric characters

Response body JSON model

json
{
  "minPasswordLength": 1,
  "minNumberOfUppercaseChars": 1,
  "minNumberOfLowercaseChars": 1,
  "minNumberOfDigits": 1,
  "minNumberOfNonAlphanumericChars": 1
}

Example

In this example, you query your managed deployment (myManaged.cluster.com) for its password policy. In return you receive information on current password policy settings.

Curl

bash
curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/passwordPolicy" -H  "accept: application/json"

Request URL

plaintext
https://myManaged.cluster.com/api/v1.0/onpremise/passwordPolicy

Response body

json
{
  "realmId": "string",
  "minPasswordLength": 12,
  "minNumberOfUppercaseChars": 1,
  "minNumberOfLowercaseChars": 1,
  "minNumberOfDigits": 1,
  "minNumberOfNonAlphanumericChars": 10
}

Response code

200