GET /api/usergroups
Llista tots els grups d'usuaris

Params

Param name Description
search
optional

filtra els resultats

Validations:

  • Must be a String

order
optional

ordena els resultats

Validations:

  • Must be a String

page
optional

pagina els resultats

Validations:

  • Must be a String

per_page
optional

Nombre d'entrades per peticiĆ³

Validations:

  • Must be a String


GET /api/usergroups/:id
Mostra un grup d'usuaris

Params

Param name Description
id
required

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
Crea un grup d'usuaris

Params

Param name Description
usergroup
required

Validations:

  • Must be a Hash

usergroup[name]
required

Validations:

  • Must be a String

usergroup[admin]
optional , nil allowed

is an admin user group

Validations:

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

usergroup[user_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Actualitza un grup d'usuaris

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.

Params

Param name Description
id
required

Validations:

  • Must be a String

usergroup
required

Validations:

  • Must be a Hash

usergroup[name]
optional

Validations:

  • Must be a String

usergroup[admin]
optional , nil allowed

is an admin user group

Validations:

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

usergroup[user_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Suprimeix un grup d'usuaris

Params

Param name Description
id
required

Validations:

  • Must be a String