In this article
...
Use this Snap to authenticate Active Directory user credentials against an LDAP server through the authentication API. This Snap returns whether a given user entry (Username and Password combination) is valid in the Active Directory instance.
Prerequisites
...
| Parameter Name | Data Type | Description | Default Value | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Label | String |
| Active Directory Authenticate Users | AD Auth User | ||||||||
| Username | String/Expression | Required. Username of the user. This value can be passed as a Pipeline parameter or through an input document. | N/A | JohnDoe | ||||||||
| Password | String/Expression | Required. The password associated with the username provided. This value can be passed as a Pipeline parameter or through an input document. | N/A | sFispGq@j3o! | ||||||||
| Pass through | Check box | Select this check box to specify whether the data in the incoming document must be passed through and merged with the output document. If selected, the input document is passed through to the output view under the key original. | Selected | Selected | ||||||||
| Snap Execution | Drop-down list | Select one of the three following modes in which the Snap executes:
| Validate & Execute | Execute only |
Troubleshooting
...
| Authenticate Users Snap |
|---|
|
| Output |
|
| Note | ||
|---|---|---|
| ||
In certain scenarios, the Snap may be unable to process the entire input due to limitations 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 Snap 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. |
The Pipeline uses a Filter Snap to filter the document with "success" authentication result (output from Authenticate Users Snap) and pass it into the downstream Snap. When the username or password is not valid, the Pipeline drops the document with the following response: result = fail.
| Filter Snap |
|---|
|
| Output |
|
After the authentication is complete, we can use other Snaps to suit the need. For example:
...