Validate Password Policy

Purpose

Validates the password against the password policy.

URL

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

Method

POST

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <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.

Payload Definition

The request takes the following format. The properties of the request are described in the table that follows.

{
"password": "string"
}

Parameter	Description	Valid Values
"password"	The new password which needs to be validated against the password policy.	Any string value.

Sample Request

{
"password": "TESTUSER"
}

Sample Server Response

The response lists details about each rule and whether the password passes or fails each rule.

{
"passwordValidationResponse": {
"passed": false,
"rules": [{
"ruleId": "rule1",
"title": "Contains atleast 8 characters",
"passed": true
},
{
"ruleId": "rule2",
"title": "Does not contain portion of username",
"passed": false
},
{
"ruleId": "rule_char_grp1",
"title": "Can contain characters from these three classes",
"passed": false,
"rules": [{
"ruleId": "uppercaseLetterRule",
"title": "Upper Case Letters A-Z",
"passed": true
},
{
"ruleId": "lowerCaseLetterRule",
"title": "Lower Case Letters a-z",
"passed": false
},
{
"ruleId": "numericRule",
"title": "Numbers 0-9",
"passed": false
},
{
"ruleId": "special_char_rule",
"title": "Non-white space special characters",
"passed": false
}
]
}
]
}
}

Sample Server Response

{
"error": {
"code": 222206117
"message": {
"lang": "en-US",
"value": "Password does not meet the password policy requirements."
}
}
}

Authentication/Authorization

No authentication/authorization needed for this API.