Skip to main content

DELETE /userAccounts/{id}

Use this method to remove a specific user account from Lenovo XClarity Administrator.

Authentication​

Authentication with username and password is required.

Request URL​

DELETE https://{management_server_IP}/userAccounts/{id}

where {id} is the unique ID of the user to be removed. To obtain the user ID, use the GET /userAccounts method.

Query parameters​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
    "result": "success",
    "messages": [{
        "id": "FQXHMSE0270I",
        "text": "The request to delete the user ID TEST2 completed successfully.",
        "explanation": "The request to delete the user ID TEST2 was successful.",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        }
    }]
}