VMware Cloud Director API - OrgSettings
OrgSettingsType
- Element:
- OrgSettings
- Type:
- OrgSettingsType
- Namespace:
- http://www.vmware.com/vcloud/v1.5
- Description:
- Container for this organization's settings.
- Since:
- 0.9
- Schema:
- vCloudEntities.xsd
- Media type(s):
-
application/vnd.vmware.admin.orgSettings+xml
application/vnd.vmware.admin.orgSettings+json
- Extends:
- ResourceType
- XML Representation:
-
<OrgSettings xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<OrgGeneralSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<CanPublishCatalogs> xs:boolean </CanPublishCatalogs>
<CanPublishExternally> xs:boolean </CanPublishExternally>
<CanSubscribe> xs:boolean </CanSubscribe>
<DeployedVMQuota> xs:int </DeployedVMQuota>
<StoredVmQuota> xs:int </StoredVmQuota>
<UseServerBootSequence> xs:boolean </UseServerBootSequence>
<DelayAfterPowerOnSeconds> xs:int </DelayAfterPowerOnSeconds>
<VdcQuota> xs:int </VdcQuota>
<VmDiscoveryEnabled> xs:boolean </VmDiscoveryEnabled>
</OrgGeneralSettings>
<VAppLeaseSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<DeleteOnStorageLeaseExpiration> xs:boolean </DeleteOnStorageLeaseExpiration>
<DeploymentLeaseSeconds> xs:int </DeploymentLeaseSeconds>
<StorageLeaseSeconds> xs:int </StorageLeaseSeconds>
<PowerOffOnRuntimeLeaseExpiration> xs:boolean </PowerOffOnRuntimeLeaseExpiration>
</VAppLeaseSettings>
<VAppTemplateLeaseSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<DeleteOnStorageLeaseExpiration> xs:boolean </DeleteOnStorageLeaseExpiration>
<StorageLeaseSeconds> xs:int </StorageLeaseSeconds>
</VAppTemplateLeaseSettings>
<OrgLdapSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<OrgLdapMode> xs:string </OrgLdapMode>
<CustomUsersOu> xs:string </CustomUsersOu>
<CustomOrgLdapSettings>
<HostName> xs:string </HostName>
<Port> xs:int </Port>
<IsSsl> xs:boolean </IsSsl>
<CustomTruststore> xs:string </CustomTruststore>
<Realm> xs:string </Realm>
<SearchBase> xs:string </SearchBase>
<UserName> xs:string </UserName>
<Password> xs:string </Password>
<AuthenticationMechanism> xs:string </AuthenticationMechanism>
<GroupSearchBase> xs:string </GroupSearchBase>
<IsGroupSearchBaseEnabled> xs:boolean </IsGroupSearchBaseEnabled>
<ConnectorType> xs:string </ConnectorType>
<UserAttributes>
<ObjectClass> xs:string </ObjectClass>
<ObjectIdentifier> xs:string </ObjectIdentifier>
<UserName> xs:string </UserName>
<Email> xs:string </Email>
<FullName> xs:string </FullName>
<GivenName> xs:string </GivenName>
<Surname> xs:string </Surname>
<Telephone> xs:string </Telephone>
<GroupMembershipIdentifier> xs:string </GroupMembershipIdentifier>
<GroupBackLinkIdentifier> xs:string </GroupBackLinkIdentifier>
</UserAttributes>
<GroupAttributes>
<ObjectClass> xs:string </ObjectClass>
<ObjectIdentifier> xs:string </ObjectIdentifier>
<GroupName> xs:string </GroupName>
<Membership> xs:string </Membership>
<MembershipIdentifier> xs:string </MembershipIdentifier>
<BackLinkIdentifier> xs:string </BackLinkIdentifier>
</GroupAttributes>
<CustomUiButtonLabel> xs:string </CustomUiButtonLabel>
</CustomOrgLdapSettings>
</OrgLdapSettings>
<OrgEmailSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<IsDefaultSmtpServer> xs:boolean </IsDefaultSmtpServer>
<IsDefaultOrgEmail> xs:boolean </IsDefaultOrgEmail>
<FromEmailAddress> xs:string </FromEmailAddress>
<DefaultSubjectPrefix> xs:string </DefaultSubjectPrefix>
<IsAlertEmailToAllAdmins> xs:boolean </IsAlertEmailToAllAdmins>
<AlertEmailTo> xs:string </AlertEmailTo>
<SmtpServerSettings>
<IsUseAuthentication> xs:boolean </IsUseAuthentication>
<Host> xs:string </Host>
<Port> xs:int </Port>
<Username> xs:string </Username>
<Password> xs:string </Password>
<SmtpSecureMode> SmtpSecureModeType </SmtpSecureMode>
<SslTrustStore> xs:string </SslTrustStore>
</SmtpServerSettings>
</OrgEmailSettings>
<OrgPasswordPolicySettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<AccountLockoutEnabled> xs:boolean </AccountLockoutEnabled>
<InvalidLoginsBeforeLockout> xs:int </InvalidLoginsBeforeLockout>
<AccountLockoutIntervalMinutes> xs:int </AccountLockoutIntervalMinutes>
</OrgPasswordPolicySettings>
<OrgOperationLimitsSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<ConsolesPerVmLimit> xs:int </ConsolesPerVmLimit>
<OperationsPerUser> xs:int </OperationsPerUser>
<OperationsPerOrg> xs:int </OperationsPerOrg>
<QueuedOperationsPerUser> xs:int </QueuedOperationsPerUser>
<QueuedOperationsPerOrg> xs:int </QueuedOperationsPerOrg>
</OrgOperationLimitsSettings>
<OrgFederationSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<SAMLMetadata> xs:string </SAMLMetadata>
<Enabled> xs:boolean </Enabled>
<CertificateExpiration> xs:dateTime </CertificateExpiration>
<SigningCertificateExpiration> xs:dateTime </SigningCertificateExpiration>
<EncryptionCertificateExpiration> xs:dateTime </EncryptionCertificateExpiration>
<SamlSPEntityId> xs:anyURI </SamlSPEntityId>
<SamlAttributeMapping href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<EmailAttributeName> xs:string </EmailAttributeName>
<UserNameAttributeName> xs:string </UserNameAttributeName>
<FirstNameAttributeName> xs:string </FirstNameAttributeName>
<SurnameAttributeName> xs:string </SurnameAttributeName>
<FullNameAttributeName> xs:string </FullNameAttributeName>
<GroupAttributeName> xs:string </GroupAttributeName>
<RoleAttributeName> xs:string </RoleAttributeName>
</SamlAttributeMapping>
<SigningCertLibraryItemId> xs:string </SigningCertLibraryItemId>
<EncryptionCertLibraryItemId> xs:string </EncryptionCertLibraryItemId>
<CustomUiButtonLabel> xs:string </CustomUiButtonLabel>
</OrgFederationSettings>
<OrgOAuthSettings href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<OrgRedirectUri> xs:string </OrgRedirectUri>
<IssuerId> xs:string </IssuerId>
<OAuthKeyConfigurations href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<OAuthKeyConfiguration href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<KeyId> xs:string </KeyId>
<Algorithm> xs:string </Algorithm>
<Key> xs:string </Key>
<ExpirationDate> xs:dateTime </ExpirationDate>
</OAuthKeyConfiguration>
</OAuthKeyConfigurations>
<Enabled> xs:boolean </Enabled>
<ClientId> xs:string </ClientId>
<ClientSecret> xs:string </ClientSecret>
<UserAuthorizationEndpoint> xs:anyURI </UserAuthorizationEndpoint>
<AccessTokenEndpoint> xs:anyURI </AccessTokenEndpoint>
<UserInfoEndpoint> xs:anyURI </UserInfoEndpoint>
<ScimEndpoint> xs:anyURI </ScimEndpoint>
<Scope> xs:string </Scope>
<OIDCAttributeMapping href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<SubjectAttributeName> xs:string </SubjectAttributeName>
<EmailAttributeName> xs:string </EmailAttributeName>
<FullNameAttributeName> xs:string </FullNameAttributeName>
<FirstNameAttributeName> xs:string </FirstNameAttributeName>
<LastNameAttributeName> xs:string </LastNameAttributeName>
<GroupsAttributeName> xs:string </GroupsAttributeName>
<RolesAttributeName> xs:string </RolesAttributeName>
</OIDCAttributeMapping>
<MaxClockSkew> xs:int </MaxClockSkew>
<JwksUri> xs:anyURI </JwksUri>
<AutoRefreshKey> xs:boolean </AutoRefreshKey>
<KeyRefreshStrategy> xs:string </KeyRefreshStrategy>
<KeyRefreshFrequencyInHours> OrgOAuthSettingsType/KeyRefreshFrequencyInHours </KeyRefreshFrequencyInHours>
<KeyExpireDurationInHours> OrgOAuthSettingsType/KeyExpireDurationInHours </KeyExpireDurationInHours>
<WellKnownEndpoint> xs:anyURI </WellKnownEndpoint>
<LastKeyRefreshAttempt> xs:dateTime </LastKeyRefreshAttempt>
<LastKeySuccessfulRefresh> xs:dateTime </LastKeySuccessfulRefresh>
<EnableIdTokenClaims> xs:boolean </EnableIdTokenClaims>
<UsePKCE> xs:boolean </UsePKCE>
<SendClientCredentialsAsAuthorizationHeader> xs:boolean </SendClientCredentialsAsAuthorizationHeader>
<CustomUiButtonLabel> xs:string </CustomUiButtonLabel>
</OrgOAuthSettings>
</OrgSettings>
-
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. -
Elements
-
Element Type Required Modifiable Since Deprecated Description Link LinkType No none 0.9 A reference to an entity or operation associated with this object. OrgEmailSettings OrgEmailSettingsType No always 0.9 Represents the email settings for this organization. OrgFederationSettings OrgFederationSettingsType No always 5.1 Represents federated identity settings for this organization. OrgGeneralSettings OrgGeneralSettingsType No always 0.9 Represents general settings for this organization. OrgLdapSettings OrgLdapSettingsType No always 0.9 Represents the hostname and connection details for this organization's primary LDAP service. OrgOAuthSettings OrgOAuthSettingsType No always 9.0 Contains OAuth identity provider settings for this organization. OrgOperationLimitsSettings OrgOperationLimitsSettingsType No 5.1 Represents operation limits settings for this organization. OrgPasswordPolicySettings OrgPasswordPolicySettingsType No always 0.9 Represents the password policy settings for this organization. VAppLeaseSettings OrgLeaseSettingsType No always 0.9 Represents default lease durations and related policies for this organization. Runtime lease default is 7 days. Storage lease default is 30 days. VAppTemplateLeaseSettings OrgVAppTemplateLeaseSettingsType No always 1.5 Represents default vAppTemplate lease policies for this organization. Storage lease default is 30 days. 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 read GET /admin/org/{id}/settings Retrieve settings for this organization. update PUT /admin/org/{id}/settings Updates settings for this organization. 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/oauth/openIdProviderConfig Reads an OpenID configuring from a well-known endpoint and responds with the raw information from the IDP as well as VCD's interpretation of that information. 36.0