Integration's credentials checker

The Credential Checker analyzes Scopes, Permissions, and available git projects while creating new integrations or checking existing ones for:

The credentials are checked for integrations authenticated via OAuth and a token for both Direct and Hybrid Connections.

The Credential Checker displays the status of your integration’s scope, permissions, and projects. In addition, it lets you download a report on missing credentials.

Required scopes and permissions

In addition to verifying your OAuth or token credentials required for establishing a connection between Flow and the vendor, Flow also checks for the following permissions in GitHub and GitLab:

GitHub

Flow supports credential checks for both GitHub Cloud and GitHub Enterprise Server (Self-Hosted) for the following authentication types:

Token		OAuth
Personal Access Token (Classic)	Fine-grained Personal Access Token	OAuth
Required Scopes `repo` `read:org` `admin:repo_hook` `admin:org_hook` `read:user`	Required Permissions Repository Permissions (Read-Only) `Issues` `Pull Requests` `Metadata` `Content` Organization Permissions (Read-Only) `Members`	Required Scopes `repo` `user:email` `write:public_key`

GitLab

Flow supports credential checks for both GitLab Cloud and GitLab Self-Hosted for the following authentication types:

Personal Access Token	OAuth

Personal Access Token	OAuth
Required Permissions: None Required Scopes: `read_api` `read_user`	Required Permissions: None Required Scopes: `read_api` `read_user`

Credentials verification

Your integration’s credentials are checked when you:

Create a new integration
Edit an existing integration

Status icons

If any of the required permissions and/or scopes are missing, Flow displays their verification status in the Connect with/ Add credentials tab:

A green checkmark is displayed to confirm that the authorization and credentials verification were successful.
A yellow warning icon is displayed when Flow successfully connects to the vendor but is unable to verify the Scopes, Permissions, and Projects.

Example

In the screenshot below, the Project Count is 0, but the required Scopes and Permissions are enabled. The credential checker indicates that the GitHub account doesn’t have access to any projects. This issue must be solved on the vendor side either in repos permissions or permissions for this integration.

Also, check if you're using a service account to create the integration.

Connection state of the GitHub Cloud integration via OAuth..

Download report (new and existing integrations)

To determine which permissions and/or scopes are missing from your connection, click the Download report button. This will generate a CSV file.

Example

In the screenshot below, the Project Count is 0, and some Scopes are missing.

Connection state of the GitHub Cloud integration via access token.

Download the report to find out which scopes are missing.

A screenshot of the csv file - a connection report.

The missing_scopes row in the CSV file lists two scopes: read:org and repo. Since Flow cannot read repos, it displays the Project Count as 0. Once you enable the required scopes, you will see a green checkmark next to Projects (if there are any) and Scopes.

If you decide to create your new integration despite the warnings, Flow will prompt a modal where you can download a report.

Your integration will have no data modal.

The modal informs you that Flow will not be able to digest data from your new integration. On this modal, you can:

Download the report
Cancel to go back and fix the missing permissions or scopes before you proceed
Proceed anyway

After completing the integration process, you can edit the existing integration and retest the connection. The credential checker will recheck the scopes and permissions for the connection and authentication methods you have provided.

If there are still missing scopes/permissions, you can download the report and forward it in the ticket to your respective internal system team requesting permissions/scopes update.

When it’s fixed, retest the connection to ensure the Projects, Scopes, and Permissions received a green checkmark.

Download report (existing integrations)

You can also download a report from the modal after you retest the connection of the existing integration.

Go to Settings > Integrations. Select the integration from the list.
On the integration page, click the Test connection button.
A modal displays.
Click the Download report button to check the status for Projects, Scopes, and Permissions.