REST API - get

cis session: get

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:

HTTP request

POST https://{server}/rest/com/vmware/cis/session?~action=get

No request parameters

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "created_time": "2015-01-01T22:13:05.651Z",
        "last_accessed_time": "2015-01-01T22:13:05.651Z",
        "user": "string"
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Information about the session.
value.user	string	Fully qualified name of the end user that created the session, for example Administrator@vsphere.local. A typical use case for this information is in Graphical User Interfaces (GUI) or logging systems to visualize the identity of the current user.
value.created_time	date_time	Time when the session was created.
value.last_accessed_time	date_time	Last time this session was used by passing the session key for invoking an API.

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	if the session id is missing from the request or the corresponding session object cannot be found.
503	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.