On this Page
This Snap lets you search Active Directory and provides options to select the scope and the filter table to effectively return search results as compared to the List Users Snap which returns all the entries.
The attributes of table will create on suggest based on the existing distinguished name into Active Directory. The table consists of all the fields that can be used as filter attributes to perform search and effectively return the results. To generate the suggested filter attributes into the table the existing distinguished name is required.
|Support and limitations:|
Works in Ultra Task Pipelines.
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Active Directory Basic Auth Account for information on setting up this type of account.
|Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.|
Existing distinguished name*
Specify the LDAP API references an LDAP object by its distinguished name (DN). A DN is a sequence of relative distinguished names (RDN) connected by commas. An RDN is an attribute with an associated value in the form attribute=value, normally expressed in a UTF-8 string format. The typical RDN attribute types include:
DC = domainComponent, CN = commonName, OU = organizationalUnitName,O = organizationName, STREET = streetAddress, L = localityName,ST = stateOrProvinceName, C = countryName, UID = userid.
This field is applicable only to existing users. If the user does not exist, create an entry using the Create Entry Snap first.
Example: A distinguished name for an LDAP entry can be represented as:
In this example, to refer to the entire user list, you can remove the initial attribute, CN=AbcUser.
Default value: [None]
You can also use special characters in the distinguished name. See the section Using Special Characters in Distinguished Name below.
Specify the size of the page to receive search results. The maximum value accepted by Active Directory is 1000. See https://msdn.microsoft.com/en-us/library/ms180880(v=vs.80).aspx for more information.
Default value: 1000
Specify the number of search records to be fetched from the Active Directory.
Default value: 0
|Scope type||Specify the scope type to search against. The options available include:|
Specify the table of key-value pairs to filter the search.
The suggested filter attributes based on the provided Existing distinguished name property.
The corresponding values of the suggested filter key to perform an effective search.
Use this field set to define the attributes that should return in the search results. This field set contains the Attribute Keys field. Click to add a row for defining the attribute key.
Specify the attribute keys that should return in the search results.
Select to group the output result in a single array.
Default value: Not selected.
Select to include the entire input data in the Snap's output. The Snap includes this data within the $original field in the output.
Default value: Not selected
|Distinguished name value||Returns|
|Details about that group.|
|CN=Users,DC=server,DC=company,DC=com||Details about all items in Users under that domain.|
|DC=server,DC=company,DC=com||Details about all objects on that server domain.|