更新用户组
描述
object usergroup.update(object/array userGroups)
此方法用于更新已存在的用户组.
此方法仅适用于 超级管理员 用户类型.可在用户角色配置中撤销对此方法的调用权限. 参阅用户角色 查看详情.
参数
(object/array)
此方法允许更新现有的用户组.
必须为每个用户组定义usrgrpid
属性, 所有其他属性都是可选的. 只有通过验证的属性会被更新,所有其他属性将保持不变.
除了 标准用户组属性,该方法接受以下参数.
参数 | 类型 | 描述 |
---|---|---|
rights | object/array | 需要非配给用户组用于代替当前权限的 权限 . |
tag_filters | array | 分配给用户组的 标签权限. |
users | object/array | 需要加入用户组的 用户. 用户必须具备 userid 属性. |
返回值
(object)
返回一个带有usrgrpids
属性(其中包含被更新用户组ID)的对象.
示例
禁用一个用户组
禁用一个用户组.
请求:
{
"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() in ui/include/classes/api/services/CUserGroup.php.