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

Parâmentros

Nome parâmetro Descrição
search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

ordenar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a 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 a String

usergroup[admin]
opcional , nulo permitido

é um grupo de usuários admini

Validations:

  • Must be one of: true, false, 1, 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

User groups linked to external groups (LDAP) are automatically synced with these groups on update. Remember this synchronization will remove any LDAP users manually added to the Foreman user group. Only LDAP users in the external groups will remain. Internal users can be added or removed freely.

Parâmentros

Nome parâmetro Descrição
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 , nulo permitido

é um grupo de usuários admini

Validations:

  • Must be one of: true, false, 1, 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 a String