VMware Cloud Director API - OrgLdapSettings

VMware Cloud Director API - OrgLdapSettings

OrgLdapSettingsType

Element:
OrgLdapSettings
Type:
OrgLdapSettingsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents LDAP connection settings for an organization.
Since:
1.5
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.organizationLdapSettings+json
application/vnd.vmware.admin.organizationLdapSettings+xml
Extends:
ResourceType
XML Representation:
<OrgLdapSettings 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"/>
    <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>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 1.5 The URI of the entity.
type string No always 1.5 The MIME type of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
CustomOrgLdapSettings CustomOrgLdapSettingsType No always 1.0 If OrgLdapMode is CUSTOM, this element defines the hostname and connection details for the organization's LDAP service.
CustomUsersOu string No always 1.0 If OrgLdapMode is SYSTEM, specifies an LDAP attribute=value pair to use for OU (organizational unit).
Link LinkType No none 1.5 A reference to an entity or operation associated with this object.
OrgLdapMode string No always 1.5 Defines whether this organization is connected to an LDAP service, and whether it uses the system default LDAP service or a custom LDAP service. One of:
NONE (This organization has no LDAP connection.)
SYSTEM (This organization uses the system default LDAP service.)
CUSTOM (This organization uses the LDAP service specified in CustomOrgLdapSettings.)
VCloudExtension VCloudExtensionType No always 1.5 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/ldap Retrieve organization LDAP settings. 1.5 5.1
update PUT /admin/org/{id}/settings/ldap Update organization LDAP settings. 1.5 5.1