DELETE/admins/{username}

Delete an administrator

Deletes an existing administrator account identified by its username. Use this operation when you need to remove an administrator; the username must identify the account to delete.

1 parameter
usernamestringrequired
The username of the administrator to delete.

7 status codes
200Returns an object containing an `error` description, if any, and a `message`, which can be empty.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
400Returned when the request is invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Returned when authentication is missing or invalid.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Returned when the authenticated user is not permitted to delete the administrator.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Returned when the specified administrator cannot be found.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Returned when an internal server error occurs.
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 400 is returned for an invalid request. A 401 indicates that authentication is missing or invalid, and a 403 indicates that the authenticated user is not permitted to delete the administrator. A 404 is returned when the administrator cannot be found, and a 500 indicates a server error; the username path parameter must identify the administrator to delete.