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]
选填 , 允许空值

是管理员用户组

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]
选填 , 允许空值

是管理员用户组

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