Update User (MS Azure Active Directory) activity

An activity that changes a specified user's information in Microsoft Azure Active Directory.


Update User activity

Configure the Update User activity

To configure the Update User 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 Update User activity onto your process.

    Drag Update User activity

General Configuration

Specifies the basic settings for the Update User 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

Update User Configuration

Specifies the user information to change in Microsoft Azure Active Directory.

Figure: Update User Configuration screen

Update User 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.

Update User By ID / Update User By User Name

Function:
Specifies whether to change a user's information based on user ID or user name to a group in Microsoft Azure Active Directory.
Accepted Values:
  • Update User By ID - Changes the user's infromation in a group based on user ID.
  • Update User By User Name - Changes the user's infromation in a group based on user name.
Default Value:
Update User By ID
Accepts Process Data Variables:
No

User Name or User ID

Function:
Specifies the name or ID of the user to change the information in a Microsoft Azure Active Directory.
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
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use 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, or 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?

Request Mapping

Function:
Connects the Microsoft Azure Active Directory API request parameter to your process schema. This is mandatory only if the request passes data from the process schema to parameters in the Microsoft Azure Active Directory API.
To Open this Field:
  1. On the Create Group Configuration screen, click the Request tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

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

Default Value:
None
Example:
Refer to: