Organisation hinzufügen¶

Note

Der Body enthält nicht die Attribute id, created und modified. Das System legt diese Werte nach dem Erstellen des Eintrags fest.

Note

Diese Anfrage steht ausschließlich SOC-Nutzenden zur Verfügung.

Senden einer POST-Anfrage an den Endpunkt /organisations.

Beschreibung¶

Mit der Add-Organisation-Anfrage fügen Sie dem System eine neue Organisation hinzu.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: OrganisationVO

Anfrage¶

Um eine Organisation hinzuzufügen, ist im Pfad der Anfrage keine zusätzliche Information erforderlich.

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen einer Organisation erforderlich sind, muss im Body ein Objekt OrganisationVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`name`	Der Name der Organisation. Maximale Länge: 255 Zeichen.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`customer_id` (falls Kundenreferenzen aktiviert)	Eine eindeutige Kundenreferenz für die Organisation.	`string`
`showReports`	Definiert, ob Mitigationsberichte aktiviert sind.	`true` `false`
`siemEnabled`	Definiert, ob die SIEM-Integration aktiviert ist.	`true` `false`
`anomaliesEnabled` (falls Anomalien aktiviert)	Definiert, ob die Funktion Anomalien für diese Organisation aktiviert ist, einschließlich der Benachrichtigungs-E-Mails zu erkannten Anomalien und zu startenden und endenden Mitigationen.	`true` `false`
`emails`	Die vollständige Liste der Benachrichtigungsadressen der Organisation. Jeder Eintrag muss eine gültige und eindeutige E-Mail-Adresse sein. Die übermittelte Liste ersetzt die bisherigen Adressen; neu hinzugefügte Adressen erhalten eine Bestätigungs-E-Mail und werden erst nach der Bestätigung für Benachrichtigungen verwendet.	`array` von `string`

Das System gibt als Antwort das Objekt OrganisationVO mit den Informationen zum neuen Eintrag zurück.

Beispiel¶

Beispiel-Request-Body:

{
  "name": "string",
  "customer_id": "string",
  "showReports": true,
  "siemEnabled": true,
  "anomaliesEnabled": true,
  "emails": [
    "alerts@example.com"
  ]
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.
422	Die Anfrage war nicht erfolgreich, da die übermittelten Daten nicht verarbeitet werden konnten.