Changing the settings of an organisation

Sends a PATCH request to the endpoint /organisations/{organisation}.

Description

SOC only. The Change-Organisation request changes the settings of an organisation.

Requirements

Values of the request: Organisation ID {organisation}

Objects: none

Request

To change the settings of an organisation, add the Organisation ID {organisation} to the path of the request.

For a detailed specification of which information is required to change the settings of an organisation, the following attributes can be defined in the body.

The following attributes are optional:

Attributes	Description	Values
name	The name of the organisation.	string
customer_id	A unique customer reference for the organisation.	string
showReports	Defines whether reports are shown for this organisation.	true false
siemEnabled	Defines whether SIEM is enabled for this organisation.	true false
siemProvider	The name of the SIEM provider.	string

In response to a successful request, the system returns only an HTTP status code 200.

Example

Example request body:

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

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.