Adding an organisation¶

Note

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

Note

This request is only available to SOC users.

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` (if customer references enabled)	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`
`anomaliesEnabled` (if anomalies enabled)	Whether the anomalies feature is enabled for this organisation, including email notifications for detected anomalies and for mitigations that start or stop.	`true` `false`
`emails`	The full list of notification recipients for the organisation. Each entry must be a valid, unique email address. Submitting the list replaces the current recipients; newly added addresses are sent a verification email and are only used for notifications once confirmed.	`array` of `string`

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,
  "anomaliesEnabled": true,
  "emails": [
    "alerts@example.com"
  ]
}

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.