Skip to content

Create#

Create an User.

Query#

POST /api/v1/user

Request Body Example#

{
  "login" : "[email protected]",
  "name" : "Jerome",
  "organisation": "StrangeBee",
  "profile": "org-admin",
  "email": "[email protected]",
  "password": "my-secret-password"
}

The following fields are required:

  • login: (String - email address)
  • name: (String)
  • organisation: (String)
  • profile: [admin|org-admin|analyst|read-only|any customed profile]

Response#

Status codes#

  • 201: if User is created 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": [],
  "email": "[email protected]"
}

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