Jira | Operate As Docs

Atlassian's issue tracker: projects, issues, comments, boards, sprints and backlogs

Website: atlassian.com/software/jira
Connects by: Signing in with Atlassian
Category: Projects and tasks
Part of: Atlassian
Tools: 689

Service	Key	Base URL
Jira	`jira`	`https://api.atlassian.com/ex/jira/{cloud_id}`

Connecting

Your client presses Connect on their link and approves on Atlassian's own screen. Operate As never sees their password.

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": [
      "jira"
    ]
  }
]

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

Permissions

What the client reads	Permission it asks for
See your projects and issues	`read:jira-work`
Create and change issues and comments	`write:jira-work`
See the people in your Jira sites	`read:jira-user`
See your boards	`read:board-scope:jira-software`
Change your boards	`write:board-scope:jira-software`
See your sprints	`read:sprint:jira-software`
Plan and change sprints	`write:sprint:jira-software`
See issue details	`read:issue-details:jira`
See your projects	`read:project:jira`

Tools

Install Jira's typed package for your language:

pip install operate-as-jira

pip install operate-as-jira

Run jira.add_actor_users

curl -X POST https://api.operate.as/v1/actions/jira.add_actor_users \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {
      "project_id_or_key": "<project_id_or_key>",
      "id": "<id>"
    }
  }'

curl -X POST https://api.operate.as/v1/actions/jira.add_actor_users \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {      "project_id_or_key": "<project_id_or_key>",      "id": "<id>"    }  }'

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

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.atlassian.com/ex/jira/{cloud_id}, with the parts in braces filled in from your client's account. 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-.../jira/..." \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../jira/..." \  -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

Operate As renews the sign-in before it runs out and checks it daily. If Atlassian refuses to renew it, the service shows Expired, you're alerted, and your client reconnects from the same link.

See Keeping access alive and Removing access.

Calls answer

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "detail": "Miller Dental's Atlassian access ended. Send them their link to reconnect."
}

HTTP/1.1 409 ConflictContent-Type: application/json{  "detail": "Miller Dental's Atlassian access ended. Send them their link to reconnect."}

Your webhook receives

{
  "id": "evt_3f9a1c…",
  "type": "connection.expired",
  "createdAt": "2026-10-16T08:00:00+00:00",
  "data": {
    "clientId": "6f1c2a7e-...",
    "clientName": "Miller Dental",
    "provider": "atlassian",
    "services": [
      "jira"
    ],
    "reconnectUrl": "https://…"
  }
}

{  "id": "evt_3f9a1c…",  "type": "connection.expired",  "createdAt": "2026-10-16T08:00:00+00:00",  "data": {    "clientId": "6f1c2a7e-...",    "clientName": "Miller Dental",    "provider": "atlassian",    "services": [      "jira"    ],    "reconnectUrl": "https://…"  }}