Integration Service user guide

Connections

About connections​

Prerequisites​

• Integration Service is enabled and provisioned for your tenant.
• Users who work with connections have the necessary permissions in Orchestrator. To create a connection, a user must have the Connections - Create permission in the target folder. For more information on permissions, see Configuring access for accounts in the Orchestrator user guide.

Creating a connection​

1. Access Automation Suite.
2. On the left-side menu, select Integration Service. The Integration Service windows includes three separate tabs: Connectors, Connections, and Triggers. By default, the Connectors tab is selected. Only the connectors installed in your on-premises environment are displayed.

1. In the My Folders section you can select whether you want to work in your personal workspace, or in a shared folder, where created connections can be used by all users that have access to this folder.

2. Select the desired Connector to create a new connection or update an existing one.
3. Select Connect to <connector name>. Depending on the connector you have chosen, the specific credentials required for your connections are requested.

Shared connections​

Modifying connections​

1. From the left rail, select Integration Service. The Integration Service window includes three separate tabs: Connectors, Connections and Triggers.
2. Select the Folder you want to modify the connection in.
   Note:

   The folder you want to create the connection in can also be selected after step 4.

3. Go to the Connections tab, where the list of created connections is displayed.
4. Select the More button corresponding to the desired connection to modify it. You can perform the following actions:
   • Delete the connection.
   • Set it as default (this option is only available if you have several connections established for the same application.
   • Check the connection to verify its status.

Renaming connections​

1. Access the Connections tab.
2. On the left-side menu, select Integration Service. The Integration Service window includes separate tabs for Connectors, Connections and Triggers, along with a left navigation window displaying the folders.
3. Select the Folder you want to modify the connection in.
   Note:

   The folder can be selected after step 4.

4. Go to the Connections tab, where the list of created connections is displayed.
5. Hover with the mouse cursor over the name of the connection you wish to modify. The Edit button is displayed.
   Note:

   Alternatively, you can select your connection from the list to access the detailed view. The Edit button is located on the right side of your connection name.

6. Select the Edit button and you can choose a new name for your connection.

Selecting the authentication type​

1. In Integration Service, from the Connectors list, select a supported connector.
2. Select Connect to <connector name> to go to the connection setup page.
3. Use the Folder in which connection is stored dropdown to choose the appropriate folder (e.g., My Workspace).
4. Use the Authentication Type dropdown to select from the available options, such as:
   • OAuth 2.0 Authorization code
   • OAuth 2.0 Password
   • Bring your own OAuth 2.0 app
   • Personal Access Token (PAT)
   Note:

   Available options may vary depending on the connector.

5. Enter the required credentials for your selected authentication type, then select Connect to establish the connection.

Bring your own OAuth 2.0 app​

Common scenarios for when to use BYOA​

• The application supports the OAuth 2.0 Authorization code grant authentication type. Other OAuth 2.0 types cannot be used under BYOA.
• Your enterprise requires that all third-party integrations use internally managed OAuth apps.
• You need to add or modify scopes that are not part of UiPath’s default registered app.
• Your organization’s security or compliance policies prohibit shared app usage.
• You want to control the OAuth app lifecycle, including rotation of secrets.

How BYOA works​

• Client ID and Client Secret - Credentials obtained from your app registration in the vendor’s developer portal.
• Scopes - Permissions required by the connector.
• Redirect URI - Non-editable callback URL (https://{yourDomain}/provisioning_/callback for Automation Suite). This is the callback URL that Integration Service uses to complete the OAuth flow.

Configuring a BYOA connection​

Step 1: Register an OAuth App on the vendor portal​

• Set the redirect/callback URI to https://{yourDomain}/provisioning_/callback.
• Add the required scopes (see connector-specific documentation for mandatory scopes).
• Ensure the vendor supports the grant type required by the connector (Authorization Code Grant).

Step 2: Create a connection in Integration Service​

1. In Integration Service, from the Connectors list, select the desired connector, and then click Connect to open the connection creation page.

2. If multiple authentication types are available, select the authentication type Bring your own OAuth 2.0 app.

3. Enter the following details from your registered app:

   • Client ID
   • Client Secret
   • Scopes (select from existing or type them manually)
   Note:

   Many vendors (Atlassian Jira, Coupa, etc.) expect the same scopes are present in your app as well.

4. Follow the on-screen prompts to complete the OAuth consent flow by providing your username and password on the vendor’s login page.

5. Once authorized, the connection is securely stored and available to be used.

6. Integration Service takes care of periodically refreshing the access token.

Step 3: Verify mandatory scopes​

Best practices​

• Use a dedicated enterprise app registration for UiPath Integration Service; avoid reusing app IDs from unrelated integrations.
• Include only the necessary scopes for least-privilege access.
• Keep client secrets rotated periodically and update them in Integration Service by editing connections.
• Document app ownership and ensure continuity if admins change.
• Verify redirect URIs exactly match the value displayed in Integration Service; mismatched URIs cause OAuth errors.

Security and maintenance​

• BYOA credentials are encrypted and stored securely in UiPath Integration Service and never exposed in plain text.
• UiPath does not manage or monitor your custom app credentials or scopes.
• Secret rotation, app de-registration, or scope maintenance are the customer’s responsibility.

Common issues​

Troubleshooting connection issues​