Skip to content

Update example config and docs to mention API keys instead of deprecated passwords #127

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
cbruno10 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update example config and docs to mention API keys instead of deprecated passwords #127

Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions config/bitbucket.spc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
connection "bitbucket" {
plugin = "bitbucket"

# Bitbucket username.
# Atlassian account email (the address listed under "Email Aliases" in your Bitbucket Personal settings).
# Can also be set with the BITBUCKET_USERNAME environment variable.
# username = "MyUsername"
# username = "me@example.com"

# Bitbucket app password, which can be created at https://bitbucket.org/account/settings/app-passwords/.
# Bitbucket API token, created at https://id.atlassian.com/manage-profile/security/api-tokens.
# Can also be set with the BITBUCKET_PASSWORD environment variable.
# password = "blHdmvlkFakeToken"
# password = "ATATT3xFfGF0FakeToken"

# Base URL of your Bitbucket Server.
# Defaults to "https://api.bitbucket.org/2.0".
Expand Down
12 changes: 6 additions & 6 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ steampipe plugin install bitbucket

| Item | Description |
| :---------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Credentials | Bitbucket requires an [app password](https://bitbucket.org/account/settings/app-passwords/). |
| Permissions | You must create app password with the following [scopes](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#scopes):<br />&nbsp;&nbsp;&nbsp;&nbsp;- `account:read`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `issue:read`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `pullrequest:read`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `repository:read`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `snippet:read`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `webhook:read`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `wiki:read`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `workspace:read` |
| Credentials | Bitbucket requires an [API token](https://support.atlassian.com/bitbucket-cloud/docs/create-an-api-token/). Set `username` to your **Atlassian account email** (listed under *Email Aliases* in your Bitbucket Personal settings), not your Bitbucket username, and `password` to the API token. |
| Permissions | Create the token via *Atlassian account settings → Security → Create and manage API tokens → Create API token with scopes*, select **Bitbucket** as the app, and grant these [scopes](https://support.atlassian.com/bitbucket-cloud/docs/api-token-permissions/):<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:user:bitbucket`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:workspace:bitbucket`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:project:bitbucket`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:repository:bitbucket`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:pullrequest:bitbucket`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:issue:bitbucket`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:snippet:bitbucket`<br />&nbsp;&nbsp;&nbsp;&nbsp;- `read:webhook:bitbucket` |

### Configuration

Expand All @@ -67,13 +67,13 @@ Installing the latest bitbucket plugin will create a config file (`~/.steampipe/
connection "bitbucket" {
plugin = "bitbucket"

# Bitbucket username.
# Atlassian account email (the address listed under "Email Aliases" in your Bitbucket Personal settings).
# Can also be set with the BITBUCKET_USERNAME environment variable.
# username = "MyUsername"
# username = "me@example.com"

# Bitbucket app password, which can be created at https://bitbucket.org/account/settings/app-passwords/.
# Bitbucket API token, created at https://id.atlassian.com/manage-profile/security/api-tokens.
# Can also be set with the BITBUCKET_PASSWORD environment variable.
# password = "blHdmvlkFakeToken"
# password = "ATATT3xFfGF0FakeToken"

# Base URL of your Bitbucket Server.
# Defaults to "https://api.bitbucket.org/2.0".
Expand Down
Loading