Integrate a new Bitbucket Cloud source

GitGuardian integrates with your Bitbucket Cloud workspace using an App password. For more details on App passwords, refer to the Bitbucket Cloud documentation.

Setup

Create an App Password

We recommend using a bot user to generate the App password. Ensure this user has access to the workspaces and repositories you intend to monitor.

tip

Using a bot user prevents disruptions caused by account changes, such as a personal account being deleted.

1. On Bitbucket Cloud, navigate to the Account settings section within the user settings;

2. Get the username in the Bitbucket profile settings

   

3. On Bitbucket Cloud, navigate to the App passwords section within the user settings;

4. Create an app password with a simple name such as "GitGuardian" and assign the following permissions:

   • Read for: Account, Workspace membership, Projects and Repositories;
   • Read and write for: Webhooks.

   

5. Get the App password

   

Integrate your Bitbucket workspaces with GitGuardian

1. Navigate to Settings > Integrations > Sources.

2. Click on Install for Bitbucket Cloud.

3. Enter your username and the app password generated earlier. Add a name for the integration, then click Configure.

   

4. On the configuration page, review the list of workspaces your Bitbucket Cloud user has access to. Click Install for each workspace you want to monitor.

   

5. That's it! You can view the monitored projects and repositories in your Bitbucket Cloud settings page.

   

Automatic historical scan

By default, GitGuardian runs a historical scan on every Bitbucket Cloud repository added to the monitored perimeter.

To disable this feature, navigate to your Bitbucket Cloud settings. Only workspace Managers can modify this setting.

Customize your monitored perimeter

After installing your Bitbucket Cloud instance(s), you can configure which projects to monitor in the Bitbucket Cloud settings.

If you deselect an entity (a repository, a project or a whole workspace) from your monitored perimeter:

• GitGuardian will stop fetching commits from that entity, new incidents will not be uncovered and existing incidents won't be updated for this entity.
• The webhook will remain active, allowing you to resume monitoring anytime.