Retrieve Group Members activity

An activity that gets information about the users who are members of an Active Directory group.


Retrieve Group Members activity

Configure the Retrieve Group Members activity

To configure the Retrieve Group Members activity, do the procedure in this topic.

Good to Know

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Active Directory Active Directory icon tab.
      2. On the Active Directory Active Directory icon tab, drag the Retrieve Group Members Retrieve Group Members icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Retrieve Group Members activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name
Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description
Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Retrieve Group Members

Specifies the configuration to get the information about users from an Active Directory group.

Figure: >Retrieve Group Members screen

Retrieve Group Members screen

Fields

Field Name Definition

Active Directory
Function:
Specifies the access token that connects to your Active Directory.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon
Opens this Screen:
Access Token for Active Directory.
Function of this Screen:
Configure an access token to connect to Active Directory.

Group Member Names
Function:
Specifies the name of the users in Active Directory group whose information to get.
Accepted Values:
A list of Active Directory user names in the group, separated by semi-colons (;).
Default Value:
None
Accepts Process Data Variables:
Yes

Group Name
Function:
Specifies the name of the Active Directory group.
Accepted Values:
A valid Active Directory group name.

When you select the access token from the Active Directory field, a list of group names shows in this field.

Default Value:
None
Accepts Process Data Variables:
Yes

Map Response to AgilePoint Schema
Function:
Specifies the connection of the Active Directory API response parameter, such as display name, e-mail address, or phone number to your schema.
To Open this Field:
  1. On the Retrieve Group Members screen, click the Response tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Default Value:
None
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?