POST /system/authorization/password_validators

Creates a new password validator for the provided password based on the current Password Policy.

Creates a new user password validator. Password validators are used to determine if a password passes the password policy. If it does not pass the policy, it gives feedback on why the password did not pass the policy. The validator is returned in the response from the server. The validator or the password is not persisted.

Table 1. POST /system/authorization/password_validators resource details
MIME Type
application/json

Table 2. POST /system/authorization/password_validators request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
fields	header	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. POST /system/authorization/password_validators request body details
Parameter	Data Type	MIME Type	Description	Sample
body	Object	application/json	Only password field on the password validator is modifiable. All other fields are ignored. password - String - The password that the validator will validate. ignore_history - Boolean - If the ignore history is set to true, a new password validator ignores the password history rule. If the ignore history is set to false, a new password validator will check the password history rule. The default is false if the ignore history is not provided.	{ "disallow_repeating_characters_rule_passed": true, "ignore_history": true, "minimum_length_rule_passed": true, "password": "String", "password_history_size_rule_passed": true, "provided_password_length": 42, "variance_rules_failed": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_passed": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_required_count_passed": true }

Table 4. POST /system/authorization/password_validators response codes
HTTP Response Code	Unique Code	Description
200		response with the password validator. The successful 200 response is returned regardless if the password passed the validation or not. The 200 response indicates the validation was performed. Details of the validation will be in the returned password validator structure.
422	38312001	The password must not be null

Response Description

A Password Validator with the following fields:

password - Caller is required to set this field when creating a new user password validator. This field is always null in every server response.
ignore_history - If the ignore history is set to true, a new password validator ignores the password history rule. If the ignore history is set to false, a new password validator will check the password history rule. The default is false if the ignore history is not provided.
minimum_length_rule_passed - Indicates if the provided password passed the minimum length rule from the password policy. Set to null if the minimum length rule from the password policy is not enabled.
provided_password_length - The number of unicode characters in the provided password.
variance_rules_required_count_passed - Indicates if the provided password passed the variance count rule from the password policy. Set to null if the variance count rule is not enabled.
variance_rules_passed - Lists the variance rules that the provided password passed. Set to null if the variance count rule is not enabled.
variance_rules_failed - Lists the variance rules that the provided password failed. Set to null if the variance count rule is not enabled.
password_history_size_rule_passed - Indicates if the provided password passed the password history rule. Set to null if the password history rule is not enabled.
disallow_repeating_characters_rule_passed - Indicates if the provided password passed the repeating characters rule. Set to null if the repeating characters rule is not enabled.

Response Sample


{
    "disallow_repeating_characters_rule_passed": true,
    "ignore_history": true,
    "minimum_length_rule_passed": true,
    "password": "String",
    "password_history_size_rule_passed": true,
    "provided_password_length": 42,
    "variance_rules_failed": [
        "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>"
    ],
    "variance_rules_passed": [
        "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>"
    ],
    "variance_rules_required_count_passed": true
}