Querying Custom Password Policies

Function

This API is used to query custom password policies. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/identity-stores/{identity_store_id}/password-policy

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
identity_store_id	Yes	String	Globally unique ID of an identity source.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
Parameter	Type	Description
password_policy	PasswordPolicyDto object	Custom password policy information.

**Table 4** PasswordPolicyDto
Parameter	Type	Description
minimum_password_length	Integer	Minimum password length.
require_lowercase_characters	Boolean	Whether lowercase letters are required.
require_numbers	Boolean	Whether digits are required.
require_symbols	Boolean	Whether special characters are required.
require_uppercase_characters	Boolean	Whether uppercase letters are required.
max_password_age	Integer	Password validity period.
password_reuse_prevention	Integer	Password reuse limit. The default value is 1.

Status code: 400

**Table 5** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.

Status code: 403

**Table 6** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of a request.
encoded_authorization_message	String	Encrypted error message.

Example Request

Querying custom password policies

GET https://{hostname}/v1/identity-stores/{identity_store_id}/password-policy

Example Response

Status code: 200

Successful

{
  "password_policy" : {
    "minimum_password_length" : 8,
    "require_lowercase_characters" : true,
    "require_numbers" : true,
    "require_symbols" : true,
    "require_uppercase_characters" : true,
    "password_reuse_prevention" : 1
  }
}