Connect an integration

Jamie Kandola
Jamie Kandola
  • Updated

About

Integrations connect the tools you already use to ControlMap, so evidence collection and compliance data stay up to date without manual work. Once a tool is connected, ControlMap collects its data on a schedule and shows it in Monitor, where it feeds your compliance checks.

This article covers the steps that are the same for most tools: finding your integrations, adding one, and changing it afterwards. Each tool also has its own article with what you need on the tool's side before you start.

Setting up integrations from the client portal is not part of the Free and Essentials plans. For details, see the Free, Essentials and Pro plans article.

Find your integrations

Go to Monitor › Integrations. The page has these parts:

  • Four tiles: Integrations, Connected, With issues and Pending. They count what the current search and filters show.
  • A search box, Search integrations..., and a Filter menu. You can filter by Source (the category, such as Cloud Infrastructure or Identity Providers) and by Status (Connected, Pending, With issues, Disconnected or Managed by partner).
  • One card for each connection, showing its logo, name, category, status, a short description, the date it last synced and its number of records.

The Integrations tab in Monitor with the four tiles, search box, Filter menu and a card for each connection

A card's status shows how the connection is doing:

  • Connected: the latest connection check passed.
  • Disconnected: the connection check failed. A previous sync does not prove the connection still works.
  • Pending: a scan is running.

Some cards carry a Partner badge. These connections are set up and managed by your MSP. You can see them, but you can't edit, run, stop or delete them. If you have no connections yet, the page says "No integrations yet" and "Add an integration to connect your first tool."

Connect an integration

  1. Go to Monitor › Integrations and select Add Integration.
  2. Search for the tool, or scroll the list. Each card shows the tool's name, category and a one-line description. A tool that isn't available yet is greyed out and listed last.

The Add Integration window with a search box and a card for each available tool

  1. Select the tool's card. The setup page opens.
  2. Complete each step, shown along the top of the page. Most tools have four: Connection, Checks, Watchers and Schedule.

The steps work like this:

  • Connection: enter what the tool needs, such as a connection name, an API key, or a tenant or account ID. What you enter is different for each tool, so follow the article for your tool. Some tools show a help panel on the right with a link to read more. Tools that sign in with OAuth have a connect button instead of a plain save. Selecting it takes you to the tool's own approval page, then back to ControlMap when it is approved.
  • Checks: choose which automated compliance checks this connection runs.
  • Watchers: choose who is notified when the connection's status changes. You are added by default.
  • Schedule: scans run weekly. Choose the Day of the week and the Time of the day. Scan results and collected evidence are kept for 180 days.

The Add AWS setup page on the Connection step, with the four steps along the top and a help panel on the right

The screenshot above shows AWS as an example. Select Cancel on the first step to return to the Integrations list. On later steps, use the back button.

When you finish, the new connection's page opens. Its data starts to appear in the other Monitor tabs after the first scan. A few tools have a single-page setup with no steps: Asana, Jira tickets, Google Drive, Confluence and Notion.

Microsoft and Microsoft GCC add a fifth step, Inclusions & Exclusions, between Checks and Watchers. See the Microsoft integration article for details.

Open or change a connection

Go to Monitor › Integrations and select the connection's card. The page header shows the connection's name, category and status, and whether it is Running or Not Running. The status reads Checking connection..., Connected, Disconnected or Connection status unavailable.

A connected integration's page with its name, status, Run Once button and the Connection, Schedule, Watchers, Logs and Help tabs

The page has these tabs, in order:

  • Connection: the saved settings. Secrets stay hidden. To change a setting, edit it and select Update Connection.
  • Schedule: when scans run.
  • Inclusions and Exclusions: rules for what the connection syncs. This tab appears only for tools that support rules.
  • Watchers: who is notified when the connection's status changes.
  • Logs: Past runs & logs shows when the integration last ran. It does not list earlier runs.
  • Help: guidance for the tool.

To rename a connection, select Edit name next to its name.

Change the schedule

  1. Open the connection and select the Schedule tab.
  2. Choose a Day of the week and a Time of the day.
  3. Select Save Schedule, or select Save & Scan Now to save and scan straight away.

The Schedule tab of a connection with the Day of the week and Time of the day fields and the Save & Scan Now and Save Schedule buttons

Each scan refreshes the evidence and data while keeping the history. Scan results and collected evidence are kept for 180 days.

Run a scan now or stop one

  1. On the connection's page, select Run Once. A message says the scan is scheduled to start in the next few minutes. The button is off while a scan is running.
  2. To stop a scan that is running, select Force stop, which appears while it runs.

Scans also run on the weekly schedule. Partner connections can't be run or stopped from here.

Delete an integration

  1. Go to Monitor › Integrations.
  2. Select the bin icon on the connection's card. Partner connections have no bin.
  3. When "Delete Integration?" asks you to confirm, choose Yes. Choose No to keep it.

ControlMap confirms with "Successfully deleted the integration". Deleting an integration also deletes all of its assets and their compliance status.

Was this article helpful?

Yes! No