Sidebar

zh:manual:api:reference:usergroup:delete

usergroup.delete

说明

object usergroup.delete(array userGroupIds)

此方法允许删除用户组。

参数

(array) 要删除的用户组的ID。

返回值

(object) 返回包含“usrgrpids”属性下删除的用户组的ID的对象。

Description

object usergroup.delete(array userGroupIds)

This method allows to delete user groups.

Parameters

(array) IDs of the user groups to delete.

Return values

(object) Returns an object containing the IDs of the deleted user groups under the usrgrpids property.

示例

删除多个用户组

Examples

Deleting multiple user groups

删除2个用户。

Delete two user groups.

Request:

{
    "jsonrpc": "2.0",
    "method": "usergroup.delete",
    "params": [
        "20",
        "21"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

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

来源

CUserGroup::delete() in frontends/php/include/classes/api/services/CUserGroup.php.