GET /api/usergroups
Alle Benutzergruppen auflisten

Parameter

Parametername Beschreibung
search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


GET /api/usergroups/:id
Benutzergruppe anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • 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

Parameter

Parametername Beschreibung
usergroup
verpflichtend

Validations:

  • Must be a Hash

usergroup[name]
verpflichtend

Validations:

  • Must be a String

usergroup[admin]
optional , nil erlaubt

ist eine Admin-Benutzergruppe

Validations:

  • Must be one of: true, false, 1, 0

usergroup[user_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

usergroup[role_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Benutzergruppe aktualisieren

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be a String

usergroup
verpflichtend

Validations:

  • Must be a Hash

usergroup[name]
optional

Validations:

  • Must be a String

usergroup[admin]
optional , nil erlaubt

ist eine Admin-Benutzergruppe

Validations:

  • Must be one of: true, false, 1, 0

usergroup[user_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

usergroup[role_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type


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

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be a String