GET /api/usergroups
Listar todos los grupos de usuarios

Parámetros

Nombre del parámetro Descripción
search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

organizar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


GET /api/usergroups/:id
Mostrar un grupo de usuarios

Parámetros

Nombre del parámetro Descripción
id
requerido

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
Crear un grupo de usuarios

Parámetros

Nombre del parámetro Descripción
usergroup
requerido

Validations:

  • Must be a Hash

usergroup[name]
requerido

Validations:

  • Must be a String

usergroup[admin]
opcional , nil permitido

es un grupo de usuarios administradores

Validations:

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

usergroup[user_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Actualizar un grupo de usuarios

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be a String

usergroup
requerido

Validations:

  • Must be a Hash

usergroup[name]
opcional

Validations:

  • Must be a String

usergroup[admin]
opcional , nil permitido

es un grupo de usuarios administradores

Validations:

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

usergroup[user_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Borrar un grupo de usuarios

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be a String