Class: ExecuteLdapQueryRequest

tibco.objectapi.service.request.ExecuteLdapQueryRequest

new ExecuteLdapQueryRequest(ldapAlias, query)

Object ExecuteLdapQueryRequest Usage: RestApiService.getDirectoryService().executeLdapQuery(request, callback);
Parameters:
Name Type Description
ldapAlias string 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.
query string The LDAP Query to be evaluated. The query must conform to the RFC 2254 LDAP Search Filter standard.
Since:
  • 4.0.0

Members

baseDn :string

Query parameter: 'basedn' (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.
Type:
  • string
Since:
  • 4.0.0

scope :string

Query parameter: 'scope' (optional) The starting point of an LDAP search and the depth from the base DN to which the search should occur. The valid values are:
  • SUBTREE - elements directly within, and below, the Base-DN level are searched.
  • ONELEVEL - only the elements directly within the Base-DN level are searched.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = SUBTREE