Get User Information from an Active Directory Group

To get information about the users in an Active Directory group, do the procedure in this topic.

Figure: Retrieve Group Members screen

Retrieve Group Members screen

Prerequisites

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • 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?

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.
  3. Click Retrieve Group Members Retrieve Group Members icon

Procedure

  1. On the Retrieve Group Members screen, in the Active Directory field, select your Active Directory access token.

    To create a new access token, click Add Token Add Token icon. For more information, refer to Access Token for Active Directory.

  2. Click the Request tab.
  3. Complete these fields.
    Field Name Definition

    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
  4. Click the Response tab.
  5. To connect response data from Active Directory to your schema, complete this field.
    Field Name Definition

    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?