Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

Use this Snap to authenticate Active Directory user credentials against an LDAP server through the authentication API. This Snap returns if Snap returns whether a given user entry (username+passwordUsername and Password combination) is a valid entry in the Active Directory instance or not.

Image Modified

Prerequisites

...

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
Active Directory Authenticate UsersAD Auth User
UsernameString/Expression

Required. Username of the user. This value can be passed as a Pipeline parameter or through an input document.

N/AJohnDoe
PasswordString/ExpressionRequired. The password associated with the username provided. This value can be passed as a Pipeline parameter or through an input document.N/AsFispGq@j3o!
Pass throughCheck boxSelect 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.SelectedSelected
Snap ExecutionDrop-down list

Select one of the three following modes in which the Snap executes:

  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps downstream from it.

Validate & ExecuteExecute only

Troubleshooting

...

There are cases where the Active Directory is used as an authentication server. The Username and Password can be passed from other Pipelines, Ultra, or Ultra/ Triggered tasksTasksThe following Pipeline verifies user credentials against an Active Directory and returns the details where the authentication result is success. Each entry that fails authentication, also contains the reason and suggested resolution for the error. The Pipeline drops the document when the username and password are not valid.

...

Configure the Authenticate Users Snap to capture the user credentials from the Mapper output and verify them against the LDAP server to which it is connectedconnecting

Authenticate Users Snap

Output

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. It drops the document when When the username and or password are 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:

...