Skip to content
Support
  • There are no suggestions because the search field is empty.

Connections

The Connections page in Vince Live is used to manage and configure integrations to external systems (e.g., M3, Salesforce, Azure). Each connection contains authentication and environment details used for secure communication with external platforms.

Navigation

Go to: Administration > Connections

API Connection to Vince Live

If you want to use an external system to interact with Vince Live data you can configure an API Client that can be used to access all APIs, provided it has permission to do so.

In this guide, we will configure an API Client that has access read and write data to a single Custom Table.

API Clients use the Client Credentials OAuth2 flow for authentication.

You will see a list of all configured connections including:

  • Connection Name
  • Description
  • System (e.g., M3, Salesforce, Azure)
  • Authentication Type (OAuth, Basic, API Key)
  • Environment
  • Labels
  • Actions (⋮)

Actions Menu (⋮)

Available per connection:

  • Validate Connection — Tests the connection parameters.
  • Revoke Certificate — Revokes linked SSL certificates (if used).
  • Edit — Opens the connection details for editing.
  • Delete — Removes the connection.

Edit or Create Connection

Click + New Connection or use Edit on an existing one to configure.

Creating the API Client

Click to add a new client, and give it a name

For now, we can leave the Roles empty, but without assigning a Role to the API Client, it will not have permission to do anything if you attempt to use it.

Once created, you can see your client in the list. Click the actions, and select Manage Client

Here you can see your Client ID and click to expose the Client Secret.

Configuring roles

Please see the section Roles and Attribute-Based Access Control (ABAC) on how to configure and create Roles.

Authenticating the API Client

To get the access token needed for requests to the Vince Live APIs,

  1. Find, your Tenant ID by going to Menu > About
  2. Use token url https://{tenantId}.auth.eu-central-1.amazonaws.com.amazoncognito.com/oauth2/token (replace {tenantId} with your Tenant ID
  3. Make a POST request to the URL
    1. using Client ID and Client Secret as username and password with Basic authentication
    2. a header with content-type: application/x-www-form-urlencoded
    3. a body with grant_type=client_credentials
  4. Response will contain your access token that you need to pass as ctoken to Vince Live APIs

Required Fields

Field Description
Connection Name Unique name for internal reference
Alias Optional alias name
Description Purpose or notes for the connection
System Select system type (e.g., M3, Salesforce, Azure, Other)
Authentication Type Choose from OAuth, Basic, API Key
Protocol HTTP or HTTPS
Environment Select an existing environment or create a new one
Base URI The base endpoint of the external system
Token URI (OAuth only) Token endpoint URL
Username Login credential (if needed)
Password Secret credential
Client ID / Secret OAuth client credentials
Grant Type, Scope, Resource, Audience OAuth-specific fields

You may also:

  • Use Autofill from File for certificate-based or prefilled connections.
  • Check Ignore Certificate Errors if necessary.
  • Enable Use Static IP when required by firewall policies.

Validate Connection

Click the Validate Connection button to confirm all settings are functional.

Best Practices

  • Use descriptive Connection Names to easily identify usage.
  • Group connections by Environment (e.g., DEV, TEST, PROD).
  • Regularly Validate connections to prevent silent failures.
  • Rotate Client Secrets and Passwords as part of your security routine.

Setup OneDrive Connection

Overview

This provides step-by-step instructions on how to activate the OneDrive connection in Vince Live. By following these instructions, users will be able to connect and authenticate with their Microsoft OneDrive account, allowing them to access and use files from their OneDrive / Sharepoint in Vince Live workflows.

Prerequisites

Before proceeding with the activation process, ensure that you have the following:

  • Access to Vince Live platform
  • Microsoft M365 adminstrator account with the necessary permissions to create an application
  • Basic understanding of Azure and OneDrive services

Note: To successfully setup the OneDrive connection, users must have at least one of the following Microsoft M365 roles assigned to their account:

  • Cloud Application Administrator
  • Application Developer
  • Application Administrator
  • Global Administrator

Please ensure that you have the necessary role assigned to your Microsoft M365 account before proceeding with the activation process.

File Picker

When a user attempts to run the OneDrive File Picker for the first time from Vince Live, the app “VL POC FilePicker Multitenant” will request Admin Consent for the following Delegated permissions:

• Profile

• User.Read

• Files.Read

• Files.Read.All

• Files.ReadWrite.All

• Sites.Read.All

• openid

• Team.ReadBasic.All

Once admin consent is granted, the File Picker will allow users to manually select input files from OneDrive or SharePoint sites when running a workflow through Vince Live. This is sufficient if you only need to manually select files for workflow execution.

However, if you wish to automate or schedule workflows, additional setup steps are required. Continue reading below for further instructions.

How to activate Sharepoint Connection in Vince Live for automating read from Folder

Step 1: Registering a New App in Azure

  1. Log in to your Azure account.
  2. Navigate to the Azure portal (https://portal.azure.com) and go to the Azure Active Directory section (also called Microsoft Entra ID).
  3. Select "App registrations" and click on "New registration".
  4. Provide a name for your application and choose the appropriate account type.
  5. Click on "Register" to create the new application.

Step 2: Creating Client Credentials

  1. In the Azure portal, go to the "Certificates & secrets" section of your registered application.
  2. Under "Client secrets", click on "New client secret".
  3. Provide a description for the client secret and set the expiration.
  4. Click on "Add" to generate the client secret.
  5. Take note of the generated client secret as it will be required later.

Step 3a: Configuring App Permissions

  1. In the Azure portal, navigate to the "API permissions" section of your registered application.
  2. Click on "Add a permission" and select "Microsoft Graph".
  3. Choose permission type “Application” (it’s important to chose the correct permission type here) and select the desired permissions: "Sites.Selected" for accessing Sharepoint files.
  4. Click on "Add permissions" to save the selected permissions.
  5. To save time later you can also tap on Grant admin consent if the admin consent is required for the type of permission you have just added.

Step 3b: Assign SharePoint permissions

  1. Make sure the newly created Application has the correct access to the relevant Sharepoint sites which will be used by the integration later (Read here for more info)
  2. Grant a “write” role to the application for all needed Sharepoint sites (Can be done with Postman or PowerShell etc..)

Step 4: Configuring Connection in Vince Live

  1. Access the Vince Live platform and go to the Connections module.
  2. Enter a name and description for the connection.
  3. Click on "Create new connection" and select Azure as the System from the dropdown.
  4. Set Authentication type to “Auth”, Protocol to “HTTPS” and then chose the Vince Live Environment you wish this connection to be available for.
  5. In the "Client ID" field, enter the Application (Client) ID obtained from the Azure portal.
  6. In the "Client Secret" field, enter the client secret generated in Step 2.
  7. In the Token Uri field, enter the OAuth 2.0 token endpoint (v2) url which can be obtained from the App registrations page in Azure portal by clicking on the Endpoints button
  8. Set the remaining fields as following:
Base Uri Grant type Scope
https://graph.microsoft.com/v1.0/ client_credentials https://graph.microsoft.com/.default
  1. Configure any additional settings as required.
  2. Click on "Save" to create the OneDrive connection.

Step 5: Verify Connection (optional)

  1. Go back to the Vince Live platform and navigate to the Connections module.
  2. Locate the newly created OneDrive connection in the connections table.
  3. Click on the three-dot menu next to the connection and select "Validate Connection" from the dropdown menu.
  4. This will test if the connection is correctly configured and will verify if the authentication and communication with the Microsoft OneDrive service are working as expected.

Make sure to validate the connection to ensure it is properly set up before proceeding with using the OneDrive connection in your Vince Live workflows.