AdminOrgType

Element:
AdminOrg
Type:
AdminOrgType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents the admin view of an organization.
Since:
0.9
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.organization+xml
Extends:
OrgType
XML Representation:
<AdminOrg xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
        </Task>
    </Tasks>
    <FullName> xs:string </FullName>
    <IsEnabled> xs:boolean </IsEnabled>
    <Settings href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="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"/>
            <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>
        </OrgGeneralSettings>
        <VAppLeaseSettings href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <DeleteOnStorageLeaseExpiration> xs:boolean </DeleteOnStorageLeaseExpiration>
            <DeploymentLeaseSeconds> xs:int </DeploymentLeaseSeconds>
            <StorageLeaseSeconds> xs:int </StorageLeaseSeconds>
        </VAppLeaseSettings>
        <VAppTemplateLeaseSettings href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="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"/>
            <OrgLdapMode> xs:string </OrgLdapMode>
            <CustomUsersOu> xs:string </CustomUsersOu>
            <CustomOrgLdapSettings>
                <HostName> xs:string </HostName>
                <Port> xs:int </Port>
                <IsSsl> xs:boolean </IsSsl>
                <IsSslAcceptAll> xs:boolean </IsSslAcceptAll>
                <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>
                <UseExternalKerberos> xs:boolean </UseExternalKerberos>
            </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"/>
            <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>
            </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"/>
            <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"/>
            <ConsolesPerVmLimit> xs:int </ConsolesPerVmLimit>
            <OperationsPerUser> xs:int </OperationsPerUser>
            <OperationsPerOrg> xs:int </OperationsPerOrg>
        </OrgOperationLimitsSettings>
        <OrgFederationSettings href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <SAMLMetadata> xs:string </SAMLMetadata>
            <Enabled> xs:boolean </Enabled>
            <CertificateExpiration> xs:dateTime </CertificateExpiration>
        </OrgFederationSettings>
    </Settings>
    <Users>
        <UserReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Users>
    <Groups>
        <GroupReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Groups>
    <Catalogs>
        <CatalogReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Catalogs>
    <Vdcs>
        <Vdc href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Vdcs>
    <Networks>
        <Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Networks>
</AdminOrg>

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.
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.
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 network. 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