Adding an organisation

Note

The body does not contain the id, created, and modified attributes. The system sets these values after the entry has been created.

Note

This request is available to SOC users only.

Sends a POST request to the endpoint /organisations.

Description

The Add-Organisation request adds a new organisation to the system.

Requirements

Values of the request: none

Objects: OrganisationVO

Request

To add an organisation, no additional information is required in the path of the request.

For a detailed specification of which information is required to add an organisation, an object OrganisationVO with the following attributes must be defined in the body:

Attributes	Description	Values
`name`	The name of the organisation. Maximum length: 255 characters.	`string`

The following attributes are optional:

Attributes	Description	Values
`customer_id`	A unique customer reference for the organisation.	`string`
`showReports`	Defines whether mitigation reports are enabled.	`true` `false`
`siemEnabled`	Defines whether the SIEM integration is enabled.	`true` `false`

In response, the system returns the object OrganisationVO with the information about the new entry.

Example

Example request body:

{
  "name": "string",
  "customer_id": "string",
  "showReports": true,
  "siemEnabled": true
}

Responses

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.
422	The request was unsuccessful because the submitted data could not be processed.