Skip to content

User Delete

To delete a user, call the URI http(s)://<qie_server>:<management_api_port>/user/delete with the following payload:

{
   "userId": "<desired user id>",
   "formatOutput": true | false
}

Base JSON Payload Definition

Node Description
userId REQUIRED: The user id of the user to delete. Deleting the default 'admin' user or the management API user used to make this request is not allowed.
formatOutput True if the response JSON should be formatted as human readable (default=false).

The following response is received if the user was found and successfully deleted:

HTTP Status: 200

{
   "message": "<response_message>"
}
Node Description
message This message indicates whether the user was deleted.

If there is an error finding the user or deleting the user, then the following response is received:

HTTP Status: 400

{
   "error": "<error message>"
}

Example curl command:

curl -H "apiToken:abc123" --request POST http://qieserver:9999/user/delete -d '{"userid":"myUserid"}'

curl -H "apiToken:abc123" --request POST http://qieserver:9999/user/delete -d "{\"userid\":\"myUserid\"}"

curl -H @{"apiToken"="abc123"} -Method POST http://qieserver:9999/user/delete -Body '{"userid":"myUserid"}' | Select-Object -Expand RawContent