In this article
Table of Contents | ||||
---|---|---|---|---|
|
...
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 |
|
Additional Information
User-Agent Header
The Azure Active Directory Snap Pack utilizes the REST HTTP Client to send HTTP requests to the Azure endpoint. This process incorporates a User-Agent header with the value of "SnapLogic
" for every request. By including the User-Agent header, you can monitor and track the requests made to the Azure endpoint, allowing you to determine the total count of requests made.
To view the User-Agent number for a user or group:
Log in to the Azure portal.
Navigate to Azure services > Azure Active Directory.
Navigate to Users/Groups and select the desired User/Group.
Click Audit logs in the left navigation menu.
In the right pane, you can view the User-Agent number in the following format:SnapLogic (<build_number>) - pid-113e3955-1969-4541-9c9c-e3e0c897cccd
. For example, a PR build might haveSnapLogic (PR21312) - pid-113e3955-1969-4541-9c9c-e3e0c897cccd
as the User Agent
Thepid
value comes from Microsoft®.
...
Information
The following table indicates the output the Search Snap returns for a given Distinguished name.
...