VMware Cloud Director API - Role

VMware Cloud Director API - Role

RoleType

Element:
Role
Type:
RoleType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
A named collection of rights.
Since:
0.9
Deprecated:
33.0
Schema:
user.xsd
Media type(s):
application/vnd.vmware.admin.role+xml
application/vnd.vmware.admin.role+json
Extends:
EntityType
XML Representation:
<Role 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>
    <RightReferences>
        <RightReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </RightReferences>
</Role>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 0.9 The URI of the entity.
type string No always 0.9 The MIME type of the entity.
id string No none 0.9 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 0.9 The name of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
Description string No always 0.9 Optional description.
Link LinkType No none 0.9 A reference to an entity or operation associated with this object.
RightReferences RightReferencesType No always 0.9 Container for references to the rights assigned to this role.
Tasks TasksInProgressType No none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension VCloudExtensionType No always 0.9 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
create POST /admin/org/{orgId}/roles Creates a role or optionally creates a role template along with role instances based on the template for a sys-admin client at API version < 27 0.9 33.0
create POST /admin/roles Creates a role or optionally creates a role template along with role instances based on the template for a sys-admin client at API version < 27 0.9 33.0
read GET /admin/org/{orgId}/role/{id} Retrieve a role. 0.9 33.0
read GET /admin/role/{id} Retrieve a role. 0.9 33.0
update PUT /admin/org/{orgId}/role/{id} Update a role. 0.9 33.0
update PUT /admin/role/{id} Update a role. 0.9 33.0
delete DELETE /admin/org/{orgId}/role/{id} Delete a role. 0.9 33.0
delete DELETE /admin/role/{id} Delete a role. 0.9 33.0