GET /api/usergroups
Listar todos os grupos de usuários

Parâmentros

Nome parâmetro Descrição
search
opcional

filtrar resultados

Validations:

  • Must be String

order
opcional

ordenar resultados

Validations:

  • Must be String

page
opcional

paginar resultados

Validations:

  • Must be String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be String


GET /api/usergroups/:id
Mostrar um grupo de usuário

Parâmentros

Nome parâmetro Descrição
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
Criar um grupo de usuários

Parâmentros

Nome parâmetro Descrição
usergroup
requerido

Validations:

  • Must be a Hash

usergroup[name]
requerido

Validations:

  • Must be String

usergroup[admin]
opcional , nulo permitido

is an admin user group

Validations:

  • Must be 'true' or 'false' or '1' or '0'

usergroup[user_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Atualizar um grupo de usuário

Parâmentros

Nome parâmetro Descrição
id
requerido

Validations:

  • Must be String

usergroup
requerido

Validations:

  • Must be a Hash

usergroup[name]
opcional

Validations:

  • Must be String

usergroup[admin]
opcional , nulo permitido

is an admin user group

Validations:

  • Must be 'true' or 'false' or '1' or '0'

usergroup[user_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Apagar um grupo de usuário

Parâmentros

Nome parâmetro Descrição
id
requerido

Validations:

  • Must be String