You can delete a user from the Analyzer detail view. You cannot delete the default administrator user (admin user).
Request line
POST baseURL/userapi.do?action=deleteUser
Request payload is a JSON object.
Request body
{
"username":""
}
Request example
POST /userapi.do?action=deleteUser x-authorization:<license authentication key>
{
"username":"john.s"
}
Request parameters
| Parameter | Type | Description |
|---|---|---|
| username | String | User name of the user to be deleted. Up to 20 characters except <,>,[,] |
Response body
{
"deleted":""
}
Response example
{
"deleted":"john.s"
}
Status codes
|
Status code |
Message |
Description |
|---|---|---|
| 400 | BAD REQUEST | Request URL or request body validation failed. Check the response body for details. |
| 401 | UNAUTHORIZED | Supplied authentication token is invalid or does not have the appropriate credentials to access the resource. |
| 404 | NOT FOUND | API server could not find a resource matching the request. |
| 405 | METHOD NOT ALLOWED | Request HTTP method is not allowed for the operation. |
Response codes
The following table lists the common API response codes that might be generated through the standard API. If an error response is not listed, examine the HTTP status codes to determine the best method for addressing the issue.
| Response code | Message | Condition |
|---|---|---|
| C40100E0 | HTTP method [GET] is not supported for action [deleteUser] | HTTP method is not POST. |
| C4010001 | Authorization failed. | Request is sent with an invalid authentication token. |
| C4010002 | Invalid JSON Request. | Specified JSON input is invalid. |
| C4010003 | Mandatory parameter {username} is not specified. | Username is not specified in the parameter {username}. |
| C4010004 | Invalid value specified for parameter {username}. | Specified username is invalid. |
| C4040006 | User name that is specified in the parameter {username} does not exist. | Specified username does not exist. |