Hosted Active Directory::ADSearch

  • Article

The ADSearch method performs a directory search in Microsoft Active Directory.

Arguments

Input Arguments Required Description

<path>

Yes

The Lightweight Directory Access Protocol (LDAP) path of the starting object for the search.

<filter>

Yes

Search filter string in LDAP format. The following sample code illustrates the use of filter.

<preferredDomainController>

No

The name of the preferred domain controller.

<propertyList>/<property name="..">

No

Active Directory property. For output, properties with multiple values are returned with corresponding value nodes.

<preferences>/<preference>

No

Individual search preference. This element modifies the behavior of the search by changing one of the search preferences from the default value to the value specified.
Output Arguments Description

<objects>

List of objects found.

Remarks

Procedures Steps

  1. Active Directory Provider::Search

Sample Code

Example XML Request

<request xmlns:xsl="https://www.w3.org/1999/XSL/Transform"> 
          <procedure xmlns:xsl='https://www.w3.org/1999/XSL/Transform'> 
            <execute namespace="Hosted Active Directory" procedure="ADSearch" impersonate="1"> 
              <executeData> 
                <path>LDAP://bob@alpineskihouse.com,OU=AlpineSkiHouse,OU=WH,OU=HOSTING,DC=Fabrikam,DC=Com</path> 
                <filter>objectClass=user</filter> 
                <preferredDomainController>ad01.fabrikam.com</preferredDomainController> 
                    <propertyList> 
                        <property name="sAMAcountName" /> 
                    </propertyList> 
                    <preferences> 
                        <preference> 
                                <searchPref>ADS_SEARCHPREF_SEARCH_SCOPE</searchPref> 
                                <type>ADSTYPE_INTEGER</type> 
                                <value>ADS_SCOPE_ONELEVEL</value> 
                        </preference> 
                    </preferences> 
              </executeData> 
            </execute> 
          </procedure> 
</request>

Applies To

Hosted Active Directory Namespace API for

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0