REST API - executeLdapQuery

Request

Format	GET <baseurl>/directory/query/<ldapalias>/<ldapquery>
Path parameters	ldapalias: the alias of the LDAP shared resource on which the query is executed. LDAP connection shared resources are named with the prefix ldap/de/ in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the ldap/de/ prefix. Can be obtained from a previous call to listLdapConnections . ldapquery: the query to be evaluated.
Query parameters	`basedn=``string` (optional): the base Distinguished Name (DN) to which the query is restricted. This is relative to, and in addition to, any base DN specified in the LDAP connection shared resource's URL.

Response

JSON	Returns a JSON representation of the content of the executeLdapQueryResponse element.
XML	Returns the content of the executeLdapQueryResponse element (from the DirectoryService schema).

Example

Request

GET <baseurl>/directory/query/easyAs/(objectclass=person)?basedn=ou%3DLondon,ou%3DAllEmployees

Response

 {

       "xml-fragment":

       {

           "@ldap-alias": "easyAs",

           "@ldap-query": "(objectclass=person)",

           "@base-dn": "ou=London,ou=AllEmployees",

           "ldap-entry":

           [

               {

                   "@ldap-dn": "OU=Liam Lawrence, OU=London, OU=AllEmployees, O=easyAsInsurance"

               },

               {

                   "@ldap-dn": "OU=Richard Cresswell, OU=London, OU=AllEmployees, O=easyAsInsurance"

               },

               {

                   "@ldap-dn": "OU=Steve Simonsen, OU=London, OU=AllEmployees, O=easyAsInsurance"

               },

               {

                   "@ldap-dn": "OU=Tony Pulis, OU=London, OU=AllEmployees, O=easyAsInsurance"

               }

           ]

       }

    }