API v2: Password Changer Policy¶

Password changer policy defines specifics of how frequently the password should be changed and password complexity requirements.

Data Structures¶

`PasswordPolicyModel`¶
Attribute	Type	Required	Description
id	string		Read-only. Unique. Password change policy identifier.
name	string	yes	Unique, case-insensitive, password change policy name.
change_frequency	number {0 - 2147483647}	with `complexity_length`	Time in minutes after which password should be changed.
verification_frequency	number {0 - 2147483647}		Time in minutes after which password should be verified.
complexity_length	number {0 - 2147483647}		Total password length.
password_chan- ger_enabled	boolean		Read-only. Expensive to use. Is password changer enabled for this policy?
password_verifi- er_enabled	boolean		Read-only. Expensive to use. Is password verifier enabled for this policy?
complexity_lowercase	number {0 - 2147483647}	with `complexity_length`	Number of lower case characters in password.
complexity_uppercase	number {0 - 2147483647}	with `complexity_length`	Number of upper case characters in password.
complexity_numeric	number {0 - 2147483647}	with `complexity_length`	Number of numeric characters in password.
complexity_nonalnum	number {0 - 2147483647}	with `complexity_length`	Number of special characters in password.
created_at	string		Read-only. Timestamp of creation.
modified_at	string		Read-only. Timestamp of modification.
removed	boolean		Read-only.

Request for Retrieving Available Attributes of the PasswordPolicyModel

Method	GET
Path	/api/v2/objspec/password_change_policy

Note

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.

The next chapter describes procedures for creating separate requests.

Retrieving Password Changer Policies List¶

Request

Method	GET
Path	/api/v2/password_change_policy

Example Request

Sending GET https://10.0.0.0/api/v2/password_change_policy

curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/password_change_policy'

Response

{
    "result": "success",
    "password_change_policy": [
        {
            "id": "1",
            "name": "Static, without restrictions",
            "password_changer_enabled": false,
            "password_verifier_enabled": false,
            "created_at": "2024-06-10 05:59:22.994431-07",
            "modified_at": "2024-06-10 05:59:22.994431-07",
            "builtin": true,
            "hidden": false
        },
        {
            "id": "9124292845052624897",
            "name": "Pass Changing Enabled",
            "change_frequency": 2,
            "complexity_length": 8,
            "password_changer_enabled": true,
            "password_verifier_enabled": false,
            "complexity_lowercase": 1,
            "created_at": "2024-06-11 23:29:24.511416-07",
            "modified_at": "2024-06-12 02:16:38.410347-07",
            "builtin": false,
            "hidden": false
        }
    ]
}

Retrieving Password Change Policy by ID¶

Request

Method	GET
Path	/api/v2/password_change_policy/<id>

Example Request

Sending GET https://10.0.0.0/api/v2/password_change_policy/9124292845052624897

curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/password_change_policy/9124292845052624897'

Response

{
    "result": "success",
    "password_change_policy": {
        "id": "9124292845052624897",
        "name": "Pass Changing Enabled",
        "change_frequency": 2,
        "complexity_length": 8,
        "password_changer_enabled": true,
        "password_verifier_enabled": false,
        "complexity_lowercase": 1,
        "created_at": "2024-06-11 23:29:24.511416-07",
        "modified_at": "2024-06-12 02:16:38.410347-07",
        "builtin": false,
        "hidden": false
    }
}

Defining Password Change Policy¶

Request

Method	POST
Path	/api/v2/password_change_policy
Headers	Content-Type: Application/HTML
Body	PasswordPolicyModel

Example Request

Sending POST https://10.0.0.0/api/v2/password_change_policy

curl -s -k -X POST -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/password_change_policy' -H 'Content-Type: application/json' -d'{"name":"Password_Verif_1","change_frequency":2,"complexity_length":8,"complexity_lowercase":2}'

Response

{
    "result": "success",
    "password_change_policy": {
        "id": "9124292845052624898"
    }
}

Modifying Password Change Policy¶

Request

Method	PATCH
Path	/api/v2/password_change_policy/<id>
Headers	Content-Type: Application/HTML
Body	PasswordPolicyModel

Example Request

Sending PATCH https://10.0.0.0/api/v2/password_change_policy/9124292845052624897

curl -s -k -X PATCH -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/password_change_policy/9124292845052624897' -H 'Content-Type: application/json' -d'{"change_frequency":4,"complexity_lowercase":2}'

Response

{
    "result": "success"
}

Deleting Password Change Policy¶

Request

Method	DELETE
Path	/api/v2/password_change_policy/<id>

Example Request

Sending DELETE https://10.0.0.0/api/v2/password_change_policy/9124292845052624897

curl -s -k -X DELETE -H 'Authorization: vg1ei6rgo58fsbobr7octp0w3afd9vsm' https://10.0.214.98/api/v2/password_change_policy/9124292845052624897

Response

{
    "result": "success"
}