Bitbucket | Operate As Docs

Connect your client's Bitbucket with a key they paste, and call its API through Operate As.

Website: bitbucket.org
Connects by: Pasting a API token
Category: Developer tools
Services: 1
Tools: 292

Service	Key	Base URL
Bitbucket	`bitbucket`	`https://api.bitbucket.org/2.0`

Your client also types their email (The address you sign in to Atlassian with).

Connecting

Your client makes a API token in their Bitbucket settings and pastes it on their link. Operate As tries it with Bitbucket before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "bitbucket"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "bitbucket"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the Bitbucket key you paste, with only the access you gave that key	Chosen on the provider's screen

Tools

Install Bitbucket's typed package for your language:

pip install operate-as-bitbucket

pip install operate-as-bitbucket

Run bitbucket.bulk_create_or_update_annotations

curl -X POST https://api.operate.as/v1/actions/bitbucket.bulk_create_or_update_annotations \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {
      "workspace": "<workspace>",
      "repo_slug": "<repo_slug>",
      "commit": "<commit>",
      "report_id": "<report_id>"
    }
  }'

curl -X POST https://api.operate.as/v1/actions/bitbucket.bulk_create_or_update_annotations \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {      "workspace": "<workspace>",      "repo_slug": "<repo_slug>",      "commit": "<commit>",      "report_id": "<report_id>"    }  }'

Shows the required inputs. Every input, with its JSON Schema: GET /v1/actions/bitbucket.bulk_create_or_update_annotations

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://api.bitbucket.org/2.0. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../bitbucket/user" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../bitbucket/user" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in Bitbucket. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}