executeLdapQuery

The executeLdapQuery service enters an LDAP query and returns the Distinguished Names (DNs) of all those entries that match the query. The query traverses all sub-tree nodes starting from the node identified by the base-dn attribute.

  • The request identifies an LDAP connection shared resource and specifies the query to be resolved against that resource.
  • The response lists the DNs of all LDAP entries that match the given LDAP query.

Note that a page-size parameter can be passed in the SOAP API request to page the results, rather than having all of the DNs returned in the response. That parameter is not available, however, for the executeLdapQuery call in the REST API. Instead, a separate pagedquery call is available to page the results when using the REST API.

Required System Action
LDAPAdmin
API Descriptions