Purpose

Returns details on the specified password policy

URL

https://<myserver>:<port>/api/admin/passwordpolicy/{id}

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.

The URL parameter {id} described in the following table is required.

Parameter Description Valid Values
{id} The password policy ID 1 | 2

1 is the ID for the default policy.

2 is the ID for the custom policy.

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 password policy ID 1 | 2

1 is the ID for the default policy.

2 is the ID for the custom policy.
"name" The password policy name The name of the password policy
"description" The 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 Success Response


{
    "id": 2,
    "name": "Custom Policy",
    "description": "Custom Password Policy",
    "rules": [
        {
            "title": "Must contain at least 12 characters but no more than 128 characters",
            "ruleId": "pwdLengthRule",
            "ruleName": "PASSWORD_LENGTH_RULE",
            "minLength": 12,
            "maxLength": 128
        },
        {
            "title": "Must contain at least 1 special character",
            "ruleId": "specialCharacterRule",
            "ruleName": "SPECIAL_CLASS_RULE",
            "minChars": 1
        },
        {
            "title": "Must contain at least 1 lower case character",
            "ruleId": "lowerCaseCharacterRule",
            "ruleName": "LOWER_CLASS_RULE",
            "minChars": 1
        },
        {
            "title": "Must contain at least 1 upper case character",
            "ruleId": "upperCaseCharacterRule",
            "ruleName": "UPPER_CLASS_RULE",
            "minChars": 1
        },
        {
            "title": "Must contain at least 1 numeric character",
            "ruleId": "numericCharacterRule",
            "ruleName": "NUMERIC_CLASS_RULE",
            "minChars": 1
        }
    ],
    "expirationDays": 120
}


{
    "id": 2,
    "name": "Custom Policy",
    "description": "Custom Password Policy",
    "rules": [
        {
            "ruleName": "PASSWORD_LENGTH_RULE",
            "minLength": 12,
            "ruleId": "pwdLengthRule",
            "maxLength": 128,
            "title": "Must contain at least 12 characters but no more than 128 characters"
        },
        {
            "ruleName": "SPECIAL_CLASS_RULE",
            "minChars": 1,
            "title": "Must contain at least 1 special character",
            "ruleId": "specialCharacterRule"
        },
        {
            "ruleName": "LOWER_CLASS_RULE",
            "minChars": 1,
            "title": "Must contain at least 1 lower case character",
            "ruleId": "lowerCaseCharacterRule"
        },
        {
            "ruleName": "UPPER_CLASS_RULE",
            "minChars": 1,
            "title": "Must contain at least 1 upper case character",
            "ruleId": "upperCaseCharacterRule"
        },
        {
            "ruleName": "NUMERIC_CLASS_RULE",
            "minChars": 1,
            "title": "Must contain at least 1 numeric character",
            "ruleId": "numericCharacterRule"
        }
    ],
    "expirationDays": 120
}

Sample Server Failure Response 


{
    "error": {
        "code": 222208113,
        "message": {
            "lang": "en-US",
            "value": "Invalid password policy ID: 3."
        }
    }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission.