Help Centre › Building Processes
This article describes the RPA Active Directory functionality to get group members.
For a full list of available functions, please read ACTIVE DIRECTORY functions.
Description
The ACTIVE DIRECTORY Get group members function retrieves all direct members of an Active Directory group.
Setting it up
To use the ACTIVE DIRECTORY Get group members function, follow these instructions:
{{popups:rpas/add:action=ad-get-group-members}}
Once on a process map:
- Navigate to the process where you would like to add the ACTIVE DIRECTORY Get group members 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 group members 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 |
| Group DN | Yes | Text | - | The distinguished name of the group |
| Variable | No | Text | members | The variable name to store the results |
Output variables
The {members} variable contains an array of objects with properties: dn, sAMAccountName, displayName, mail.
Errors
| Error | Description |
|---|---|
| Connection not found | No connection exists with the specified name |
| Group not found | No group was found with the specified DN |
Tips
- Returns all direct members only; nested groups are not expanded