Safeguard Docs
Integrations

Jira

Create and sync Jira issues from Safeguard. The Jira permissions and API token scopes Safeguard needs, which tokens work, and step-by-step setup.

What it does

The Jira card connects Safeguard to one Jira Cloud project. Safeguard creates Jira issues for the findings and work you send to Jira, updates them, and moves them through your workflow using the status mapping you set (new, in progress, under review, completed). It checks the issues it created every few minutes to pick up changes made in Jira. Find the card under Integrations on the Notification tab.

Public vs private

This does not apply to Jira: you always connect your own Jira Cloud site with an account's API token. Jira Data Center is not supported yet.

Supported auth methods

MethodUse it whenNotes
Atlassian API token (classic, unscoped) with the account emailRecommended defaultEnter your Jira site address, such as https://your-site.atlassian.net
Atlassian API token with scopesYou want the token limited to the Jira scopes belowAtlassian requires scoped tokens to be used through https://api.atlassian.com/ex/jira/<cloudId>, so enter that address as the site
OAuth (sign in with Atlassian)Not available yet

Permissions required

Safeguard reads projects and statuses, and creates and updates issues in the project you choose. It never deletes issues, projects or users. The token acts as its account, so the account's Jira permissions decide what works.

Jira permissions of the account

Jira permissionRequired?What Safeguard uses it for
Browse projectsRequiredListing projects, reading the project's statuses, and reading the issues it created
Create issuesRequiredCreating issues
Edit issuesRequiredUpdating the issues it created
Transition issuesRequiredMoving issues to the mapped status
Browse users and groups (global permission)OptionalFinding the Default Assignee by email. Without it, the search returns no one
Assign issuesOptionalSetting the Default Assignee on new issues

API token with scopes

ScopeRequired?What Safeguard uses it for
read:jira-userRequiredChecking the token (/rest/api/3/myself) and finding the default assignee
read:jira-workRequiredListing projects and statuses, and reading issues
write:jira-workRequiredCreating, updating and transitioning issues

Least privilege: a dedicated Jira account with the project permissions above on the one project, and a token with those three scopes.

Token types

Token typeWorks?Notes
API token without scopesYesActs with the full Jira permissions of its account, limited by the project's permission scheme
API token with scopes (Jira app)YesUse the api.atlassian.com/ex/jira/<cloudId> address as the site
Your Atlassian passwordNoJira Cloud's REST API takes an API token
Jira Data Center personal access tokenNoData Center is not supported yet
Service accountYesA token of a dedicated Atlassian account works the same way

Expiry: Atlassian API tokens expire after 1 to 365 days (one year by default). When the token expires, issue creation and sync stop until you paste a new one.

What we never need: Jira administrator permissions, delete permissions, manage:jira-configuration or any admin scope.

Step-by-step setup

Create the credential in Atlassian

  1. Open the API tokens page of your Atlassian account (https://id.atlassian.com/manage-profile/security/api-tokens).
  2. Select Create API token (or Create API token with scopes, choose Jira, and select the three scopes above).
  3. Enter a name and an expiration date, select Create, and copy the token. Atlassian shows it only once.

Or check it with curl

Atlassian has no CLI for creating API tokens. To check a token the way Safeguard does:

curl -s -u 'you@example.com:<api-token>' https://your-site.atlassian.net/rest/api/3/myself
curl -s -u 'you@example.com:<api-token>' "https://your-site.atlassian.net/rest/api/3/project/search"

Connect it in Safeguard

  1. Open Integrations and choose the Notification tab.
  2. Click Connect on the Jira card.
  3. Enter a Name. Under Where does Jira run?, keep Cloud and enter your Site URL.
  4. Paste the token into Jira Token and enter the account email under Username. Optionally enter a Default Assignee email and a Description.
  5. Click Next. "Jira connection validated successfully" means Jira accepted the token. Choose the project under Select Project.
  6. Under Status Mapping, map Safeguard's states to your Jira statuses, then click Connect.

Webhooks and triggers

This card has no webhooks to set up. Safeguard pushes changes to the issues it created and checks those issues in Jira every few minutes to pick up status and field changes.

What we read and store

  • Read: the token's account, your projects, the chosen project's statuses, user search results for the default assignee, and the issues Safeguard created.
  • Stored: the connection's settings, project and status mapping, links between Safeguard items and Jira issues, and the API token, which is encrypted at rest.
  • Sent to Jira: issue titles, descriptions and status changes about your Safeguard findings.
  • No customer data from this integration is sent to third-party LLMs.

Troubleshooting

Message you seeCauseFix
Failed to validate Jira connectionSafeguard could not reach the siteCheck the Site URL
Jira's own error text, shown as is (for example an authentication error)Jira refused the email and tokenUse the account email as Username and a current API token
Jira answered with a redirect, which Safeguard does not follow. Enter the site's current address.The site moved or was renamedEnter the current https://<site>.atlassian.net address
This server address isn't allowed: ...The address is not an Atlassian Cloud siteEnter your atlassian.net site, or the api.atlassian.com/ex/jira/<cloudId> address for a scoped token
No projects foundThe account cannot browse any project, or a scoped token lacks read:jira-workGrant Browse projects, or add the scope
Issues are not created or do not moveThe account lacks Create issues, Edit issues or Transition issues on the projectAdd the permissions in the project's permission scheme

Rotation and disconnect

  • Rotate: create a new API token, open the Jira connection on the Notification tab, choose Update, paste the new token and save. Then revoke the old token on the Atlassian API tokens page.
  • Disconnect: choose Delete on the connection, then revoke the token in your Atlassian account. Issues already created stay in Jira.

Vendor references

On this page