Help Centre › Building Processes
This article describes the RPA Active Directory functionality to authenticate a user.
For a full list of available functions, please read ACTIVE DIRECTORY functions.
Description
The ACTIVE DIRECTORY Authenticate a user function verifies a user's credentials against Active Directory and returns whether the authentication was successful.
Setting it up
To use the ACTIVE DIRECTORY Authenticate a user function, follow these instructions:
{{popups:rpas/add:action=ad-authenticate}}
Once on a process map:
- Navigate to the process where you would like to add the ACTIVE DIRECTORY Authenticate a user function
- Click on the green button's drop-down (right side of the green button labelled "Process")
- On the menu that appears, click on the "+ Activity" item
- From here you can select the ACTIVE DIRECTORY Authenticate a user option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Name | Yes | Text | - | The name of the Active Directory connection to use |
| Username | Yes | Text | - | The username to authenticate |
| Password | Yes | Text | - | The password to verify |
| Variable | No | Text | authenticated | The variable name to store the result |
Output variables
The {authenticated} variable contains a boolean value: true if authentication succeeded, false otherwise.
Errors
| Error | Description |
|---|---|
| Connection not found | No connection exists with the specified name |
Tips
- This function does not raise an exception on invalid credentials; it returns false instead, allowing you to handle failed authentication gracefully