Sidebar

zh:manual:api:reference:user:delete

user.delete

说明

object user.delete(array users)

此方法允许删除用户。

Description

object user.delete(array users)

This method allows to delete users.

Parameters

(array) 要删除用户ID。

Parameters

(array) IDs of users to delete.

Return values

(object) 返回一个包含 userids 属性下删除用户ID的对象。

Return values

(object) Returns an object containing the IDs of the deleted users under the userids property.

示例

Examples

删除多个用户

删除2个用户。

Deleting multiple users

Delete two users.

Request:

{
    "jsonrpc": "2.0",
    "method": "user.delete",
    "params": [
        "1",
        "5"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "1",
            "5"
        ]
    },
    "id": 1
}

来源

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