user.delete

Description

object user.delete(array users)

This method allows to delete users.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of users to delete.

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:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "user.delete",
  4.            "params": [
  5.                "1",
  6.                "5"
  7.            ],
  8.            "auth": "3a57200802b24cda67c4e4010b50c065",
  9.            "id": 1
  10.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "userids": [
  5.                    "1",
  6.                    "5"
  7.                ]
  8.            },
  9.            "id": 1
  10.        }

Source

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