Connectors

Jira Cloud connector

Tickets, comments and the epic from 2019.

In short

  • Reads issues and comments from Jira Cloud with a scoped service-account API token.
  • Modes: sync for company-managed software and business projects, fixed for any project.

Setup

  1. Create a dedicated service account and a scoped API token for it. Put the token in an environment variable; the client sends it as Bearer authentication. Use the numeric id from project API responses for scope.projects. Requests go through the Cloud gateway https://api.atlassian.com/ex/jira/<cloud-id>.
  2. Find the site's cloud ID (https://<site>.atlassian.net/_edge/tenant_info). The connector verifies the site URL and cloud ID every run and sends credentials only to that gateway.
  3. Rights for sync: the account needs Administer Jira (security-level members and application roles), Browse users and groups, the project rights to read permission schemes and roles, and the API scopes for issues, comments, users, groups, projects, roles, permission schemes and security schemes. Administrator rights do not make content visible: the account must also hold every Browse permission, security level and comment-visibility group of the content to sync.
  4. Rights for fixed: Browse Projects plus the security levels and comment visibilities of the content to read.

Configuration

See shared configuration for installation, permission intervals, encryption keys and identity links.

[[sources]]
id = "jira-eng"
type = "jira"
permissions = "sync"                   # or "fixed" with readers = [...]

[sources.settings]
site_url = "https://acme.atlassian.net"
cloud_id = "11111111-1111-4111-8111-111111111111"
api_token = { env = "FYRR_JIRA_API_TOKEN" }

[sources.scope]
projects = [10001, 10002]              # stable numeric project IDs ...
# jql = "project = 10001 AND status != Closed"   # ... or one bounded static JQL expression
issue_types = []                       # issue type IDs; empty = all
labels = []                            # any-of exact labels
skip_comment_authors = []              # account IDs whose comments are omitted
KeyMeaning
settings.site_url, cloud_idPinned HTTPS site and its Cloud UUID; both verified.
settings.api_tokenEnvironment reference to the scoped token.
settings.api_endpointOptional HTTPS or loopback origin instead of the cloud gateway.
scope.projects or scope.jqlExactly one. JQL is a bounded static expression: no ORDER BY, saved filters, currentUser(), membersOf() or relative-time functions.
scope.issue_types, labels, skip_comment_authorsOptional narrowing (at most 256, 64 and 256 entries).

Issues are identified by numeric ID (jira:<cloud-id>:issue:<id>), so key changes, project renames and moves keep their identity.

Documents

Permissions

Permission snapshots are reused within a run; see source revocation timing.

Under sync the audience of an issue is the intersection of three layers: the project's static Browse holders, the issue's security level and each comment's visibility restriction. Jira users, groups, project roles, project leads, application access and "any logged-in user" holders are resolved to concrete active human accounts; reporter, assignee and user-picker holders add per-issue users.

Jira caseResult
Unsecured issue in a static projectproject container jira:<cloud-id>:project:<id> plus policy groups
Secured or user-dependent issuethe issue's own readers; no container
Comment with group or role visibilitya separate record readable by the matching policy group only
Comment readable only through a reporter, assignee or picker fielddeliberately omitted (under-shared)
Public or anonymous Browserefused under sync; use fixed
Unknown holder type or unknown comment visibilitygrants nobody (under-shared)
Malformed scheme, incomplete member pagethe permission pass fails (failure handling)

User tokens are usr:atlassian.net:<cloud-id>:<accountId>; groups are synthetic policy groups per project, level and visibility target. There is no administrator, creator or author bypass. See corporate identity links for member e-mail handling.

Under fixed the configured readers apply; restricted and unknown-visibility comments are omitted, and no scheme, role, group or directory call is made.

Limits

Edit this page on GitHub ↗