Help Centre › Building Processes
This article describes the RPA Active Directory functionality to search Active Directory.
For a full list of available functions, please read ACTIVE DIRECTORY functions.
Description
The ACTIVE DIRECTORY Search function searches Active Directory using an LDAP filter and returns matching entries with their attributes.
Setting it up
To use the ACTIVE DIRECTORY Search function, follow these instructions:
{{popups:rpas/add:action=ad-search}}
Once on a process map:
- Navigate to the process where you would like to add the ACTIVE DIRECTORY Search 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 Search 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 |
| Filter | Yes | Text | - | The LDAP filter string (e.g. (&(objectClass=user)(department=IT))) |
| Base DN | No | Text | - | Override the base DN for this search |
| Attributes | No | Array | - | List of attributes to return (e.g. ["cn", "mail", "department"]) |
| Size limit | No | Number | 0 | Maximum number of results to return (0 for unlimited) |
| Variable | No | Text | results | The variable name to store the results |
Output variables
The {results} variable contains an array of objects, each with a 'dn' property and the requested attributes.
Errors
| Error | Description |
|---|---|
| Connection not found | No connection exists with the specified name |
| Invalid filter | The LDAP filter string is not valid |
Tips
- Use compound LDAP filters like (&(objectClass=user)(department=IT)) to narrow results
- Limit the attributes list for better performance when you only need specific fields