Authenticate with Bitbucket/Jira

This guide will teach you how to authenticate with Bitbucket and/or Jira. Bitbucket is a product of Jira and uses similar authentication methods for their products.

Obtain an App Password

In Bitbucket login to the account which should make the requests. After logging in go to the Bitbucket settings. From this page, navigate to App passwords under Access management. Now click on the Add app password button. Under label fill in: Alumio and select the Permissions that are going to be managed through Alumio. When done, press Create. An app password will be presented one time.

Environment variables

Within Alumio navigate to Configuration > Environment variables and create a new variable.

Give the variable a good identifier e.g.: BITBUCKET_APP_PASSWORD. In the value field fill in the app password from the previous step and check the encrypted checkbox. Now save the variable.

HTTP Client

In order to communicate with Bitbucket we're going to need an HTTP Client. Navigate to Configuration > HTTP Clients. And click the button to add a new HTTP Client.

Give the HTTP Client a name, e.g.: Bitbucket API HTTP Client (the identifier will be automatically generated).

Enter a valid description in the description field, e.g.: The Bitbucket API HTTP Client.

Under "Plugins to use" add one plugin. This plugin should be the Add base URI to requests plugin. Leave the default prototype as is and fill in the URI of the Bitbucket API e.g.: https://api.bitbucket.org/2.0.

Bitbucket HTTP Client plugins

Under authentication add an authentication method. Select the Basic authentication method. In the "Username" fill in your Bitbucket username, e.g.: john.doe@alumio.com. In the "Password" field, add the reference to the previously created environment variable: ${BITBUCKET_APP_PASSWORD}.

Bitbucket Authentication method

Now save the HTTP client.

The Bitbucket HTTP client can now be used in the Alumio project to communicate with any Bitbucket endpoint, as long as it has the correct permissions.