GET /api/usergroups
Lista wszystkich grup użytkowników

Parametry

Nazwa parametru Opis
search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

rezultat sortowania

Validations:

  • Must be a String

page
opcjonalny

rezultat paginacji

Validations:

  • Must be a String

per_page
opcjonalny

Liczba wpisów na jedno żądanie

Validations:

  • Must be a String


GET /api/usergroups/:id
Pokaż grupę użytkowników

Parametry

Nazwa parametru Opis
id
wymagany

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
Utwórz grupę użytkowników

Parametry

Nazwa parametru Opis
usergroup
wymagany

Validations:

  • Must be a Hash

usergroup[name]
wymagany

Validations:

  • Must be a String

usergroup[admin]
opcjonalny , nil dopuszczalny

is an admin user group

Validations:

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

usergroup[user_ids]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Aktualizuj grupę użytkowników

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.

Parametry

Nazwa parametru Opis
id
wymagany

Validations:

  • Must be a String

usergroup
wymagany

Validations:

  • Must be a Hash

usergroup[name]
opcjonalny

Validations:

  • Must be a String

usergroup[admin]
opcjonalny , nil dopuszczalny

is an admin user group

Validations:

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

usergroup[user_ids]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type

usergroup[role_ids]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Usuń grupę użytkowników

Parametry

Nazwa parametru Opis
id
wymagany

Validations:

  • Must be a String