Eine Benutzergruppe erstellen

Note

Eine Untergruppe kann nur unter der Root-Gruppe oder einer anderen Untergruppe erstellt werden. Das Erstellen einer Benutzergruppe ohne das Attribut parent ist nicht möglich.

Note

Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen des Eintrags gesetzt.

Note

Der Body darf nur die genannten Attribute enthalten. Alle anderen möglichen Attribute des Objekts GroupVO werden ignoriert.

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

Beschreibung

Mit der Create-User-Group-Anfrage erstellen Sie eine neue Benutzergruppe für die Organisation.

Voraussetzungen

Werte der Anfrage: keine

Objekte: GroupVO

Anfrage

Um eine Benutzergruppe für die Organisation zu erstellen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen einer Benutzergruppe erforderlich sind, müssen im Body ein oder mehrere Objekte GroupVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
name	Der Name der Benutzergruppe.	string
parent	Die ID der übergeordneten Benutzergruppe.	integer

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 als Antwort das Objekt GroupVO mit den Informationen zum neuen Eintrag zurück.

Beispiel

Beispiel-Request-Body:

{
  "name": "string",
  "parent": 0,
  "children": []
}

Antworten

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
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.