更新

Description

object usergroup.update(object/array userGroups)

此方法用于更新已存在的用户组。

此方法仅适用于Super admin(超级管理员)类型的用户。可在用户角色设置中撤销调用该方法的权限,参阅用户角色获取详情。

参数

(object/array) 此方法允许更新现有的用户组。

必须为每个用户目录组定义usrgrpid属性,其他所有属性都是可选的。 注意只有通过验证的属性将被更新,其他所有属性将保持不变。

除了标准用户组属性,该方法接受以下参数。

参数类型描述
hostgroup_rightsobject/array主机组权限用于替换当前分配给用户组的该权限。
templategroup_rightsobject/array模板组权限用于替换当前分配给用户组的该权限。
tag_filtersarray标签权限用于替换当前分配给用户组的该权限。
usersobject/array用户可以将当前分配给用户组的用户替换为其他用户。

用户必须仅定义 userid 属性。
rights
(deprecated)
object/array此参数已弃用,请使用hostgroup_rightstemplategroup_rights代替。
分配给用户组的权限

返回值

(object) 返回一个带有usrgrpids属性(其中包含被更新用户组ID)的对象。

示例

启用用户组并更新权限

启用一个用户组,并为其提供对主机组“2”和“4”的读写权限。

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "usergroup.update",
  4. "params": {
  5. "usrgrpid": "17",
  6. "users_status": "0",
  7. "hostgroup_rights": [
  8. {
  9. "id": "2",
  10. "permission": 3
  11. },
  12. {
  13. "id": "4",
  14. "permission": 3
  15. }
  16. ]
  17. },
  18. "id": 1
  19. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": {
  4. "usrgrpids": [
  5. "17"
  6. ]
  7. },
  8. "id": 1
  9. }

参考

来源

CUserGroup::update() in ui/include/classes/api/services/CUserGroup.php.