.. _password_policies:

Method: Obtain all password policies
------------------------------------

Description
~~~~~~~~~~~

Obtain list of all available password policies.

URL Syntax
~~~~~~~~~~

/api/{version}/utils/policies

HTTP Method
~~~~~~~~~~~

GET

Successful HTTP Response
~~~~~~~~~~~~~~~~~~~~~~~~

200

Parameters
~~~~~~~~~~

+----------------+------------------+----------------+--------+-----------+------------------+
| Parameter name |   Description    | Parameter type |  Type  | Mandatory |     Comment      |
+================+==================+================+========+===========+==================+
| X-Http-Token   | StoredSafe token | HTTP Header    | String | :sup:`1)` | Preferred method |
+----------------+------------------+----------------+--------+-----------+------------------+
| token          | StoredSafe token | URL-parameter  | String | :sup:`1)` | Legacy method    |
+----------------+------------------+----------------+--------+-----------+------------------+

.. note:: :sup:`1)` One of the methods is required.

Response Attributes
~~~~~~~~~~~~~~~~~~~

+------------------------+-------------------------------------------------+---------+
|       Attribute        |                   Description                   |  Type   |
+========================+=================================================+=========+
| CALLINFO.errorcodes    | Number of errors                                | Integer |
+------------------------+-------------------------------------------------+---------+
| CALLINFO.errors        | Number of errors                                | Integer |
+------------------------+-------------------------------------------------+---------+
| CALLINFO.general       | Information                                     | Array   |
+------------------------+-------------------------------------------------+---------+
| CALLINFO.handler       | Handler used                                    | String  |
+------------------------+-------------------------------------------------+---------+
| CALLINFO.status        | SUCCESS or FAIL                                 | String  |
+------------------------+-------------------------------------------------+---------+
| CALLINFO.policies.(id) | Password policies                               | Array   |
+------------------------+-------------------------------------------------+---------+
| CALLINFO.token         | StoredSafe token to be used in subsequent calls | String  |
+------------------------+-------------------------------------------------+---------+
| DATA                   | Supplied data in API-call                       | String  |
+------------------------+-------------------------------------------------+---------+
| HEADERS.(headers)      | HTTP Headers                                    | String  |
+------------------------+-------------------------------------------------+---------+
| PARAMS                 | Route parameters (empty)                        | Array   |
+------------------------+-------------------------------------------------+---------+
| ERRORCODES             | Error code and text (Only present if errors)    | Object  |
+------------------------+-------------------------------------------------+---------+
| ERRORS                 | Error code and text (Only present if errors)    | Array   |
+------------------------+-------------------------------------------------+---------+

Examples
~~~~~~~~

Obtain list of all available password policies.

**Request**

::

   GET /api/1.0/utils/policies
   x-http-token: your_storedsafe_token

**Response**

::

   HTTP/2 200
   content-type: application/json; charset=UTF-8
   {
       "CALLINFO": {
           "errorcodes": 0,
           "errors": 0,
           "general": [],
           "handler": "UtilsHandler",
           "status": "SUCCESS",
           "policies": [
               {
                   "id": 7,
                   "name": "High Quality Password (14+ chars, mixed case, number and special)",
                   "rules": {
                       "min_length": 14,
                       "min_lowercase_chars": 1,
                       "min_nonalphanumeric_chars": 1,
                       "min_numeric_chars": 1,
                       "min_uppercase_chars": 1
                   }
               },
               {
                   "id": 8,
                   "name": "Good Quality Password (12+ chars, mixed case, number and special))",
                   "rules": {
                       "min_length": 12,
                       "min_lowercase_chars": 1,
                       "min_nonalphanumeric_chars": 1,
                       "min_numeric_chars": 1,
                       "min_uppercase_chars": 1
                   }
               },
               .
               .
           ],
           "token": "rotated_storedsafe_token"
       },
       "DATA": {
           "token": "your_storedsafe_token"
       },
       "HEADERS": {
           "Accept": "*/*",
           "Host": "safe.domain.cc",
           "User-Agent": "curl/7.64.1",
           "X-Http-Token": "your_storedsafe_token"
       },
       "PARAMS": []
   }