user.delete

Description

object user.delete(array users)

This method allows to delete users.

Parameters

(array) Users to delete.

The users must have the userid property defined.

Return values

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

Examples

Deleting multiple users

Delete two users.

Request:

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

Response:

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

Source

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