VMware Cloud Director API - CustomOrgLdapSettingsType

VMware Cloud Director API - CustomOrgLdapSettingsType

CustomOrgLdapSettingsType

Type:
CustomOrgLdapSettingsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents connection details for an organization's LDAP service.
Since:
0.9
Schema:
vCloudEntities.xsd
Media type(s):
None
Extends:
VCloudExtensibleType
XML Representation:
<CustomOrgLdapSettingsType xmlns="http://www.vmware.com/vcloud/v1.5">
    <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>
</CustomOrgLdapSettingsType>

Elements

Element Type Required Modifiable Since Deprecated Description
AuthenticationMechanism string Yes always 0.9 One of:
SIMPLE (Simple authentication as specified in RFC 2251 and RFC 2829.)
MD5DIGEST (Digest MD5 authentication as specified in RFC 2831.)
NTLM (Windows NTLM authentication.)
Kerberos support has been removed.
ConnectorType string Yes always 0.9 Defines LDAP service implementation type. One of:
ACTIVE_DIRECTORY (LDAP service provided by Microsoft Active Directory.)
OPEN_LDAP (LDAP service provided by Open LDAP).
CustomTruststore string No always 31.0 34.0 Optional Custom Truststore for the LDAP HostName. Until it is removed the certificate can still be set here, however this field will always be null on return. This field is under accelerated deprecation and will be removed more quickly than the normal deprecation cycle. In order to manage LDAP certificates, please instead use the Centralized SSL management API.
CustomUiButtonLabel string No always 38.1 Custom label to use when displaying this LDAP configuration on the VCD login pane. If null, a default label will be used.
GroupAttributes OrgLdapGroupAttributesType Yes always 0.9 Defines how LDAP attributes are used when importing a group.
GroupSearchBase string No always 0.9 LDAP group search base.
HostName string No always 0.9 Hostname of the LDAP server.
IsGroupSearchBaseEnabled boolean Yes always 0.9 True if the group search base is enabled.
IsSsl boolean No always 0.9 True if the LDAP service requires an SSL connection.
Password string No always 0.9 Password for the user identified by UserName. This value is never returned by GET. It is inspected on create and modify. On modify, the absence of this element indicates that the password should not be changed.
Port int Yes always 0.9 Port at which to connect to the LDAP service.
Realm string No always 0.9 LDAP realm to use when looking up users.
SearchBase string No always 0.9 LDAP search base.
UserAttributes OrgLdapUserAttributesType Yes always 0.9 Defines how LDAP attributes are used when importing a user.
UserName string No always 0.9 Username to use when logging in to LDAP, specified using LDAP attribute=value pairs (for example: cn="ldap-admin", c="example", dc="com").
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.