Apache CloudStack 4.16.0.0 Root Admin API Reference

ldapConfig

(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.

Request parameters

Parameter NameDescriptionRequired
binddnSpecify the distinguished name of a user with the search permission on the directory.false
bindpassEnter the password.false
hostnameHostname or ip address of the ldap server eg: my.ldap.comfalse
listallIf true return current LDAP configurationfalse
portSpecify the LDAP port if required, default is 389.false
queryfilterYou specify a query filter here, which narrows down the users, who can be part of this domain.false
searchbaseThe search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.false
sslCheck Use SSL if the external LDAP server is configured for LDAP over SSL.false
truststoreEnter the path to trust certificates store.false
truststorepassEnter the password for trust store.false

Response Tags

Response NameDescription
binddnSpecify the distinguished name of a user with the search permission on the directory
bindpassDN password
hostnameHostname or ip address of the ldap server eg: my.ldap.com
portSpecify the LDAP port if required, default is 389
queryfilterYou specify a query filter here, which narrows down the users, who can be part of this domain
searchbaseThe search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com
sslCheck Use SSL if the external LDAP server is configured for LDAP over SSL