Purpose

Returns the details of the currently enabled password policy.

URL

https://<myserver>:<port>/api/public/passwordpolicy

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Response Definition


{
  "id": policy_id,
  "name": "policy_name",
  "description": "policy_description",
  "rules": [
    {
      "title": "rule1_title",
      "ruleId": rule1_id,
      "ruleName": "rule1_name",
      "property": property_value
    },
    ...
  ],
  "expirationDays": integer
}
Parameter Description Valid Values
"id" The enabled password policy ID 1 | 2

1 is the ID for the default policy.

2 is the ID for the custom policy.
"name" The enabled password policy name The name of the password policy
"description" The enabled password policy description A description of the password policy
"rules" The rules associated with the password policy A JSON object that contains the rules associated with the policy. See rulesInfo Object for details.
"expirationDays" The number of days in which the password will expire 0 | x

0 specifies that there is no expiration date associated with the policy.

x specifies the number of days in which the password will expire.

Sample Server Response

This response shows the default password policy is enabled.


{
    "id": 1,
    "name": "Default Policy",
    "description": "Default Password Policy",
    "rules": [
        {
            "title": "Must contain at least 8 characters but no more than 12 characters",
            "ruleId": "pwdLengthRule",
            "ruleName": "PASSWORD_LENGTH_RULE",
            "minLength": 8,
            "maxLength": 12
        },
        {
            "title": "Upper Case Letters A-Z",
            "ruleId": "uppercaseLetterRule",
            "ruleName": "CHARACTER_CLASS_RULE",
            "charClass": "[A-Z]",
            "minChars": 1
        },
        {
            "title": "Lower Case Letters a-z",
            "ruleId": "lowercaseLetterRule",
            "ruleName": "CHARACTER_CLASS_RULE",
            "charClass": "[a-z]",
            "minChars": 1
        },
        {
            "title": "Numbers 0-9",
            "ruleId": "numericRule",
            "ruleName": "CHARACTER_CLASS_RULE",
            "charClass": "[0-9]",
            "minChars": 1
        },
        {
            "title": "Non-white space special characters",
            "ruleId": "specialCharRule",
            "ruleName": "CHARACTER_CLASS_RULE",
            "charClass": "[^A-Za-z0-9]",
            "minChars": 1
        }
    ],
    "expirationDays": 0
}

Authentication/Authorization

No authentication/authorization needed for this API.