Group

Element:
Group
Type:
GroupType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents group in the system.
Since:
0.9
Schema:
user.xsd
Media type(s):
application/vnd.vmware.admin.group+xml
Extends:
EntityType
XML Representation:
<Group xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                endTime="xs:dateTime" expiryTime="xs:dateTime">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <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>
        </Task>
    </Tasks>
    <NameInSource> xs:string </NameInSource>
    <UsersList>
        <UserReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </UsersList>
    <Role href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Group>

Attributes

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

Elements

Element Type Occurrence Modifiable Since Description
VCloudExtension VCloudExtensionType 0..* always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 0.9 Optional link to an entity or operation associated with this object.
Description string 0..1 always 0.9 Optional description.
Tasks TasksInProgressType 0..1 none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
NameInSource string 0..1 always 0.9 Group name as retrieved from, and in the encoding used by, LDAP.
UsersList UsersListType 0..1 none 0.9 A list of references to users in the group.
Role ReferenceType 0..1 always 0.9 The role that the users in this group.

Operations

CRUD Operation Description Since
create POST /admin/org/{id}/groups Imports a group in an organization. 0.9
read GET /admin/group/{id} Retrieves a group. 0.9
update PUT /admin/group/{id} Modifies a group. 0.9
delete DELETE /admin/group/{id} Deletes a group. 0.9