Integration Service for Automation Suite User Guide

DELIVERY:

RELEASE: 2.2510

Last updated Nov 11, 2025

Connections

About connections

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

Creating a connection

Access Automation Suite.
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.

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

Shared connections

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.

Note:

All the Integration Service connectors support connection sharing and configuration at run time. For more information on configuring connections at run time, refer to the Orchestrator User Guide.

Modifying connections

From the left rail, select Integration Service. The Integration Service window includes three separate tabs: Connectors, Connections and Triggers.
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.
Go to the Connections tab, where the list of created connections is displayed.
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

To rename a connection, you have to:

Access the Connections tab.
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.
Select the Folder you want to modify the connection in.
Note: The folder can be selected after step 4.
Go to the Connections tab, where the list of created connections is displayed.
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.
Select the Edit button and you can choose a new name for your connection.

Selecting the authentication type

Some connectors in Integration Service support multiple authentication methods. You can select your preferred method before initiating a connection.

In Integration Service, from the Connectors list, select a supported connector.
Select Connect to <connector name> to go to the connection setup page.
Use the Folder in which connection is stored dropdown to choose the appropriate folder (e.g., My Workspace).
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.
Enter the required credentials for your selected authentication type, then select Connect to establish the connection.

Bring your own OAuth 2.0 app

The authentication experience enables you to use the Bring your own OAuth 2.0 app (BYOA) option for connectors that support OAuth 2.0 Authorization Code. This allows you to select a private application when authenticating prior to making your connection.

When using Integration Service in an on-premises environment, if you are required to authenticate using a Client ID and Secret, you must create your own OAuth 2.0 application, similar to the Bring your own OAuth 2.0 app option.

To create a connection using the Bring your own OAuth 2.0 app method, you need the following credentials:

Client ID
Client secret

Note:

If your organization uses BYOA, you can set default values for these credentials through an Integration Service governance policy in Automation Ops. For more information, refer to Settings for Integration Service policies.

When you create a private OAuth application with a third-party, follow the specific third-party documentation to set it up. Make sure you set the Redirect URI (or callback URL) for your application to: https://{yourDomain}/provisioning_/callback.

To create a connection to your private OAuth 2.0 application, perform the following steps:

Select Integration Service from Automation Suite.
From the Connectors list, select a supported connector. You can also use the search bar to narrow down the connector.
Select the Add connection button.
You are now redirected to the connection page.
Select your preferred Authentication type.
By default, Bring your own OAuth 2.0 app is selected.
Enter your Client ID and Client secret and select Connect.