Zabbix Documentation 1.8

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


Sidebar

api:user:delete

Table of Contents

delete()

Available since version: 1.8
This function allows you to delete information about one or several users. All user-related information will be removed. Method available only to super admins.

Parameters

Array of User IDs

Returns

ParameterDescription
resultOperation successful. Result will contain array of deleted User IDs.
errorIn case of any errors

Example

Delete users by User ID

{
"jsonrpc":"2.0",
"method":"user.delete",
"params":[
      {
         "userid":"107824"
      },
      {
         "userid":"107825"
      }
],
"auth":"3a57200802b24cda67c4e4010b50c065",
"id":2
}

Users deleted successfully:

{
"jsonrpc":"2.0",
"result":{
   "userids": ["107824", "107825"]
},
"id":2
}
User does not exist:

{
"jsonrpc":"2.0",
"error":{
      "code":-32500,
      "message":"Application error.",
      "data":"[ CUser::delete ] User does not exist"
},
"id":2
}