[comment]: # translation:outdated

[comment]: # ({9d4a1084-9d4a1084})
# 更新用户组

[comment]: # ({/9d4a1084-9d4a1084})

[comment]: # ({6126e201-9fdfde6c})
### 描述

`object usergroup.update(object/array userGroups)`

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

::: noteclassic
此方法仅适用于 *超级管理员* 用户类型.可在用户角色配置中撤销对此方法的调用权限. 参阅[用户角色](/manual/web_interface/frontend_sections/administration/user_roles) 查看详情.
:::

[comment]: # ({/6126e201-9fdfde6c})

[comment]: # ({4b32f1a1-93a5d635})
### 参数

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

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

除了 [标准用户组属性](object#user_group),该方法接受以下参数.

|参数|[类型](/manual/api/reference_commentary#data_types)|描述|
|---------|---------------------------------------------------|-----------|
|rights|object/array|需要非配给用户组用于代替当前权限的 [权限](/manual/api/reference/usergroup/object#permission) .|
|tag\_filters|array|分配给用户组的 [标签权限](/manual/api/reference/usergroup/object#tag_based_permission).|
|users|object/array|需要加入用户组的 [用户](/manual/api/reference/user/create).<br><br>用户必须具备 `userid` 属性.|

[comment]: # ({/4b32f1a1-93a5d635})

[comment]: # ({c04afd7f-c04afd7f})
### 返回值

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

[comment]: # ({/c04afd7f-c04afd7f})

[comment]: # ({b41637d2-b41637d2})
### 示例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({81f93d40-e1a75e7b})
#### 禁用一个用户组

禁用一个用户组.

请求:

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

返回:

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

[comment]: # ({/81f93d40-e1a75e7b})

[comment]: # ({d5c7ed4f-d5c7ed4f})
### 参考

-   [权限](object#permission)

[comment]: # ({/d5c7ed4f-d5c7ed4f})

[comment]: # ({09e213c5-09e213c5})
### 来源

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

[comment]: # ({/09e213c5-09e213c5})