Skip to content
Alberto Gonzalez edited this page Jun 19, 2017 · 2 revisions

(GET)/users

Returns the list of users in the environment. For detailed information about the fields returned, see (GET)/users/{id}.

Resource URL

https://{applianceaddress}/api/users

Request

Syntax

GET api/users
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Name Description Required
&sid={sid} The system ID for the system for which we want to get users No

Related Resources

(GET)/users/{id}

(POST)/users

Response

For GET /users API the response type is:

[
    "data": [
         {
            "id": 1,
            "name": "root",
            "superuser": true,
            "vault_user": false,
            "portal_user": false,
            "customers": [],
            "locations": [],
            "systems": []
        },
        {
            "id": 34,
            "name": "grok-manage",
            "superuser": false,
            "vault_user": false,
            "customers": [
                {
                    "id": 1,
                    "privilege_level": 2
                }
            ],
            "locations": [],
            "systems": [],
            "administrator": false,
            "user_role": {
                "level": 3,
                "name": "restore_operator",
                "recover_options": "no_download;suffix:*.doc, *.html",
                "scope": "1_121_1_331,1_121_5_332,1_121_5_333"
            }
        }
]

Clone this wiki locally