Retrieve User Profile activity

An activity that gets user profile information from Microsoft Entra ID.

Configure the Retrieve User Profile activity

To configure the Retrieve User Profile activity, do the procedure in this topic.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
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?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the MS Entra ID tab.
On the MS Entra ID tab, drag the Retrieve User Profile activity onto your process.

General Configuration

Specifies the basic settings for the Retrieve User Profile activity.

Fields

Field Name	Definition
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
Connection Timeout (Seconds)	Description: Specifies the number of seconds permitted to complete an action before the connection stops. Allowed Values: An integer. Represents: A number of seconds Default Value: 600 Accepts Variables: No

Retrieve User Profile Configuration > Response tab

Specifies user profile information to get from Microsoft Entra ID.

Figure: Retrieve User Profile Configuration > Response tab

Fields

Field Name	Definition
MS Azure Active Directory	Description: Specifies the access token that connects to your Microsoft Entra ID. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Create	Opens this Screen: Access Token for Microsoft Entra ID Function of this Screen: Configure an access token to connect to Microsoft Entra ID.
Retrieve User By User ID / Retrieve User By User Name	Description: Specifies whether to retrieve one or more users based on a user ID or user name in Microsoft Entra ID. Allowed Values: Retrieve User By User ID - Retrieves a user in Microsoft Azure Active Directory based on user ID. Retrieve User By User Name - Retrieves a user in Microsoft Azure Active Directory based on user name. Default Value: Retrieve User By User ID Accepts Variables: No
User Name or User ID	Description: Specifies the Microsoft Entra ID user name or user ID whose information to get. If you want to register this user in AgilePoint NX who is not an AgilePoint NX registered user, select Register user to AgilePoint NX, and complete the fields in the User Information tab. Allowed Values: A valid user name in Microsoft Azure Active Directory. Default Value: None Accepts Variables: Yes
Response	Description: This tab is used to connect the response to the data model for your process to get the user profile information.
Map Response to AgilePoint Schema	Description: Specifies the connection from the Microsoft Entra ID API response parameter to your process schema. To Open this Field: On the Retrieve User Configuration screen, click the Response tab. Allowed Values: Click the Schema Mapping button to open the Schema Mapper screen. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper

Retrieve User Profile Configuration > User Information tab

Configures the user profile information to get in Microsoft Entra ID.

Figure: Retrieve User Profile Configuration > User Information tab

Fields

Field Name	Definition
User Information	Description: This tab is used to register and store information about the Microsoft Entra ID user in AgilePoint NX.
Register user to AgilePoint NX	Description: Specifies whether to register the Microsoft Entra ID user in AgilePoint NX. Allowed Values: Selected - Registers and stores information about the Microsoft Azure Active Directory user in AgilePoint NX. Deselected - Does not register and store information about the Microsoft Azure Active Directory user in AgilePoint NX. Default Value: Deselected Accepts Variables: Yes
User Name	Description: Specifies the process data variable that stores the Microsoft Entra ID user name to register in AgilePoint NX. The user name in this field must be the same as the user name specified in the User Name (Login ID) field. To Open this Field: Select Register user to AgilePoint NX. Allowed Values: A process data variable. Default Value: None Accepts Variables: Yes
Full Name	Description: Specifies the process data variable that stores the Microsoft Entra ID user's full name. To Open this Field: Select Register user to AgilePoint NX. Allowed Values: A process data variable. Default Value: None Accepts Variables: Yes
Manager	Description: Specifies the process data variable that stores the name of the Microsoft Entra ID user's manager. To Open this Field: Select Register user to AgilePoint NX. Allowed Values: A process data variable. Default Value: None Accepts Variables: Yes
Department	Description: Specifies the process data variable that stores the name of the Microsoft Entra ID user's department. To Open this Field: Select Register user to AgilePoint NX. Allowed Values: A process data variable. Default Value: None Accepts Variables: Yes
Language	Description: Specifies the process data variable that stores the Microsoft Entra ID user's language. To Open this Field: Select Register user to AgilePoint NX. Allowed Values: A process data variable. Default Value: None Accepts Variables: Yes
Email Address	Description: Specifies the process data variable that stores the Microsoft Entra ID user's e-mail address. To Open this Field: Select Register user to AgilePoint NX. Allowed Values: A process data variable. Default Value: None Accepts Variables: Yes