Organisation anhand der ID abrufen¶

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

Beschreibung¶

Mit der Get-Organisation-Anfrage fordern Sie eine einzelne Organisation für eine angegebene ID an.

Voraussetzungen¶

Werte der Anfrage: Organisation-ID {organisation}

Objekte: keine

Anfrage¶

Um eine Organisation anzufordern, fügen Sie die Organisation-ID {organisation} in den Pfad der Anfrage ein.

Als Ergebnis erhalten Sie ein Objekt OrganisationVO mit den angefragten Informationen.

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 im ISO-8601-Format.	`string($date-time)`
`updated_at`	Der Zeitpunkt der letzten Aktualisierung im ISO-8601-Format.	`string($date-time)`
`users`	Die zur Organisation gehörenden Nutzenden.	`array`
`emails`	Die Benachrichtigungsadressen der Organisation. Jeder Eintrag enthält die `id`, die Adresse `email`, das Kennzeichen `verified` und den Zeitpunkt `verified_at`.	`array` von `object`
`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`
`customer_id` (falls Kundenreferenzen aktiviert)	Die Kennung der Kundenreferenz.	`string`
`customer_reference` (falls Kundenreferenzen aktiviert)	Die gruppierte Kundenreferenz.	`string`

Beispiel¶

Beispiel-Antwort:

{
  "id": "xY9pQ5wR1",
  "name": "Test Organisation",
  "created_at": "2026-01-01T00:00:00+00:00",
  "updated_at": "2026-01-01T00:00:00+00:00",
  "users": [
    {
      "id": "xY9pQ5wR1",
      "name": "Max Mustermann",
      "email": "max@mustermann.de",
      "has2Fa": false,
      "permissions": {},
      "activeOrganisation": {
        "id": "xY9pQ5wR1",
        "name": "Test Organisation"
      },
      "hasActiveMitigations": false,
      "hasSiem": false,
      "invitedSince": "2024-01-15 10:30:00",
      "status": "active",
      "role": "admin",
      "teams": [
        {
          "id": "xY9pQ5wR1",
          "name": "Test Organisation"
        }
      ],
      "teams_as_admin": [
        {
          "id": "xY9pQ5wR1",
          "name": "Test Organisation"
        }
      ],
      "features": [
        {
          "name": "L_NUMBER",
          "value": null,
          "enabled": 1
        }
      ]
    }
  ],
  "showReports": true,
  "siemEnabled": false,
  "customer_id": "abc",
  "cidrs": "127.0.0.1/32, 10.0.0.0/24",
  "under_mitigation": false,
  "customer_reference": "abc"
}

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.