Vendor Integration Configuration
Overview
This article describes the Vendor Integration configuration page in detail.
The integration configuration page
Each integration page is divided into three sections:
The Integrations Header
The vendor integration header allows users to create and manage multiple integrations for the same vendor.
| # | Title | Description |
|---|---|---|
| 1. | Add integration | This button allows you to add another integration of the same vendor (e.g., if your company has multiple instances of the same application, one for different divisions). |
| 2. | Remove integration | This button allows you to remove the selected integration. |
| 3. | Integration name | Each integration will be listed here. |
Integration Settings
- In the top part of the Integration Settings section you'll find information related to this integration.
| # | Title | Description |
|---|---|---|
| 1. | Connection Name | If using multiple integrations for the same vendor you may wish to name each differently. This can help later when filtering results by source in different Relyance views, or in the analysis of data flows. |
| 2. | Connection Status | This will show one of these statuses: Not Connected Failed Connected |
| 3. | Authentication Type | This shows what kind of authentication was used in the Connection settings. |
| 4. | Audit Logs | This will open up a pop-up showing API calls to the vendor. The logs shown are truncated in the UI but it is possible to use the Download Log button to retrieve the whole log. |
It is important to note that this log may contain failures that do not necessarily indicate an integration failure but an empty response from the API. | 2. Under the integration info you'll find the expandable Connection Settings section where you provide your connection configuration settings.
| # | Title | Description |
|---|---|---|
| 1. | Refresh Frequency | Set the number of minutes between scans. By default the vendor integration will scan daily (every 1440 minutes) at the time of initial connection. |
| 2. | Business Atlas Associations | Required. The business entities or products that newly discovered third parties, services and assets from this integration are attributed to. Choose at least one from the Select Associations dropdown. See Business Atlas for more information about this feature. |
Ensure you click Save Properties after selecting your products. | | 3. | Connection Type | Depending on the vendor, there may be one or more methods to connect to their API. Common methods include: API Secrets API Keys API Tokens Following an OAuth2 flow | | 4. | Connection Configuration settings | This is where you enter your vendor configuration settings. | | 5. | Process DSRs | When subscribed to the Data Subject Requestsmodule, some integrations allow you to connect the integration to the vendor's DSR-enabled APIs. Note item #3 in the vendor integration information below. | | 6. | Connect | Once configured, the Connect button will connect the vendor integration. |
Integration Information
The bottom section of the vendor integration page provides more information on the required scopes, permissions, and endpoints needed in order to successfully connect the integration.
| # | Title | Description |
|---|---|---|
| 1. | Description | Quick description of the integration's purpose. |
| 2. | Scopes and Permissions / Endpoint | These are the programmatically defined Scopes and Permissions, and Endpoints required to retrieve the relevant properties from the vendor API. Relyance uses the least privilege possible when scanning an API for PII. |
| 3. | DSR Scopes and Permissions / Endpoints | These are the programmatically defined Scopes and Permissions, and Endpoints required to retrieve the relevant properties from the vendor API in order to respond to and manage Data Subject Requests. These Scopes, Permissions, and Endpoints are only accessed when the DSR module is subscribed to and the Process DSRs checkbox is selected in the integration connection settings. |