Get Session

Get Session

Returns the specified session for current user

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/sessions/{id:((?!provider|current).)+}
COPY
Path Parameters
string
id
Required

id

string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Session of type(s) application/json;version=39.0 
{
    "id": "urn:vcloud:session:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "site": {
        "name": "string",
        "id": "string"
    },
    "user": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "operatingOrg": {
        "name": "string",
        "id": "string"
    },
    "location": "string",
    "roles": [
        "string"
    ],
    "roleRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "sessionIdleTimeoutMinutes": 0
}
string
id
Optional

ID of session

EntityReference
site
Optional

Entity reference used to describe VCD entities

EntityReference
user
Optional

Entity reference used to describe VCD entities

EntityReference
org
Optional

Entity reference used to describe VCD entities

EntityReference
operatingOrg
Optional

Entity reference used to describe VCD entities

string
location
Optional

The accessible location this session is valid for

array of string
roles
Optional

User's roles for this session

array of EntityReference
roleRefs
Optional

References to user's roles

integer
sessionIdleTimeoutMinutes
Optional

The session idle timeout in minutes


Availability
Added in 33.0
On This Page
Sessions Operations
GET
Get Accessible Locations
GET
Get Current Session
GET
Get Current Sessions
GET
Get Session
GET
Get Token
POST
Login
DELETE
Logout
DELETE
Logout Current Session
POST
Provider Login