Alle Benutzergruppen auflisten¶

Senden einer GET-Anfrage an den Endpunkt /user/groups.

Beschreibung¶

Mit der List-User-Groups-Anfrage rufen Sie eine Liste aller Benutzergruppen der Organisation ab.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: keine

Anfrage¶

Um eine Liste aller Benutzergruppen abzurufen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.

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

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`name`	Der Name der Benutzergruppe. Beginnend mit der Root-Benutzergruppe in der Liste der `GroupVO`.	`string`
`children`	Ein Array mit Untergruppen der übergeordneten Benutzergruppe, jeweils als Objekt `GroupVO` dargestellt, mit möglichen weiteren `children` als Untergruppen.	`array`
`parent`	Die ID der übergeordneten Benutzergruppe. Erscheint nur, wenn die Benutzergruppe eine Untergruppe ist.	`integer`
`roles`	Ein Array mit den Rollen, die das anfragende Benutzerkonto in dieser Benutzergruppe hat.	`ADMINISTRATOR` `USER`
`membersCount`	Die Anzahl aller Benutzer in der Benutzergruppe.	`integer`
`type`	Zeigt an, ob ein Benutzerkonto ein normales Benutzerkonto einer Organisation oder ein Benutzerkonto mit Agent-Berechtigungen ist.	`USER` `AGENT`
`id`	Die ID des Eintrags.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`

Beispiel¶

Beispiel-Antwort:

[
  {
    "name": "string",
    "children": [],
    "parent": 0,
    "roles": "ADMINISTRATOR",
    "membersCount": 0,
    "type": "USER",
    "id": 0,
    "modified": "2026-01-01T00:00:00+00:00",
    "created": "2026-01-01T00:00:00+00:00"
  }
]

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.