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]
選填 , 允許空值

is an admin user group

Validations:

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

usergroup[user_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

usergroup[role_ids]
選填 , 允許空值

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]
選填 , 允許空值

is an admin user group

Validations:

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

usergroup[user_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

usergroup[role_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
刪除使用者群組

參數

參數名字 描述
id
必填

Validations:

  • Must be a String