VMware Cloud Director API - Group

GroupType

Element:

Group

Type:

GroupType

Namespace:

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

Description:

Represents a group in this organization.

Since:

0.9

Schema:

user.xsd

Media type(s):

application/vnd.vmware.admin.group+json
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" 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>
    <NameInSource> xs:string </NameInSource>
    <UsersList>
        <UserReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </UsersList>
    <ProviderType> xs:string </ProviderType>
    <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	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	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.
NameInSource	string	No	always	0.9	Group name as retrieved from, and in the encoding used by, the specified identity provider.
ProviderType	string	No	always	5.1	Identity provider type for this group. One of: INTEGRATED (The group is imported from LDAP.) SAML (The group is imported from a SAML identity provider.) OAUTH (The group is imported from an OAUTH identity provider.) If missing or empty the default value is INTEGRATED.
Role	ReferenceType	No	always	0.9	The default role for users in this group.
Tasks	TasksInProgressType	No	none	0.9	A list of queued, running, or recently completed tasks associated with this entity.
UsersList	UsersListType	No	none	0.9	Container for references to users in the group.
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
create	POST /admin/org/{id}/groups	Import a group from the LDAP directory service.	0.9
read	GET /admin/group/{id}	Retrieve a group.	0.9
update	PUT /admin/group/{id}	Update the name or description of a group.	0.9
delete	DELETE /admin/group/{id}	Deletes a group.	0.9