Skip to content

List#

List users.

Query#

POST /api/v1/query

Request Body Example#

List last 15 users created.

{
  "query": [
    {
      "_name": "getOrganisation",
      "idOrName": "StrangeBee"
    },
    {
      "_name": "users"
    },
    {
      "_name": "sort",
      "_fields": [
        {
          "login": "asc"
        }
      ]
    },
    {
      "_name": "page",
      "from": 0,
      "to": 15,
      "organisation": "StrangeBee"
    }
  ]
}

Response#

Status codes#

  • 200: if query is run successfully
  • 401: Authentication error
  • 403: Authorization error

ResponseBody Example#

[
  {
    "_id": "~947527808",
    "_createdBy": "[email protected]",
    "_createdAt": 1630411433091,
    "login": "[email protected]",
    "name": "Jerome",
    "hasKey": false,
    "hasPassword": false,
    "hasMFA": false,
    "locked": false,
    "profile": "analyst",
    "permissions": [
      "manageShare",
      "manageAnalyse",
      "manageTask",
      "manageCase",
      "manageProcedure",
      "managePage",
      "manageObservable",
      "manageAlert",
      "accessTheHiveFS",
      "manageAction"
    ],
    "organisation": "StrangeBee",
    "organisations": []
  }
]

Last update: September 6, 2021 07:39:12