.. _list_members:

Method: List members in Vault
-----------------------------

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

Returns a list of current members in a vault.

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

/api/{version}/vault/:vaultid/members

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    |
+----------------+-----------------------+----------------+---------+-----------+------------------+
| vault-id       | Vault-id of the Vault | URL-paramater  | Integer | Yes       |                  |
+----------------+-----------------------+----------------+---------+-----------+------------------+

.. 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.vaultmembers             | Members                                         | Array   |
+-----------------------------------+-------------------------------------------------+---------+
| CALLINFO.vaultmembers.email       | Email                                           | String  |
+-----------------------------------+-------------------------------------------------+---------+
| CALLINFO.vaultmembers.fullname    | Fullname                                        | String  |
+-----------------------------------+-------------------------------------------------+---------+
| CALLINFO.vaultmembers.groupstatus | Vault permission                                | String  |
+-----------------------------------+-------------------------------------------------+---------+
| CALLINFO.vaultmembers.id          | ID                                              | String  |
+-----------------------------------+-------------------------------------------------+---------+
| CALLINFO.vaultmembers.status      | User capabilities                               | String  |
+-----------------------------------+-------------------------------------------------+---------+
| CALLINFO.vaultmembers.username    | Username                                        | String  |
+-----------------------------------+-------------------------------------------------+---------+
| CALLINFO.token                    | StoredSafe token to be used in subsequent calls | String  |
+-----------------------------------+-------------------------------------------------+---------+
| DATA                              | Supplied data in API-call                       | Object  |
+-----------------------------------+-------------------------------------------------+---------+
| PARAMS                            | PARAMS (empty)                                  | Object  |
+-----------------------------------+-------------------------------------------------+---------+
| ERRORCODES                        | Error code and text (Only present if errors)    | Object  |
+-----------------------------------+-------------------------------------------------+---------+
| ERRORS                            | Error code and text (Only present if errors)    | Array   |
+-----------------------------------+-------------------------------------------------+---------+

Examples
~~~~~~~~

Obtain a list of current members in a vault available to the logged in user.

**Request**

::

    GET /api/1.0/vault/159/members
    x-http-token: your_storedsafe_token

**Response**

::

    HTTP/2 200
    Content-type: application/json; charset=UTF-8
    {
        "CALLINFO": {
            "errorcodes": 0,
            "errors": 0,
            "general": [],
            "handler": "VaultmembersHandler",
            "status": "SUCCESS",
            "token": "rotated_storedsafe_token",
            "vaultmembers": [
                {
                    "email": "sven@moo.se",
                    "fullname": "Sven Test",
                    "groupstatus": "4",
                    "id": "10",
                    "status": "2444",
                    "username": "sven"
                },
                {
                    "email": "alfred@test.se",
                    "fullname": "Aldred Abrahamssom",
                    "groupstatus": "4",
                    "id": "29",
                    "status": "140",
                    "username": "alfred"
                }
            ]
        },
        "DATA": {
            "token": "your_storedsafe_token"
        },
        "HEADERS": {
            "Accept": "*/*",
            "Host": "safe.domain.cc",
            "User-Agent": "curl/7.64.1",
            "X-Http-Token": "your_storedsafe_token"
        },
        "PARAMS": []
    }