Skip to main content

GET /sessions

Use this method to return information about current sessions with Lenovo XClarity Administrator.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/sessions

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.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
responseArray of objectsInformation about each user session
 AddressBooleanIP address of the server from which the user is connected
 authenticationServerStringIP address of the authentication server
 createdStringDate and time when the user logged in and the session was started
 idStringSession ID
 idleForStringAmount of time, in seconds, that the session has not had activity
 isOwnSessionBooleanThis can be one of the following values.
  • true
  • false
 lastAccessedStringDate and time when the user performed the last action
 UserIdStringUser ID
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failure. The request failed. A descriptive error message was returned.
messagesArrayInformation about one or more messages
 explanationStringAdditional information to clarify the reason for the message
 idStringThe message identifier of a returned message
 recoveryArrayRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
 textStringMessage text associated with the message identifier
The following example is returned if the request is successful.
{
   "result": "success",
   "response": [{
      "Address": "10.38.99.166",
      "authenticationServer": "127.0.0.1",
      "created": "2019-01-25T16:27:07Z",
      "id": "1vze81e09gmmk1tctgb9of8y39",
      "idleFor": "0",
      "isOwnSession": true,
      "lastAccessed": "2019-01-25T16:27:16Z",
      "UserId": "ADMIN",
   },
   {
      "Address": "10.38.111.145",
      "authenticationServer": "127.0.0.1",
      "created": "2016-05-04T20:02:44Z",
      "id": "1xarpu7b3ksk23hj89jxo9y12",
      "idleFor": "50",
      "isOwnSession": true,
      "lastAccessed": "2016-05-07T20:02:52Z",
      "UserId": "JOE"
  }],
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "explanation": ""
   }]
}