GET /api/usergroups
すべてのユーザーグループを一覧表示

パラメーター

パラメーター名 記述
search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


GET /api/usergroups/:id
ユーザーグループの表示

パラメーター

パラメーター名 記述
id
必須

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
ユーザーグループの作成

パラメーター

パラメーター名 記述
usergroup
必須

Validations:

  • Must be a Hash

usergroup[name]
必須

Validations:

  • Must be a String

usergroup[admin]
任意 , nil可

管理者ユーザーグループ

Validations:

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

usergroup[user_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[role_ids]
任意 , nil可

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
ユーザーグループの更新

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.

パラメーター

パラメーター名 記述
id
必須

Validations:

  • Must be a String

usergroup
必須

Validations:

  • Must be a Hash

usergroup[name]
任意

Validations:

  • Must be a String

usergroup[admin]
任意 , nil可

管理者ユーザーグループ

Validations:

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

usergroup[user_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
任意 , nil可

Validations:

  • Must be an array of any type

usergroup[role_ids]
任意 , nil可

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
ユーザーグループの削除

パラメーター

パラメーター名 記述
id
必須

Validations:

  • Must be a String