Delete User
DELETE {{URL}}/v1/users/{{UserUsername}}
Use the following API call to delete a user account, where username is the name of the user account you want to delete. The Bearer token is the token belonging to the admin account.
If an account is compromised or if there are any other reasons to delete it, the
admin
must delete the account. After you successfully delete an account, all the tokens associated with the account are removed from the system.
The
admin
account cannot be removed from the system.
If successful, the user account is deleted. The response includes the HTTP status code 200 OK and the payload displayed in the example response.
If not successful, the response may contain one of the following HTTP status codes:
HTTP Status Code | Reason |
---|---|
400
|
Invalid username,
admin
.
|
401
| Unable to validate the credentials. |
403
|
Not using the
admin
account.
|
404
| A user account with the username submitted in the request was not found. |
500
| Unknown reason |
If there are other errors in the response, refer to the following sources for more information: Error Codes and HTTP Status Codes .
HEADERS
| Key | Datatype | Required | Description |
| Content-Type
| string | | |
| Authorization
| string | | |
RESPONSES
status: OK
{"users":[{"username":"username"}],"meta":{"api_status":"stable","version":"v2.45.1"}}