Get Session
This request returns the session that is currently authenticated.
Request
URI
GET
https://{api_host}/sessions
COPY
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Responses
200
OK
Returns OnpremSessionDetails of type(s) application/json;charset=UTF-8
This response body class contains all of the following: SessionDetails
{
"user": "System",
"roles": [
"EVERYONE",
"ADMINISTRATORS",
"VRADMINISTRATORS"
],
"authenticatedSites": null
}
401
The returned error codes include (but are not limited to): NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
500
The returned error codes include (but are not limited to): GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.