Developer Documentation
Get Session
Returns information about the current session. This operation expects a valid session identifier to be supplied. A side effect of invoking this operation may be a change to the session’s last accessed time to the current time if this is supported by the session implementation. Invoking any other operation in the API will also update the session’s last accessed time.
This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.
Request
Operation doesn't accept any path, query or header parameters.
URL
https://{api_host}/rest/com/vmware/cis/session
Response
Response
Response BodyResponse Body
200 OK returns
GetResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Information about the session.
{
"value": {
"created_time": "string",
"last_accessed_time": "string",
"user": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| value | SessionInfo |
Information about the session. |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the session id is missing from the request or the corresponding session object cannot be found. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes. |
