Microsoft Entra ID connection

Introduction

A Microsoft Entra ID connection, created using the Microsoft Entra ID connector, establishes access to Microsoft Entra ID. Once a connection is configured, you can create instances of Microsoft Entra ID activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

To connect to on-premises instances of Microsoft Active Directory, use the Active Directory v2 connector.

Note

This connector supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Host or Tenant ID in this connection requires users to re-enter the Client Secret and/or the Password (depending on the selected Grant Types) for the connection.

Important

Microsoft Entra ID was previously known as Microsoft Entra ID (Entra ID).

Create or edit a Microsoft Entra ID connection

A new Microsoft Entra ID connection is created using the Microsoft Entra ID connector from one of these locations:

The design component palette's Project endpoints and connectors tab (see Design component palette).
The Global Connections page (see Create a global endpoint in Global Connections).

An existing Microsoft Entra ID connection can be edited from these locations:

The design component palette's Project endpoints and connectors tab (see Design component palette).
The project pane's Components tab (see Component actions menu in Project pane Components tab).
The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a Microsoft Entra ID connection

Each user interface element of the Microsoft Entra ID connection configuration screen is described below.

Microsoft Entra ID connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Connection Name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Entra ID connection and must not contain forward slashes / or colons :. This name is also used to identify the Microsoft Entra ID endpoint, which refers to both a specific connection and its activities.
Host: Automatically populated as https://login.microsoftonline.com.
Tenant ID: Enter the tenant ID for the Microsoft Entra ID instance.
Resource: Automatically populated as https://graph.microsoft.com.
Grant Types: Use the menu to select the grant type, either Client Credentials or Password Grant:
- Client Credentials: Corresponds with the OAuth 2.0 client credentials grant.
- Password Grant: Corresponds with the OAuth 2.0 resource owner password credentials grant.
Client ID: Enter the Application (client) ID of an app registration created for the connector, which can be found in the app registration's Overview page in the Microsoft Entra admin center.
Client Secret: Enter the Value of the client secret for the registered app, which can be found in the Certificates and secrets page in the Microsoft Entra admin center.
Username: If Password Grant is selected as the Grant Type, enter the email address for the Microsoft Entra ID instance.
Password: If Password Grant is selected as the Grant Type, enter the password for the Microsoft Entra ID instance.
Scope: Enter a space-separated list of scopes that the app requires (optional).
Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
Save Changes: Click to save and close the connection configuration.
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Microsoft Entra ID connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

Query: Queries object data in Microsoft Entra ID and is intended to be used as a source in an operation.
Create: Creates object data in Microsoft Entra ID and is intended to be used as a target in an operation.
Update: Updates object data in Microsoft Entra ID and is intended to be used as a target in an operation.
Delete: Deletes object data from Microsoft Entra ID and is intended to be used as a target in an operation.