Querying the Password Strength Policy

Function

This API is used to query the password strength policy, including its regular expression and description.

URI

• URI format

  GET /v3/domains/{domain_id}/config/security_compliance

• URI parameters

  Parameter	Mandatory	Type	Description
  domain_id	Yes	String	Domain ID to be queried.

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
  X-Auth-Token	Yes	String	Authenticated token of a user.

• Example request

  curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/domains/{domain_id}/config/security_compliance

Response Parameters

• Parameters in the response body

  Parameter	Mandatory	Type	Description
  security_compliance	Yes	JSON	Password strength policy.
  password_regex	Yes	String	Regular expression of the password strength policy.
  password_regex_description	Yes	String	Description of the password strength policy.

• Example response

  {
    "config": {
      "security_compliance": {
        "password_regex": "^(?=.*\\d)(?=.*[a-zA-Z]).{7,}$",
        "password_regex_description": "Passwords must contain at least 1 letter, 1 digit, and be a minimum length of 7 characters."
      }
    }
  }

Status Codes