Documentation

Table of Contents

描述
参数
返回值
示例
- 启用用户组并更新权限
另请参阅
来源

{HEADER_44515052}

描述

object usergroup.update(object/array userGroups)

此方法用于 update 现有的用户组。

此方法仅适用于 超级管理员 用户类型。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见 User roles

参数

(object/array) 要更新的用户组属性。

每个用户组必须定义 usrgrpid 属性，所有其他属性是可选的。仅更新传递的属性，其他属性将保持不变。

除了用户组外，该方法还接受以下参数。

参数	数据类型	描述
hostgroup_rights	object/array	主机组权限，用于替换分配给用户组的当前权限。
templategroup_rights	object/array	模板组权限，用于替换分配给用户组的当前权限。
tag_filters	array	基于标签的权限，用于替换分配给用户组的当前权限。
users	object/array	Users，用于替换分配给用户组的当前用户。用户必须仅定义 `userid` 属性。
rights (deprecated)	object/array	此参数已弃用，请改用 `hostgroup_rights` 或 `templategroup_rights`。要分配给用户组的权限。

返回值

(object) 返回一个 object，其中包含在 usrgrpids 属性下列出的已更新用户组的 ID。

示例

启用用户组并更新权限

启用一个用户组，并为其提供对主机组 "2" 和 "4" 的读写访问权限。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "usergroup.update",
           "params": {
               "usrgrpid": "17",
               "users_status": "0",
               "hostgroup_rights": [
                   {
                       "id": "2",
                       "permission": 3
                   },
                   {
                       "id": "4",
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应：

{
           "jsonrpc": "2.0",
           "result": {
               "usrgrpids": [
                   "17"
               ]
           },
           "id": 1
       }

另请参阅

权限

来源

CUserGroup::update() 方法位于 ui/include/classes/api/services/CUserGroup.php 文件中。