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 |
---|---|---|---|---|---|---|
Catalogs | CatalogsListType | No | none | 0.9 | Container for references to catalogs in this organization. | |
Description | string | No | always | 0.9 | Optional description. | |
FullName | string | Yes | always | 0.9 | Full name of the organization. | |
Groups | GroupsListType | No | none | 0.9 | Container for references to groups in this organization. | |
IsEnabled | boolean | No | none | 0.9 | True if this organization is enabled (allows login and all other operations). Read-only in the user view. Modifiable in the admin view (AdminOrg element). | |
Link | LinkType | No | none | 0.9 | A reference to an entity or operation associated with this object. | |
Networks | NetworksType | No | none | 0.9 | Container for references to organization vDC networks in this organization. | |
OrgAssociations | OrgAssociationsType | No | always | 29.0 | Container for the references to other organizations whose content will be listed with this organization. | |
RightReferences | OrganizationRightsType | No | none | 27.0 | A container for references to Right objects in the organization. | |
RoleReferences | OrganizationRolesType | No | none | 27.0 | A container for references to Role objects in the organization. | |
RoleTemplateReferences | RoleReferencesType | No | none | 27.0 | A container for references to Role objects in the organization. | |
Settings | OrgSettingsType | Yes | always | 0.9 | Settings for this organization. Establishes quotas, limits, and policies. Specifies how the organization connects to LDAP and email services. | |
Tasks | TasksInProgressType | No | none | 0.9 | A list of queued, running, or recently completed tasks associated with this entity. | |
Users | UsersListType | No | none | 0.9 | Container for references to users in this organization. | |
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. | |
VdcTemplates | VdcTemplatesType | No | none | 0.9 | Container for references to VDC templates in this organization. | |
Vdcs | VdcsType | No | none | 0.9 | Container for references to vDCs in this organization. |
Operations
CRUD | Operation | Description | Since | Deprecated |
---|---|---|---|---|
create | POST /admin/orgs | Create an organization. | 0.9 | |
read | GET /admin/org/{id} | Retrieve an administrative view of an organization. | 0.9 | |
update | PUT /admin/org/{id} | Update an organization. | 0.9 | |
delete | DELETE /admin/org/{id} | Delete an organization. | 0.9 | |
action | POST /admin/org/{id}/action/disable | Disable an organization. | 1.0 | |
action | POST /admin/org/{id}/action/enable | Enable an organization. | 1.0 | |
action | POST /admin/org/{id}/events | Post an external event to the system. | 5.1 | |
action | POST /admin/org/{id}/networks | Create an organization network. | 0.9 | |
action | POST /admin/org/{id}/settings/federation/action/regenerateFederationCertificate | Regenerates the certificates used to establish trust between an organization and its identity provider | 5.6 | |
action | POST /admin/org/{id}/settings/ldap/action/resetLdapCertificate | Resets organization LDAP SSL certificate. | 5.1 | |
action | POST /admin/org/{id}/settings/ldap/action/resetLdapKeyStore | Resets organization LDAP keystore. | 5.1 | |
action | POST /admin/org/{id}/settings/ldap/action/resetLdapSspiKeytab | Resets organization LDAP SSPI keytab. | 5.1 | |
action | POST /admin/org/{id}/settings/ldap/action/updateLdapCertificate | Updates organization LDAP SSL certificate. | 5.1 | |
action | POST /admin/org/{id}/settings/ldap/action/updateLdapKeyStore | Updates organization LDAP keystore. | 5.1 | |
action | POST /admin/org/{id}/settings/ldap/action/updateLdapSspiKeytab | Updates organization LDAP SSPI keytab. | 5.1 |