Establishing a Connection

The objects available within our connector are accessible from the "cdata.bitbucket" module. To use the module's objects directly:

Import the module as follows:
```
import cdata.bitbucket as mod
```
To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
```
mod.connect("Workspace=myworkspaceslug;Schema=Information")
```

Connecting to Bitbucket

For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query 'SELECT * FROM Workspaces'.

Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.
To query the Workspaces table, set Schema to Information and execute:
```
SELECT * FROM Workspace
```

Authenticating to Bitbucket

Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to Bitbucket from three common authentication flows.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Bitbucket, see Connection.

Desktop Applications

To connect via a desktop application, you must set and refresh the OAuth acess token.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
OAuthClientId: The Key displayed when you created your custom OAuth application.
OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
CallbackURL: The Callback URL defined when you registered your application. This is typically set to http://localhost:33333.

When you connect, the connector opens Bitbucket's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application the connector then completes the OAuth process:

The connector obtains an access token from Bitbucket and uses it to request data.
The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Web Applications

Authenticating via the Web requires you to create and register a custom OAuth application, as described in Creating a Custom OAuth Application. You can then use the connector to get and manage the OAuth token values.

This section describes how to get the OAuth access token, how to have the driver refresh the OAuth access token automatically, and how to refresh the OAuth access token manually.

Get the OAuth access token:

To obtain the OAuthAccessToken, set these connection properties:
- OAuthClientId: The Key displayed when you created your custom OAuth application.
- OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
  Depending on whether AuthScheme is set to code or client, authentication is performed with either an authorization code or a client credentials grant type.
Call stored procedures to complete the OAuth exchange:
1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Callback URL you specified when creating the custom OAuth app. The stored procedure returns the URL to the OAuth endpoint.
2. Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL, which will be displayed as the URL in the browser.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the Callback URL.

After you obtain the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic Refresh of the OAuth Access Token

To have the connector automatically refresh the OAuth access token:

Before connecting to data for the first time, set these connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The Key displayed when you created your custom OAuth application.
- OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the connector to save the OAuth values, which persist across connections.
On subsequent data connections, set:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set these connection properties:
- OAuthClientId: The Client Id in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret in your custom OAuth application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Note: Depending on whether AuthScheme is set to code or client, authentication is performed with either an authorization code or a client credentials grant type.

You can do this in either of the following ways:

Option 1: Obtain the OAuthVerifier value.
Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the connector to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

Authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

Set these properties:
- InitiateOAuth: OFF.
- OAuthClientId: The Key displayed when you created your custom OAuth application.
- OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

Copy this URL and paste it into a new browser tab.
Log in and grant permissions to the connector. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.
Exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, to obtain the OAuth authentication values, set these properties:
- InitiateOAuth: REFRESH.
- OAuthVerifier: The verifier code (the value of the code parameter in the Callback URL).
- OAuthClientId: The Key displayed when you created your custom OAuth application.
- OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
- OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified location.
Test the connection to generate the OAuth settings file.
You are ready to connect after you re-set these properties:
- InitiateOAuth: REFRESH.
- OAuthClientId: The Key displayed when you created your custom OAuth application.
- OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
- OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the connector.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties: