SIEM-Konfiguration einer Organisation ändern¶

Note

Der Body muss die Attribute id und modified enthalten, um den entsprechenden Eintrag zu identifizieren.

Note

Die ID des Eintrags im Pfad der Anfrage muss mit dem Wert des Attributs id im Body übereinstimmen.

Senden einer PATCH-Anfrage an den Endpunkt /organisations/{organisation}/siem.

Beschreibung¶

Mit der Change-Organisation-SIEM-Anfrage ändern Sie die SIEM-Verbindungsdetails einer Organisation.

Voraussetzungen¶

Werte der Anfrage: Organisation-ID {organisation}

Objekte: OrganisationVO

Anfrage¶

Um die SIEM-Verbindungsdetails zu ändern, fügen Sie die Organisation-ID {organisation} in den Pfad der Anfrage ein.

Für eine detaillierte Spezifikation, welche Informationen zum Ändern der SIEM-Verbindungsdetails erforderlich sind, muss im Body ein Objekt OrganisationVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`id`	Die ID des Eintrags.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`siemProvider`	Der Name des SIEM-Anbieters (z. B. splunk).	`string`
`siemConnectionDetails`	Die Verbindungsdetails für den SIEM-Anbieter.	`object`

Das System gibt als Antwort das Objekt OrganisationVO mit den aktualisierten Informationen zurück.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`id`	Die ID der Organisation.	`string`
`name`	Der Name der Organisation.	`string`
`created_at`	Der ursprüngliche Erstellungszeitpunkt.	`string($date-time)`
`updated_at`	Der Zeitpunkt der letzten Aktualisierung.	`string($date-time)`
`users`	Die der Organisation zugewiesenen Nutzenden.	`array`
`showReports`	Definiert, ob Mitigationsberichte aktiviert sind.	`true` `false`
`siemEnabled`	Definiert, ob die SIEM-Integration aktiviert ist.	`true` `false`
`customer_id` (falls Kundenreferenzen aktiviert)	Die Kennung der Kundenreferenz.	`string`
`customer_reference` (falls Kundenreferenzen aktiviert)	Die gruppierte Kundenreferenz.	`string`

Beispiel¶

Beispiel-Request-Body:

{
  "siemProvider": "string",
  "siemConnectionDetails": {
    "host": "string",
    "port": 0,
    "apiToken": "string"
  }
}

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.