Help Centre › Building Processes
This article describes the RPA Active Directory functionality to get user details.
For a full list of available functions, please read ACTIVE DIRECTORY functions.
Description
The ACTIVE DIRECTORY Get user details function retrieves the attributes of a specific user from Active Directory.
Setting it up
To use the ACTIVE DIRECTORY Get user details function, follow these instructions:
{{popups:rpas/add:action=ad-get-user}}
Once on a process map:
- Navigate to the process where you would like to add the ACTIVE DIRECTORY Get user details 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 Get user details 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 sAMAccountName or user@domain of the user to retrieve |
| Attributes | No | Array | - | List of specific attributes to return |
| Variable | No | Text | user | The variable name to store the result |
Output variables
The {user} variable contains an object with the user's dn and requested attributes.
Errors
| Error | Description |
|---|---|
| Connection not found | No connection exists with the specified name |
| User not found | No user was found matching the specified username |
Tips
- Accepts either sAMAccountName (e.g. jsmith) or UPN format (e.g. jsmith@example.com)