usergroup.update

描述

object usergroup.update(object/array userGroups)

此方法允许更新现有的用户组。

::: noteclassic 此方法仅适用于超级管理员用户类型。 调用该方法的权限可在用户角色设置中撤销。详情请参阅 User roles ::

参数

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

usrgrpid 属性必须为每个用户组定义,其他所有属性均为可选。仅传递的属性会被更新,其余属性将保持不变。

用户组外,该方法还接受以下参数。

参数 数据类型 说明
rights object/array 用于替换当前分配给用户组的权限权限。
tag_filters array 用于替换当前分配给用户组的基于标签的权限权限。
users object/array 用于替换当前分配给用户组的Users用户。

用户必须仅定义userid属性。

返回值

(object) 返回一个包含更新用户组ID的object,存储在usrgrpids属性下。

示例

禁用用户组

禁用用户组。

请求:

{
           "jsonrpc": "2.0",
           "method": "usergroup.update",
           "params": {
               "usrgrpid": "17",
               "users_status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

另请参阅

来源

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