What is a connector?
A connector represents a program in an integration. It includes the necessary authentication methods to securely access the program's environment.
In addition to authentication, some connectors also offer customizable fields that allow the integration to be tailored to a client's specific preferences or requirements. These customizations ensure that the integration aligns with the client's workflow and use cases.
Sections
A single connector may reveal different fields depending on the integration being used. However, most connectors will be broken down into four main sections:
General section
This section usually contains the basic fields required to authenticate with the program, such as:
- Environment URLs
- Account credentials
- Access tokens
Note: Some environments, such as those with conditional access policies or disabled settings (legacy authentication), may require additional steps or fields to complete authentication. This is most commonly seen in Microsoft products.
Additional Options
These fields customize the integration to align with the specific features of the connected program, helping streamline your experience.
Advanced Options
Advanced fields often include specialized settings like advanced authentication methods should the authentication methods in the general section not be sufficient enough.
Relay Options
Some programs are not readily available to the internet. To assist with accessing these programs, a relay may be set up and used. For more information on relays, please review the What is a Relay page.
Locked/Protected fields
Some fields display a Lock Icon. These fields:
- Indicate that sensitive information (like passwords or API Keys) is protected and will not show in plain text.
- Store the data securely in Cosmos DB, where it is only accessed when the integration runs.
Best Practices
Username and Password Fields
If the connector requires a username and password for authentication, ensure that:
- The account does not have multi-factor authentication (MFA) enabled. MFA can interfere with the connection process.
- The account is a service account that is dedicated only to the single integration. Service accounts that are used for multiple integrations can experience throttling especially when related to multiple Microsoft products.
Testing Credentials
After entering all of the required credentials, always test the connection using the Test button. Locked/Protected fields will have to have their credentials re-entered to confirm the connection. Previously saved values will not be part of the connector test.
- Success: A small confirmation window will temporarily appear in the top-right corner of your browser.
- Unsuccessful: An error message will appear at the bottom of the connector page in red. Review the error message to identify and resolve any issues.