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. | |
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 this group.
One of: INTEGRATED (The group is imported from LDAP.) SAML (The group is imported from a SAML 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 | Deprecated |
---|---|---|---|---|
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 |