GET /api/usergroups
Alle Benutzergruppen auflisten

Params

Param Name Description
search
Optional

Ergebnisse filtern


Value: Must be String
order
Optional

Ergebnisse sortieren


Value: Must be String
page
Optional

paginate results


Value: Must be String
per_page
Optional

Anzahl der Einträge pro Anfrage


Value: Must be String

GET /api/usergroups/:id
Benutzergruppe anzeigen

Params

Param Name Description
id
Required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

POST /api/usergroups
Eine Benutzergruppe erstellen

Params

Param Name Description
usergroup
Required

Value: Must be a Hash
usergroup[name]
Required

Value: Must be String
usergroup[user_ids]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
usergroup[usergroup_ids]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
usergroup[role_ids]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type

PUT /api/usergroups/:id
Benutzergruppe aktualisieren

Params

Param Name Description
id
Required

Value: Must be String
usergroup
Required

Value: Must be a Hash
usergroup[name]
Optional

Value: Must be String
usergroup[user_ids]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
usergroup[usergroup_ids]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
usergroup[role_ids]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type

DELETE /api/usergroups/:id
Benutzergruppe löschen

Params

Param Name Description
id
Required

Value: Must be String