GET /api/usergroups
Afficher tous les groupes d'utilisateurs

Paramètres

Nom du paramètre Description
search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

trier les résultats

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entrées par requête

Validations:

  • Must be a String


GET /api/usergroups/:id
Afficher un groupe d'utilisateurs

Paramètres

Nom du paramètre Description
id
requis

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
Créer un groupe d'utilisateurs

Paramètres

Nom du paramètre Description
usergroup
requis

Validations:

  • Must be a Hash

usergroup[name]
requis

Validations:

  • Must be a String

usergroup[admin]
optionel , nil autorisé

est un un groupe d'utilisteurs admin

Validations:

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

usergroup[user_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

usergroup[role_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Mise à jour d'un groupe d'hôtes

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String

usergroup
requis

Validations:

  • Must be a Hash

usergroup[name]
optionel

Validations:

  • Must be a String

usergroup[admin]
optionel , nil autorisé

est un un groupe d'utilisteurs admin

Validations:

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

usergroup[user_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

usergroup[role_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Supprimer un groupe d'utilisateurs

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String