usergroup.update
说明
object usergroup.update(object/array userGroups)
此方法允许更新现有的用户组。
参数
(object/array)
要更新的用户组属性。
必须为每个用户组定义“usrgrpid”属性,所有其他属性都是可选的。 只有通过的属性将被更新,所有其他属性将保持不变。
除了标准用户组属性之外, 该方法接受以下参数。
属性 | 类型 | 说明 |
---|---|---|
rights | object/array | 更改分配给用户组的当前权限的权限。 |
userids | string/array | 用户的ID替换组中的用户。 |
返回值
(object)
返回包含“usrgrpids”属性下更新的用户组的ID的对象。
示例
Disabling a user group
Disable a user group.
Request:
- {
- "jsonrpc": "2.0",
- "method": "usergroup.update",
- "params": {
- "usrgrpid": "17",
- "users_status": "1"
- },
- "auth": "038e1d7b1735c6a5436ee9eae095879e",
- "id": 1
- }
Response:
- {
- "jsonrpc": "2.0",
- "result": {
- "usrgrpids": [
- "17"
- ]
- },
- "id": 1
- }
参见
来源
CUserGroup::update() in frontends/php/include/classes/api/services/CUserGroup.php.