Purpose

Validates the password against the currently enabled password policy.

URL

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

Method

POST

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.

Request Definition


{
  "password": "string"
}
Property Description Usage Valid Values
"password" The password which is being tested. Required A string of characters that make up the password

Response Definition


{
    "passwordValidationResponse": {
        "passed": boolean,
        "rules": [
            {
                "ruleId": "rule_id",
                "title": "rule_title",
                "passed": boolean
            },
            ...
        ]
    }
}
Property Description Valid Values
"passed" Indicates whether the password passes the password policy rules true | false

true indicates that the password has passed all policy rules.

false indicates that the password has failed one or more policy rules.
"rules" The rules that define the password policy and an indication of whether the password passed each rule For "ruleId", a string is provided.

For "title", the rule title is provided.

For "passed", true indicates the password has passed the rule, while false indicates it has failed the rule.

Sample Request

In this example, MySecretWins5! is the password which is being tested.

POST https://<myserver>:<port>/api/mgmt/passwordpolicy/validate

{
  "password": "MySecretWins5!"
}

Sample Response


{
    "passwordValidationResponse": {
        "passed": true,
        "rules": [
            {
                "ruleId": "pwdLengthRule",
                "title": "Must contain at least 8 characters but no more than 12 characters",
                "passed": true
            },
            {
                "ruleId": "uppercaseLetterRule",
                "title": "Upper Case Letters A-Z",
                "passed": true
            },
            {
                "ruleId": "lowercaseLetterRule",
                "title": "Lower Case Letters a-z",
                "passed": true
            },
            {
                "ruleId": "numericRule",
                "title": "Numbers 0-9",
                "passed": true
            },
            {
                "ruleId": "specialCharRule",
                "title": "Non-white space special characters",
                "passed": true
            }
        ]
    }
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have either the Administrator (12) permission.