GET /api/usergroups
Elenca tutti i gruppi di utenti

Parametri

Nome parametro Descrizione
search
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

ordina risultati

Validations:

  • Must be a String

page
opzionale

paginazione risultati

Validations:

  • Must be a String

per_page
opzionale

numero di voci per richiesta

Validations:

  • Must be a String


GET /api/usergroups/:id
Mostra un gruppo di utenti

Parametri

Nome parametro Descrizione
id
richiesto

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 gruppo di utenti

Parametri

Nome parametro Descrizione
usergroup
richiesto

Validations:

  • Must be a Hash

usergroup[name]
richiesto

Validations:

  • Must be a String

usergroup[admin]
opzionale , consentito nil

is an admin user group

Validations:

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

usergroup[user_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[role_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Aggiorna un gruppo di utenti

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.

Parametri

Nome parametro Descrizione
id
richiesto

Validations:

  • Must be a String

usergroup
richiesto

Validations:

  • Must be a Hash

usergroup[name]
opzionale

Validations:

  • Must be a String

usergroup[admin]
opzionale , consentito nil

is an admin user group

Validations:

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

usergroup[user_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

usergroup[role_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Cancella un gruppo di utenti

Parametri

Nome parametro Descrizione
id
richiesto

Validations:

  • Must be a String