← Integrations

Jira Cloud

Read and create issues and projects in a user's Jira Cloud site.

View on GitHub →

How to use it

This profile ships with Kirak. Add "integrations" to modules in kirak.json, then name the profile as below. There is nothing to download, and a copy in your project's integrations/ folder is an error.

Environment variables

VariableHolds
KIRAK_INTEGRATION_JIRA_CLIENT_SECRETThe OAuth client secret from the vendor's console. Secret: keep it out of kirak.json and out of source control.
KIRAK_AUTH_ENCRYPTION_KEYSEncrypts stored tokens. Shared by every integration; the module refuses to start without it.

The names follow the integration's name in kirak.json (jira here). Name it something else, such as jira_sales, and the variables change to match.

Redirect URL

Register this as the redirect (callback) URL in the vendor's console, with your app's address in place of <your-app> (the base_url in kirak.json):

https://<your-app>/integrations/jira/callback

How to get your keys

  1. Open the Atlassian developer console and choose Create > OAuth 2.0 integration.
  2. Under Permissions, add the Jira API and the scopes your app needs. At least: read:jira-work (Read Jira projects, issues and fields), offline_access (added by Kirak so it gets a refresh token)
  3. Under Authorization, choose OAuth 2.0 (3LO) and set the callback URL to https://<your-app>/integrations/jira/callback.
  4. Under Settings, copy the client ID and the secret.
  5. Put the client ID in kirak.json as integrations.providers.jira.client_id, and the client secret in the environment as KIRAK_INTEGRATION_JIRA_CLIENT_SECRET. Never put the secret in kirak.json.

The vendor's own guide · Instructions out of date? ·Suggest an edit

kirak.json

Scopes
{
  "integrations": {
    "providers": {
      "jira": {
        "type": "oauth2",
        "profile": "jira",
        "client_id": "your-client-id",
        "scope": [
          "read:jira-work"
        ]
      }
    }
  }
}

Merged into the profile: scope replaces the profile's default scopes, and offline_access is always added so Kirak gets a refresh token.

Good to know

  • The site is the first accessible resource the user granted; with several sites, the first is used.
  • Each refresh returns a new refresh token that replaces the old one.
  • Not verified against the vendor docs in this session: check the facts before release.

Help improve this profile

Report a problem ·Suggest an edit to profile.json ·Add a profile ·Vendor docs the profile was checked against

Product names and logos are trademarks of their respective owners. Their use does not imply endorsement. To ask for this icon to be removed, email trademark@kirak.io.

Ask about Kirak on