Skip to content

Create#

API to create a new TheHive organisation.

Query#

POST /api/v0/organisation

Authorization#

This API requires a super admin user with manageOrganisation permission

Request#

Request Body Example#

{
    "description": "SOC team",
    "name": "soc"
}

Fields#

The following fields are required:

  • name: (String)
  • description: (String)

Response#

Status codes#

  • 201: if organisation creation completed successfully
  • 401: Authentication error
  • 403: Authorization error

ResponseBody Example#

{
    "_id": "~204804296",
    "_type": "organisation",
    "createdAt": 1630385478884,
    "createdBy": "admin@thehive.local",
    "description": "SOC team",
    "id": "~204804296",
    "links": [],
    "name": "soc"
}

{
  "type": "AuthenticationError",
  "message": "Authentication failure"
}

{
    "type": "AuthorizationError",
    "message": "Unauthorized action"
}
Last update: October 13, 2023 07:01:35