DELETE /sessions/<UUID>

Use the DELETE method to disconnect (log off) another active user session from Lenovo XClarity Administrator.

Note: This API requires Lenovo XClarity Administrator v1.2.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

DELETE https://<management_server_IP>/sessions/<UUID>

where <UUID> is the ID of the user to be logged off. To obtain the user ID, use the GET /sessions method.

Query parameters

None.

Response codes

Code Description
200 OK. The request completed successfully.
400 Bad request. An argument is missing or not valid. a descriptive error message will be returned in the body.
404 Not found. The server could not find the specified user UUID.
500 Internal server error. A descriptive error message will be returned in the body.

Response body

Attributes Type Description
result String Results 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.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
    "result": "success",
    "messages": [{
        "explanation": "",
        "id": "FQXHMSE0001I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request completed successfully."
    }]
}