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 tempalte for a sys-admin client at API version < 27 | 0.9 | |
create | POST /admin/roles | Creates a role or optionally creates a role template along with role instances based on the tempalte for a sys-admin client at API version < 27 | 0.9 | |
read | GET /admin/org/{orgId}/role/{id} | Retrieve a role. | 0.9 | |
read | GET /admin/role/{id} | Retrieve a role. | 0.9 | |
update | PUT /admin/org/{orgId}/role/{id} | Update a role. | 0.9 | |
update | PUT /admin/role/{id} | Update a role. | 0.9 | |
delete | DELETE /admin/org/{orgId}/role/{id} | Delete a role. | 0.9 | |
delete | DELETE /admin/role/{id} | Delete a role. | 0.9 |