This API has a deprecated equivalent from v7.0U1.
Get Session
Returns information about the current session. This operation expects a valid session token 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}/api/session
Header Parameters
Header Parameters
string
Authorization
Required
Required basic authentication header. Takes in a Base64 encoded value of your username:password
Authorization example
"Basic dXNlcm5hbWU6cGFzc3dvcmQ="
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SessionInfo
of type application/json
Information about the session.
{
"created_time": "string",
"last_accessed_time": "string",
"user": "string"
}
string
created_time
Required
Time when the session was created.
string
last_accessed_time
Required
Last time this session was used by passing the session token for invoking an API.
string
user
Required
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.
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the session id is missing from the request or the corresponding session object cannot be found.
503
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
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetSession
cURL Command
curl -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" https://{api_host}/api/session
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/session
x-vmw-doc-operation: get
Availability
Added in 7.0U2
