> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bitbucket

export const title_1 = "Bitbucket";

export const title_0 = "Bitbucket";

## Prerequisites

Both the **OAuth** and **OAuthClient** authentication methods require a custom OAuth application (an OAuth consumer) created in Bitbucket.

To create an OAuth consumer, follow these steps:

<Steps>
  <Step>
    Sign in to Bitbucket and open the workspace you want to connect to.
  </Step>

  <Step>
    Navigate to **Settings > Workspace settings**, then under **Apps and features** select **OAuth consumers**.
  </Step>

  <Step>
    Click **Add consumer** and enter a **Name** for the consumer.
  </Step>

  <Step>
    In the **Callback URL** field, enter the Connect AI callback URL `https://oauth.cdata.com/oauth/`.
  </Step>

  <Step>
    Select the **Permissions** your application needs to access Bitbucket data.
  </Step>

  <Step>
    Save the consumer, then record the **Key** and **Secret**. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Bitbucket to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bitbucket* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter the **Workspace**, the slug of the workspace to which to connect.
  </Step>

  <Step>
    (Optional) Enter the **Schema** to use. The available schemas are *Information*, the Repository schemas, and the Project schemas.
  </Step>

  <Step>
    (Optional) Enable **Include Deleted** to fetch deleted CommitComments and PullRequestComments records.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the Key (also known as the consumer key) assigned to your OAuth consumer.
        * **OAuth Client Secret**—Set to the Secret assigned to your OAuth consumer.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Bitbucket sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Bitbucket account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_0} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the Key (also known as the consumer key) assigned to your OAuth consumer.
        * **OAuth Client Secret**—Set to the Secret assigned to your OAuth consumer.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>