In this article
...
Field | Field Type | Description | ||||||||||||
Label* Default Value: Search | String | Specify a unique name for the Snap. | ||||||||||||
Existing distinguished name* Default Value: None | String/Expression | 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. A 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.
You can also use special characters in the distinguished name. Learn more about Using Special Characters in Distinguished Name. | ||||||||||||
Page size* Default Value: 1000 | Integer | Specify the size of the page to receive search results. The maximum value accepted by Active Directory is 1000. Refer to https://msdn.microsoft.com/en-us/library/ms180880(v=vs.80).aspx for more information.
| ||||||||||||
Limit Default Value: 0 | Integer | Specify the number of search records to be fetched from the Active Directory.
| ||||||||||||
Scope type Default Value: SUBTREE_SCOPE | Dropdown list | Specify the scope type to search against. The options available include:
| ||||||||||||
Filter Attributes | Field set | Specify the key-value pairs to filter the search results.
| ||||||||||||
Filter keys | String/Expression/Suggestion | The suggested filter attributes based on the provided Existing distinguished name property. | ||||||||||||
Filter values | String/Expression | 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. | |||||||||||||
Attribute Keys
| String/Expression/Suggestion | Specify the attribute keys that should return in the search results.
| ||||||||||||
Group results Default Value: Deselected | Checkbox | Select to group the output result in a single array.
| ||||||||||||
Pass through Default Value: Deselected | Checkbox | Select to include the entire input data in the Snap's output. The Snap includes this data within the $original field in the output. In certain scenarios, the Snap may be unable to process the entire input due to limitatons imposed by the endpoint's API. In such cases, we recommend that you select the Pass through checkbox to ensure that the unprocessed input is not lost. You can process the remaining input data using more of the same Snaps in the Pipeline. Alternatively, you can also write the original data into a separate file using a combination of the Mapper Snap and the File Writer Snap. | ||||||||||||
| Dropdown list |
|
...