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. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Active Directory tab.

    Open Active Directory tab
  3. On the Active Directory tab, drag the Retrieve Group Members activity onto your process.

    Drag Retrieve Group Members activity

General Configuration

Specifies the basic settings for the Retrieve Group Members activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts 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

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

Retrieve Group Members Details

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

Figure: Retrieve Group Members Details screen

Retrieve Group Members screen

Fields

Field NameDefinition

Active Directory

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

Create 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

Description:
Specifies the name of the users in Active Directory group whose information to get.
Allowed Values:
A list of Active Directory user names in the group, separated by semi-colons (;).
Default Value:
None
Accepts Variables:
Yes

Group Name

Description:
Specifies the name of the Active Directory group.
Allowed 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 Variables:
Yes

Map Response to AgilePoint Schema

Description:
Specifies the connection of the Active Directory API response parameter, such as display name, e-mail address, or phone number to your process schema.
To Open this Field:
  1. On the Retrieve Group Members screen, click the Response tab.
Allowed 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
Example:
Refer to: