Skip to content

Update Bitbucket authentication information #3729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −7
Open

Update Bitbucket authentication information #3729

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions docs/integrations/builtin/credentials/bitbucket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,30 @@ Create a [Bitbucket](https://www.bitbucket.com/) account.

## Supported authentication methods

- API username and app password
- Atlassian email and a scoped API token

## Related resources

Refer to [Bitbucket's API documentation](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication) for more information about the service.

## Using API username/app password
## Using Atlassian email/scoped API token

To configure this credential, you'll need:

- A **Username**: Visible in your Bitbucket profile settings **Personal settings > Account settings**.
- An **App Password**: Refer to the Bitbucket instructions to [Create an app password](https://support.atlassian.com/bitbucket-cloud/docs/create-an-app-password/).
- An Atlassian **email**: Visible in your **Atlassian account settings**.
- A **Scoped API Token**: Refer to the Bitbucket instructions to [Create an API token](https://support.atlassian.com/bitbucket-cloud/docs/create-an-api-token/).

## App password permissions
## API token permissions

Bitbucket API credentials will only work if the user account you generated the app password for has the appropriate privilege scopes for the selected app password permissions. The n8n credentials dialog will throw an error if the user account lacks the appropriate permissions for the selected scope, like `Your credentials lack one or more required privilege scopes`.
Bitbucket API credentials will only work if the API token has the appropriate scopes. The n8n credentials dialog will throw an error if the API token lacks the appropriate permissions for the selected scope.

See the [Bitbucket App password permissions documentation](https://support.atlassian.com/bitbucket-cloud/docs/app-password-permissions/) for more information on working with these permissions.
See the [Bitbucket Api token permissions documentation](https://support.atlassian.com/bitbucket-cloud/docs/api-token-permissions/) for more information on working with these permissions.

Important scopes:

- `read:webhook:bitbucket`
- `write:webhook:bitbucket`
- `delete:webhook:bitbucket`
- `read:repository:bitbucket`
- `read:workspace:bitbucket`