Eine Benutzergruppe ändern¶
Note
Der Body muss die Attribute id und modified enthalten, um den entsprechenden Eintrag zu identifizieren.
Note
Die ID des Eintrags im Pfad der Anfrage muss mit dem Wert des Attributs id im Body übereinstimmen.
Note
Nur die Einstellungen von Untergruppen können geändert werden. Die Root-Benutzergruppe kann nicht geändert werden.
Senden einer PUT-Anfrage an den Endpunkt /user/groups/{id}.
Beschreibung¶
Mit der Change-User-Group-Anfrage ändern Sie die Einstellungen einer Benutzergruppe der Organisation.
Voraussetzungen¶
Werte der Anfrage: Group-ID {id}
Objekte: GroupVO
Anfrage¶
Um die Einstellungen einer Benutzergruppe zu ändern, fügen Sie die Group-ID {id} dem Pfad der Anfrage hinzu.
Für eine detaillierte Spezifikation, welche Informationen zum Ändern der Einstellungen einer Benutzergruppe erforderlich sind, muss im Body das Objekt GroupVO mit den folgenden Attributen definiert werden:
| Attribut | Beschreibung | Werte |
|---|---|---|
name |
Der Name der Untergruppe. | string |
parent |
Die ID der übergeordneten Benutzergruppe. | integer |
id |
Die ID des Eintrags. | integer |
modified |
Das Datum der letzten Änderung im ISO-8601-Format. | string($date-time) |
Die folgenden Attribute sind optional:
| Attribut | Beschreibung | Werte |
|---|---|---|
children |
Ein Array mit Untergruppen der übergeordneten Benutzergruppe, jeweils als Objekt GroupVO dargestellt, mit möglichen weiteren children als Untergruppen. |
array |
Das System gibt das Objekt GroupVO mit den geänderten Informationen zurück.
Beispiel¶
Beispiel-Request-Body:
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. |