CustomOrgLdapSettingsType

Type:

CustomOrgLdapSettingsType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Used when OrgLdapMode=CUSTOM to define connection details for the 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>
    <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>
</CustomOrgLdapSettingsType>

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	0.9	An optional extension element that can contain an arbitrary number of elements and attributes.
HostName	string	1	always	0.9	Hostname of the LDAP server.
Port	int	1	always	0.9	Port at which to connect to the LDAP service.
IsSsl	boolean	0..1	always	0.9	True if the LDAP service requires an SSL connection.
IsSslAcceptAll	boolean	0..1	always	0.9	True if the LDAP service accepts all SSL certificates.
Realm	string	0..1	always	0.9	LDAP realm to use when looking up users.
SearchBase	string	0..1	always	0.9	LDAP search base.
UserName	string	0..1	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").
Password	string	0..1	always	0.9	On modify, the presence of this element indicates a change in the password, absence indicates that the password should remain the same. Never returned on a GET request. 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.
AuthenticationMechanism	string	1	always	0.9	One of: SIMPLE (Simple authentication as specified in RFC 2251 and RFC 2829.), KERBEROS (Kerberos authentication), MD5DIGEST (Digest MD5 authentication as specified in RFC 2831.), NTLM (Windows NTLM authentication.)
GroupSearchBase	string	0..1	always	0.9	LDAP group search base.
IsGroupSearchBaseEnabled	boolean	1	always	0.9	True if the group search base is enabled.
ConnectorType	string	1	always	0.9	Specifies LDAP service implementation type. One of: ACTIVE_DIRECTORY (LDAP service provided by Microsoft Active Directory.), OPEN_LDAP (LDAP service provided by Open LDAP).
UserAttributes	OrgLdapUserAttributesType	1	always	0.9	Defines how LDAP attributes are used when importing a user.
GroupAttributes	OrgLdapGroupAttributesType	1	always	0.9	Defines how LDAP attributes are used when importing a group.