Create a GiLab Cloud integration with Flow using OAuth or an access token.
Important: Use a service account to create this integration. Learn more about creating service accounts.
Permissions
Flow only requires read access to your repositories. This permission is needed to process the metadata used to generate our reports. In order to use all services and webhooks when integrating with Flow, the service account must be a maintainer or owner at the project and repository level. If you don't want to enable webhooks, then the minimum permission needed in GitLab is reporter at the project and repository level.
Note: Flow does not ingest data from SHA256 repos (external site, opens in new tab) at this time. If you have any SHA 256 repos, they will appear on the Repos page, but Flow will not ingest data from them.
Creating your integration
To create your GitLab Cloud integration:
- Click Settings in the top navigation.
- In the left navigation under Integrations, click Integrations.
- Click Add integration.
- Click GitLab Cloud in the Integration Provider list.
Next, select your integration method and authenticate with GitLab. In most situations, we recommend OAuth-based integrations.
- In the OAuth tab, click Connect to GitLab.
- If you're already logged in to your GitLab account, a popup will prompt you to confirm access. If you're not already logged in, you'll be prompted to log in before authorizing the connection.
- If your connection was successful, you'll see a success message.
Note: Ensure popups are allowed in your browser before attempting to connect via OAuth.
- In GitLab, create a new Personal access token (external site, opens in new tab). Use the following information:
- Name: Give the access token an identifiable name so you know it's used for Flow.
- Expiry date: Take note of this date so you can update the token again before it expires. If your access token expires before you update it in Flow, Flow can't continue to ingest and process your data. Alternatively, create a service account access token without an expiry date (external site, opens in new tab).
-
Scopes: The minimum required scopes for Flow to ingest data are:
api
read_user
read_repository
- Copy your access token into the Personal Access Token field in Flow.
- Click Test connection. Once your connection is successfully verified, you'll receive a success message.
Once your authentication is successful, click Next to finish setting up your integration.
Finishing your integration setup
Once you've authenticated successfully:
- Select the services you want enabled for this integration to determine which data types Flow will ingest. Choose to enable to disable repo, PR, and ticket services. After you've made your selections, click Next.
- Name your integration. This is the name Flow will display for the integration. Choose a name that will help you identify the integration in the future.
- Once you've completed all sections, click Create.
You've successfully created a GitLab Cloud integration. Next, Flow directs you to the details page for this integration to complete additional setup steps. At this point, choose whether to enable auto-import for your repos and set up repo exclusions.
Tip: Make sure the list of groups matches what you expect. If any seem to be missing, double-check the permissions and scopes you used during authentication.
Learn more about managing integrations.