VMware Cloud Director API - AuthorizedLocation

VMware Cloud Director API - AuthorizedLocation

AuthorizedLocationType

Element:
AuthorizedLocation
Type:
AuthorizedLocationType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents a vCloud Director server group that this session is authorized to access.
Since:
29.0
Schema:
multiSite.xsd
Media type(s):
None
Extends:
EntityType
XML Representation:
<AuthorizedLocation xmlns="http://www.vmware.com/vcloud/v1.5" 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>
</AuthorizedLocation>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 29.0 The URI of the entity.
type string No always 29.0 The MIME type of the entity.
id string No none 29.0 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 29.0 The name of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
ApiVersion string No 33.0 Highest API version supported by this location.
AuthContext string No 30.0 The auth context for this org
Description string No always 29.0 Optional description.
Link LinkType No none 29.0 A reference to an entity or operation associated with this object.
LocationId string No 30.0 The id of the location. format: orgId@siteId
LocationName string No create 29.0 30.0 The name of the location.
OrgName string No create 30.0 The name of the organization.
RestApiEndpoint anyURI Yes always 29.0 The vCloud API endpoint (RestApiBaseUri) for the location.
SiteName string No create 30.0 The name of the site.
Tasks TasksInProgressType No none 29.0 A list of queued, running, or recently completed tasks associated with this entity.
UIEndpoint anyURI No always 29.0 The vCloud Director Web Console (SystemExternalHttpAddress) endpoint for the location.
UseMultisiteToken boolean No always 29.0 30.0 True if the location accepts multisite x-vcloud-authorization token for this user.
VCloudExtension VCloudExtensionType No always 29.0 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.