Get Session
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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
URLURL
https://{api_host}/rest/com/vmware/cis/session
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required basic authentication header. Takes in a Base64 encoded value of your username:password |
Response
Response
Response BodyResponse Body
200 OK returns
SessionGetResponseBody
of type application/json
Information about the session.
{
"value": {
"created_time": "string",
"last_accessed_time": "string",
"user": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| value | SessionInfo |
Information about the session. |
cURL Command
curl -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" https://{api_host}/rest/com/vmware/cis/session
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : if the session id is missing from the request or the corresponding session object cannot be found. |
| 503 | ErrorRest | 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. |
| default | ErrorRest | Not available |
