Skip to main content

Bitbucket

Outline

Introduction

This document gives you the step-by-step procedure to configure Bitbucket in SAFE.

SAFE integrates with Bitbucket and fetches the security misconfiguration of the Bitbucket account in SAFE.

Prerequisites

  • Access required in SAFE:

    • SAFE Admin Access

  • Access required in Bitbucket:

    • Bitbucket Admin Access

  • Required User Inputs

    • API URL

    • Workspace ID

    • Key

    • Secret

  • Required Scope

    • account: Read

    • project: Read

    • repository: Read

Generate Connection Details

Generate Workspace ID

    • Log in to your Bitbucket account as Admin.

    • Navigate to your Workspace, by clicking on profile icon in the top right corner and select All Workspaces.

    • Select the workspace.

    • Click the Settings icon at the top-right of the screen.

    • Click on the Workspace settings option. Here on this page, you can get the Workspace ID. Copy and Save the Workspace ID to use later while configuring Bitbucket in SAFE.


  • How to get Key & Secret

    • Log in to your Bitbucket account as Admin.

    • Navigate to your Workspace, by clicking at profile icon on the top right corner and select All Workspaces.

    • Select the workspace.

    • Click on the Settings icon at the top-right of the screen.

    • Click on the Workspace settings.

    • Click on the OAuth consumers.

    • Click on the Add Consumer button.

    • Enter the Name and Description.

    • Enter the Callback URL as https://us.safeone.ai.

    • Mark the checkbox for the "This is a private consumer" option.

    • Click the the Save Button. The system redirects you to the OAuth consumer page.

    • The system displays the Key and Secret. Copy and save the Key and Secret to use it while configuring Bitbucket in SAFE.

    • It's important to regularly update the Key and Secret in SAFE according to its expiration date.

  • How to get API URL

    • Access the Bitbucket API documentation by clicking on the provided link.

    • Upon reaching the Bitbucket API documentation page, locate the section titled "URI structure".

    • In the exhibit provided, find the base URL highlighted as 3. Copy and save this API URL to use it while configuring Bitbucket in SAFE.

Configure Bitbucket in SAFE

  • Log in to your SAFE account as Admin.

  • Click on the Integrations option from the left navigation.

  • Scroll to find the Bitbucket integration card or search for Bitbucket in the search bar.

  • Hover over the Bitbucket integration card and click on the Configure button.

  • Enter the following:

    • API URL

    • Workspace ID

    • Key

    • Secret


  • Enter the Auto Sync Frequency.


  • Click on the Test Connection button.



  • Once the connection is successful, click on the Save button.


  • Once the configuration is saved successfully, click on the Sync Now button to trigger an on-demand sync.

  • Upon a successful sync, the system pulls the Bitbucket assets and their findings in SAFE. You can track the status of the sync in the History table.

View Results

  • Go to the integration homepage.

  • Scroll to find the Bitbucket integration card or search for Bitbucket in the search bar.

  • Click on the Bitbucket integration card for Finding View and Asset View.

    • Finding View: This tab displays all the findings details pulled from Bitbucket.

    • Asset View: This tab displays all the assets pulled from Bitbucket.

To check sync status and errors for this integration, see Integration History.

Did this article help?

Let us know by leaving a star rating at the top of this article.