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

1. Access Automation Suite.
2. On the left-side menu, click on 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.

   
   

   

   
   
   .
3. 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.
   
   

   

   
   
4. Click the desired Connector to create a new connection or update an existing one.
5. Click Add Connection. 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, see the Orchestrator User Guide.

Modifying connections

1. Access Automation Suite.
2. On the left-side menu, click on Integration Service. The Integration Service window includes three separate tabs: Connectors, Connections and Triggers.
3. 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.

4. Go to the Connections tab, where the list of created connections is displayed.

5. Click 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:

1. Access the Connections tab.
2. On the left-side menu, click on 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, and you should now see the Edit button 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. Click the Edit button and you can choose a new name for your connection.

Multi-authentication

You can configure multi-authentication options for supported connectors in Integration Service. This allows you to select alternate methods of authenticating prior to creating a connection.

To create a connection using multi-authentication, you must perform the following steps:

1. In Integration Service, from the Connectors list, select a supported connector.
2. Select the Add connection button. You are now redirected to the page where you can create a connection.
3. Click the ⚙ icon to change your Authentication type.
4. Select your preferred authentication method.
5. Enter the required credentials and click Connect.

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, see 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:

1. Select Integration Service from Automation Suite.

2. From the Connectors list, select a supported connector. You can also use the search bar to narrow down the connector.

3. Select the Add connection button.

4. You are now redirected to the connection page.

5. Click the ⚙ icon to change your Authentication type.

6. By default, Bring your own OAuth 2.0 app is selected.

7. Enter your Client ID and Client secret and select Connect.

Note:

For OAuth 2.0 app connections, we encrypt and store the authentication token, but don’t use it to access any client data.