Organisationen mit Netzwerk- und Mitigationsdetails auflisten

Note

Die Objekte OrganisationVO sind in data verpackt, ergänzt durch die Paginierungsblöcke links und meta.

Senden einer GET-Anfrage an den Endpunkt /organisations.

Beschreibung

Mit der List-Organisations-Paginated-Anfrage fordern Sie eine paginierte Liste aller Organisationen an, angereichert mit Netzwerk-CIDRs und dem aktuellen Mitigationsstatus.

Voraussetzungen

Werte der Anfrage: keine

Objekte: keine

Anfrage

Um eine paginierte Liste aller Organisationen anzufordern, ist im Pfad der Anfrage keine zusätzliche Information erforderlich.

Als Ergebnis erhalten Sie ein oder mehrere Objekte 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 Erstellungszeitstempel im ISO-8601-Format.	`string($date-time)`
`updated_at`	Der letzte Aktualisierungszeitstempel im ISO-8601-Format.	`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`	Die Kennung der Kundenreferenz.	`string`
`cidrs`	Die kommagetrennte Liste der CIDRs.	`string`
`under_mitigation`	Zeigt an, ob sich aktuell ein Netzwerk in Mitigation befindet.	`true` `false`
`customer_reference`	Die gruppierte Kundenreferenz.	`string`

Beispiel

Beispiel-Antwort:

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "https://datahub-api.com/api/networks?page=1",
    "last": "https://datahub-api.com/api/networks?page=5",
    "prev": null,
    "next": "https://datahub-api.com/api/networks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "https://datahub-api.com/api/networks?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://datahub-api.com/api/networks",
    "per_page": 15,
    "to": 15,
    "total": 64
  }
}

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.