Add Users To Group (MS Azure Active Directory) activity

An activity that adds one or more users to a group in Microsoft Azure Active Directory.


Add Users To Group activity

Configure the Add Users To Group activity

To configure the Add Users To Group activity, do the procedure in this topic.

Prerequisites

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 MS Azure Active Directory tab.

    Open MS Azure Active Directory tab
  3. On the MS Azure Active Directory tab, drag the Add Users To Group activity onto your process.

    Drag Add Users To Group activity

General Configuration

Specifies the basic settings for the Add Users To Group activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

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

Connection Timeout (Seconds)

Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer, representing a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Add Users To Group Configuration

Specifies how to add Microsoft Azure Active Directory users to a group.

Figure: Add User To Group Configuration screen

Add User To Group Configuration screen

Fields

Field NameDefinition

MS Azure Active Directory

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

Create Add Token icon

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

By ID / By User Name

Function:
Specifies whether to add a user based on user ID or user name to a group in Microsoft Azure Active Directory.
Accepted Values:
  • By ID - Adds a user to a group based on user ID.
  • By User Name - Adds a user to a group based on user name.
Default Value:
Add User By ID
Accepts Process Data Variables:
No

User Names or User IDs

Function:
Specifies the user name or user ID of the user to add to a Microsoft Azure Active Directory group.
Accepted Values:
One or more user name or user ID in Microsoft Azure Active Directory, separated by semicolons (;).
Default Value:
None
Accepts Process Data Variables:
Yes

Group Name

Function:
Specifies the name of the Microsoft Azure Active Directory group to which to add the user.
Accepted Values:
A valid Microsoft Azure Active Directory group name.
Default Value:
None
Accepts Process Data Variables:
Yes