Integration Service user guide

Connections help in establishing tasks between single users and external applications. The connections are created once users authenticate with an API Provider.

Before you can use connections, make sure the following conditions are met:

This move brings several key advantages:

When a connection is created in a shared folder, all users with access to that folder can use the connection in their automation workflows. The connection can be edited by all users with access to it.

We recommend creating connections for which authentication is done through personal accounts in Personal Workspaces, and only using shared folders for connections where authentication is done through service accounts. Administrators can prevent regular users from creating shared Integration Service connections in team folders. For more information, refer to Enforcing user-level Integration Service connection governance in the Orchestrator user guide.

The Connections tab in Orchestrator provides a central location for creating and managing connections. You can also create connections directly from automations in UiPath Studio, UiPath Studio Web, or UiPath Assistant.

To create a connection in Orchestrator, follow these steps:

For more details, refer to Managing connections in the Orchestrator user guide.

Some Integration Service connectors support multiple authentication types. You select the type when creating the connection. Available options can include:

You can manage all connections in one place from the Connections tab in Orchestrator. This is where you can check the health of connections, reconnect, manage triggers, edit connection details such as the name and polling interval, and delete connections.

For more details, refer to Managing connections in the Orchestrator user guide.

You can manage Integration Service connections directly from UiPath Assistant. To learn more, refer to Connections in UiPath Assistant.

Select Configure in browser to open the Connections page in Studio Web. To learn more, refer to Managing Connections in the Studio Web user guide.

UiPath Integration Service offers a Bring your own Oauth2.0 app (BYOA) model that allows enterprises to connect using their own OAuth 2.0 applications instead of the default UiPath-registered public OAuth app.

UiPath registers and maintains OAuth 2.0 apps on vendor developer portals for the majority of connectors (for example, Microsoft, Google, Salesforce, Atlassian Jira, etc.). In most cases, these apps come with predefined scopes and are managed entirely by UiPath.

However, some organizations may have strict IT, security, or compliance policies that prevent them from using external app registrations. In such cases, BYOA enables customers to use their own Client ID and Client Secret to authenticate and authorize Integration Service connections.

Use BYOA when:

When creating a connection in Integration Service, you can select Bring your own Oauth2 app as the authentication type.

This allows you to enter:

Integration Service uses your credentials to perform the OAuth flow and securely stores the resulting access and refresh tokens.

Create an OAuth 2.0 app in the vendor's developer portal (for example, Salesforce, Microsoft, Jira or Google). During registration:

Each connector has mandatory scopes required for its activities and triggers.

If your BYOA app does not include these scopes, connection creation will fail, or certain actions may not work as expected.

Refer to the connector's documentation to confirm the list of mandatory scopes.

The following table lists common issues encountered when using BYOA connections, along with their possible causes and resolutions.

You can manage connections and event triggers as part of your solution package. Refer to Solutions Management overview to learn what solution packages are, how they work, and how to create, manage, and deploy them.

When you create a solution package, connections and their associated event triggers are available in the Components panel. You can edit the following properties: Connection name, Connection description, and Authentication type. For event triggers, you can perform the same configuration steps as in Orchestrator.

Once the solution is built and published, the connections are available in the solution's Components panel. All the connections selected when creating the solution package can now be deployed.

Solutions Management does not display connections for processes unless an event trigger is connected as well. The issue may impact the solution deployment, requiring manual connection configuration for proper operation.

You can choose to deploy the solution package to a specific folder which doesn't yet exist in Integration Service. In this case, the folder is created automatically.

Connection Authentication type

As an admin, you decide during deployment whether to use an existing connection, create a new one, or allow the end user to select the connection.

During deployment, the administrator can set the Authentication type as:

You also have the option of linking components. When you select Link to existing, a pop-up window displays all the connections accessible to the user deploying the solution package. You can choose any existing connection to be part of the solution package.

The Link to existing option is not available when you edit a configuration using the following methods: Deployment configuration or Edit deployment configuration. To link components or edit the Authentication type after deployment, you must upgrade the solution package. This requires editing the solution and deploying the new version again.

Connections created in any folder through Solutions are not deleted, even when upgrading the workflow to use different connections. This guarantees that processes and automations relying on these connections are not impacted by the upgrade.

For information on how to fix common issues you might encounter when using connection, see Connections troubleshooting.