ACTIVE DIRECTORY Get user groups function

The ACTIVE DIRECTORY Get user groups function in RPA.

Help CentreBuilding Processes

This article describes the RPA Active Directory functionality to get a user's group memberships.

For a full list of available functions, please read ACTIVE DIRECTORY functions.


Description

The ACTIVE DIRECTORY Get user groups function retrieves all groups that a specified user belongs to.


Setting it up

To use the ACTIVE DIRECTORY Get user groups function, follow these instructions:

{{popups:rpas/add:action=ad-get-user-groups}}

Once on a process map:

  1. Navigate to the process where you would like to add the ACTIVE DIRECTORY Get user groups function
  2. Click on the green button's drop-down (right side of the green button labelled "Process")
  3. On the menu that appears, click on the "+ Activity" item
  4. From here you can select the ACTIVE DIRECTORY Get user groups option
  5. Click "Add" once you are done

Input parameters

ParameterRequiredTypeDefaultDescription
NameYesText-The name of the Active Directory connection to use
User DNYesText-The distinguished name of the user
VariableNoTextgroupsThe variable name to store the results

Output variables

The {groups} variable contains an array of group distinguished name strings.


Errors

ErrorDescription
Connection not foundNo connection exists with the specified name
User not foundNo user was found with the specified DN

Tips

  • Returns direct group memberships including nested groups via the memberOf attribute

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.