Alle einem Benutzerkonto zugewiesenen Gruppen auflisten¶

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

Beschreibung¶

Mit der List-Users-Groups-Anfrage rufen Sie eine Liste aller Gruppen ab, die einem Benutzerkonto der Organisation zugewiesen sind.

Voraussetzungen¶

Werte der Anfrage: User-ID {id}

Objekte: keine

Anfrage¶

Um eine Liste aller einem Benutzerkonto zugewiesenen Gruppen 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 Gruppe.	`string`
`children`	Ein Array mit Untergruppen der Hauptgruppe, jeweils als Objekt `GroupVO` dargestellt, mit möglichen weiteren `children` als Untergruppen.	`array`
`roles`	Ein Array mit den Rollen, die das angefragte Benutzerkonto in dieser Gruppe hat.	`ADMINISTRATOR` `USER`
`membersCount`	Die Anzahl aller Benutzer in der Gruppe.	`integer`
`type`	Zeigt an, ob ein Benutzerkonto ein normaler Benutzer 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": [],
    "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	Eine Liste von `GroupVO`-Elementen.
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.