On this Page

Snap type:

Read

Description:

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.

  • Expected upstream Snaps: File reader followed by any file Parser followed by Structure.
  • Expected downstream Snaps: Any file Formatter followed by File Writer.
  • Expected input: Existing distinguished name, Filter attributes (Filter keys, Filter values).
  • Expected output: This Snap will give the output data as all the searched entries based on the provided existing distinguished name.
Prerequisites:

[None]

Support and limitations:

Works in Ultra Task Pipelines.

  • Previously the Page Size field worked similar to the Limit field, that is, it sets the limit on fetching records instead of fetching all the records. 
  • The Active Directory Search Snap output now displays the number of records that you specify in the Limit field under Settings. If your Pipelines use the Snap with the Page Size field, they may fail to execute if the downstream Snap expects the same count. To retrieve all the records, configure the Snap with default settings, that is, Limit: 0 and Page Size: 1000.


Account: 

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.

Views:


InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Settings

Label*

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.

ExampleA distinguished name for an LDAP entry can be represented as: 

CN=AbcUser,CN=Users,DC=server,DC=company,DC=com. 

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.

Page size*


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

A new field Limit is introduced in a 4.23 dot release (423patches8210)Your Pipelines created prior to this release, which use Page Size for limiting records may fail to execute. Hence, modify your Pipelines using the Limit field below.


Limit

Specify the number of search records to be fetched from the Active Directory.

  • If the value is 0, then the Snap will fetch all the records.
  • Your existing Pipelines that use Page Size for limiting records may fail to execute. Hence, modify your Pipelines using the Limit field.

Default value: 0

Scope typeSpecify the scope type to search against. The options available include:
  • SUBTREE_SCOPE A subtree search (or a deep search) includes all child objects as well as the base object.
  • ONELEVEL_SCOPE A one-level search is restricted to the immediate children of a base object, but excludes the base object itself. This setting can perform a targeted search for immediate child objects of a parent object.
  • OBJECT_SCOPE A base search (OBJECT_SCOPE) limits the search to the base object. The maximum number of objects returned is always one. This search is useful to verify the existence of an object for retrieving group membership.

DefaultSUBTREE_SCOPE

Filter Attributes

Specify the table of key-value pairs to filter the search.

The generated filter keys generated by suggesting can be modified, that is:

  • filter key / filter value : (objectClass / user) and (cn / rock) mean select only "rock" from all users.
  • filter key / filter value : (objectClass / user) and (!cn / rock) means to select all the user objects except "rock".


Filter keys

The suggested filter attributes based on the provided Existing distinguished name property.

Filter values

The corresponding values of the suggested filter key to perform an effective search.

Returning Attributes

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.

Attribute Keys

Specify the attribute keys that should return in the search results.

Default Value: None
ExampleobjectClass, DistinguishedName (member;range=1500-1600), cn

When using this Snap to search by a distinguished name, the Snap only returns up to 1500 members if the total member in the group is greater than 1500.

  • If the result has less than 1500 members in the group, the Snap returns the members within the member key.
  • If the result has more than 1500 members in the group, the member key displays as no values.
  • If you specify a member range, for example, (member; range=1500-2000), the Snap returns the members within that range.


Group results

Select to group the output result in a single array.

When Group result is checked, the documents will now be grouped inside an array instead of individual documents.

Default value: Not selected.

Pass through

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


This option must be enabled to see preview content.


Examples

 

Distinguished name valueReturns

CN=groupname,CN=Users,DC=server,DC=company,DC=com

Details about that group.
CN=Users,DC=server,DC=company,DC=comDetails about all items in Users under that domain.
DC=server,DC=company,DC=comDetails about all objects on that server domain.