VMware Cloud Director API - Session

SessionType

Element:

Session

Type:

SessionType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents a vCloud Session.

Since:

1.5

Deprecated:

33.0

Schema:

session.xsd

Media type(s):

application/vnd.vmware.vcloud.session+json
application/vnd.vmware.vcloud.session+xml

Extends:

ResourceType

XML Representation:

<Session xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" user="xs:string" org="xs:string"
        userId="xs:string" roles="xs:string" locationId="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <AuthorizedLocations>
        <Location href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks>
                <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                        name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                        serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                        cancelRequested="xs:boolean">
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string" model="xs:string"/>
                    <Description> xs:string </Description>
                    <Tasks> TasksInProgressType </Tasks>
                    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                            vendorSpecificErrorCode="xs:string">
                        <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
                    </Error>
                    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Progress> xs:int </Progress>
                    <Params> ... </Params>
                    <Details> xs:string </Details>
                    <VcTaskList>
                        <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                                errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                                virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
                    </VcTaskList>
                    <Result>
                        <ResultContent> ... </ResultContent>
                        <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    </Result>
                </Task>
            </Tasks>
            <LocationId> xs:string </LocationId>
            <LocationName> xs:string </LocationName>
            <SiteName> xs:string </SiteName>
            <OrgName> xs:string </OrgName>
            <RestApiEndpoint> xs:anyURI </RestApiEndpoint>
            <UIEndpoint> xs:anyURI </UIEndpoint>
            <UseMultisiteToken> xs:boolean </UseMultisiteToken>
            <AuthContext> xs:string </AuthContext>
            <ApiVersion> xs:string </ApiVersion>
        </Location>
    </AuthorizedLocations>
</Session>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.5	The URI of the entity.
type	string	No	always	1.5	The MIME type of the entity.
user	string	No	none	1.5	The name of the user that owns the session
org	string	No	none	1.5	The name of the user's organization
userId	string	No	none	5.5	The URN of the user entity
roles	string	No	none	5.7	Role assigned to this user during this session.
locationId	string	No	none	30.0	Location id of the logged in org

Elements

Element	Type	Required	Modifiable	Since	Description
AuthorizedLocations	AuthorizedLocationsType	No	none	29.0	The locations, both local and remote, that can be accessed by this user in this session.
Link	LinkType	No	none	1.5	A reference to an entity or operation associated with this object.
VCloudExtension	VCloudExtensionType	No	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /session	Retrieve a representation of the current session.	1.5	33.0
as output	POST /sessions	Log in and create a Session object.	1.5	33.0