Description:

This step retrieves all groups from an Active Directory domain.

The List All Active Directory Groups workflow step connects to Microsoft Active Directory via a configured LDAP connection and retrieves all group objects in the configured directory.

The retrieved group list is stored in a FlowWright Variable or Global Variable, allowing subsequent workflow steps to process, iterate through, validate, synchronize, or report on the directory groups.

This step provides an efficient way to obtain the complete list of Active Directory groups without specifying individual group names.

The step supports:

• Active Directory group enumeration
• Retrieval of all Active Directory groups
• Configurable LDAP connections
• Storage of retrieved groups into workflow variables
• Integration with Microsoft Active Directory

This step can be used for:

• Identity synchronization
• Group inventory reporting
• Active Directory auditing
• Access review preparation
• Directory migration
• Security administration
• Business process automation

Usage:

The List All Active Directory Groups step is typically placed before synchronization, reporting, migration, or auditing activities within a workflow.

The workflow retrieves all Active Directory groups using the configured LDAP connection.

Once the group list has been retrieved, later workflow steps can:

• Synchronize identity systems
• Generate audit reports
• Validate group configurations
• Provision downstream applications
• Export group information
• Compare directory contents
• Continue identity lifecycle management processes

You need to set up an LDAP connection before using this step.

Go to:

Integration → Connections → Generic Connections

On the Manage Generic Connections page, click:

Actions → Create

Configure an Active Directory connection before using this workflow step.

A sample connection is provided here for reference. 

Example:

Let’s build and execute the “clsListAllADGroupsDef” example:

• Create a new process definition named “clsListAllADGroupsDef” and open it in designer mode. 
• Drag a “clsListAllADGroups” step to the canvas.
• Connect the dots between the “Start” and “clsListAllADGroups” steps.
• Configure a variable or global to store the list.
• Click the "clsListAllADGroups" step to configure its "Required" properties. Provide a name for the step. Select the LDAP connection from the drop-down list. Provide the variable or global reference to store the group list. Click the Save button to confirm. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the Process Definition. Create a new Process Instance and execute it. When the workflow reaches the List All Groups step, FlowWright connects to the configured Active Directory server using the selected LDAP connection and retrieves all available Active Directory groups. If the directory query completes successfully, the retrieved groups are stored in the configured output variable, and the workflow follows the True return path. If the LDAP connection cannot be established or the directory query fails, the workflow follows the False return path.

• Click the process step to view its properties. The step should retrieve all Active Directory groups and return True upon successful completion. Verify that the configured workflow variable contains the expected list of groups.

Tips:

• Verify that the LDAP connection has been configured before using this step.
• Ensure that the LDAP account has permission to read Active Directory group objects.
• Store the results in a Variable or Global Variable that can hold multiple values.
• Use the returned group list to drive workflow iterations or synchronization processes.
• Use the retrieved group list to generate reports or perform security reviews.
• Use the True and False return paths to implement appropriate success and error handling.
• Combine this step with Get Group Members, Add Users to Group, Remove Users from Group, or Create Group steps to automate complete Active Directory group management workflows.

Notes:

• A valid LDAP connection must exist before this step can execute.
• The configured LDAP account must have sufficient permissions to read Active Directory group objects.
• The retrieved group list reflects the current state of Active Directory at the time the workflow executes.
• Large Active Directory environments may require additional execution time depending on the number of group objects.
• Network connectivity or authentication issues may prevent successful retrieval.
• The workflow should include appropriate error handling for the False return path.
• The retrieved groups are stored in the configured workflow Variable or Global Variable for use by subsequent workflow steps.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Note: Verify and complete any missing configuration after importing the sample, including:

• LDAP connection
• Output variable mapping
• Workflow variable mappings
• Active Directory permissions
• Environment-specific settings

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.