Skip to content
API Reference
Jira logo

Jira

Productivity

Access Jira issues, projects, and workflows

Installing Jira creates a resource for the upstream API and the OAuth provider Keycard needs to mint tokens for it. Your app calls Keycard’s token exchange, gets back a token scoped to Jira, and uses it to call the API directly. Every exchange is governed by your zone’s identity provider, access policies, and audit log - the OAuth client secret stays inside Keycard.

OAuth permissions Keycard requests on install. Override or add scopes in Console.

read:jira-work
default
read:jira-user
default
write:jira-work
default
manage:jira-project
manage:jira-configuration
manage:jira-webhook

Add Jira to your zone so your app can exchange tokens for it.

Step 1 - Start the install in Keycard Console

Section titled “Step 1 - Start the install in Keycard Console”
  1. In your zone’s Keycard Console, go to Resources -> Explore Resources.

  2. Search for Jira and click into the catalog entry.

  3. The install dialog shows a Redirect URI. Copy it - you’ll paste it into Jira in Step 2. Leave this Keycard tab open.

  1. Go to the Atlassian Developer Console
  2. Click CreateOAuth 2.0 integration
  3. Enter a name for your integration
  4. Click Create
  1. Go to Permissions in your app settings
  2. Find Jira and click Add
  3. Configure the scopes:
    • read:jira-work - Read Jira project and issue data
    • read:jira-user - Read user information
    • write:jira-work - Create and edit issues
  1. Go to Authorization in your app settings
  2. Click Add next to OAuth 2.0 (3LO)
  3. Enter the redirect URI provided by Keycard as the Callback URL
  1. Go to Settings in your app
  2. Note the Client ID and Secret

Step 3 - Finish the install in Keycard Console

Section titled “Step 3 - Finish the install in Keycard Console”
  1. Switch back to the Keycard install dialog you left open in Step 1.

  2. Paste the Client ID and Client Secret from Step 2.

  3. Click Add Jira. The resource is provisioned and your app can start exchanging tokens for it.

Call Jira from your application with a Keycard-issued token scoped to this resource.

After installing Jira, your application exchanges a Keycard-issued access token for a token scoped to this resource. Pass the user’s access token as the subject_token.

from keycardai.oauth import Client, BasicAuth, TokenType
import requests
# Exchange the user's Keycard token for a Jira token.
with Client(
"https://<zone-id>.keycard.cloud",
auth=BasicAuth("<your-client-id>", "<your-client-secret>"),
) as client:
response = client.exchange_token(
subject_token=user_access_token,
subject_token_type=TokenType.ACCESS_TOKEN,
resource="https://api.atlassian.com/ex/jira",
)
# Call Jira directly with the exchanged token.
r = requests.get(
"https://api.atlassian.com/ex/jira/<endpoint>",
headers={"Authorization": f"Bearer {response.access_token}"},
)

See the OAuth SDK → Token Exchange reference for the full client API.

Common errors when wiring Jira into your zone.

Empty accessible-resources response

The user hasn’t granted access to any Atlassian sites. During the OAuth consent flow, ensure you select at least one site. If re-authorizing, you may need to revoke and re-grant access.

Error 401: Unauthorized

The token is invalid or expired. Atlassian tokens expire after a short period. Reconnect the provider in Keycard Console - Keycard will handle the refresh if a refresh token was issued.

Error: consent_required

The app’s permissions were updated after the user last authorized it. The user needs to re-authorize to grant the new scopes. Remove the provider connection and connect again.

What to do once Jira is installed.

Now do this

Recommended

  • Decide who can use it - write access policies scoped to the Jira resource so only the right users and apps reach the API.
  • Watch the calls - every token exchange and downstream call lands in your audit log with user identity, resource, and policy decision.

Optional

  • Add MCP access too - install the Atlassian MCP server for AI agents that need Jira’s tools, not just the REST API.