Organization settings define organization policies such as default lease settings for vApps and how incorrect login attempts are handled. They also configure how the organization uses services such as email and LDAP, and define the organization's federated identity provider if it uses one.

An AdminOrg element contains an OrgSettings element, which contains the following elements, each of which represents a group of related organization settings. Default settings are inherited from the containing cloud.

GeneralOrgSettings

Specifies quotas for stored and deployed virtual machines owned by members of this organization. Specifies default behaviors for virtual machines in the organization, and controls the ability to publish catalogs.

VAppLeaseSettings

Controls storage and deployment leases for vApps.

VAppTemplateLeaseSettings

Controls storage and deployment leases for vApp templates.

OrgLdapSettings

Defines whether this organization is connected to an LDAP service, and whether it uses the service defined in the system LdapSettings or a custom LDAP service defined here.

OrgEmailSettings

Defines whether this organization uses the email service defined in the system EmailSettings or a custom email service defined here.

OrgPasswordPolicySettings

Specifies policies to be followed when a user in this organization enters an incorrect password. Initial values are inherited from the system PasswordPolicySettings.

OrgOperationLimitsSettings

Specifies limits to be placed on simultaneous resource-intensive operations and console sessions for members of this organization.

OrgGuestPersonalizationSettings

Default values for GuestCustomizationSection elements in virtual machines created by this organization. See Retrieve or Modify the GuestCustomizationSection of a Virtual Machine

OrgFederationSettings

Defines the SAML identity provider used by this organization. An organization can define a SAML identity provider that it shares with other applications or enterprises. Users that authenticate to the identity provider obtain a token that they can then use to log in to the organization. Such a strategy can enable an enterprise to provide access to multiple, unrelated services, including vCloud Director with a single set of credentials, an arrangement often referred to as "single sign-on." An organization that wants to participate in a federated identity scheme must include an OrgFederationSettings element that contains SAML metadata retrieved from the federation's identity provider. By default, this element is empty.

Note

To update or remove OrgFederationSettings after a SAML identity provider has been specified, you must include an empty SAMLMetadata element in the update request. If this element is not present in the update request, the OrgFederationSettings are not changed.

Verify that you are logged in to the vCloud API as an organization administrator or system administrator.

1

Retrieve the list of organization settings elements.

Use a request like this one:

GET https://vcloud.example.com/api/admin/org/26/settings

The response is an OrgSettings element.

2

Examine the OrgSettings element to find the links to the sections to view or modify.

Each section is represented in the OrgSettings element with a link where rel="down". You can use that link to retrieve the section. The retrieved section includes a link where rel="edit". You can use that link as the target of a PUT request that modifies the settings that the element represents. The OrgSettings element itself also has a rel="edit" link, which you can use to update multiple settings sections in one request.

3

Retrieve the settings element to modify.

Make a GET request to the URL in the element's href attribute value.

4

Modify the retrieved settings element.

Modified sections must contain all required elements, even if you are not changing their values. Because optional elements revert to default values if they are omitted or empty, it is a best practice to include optional elements in updates. Link elements and href attributes from responses do not need to be included in modified sections. Some elements and attributes might be read-only. See the schema reference for details.

5

Update the settings with your modifications.

Find the Link element in the settings element where rel="edit". Make a PUT request to the URL in that link's href attribute value, and supply the modified section as the request body. See the request portion of Example: Update Organization General Settings.

This example updates the GeneralOrgSettings of the organization created in Example: Create an Organization. The update changes the limits on deployed and stored virtual machines. The request includes all members of the GeneralOrgSettings element, even those that are not changing. It is a best practice to include all members of the GeneralOrgSettings element in an update request. Optional elements that are missing or empty in the request are reset to their default values.

Request:

PUT https://vcloud.example.com/api/admin/org/26/settings/general
Content-Type: application/vnd.vmware.admin.organizationGeneralSettings+xml
...
<?xml version="1.0" encoding="UTF-8"?>
<GeneralOrgSettings
   type="application/vnd.vmware.admin.organizationGeneralSettings+xml">
   <CanPublishCatalogs>false</CanPublishCatalogs>
   <DeployedVMQuota>10</DeployedVMQuota>
   <StoredVmQuota>100</StoredVmQuota>
   <UseServerBootSequence>false</UseServerBootSequence>
   <DelayAfterPowerOnSeconds>0</DelayAfterPowerOnSeconds>
</GeneralOrgSettings>

The response contains information extracted from the request, and includes a rel="edit" link and other attributes that the server creates.

Response:

200 OK
Content-Type: application/vnd.vmware.admin.organizationGeneralSettings+xml
...
<GeneralOrgSettings
   type="application/vnd.vmware.admin.organizationGeneralSettings+xml"
   href="https://vcloud.example.com/api/admin/org/26/settings/general">
   <Link
      rel="edit"
      type="application/vnd.vmware.admin.organizationGeneralSettings+xml"
      href="https://vcloud.example.com/api/admin/org/26/settings/general" />
   <CanPublishCatalogs>false</CanPublishCatalogs>
   <DeployedVMQuota>10</DeployedVMQuota>
   <StoredVmQuota>100</StoredVmQuota>
   <UseServerBootSequence>false</UseServerBootSequence>
   <DelayAfterPowerOnSeconds>0</DelayAfterPowerOnSeconds>
</GeneralOrgSettings>