Authenticate Entry

Use the Authenticate Entry activity to check whether a user is authorized to access the connected LDAP server.

General

In the General tab, you can establish a connection to an LDAP server.

The following table lists the configurations in the General tab of the Authenticate Entry activity:
Field Module Property? Description
Name No The name to be displayed as the label for the activity in the process.
LDAP Connection Yes Click to select an LDAP Connection shared resource. The LDAP Connection shared resource creates a connection between the plug-in and an LDAP server.

If no matching LDAP Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating an LDAP Connection.

Description

In the Description tab, you can enter a short description for the Authenticate Entry activity.

Advanced

In the Advanced tab, you can select a base entry. The plug-in authenticates the specified user entry in this selected base entry.

The following table lists the configurations in the Advanced tab of the Authenticate Entry activity:
Field Module Property? Description
Base DN Yes Displays the distinguished name of the selected base entry.

Click Browse DIT to select a base entry from the Directory Information Tree (DIT).

The Select Base DN dialog is displayed when clicking Browse DIT. In the Select Base DN dialog, move the slider to specify the maximum number of entries to be displayed in the DIT. The maximum number is 10000.

Input

In the Input tab, you can specify the user entry that you want to authenticate.

The following table lists the input elements in the Input tab of the Authenticate Entry activity:
Input Item Data Type Description
DN String (Required) Enter the distinguished name of the user entry that you want to authenticate.

The object class of the user entry can be any of the following ones: person, organizationalPerson, user, or inteOrgPerson.

Password String (Required) Enter the password of the user entry.
Note: If you do not enter the password, the authentication fails.

Output

In the Output tab, you can find the authentication result of the user entry.

The following table lists the output elements in the Output tab for the Authenticate Entry activity:

Output Item Data Type Description
Result Boolean A value of true indicates that the user entry is authorized, whereas a value of false indicates that the user entry is not authorized.

Fault

In the Fault tab, you can find the error code and error message of the Authenticate Entry activity. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Authenticate Entry activity:
Error Schema Element Data Type Description
msgCode String Displays the error code.
msg String Displays the error message.