Alle Nutzenden einer Organisation auflisten

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

Beschreibung

Mit der List-Organisation-Users-Anfrage fordern Sie eine Liste aller Nutzenden einer angegebenen Organisation an, mit Ausnahme von Agent-Konten.

Voraussetzungen

Werte der Anfrage: Organisation-ID {organisation}

Objekte: keine

Anfrage

Um eine Liste aller Nutzenden einer Organisation anzufordern, fügen Sie die Organisation-ID {organisation} dem Pfad der Anfrage hinzu.

Als Ergebnis erhalten Sie ein oder mehrere Objekte UserVO mit den angefragten Informationen.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`id`	Die ID der Nutzenden.	`string`
`name`	Der vollständige Name der Nutzenden.	`string`
`email`	Die E-Mail-Adresse der Nutzenden.	`string`
`role`	Die Rolle der Nutzenden innerhalb der Organisation.	`admin` `editor`
`status`	Der aktuelle Status des Benutzerkontos.	`string`
`invitedSince`	Das Datum, an dem die Nutzenden eingeladen wurden, oder leer, falls die Einladung bereits angenommen wurde.	`string($date-time)`
`has2Fa`	Definiert, ob die Zwei-Faktor-Authentifizierung für die Nutzenden aktiviert ist.	`true` `false`

Beispiel

Beispiel-Antwort:

[
  {
    "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
      }
    ]
  }
]

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.