Jump to a Section

Overview

Before connecting Jira Software to Okta Workflows, ask your Jira administrator to turn on the Accept Remote API calls option on the System Admin screen.

For information about configuring Jira API Tokens, click here.

Note: You can create multiple connections and manage them from your Settings page.

To create a new connection from an Event or Action card:

  1. Click New Connection.
  2. Enter an Connection Nickname. Make this nickname unique so you can authorize multiple Jira accounts.
  3. Enter your Username and API Token.
  4. Enter your Instance URL without the “https//:“. (For example, “yourcompany.atlassian.net”)
  5. Click Create to save your configuration.

Note: If you revoke or delete your Jira API Token, you must create a new token and update all of your connections to use the new token (refer to View and Manage Connections). Jira automatically locks you out of the API if four calls are made with old or incorrect passwords/tokens. If any active flows attempt to use your old token, all calls will fail (including those that use the correct credentials). You’ll have to change your password to regain API access.

    Events

    • Issue Deleted

      Trigger a flow when an issue is deleted in Jira. The outputs on this card are retrieved dyanmically from Jira and will change depending on your Jira implementation.

      Outputs

      • Webhook
        • Raw Data (object): raw webhook data for the issue
      • Issue
        • Issue ID (text): ID of the issue
        • Self (text): URL to the issue
      • Context
        • Execution ID (text): unique identifier for the execution of the flow
    • Issue Transitioned

      Trigger a Flow when an issue’s status is changed in JIRA.

      Unless otherwise indicated, field types are text.

      Options

      • Project (drop-down): project to monitor for transitioned issues
      • JQL Query: JQL query to indicate which issues will trigger the flow

      Output

      • Webhook
        • Raw Data (object): raw webhook data for the issue
      • Issue
        • Issue ID: ID of the issue
        • Self: URL to the issue
      • Transition
        • Transition ID (number): ID of the transition
        • From: original status of the issue
        • To: new status of the issue
      • User
        • Account ID: account ID of the user who made the transition; to obtain the account ID, you can perform a search by email address using the Search Users card, or note the last ID from the profile page. For example, in the URL https://oktainc.atlassian.net/jira/people/5d0c7af1ac9cfa0bc6eed1c7, the account ID is 5d0c7af1ac9cfa0bc6eed1c7.
        • Display Name: display name of the user who made the transition
        • Active (true/false): indicator iff the user is active
        • Email: email address of the user who made the transition
      • context
        • Execution ID: unique identifier for the execution of the flow

      Note: You can select additional Jira fields as outputs.

    • Issue Updated

      Trigger a Flow when an issue is updated in Jira.

      Unless otherwise indicated, field types are text.

      Options

      • Project (drop-down): project to monitor for new issues
      • JQL Query: JQL query to indicate which issues will trigger the flow

      Output

      • Webhook
        • Raw Data (object): raw webhook data for the issue
      • Issue
        • Issue ID: ID of the issue
        • Self: URL to the issue
      • context
        • Execution ID: unique identifier for the execution of the flow
    • New Issue

      Trigger a flow when a new issue is created in Jira.

      Unless otherwise indicated, field types are text.

      Options

      • Project (drop-down): project to monitor for new issues
      • JQL Query: JQL query to indicate which issues will trigger the flow

      Output

      • Webhook
        • Raw Data (object): raw webhook data for the issue
      • Issue
        • Issue ID: ID of the issue
        • Self: URL to the issue
      • context
        • Execution ID: unique identifier for the execution of the flow

    Actions

    • Create Issue

      Create a new issue in Jira.

      Unless otherwise indicated, field types are text.

      Options

      • Project (drop-down): list of existing projects in your JIRA account; select All Projects to enter the project name as an input
      • Issue Type (drop-down): type of issue to create; select All Issue Types to use the issue type as an input

      Input

      Input fields are dynamically generated from your Options selections.

      • Project: project you selected in the Projects drop-down
      • Fields
        • Issue Type: type of issue you selected in the Issue Type drop-down
        • Summary: summary of the issue
        • Components (list of text): Container or subsection of the project, used to group issues. Setting a default assignee for a component will override the project’s default assignee.
        • Description: description of the issue; to send an email to a user, mention them (@ + accountId) here

      Output

      • Issue
        • Key: issue key or identifier
        • Issue ID: unique ID of the issue
        • URL: URL of the issue
        • API Resource URL: URL directing to the API resource
    • Custom API Action

      Make a custom, authenticated HTTP call to the Jira API.

      Options

      • Request Type (dropdown): use the appropriate request type depending on the endpoint/method
        • GET
        • POST
        • PUT
        • PATCH
        • DELETE

      Input

      • Relative URL (text): Specify the relative URL as /api/v2/{insert_remaining_URL}. You can specify query parameters in the relative URL using “?”, or specify the query parameters as an object key pair in the Query input.

        Example: https://{{auth.instance}}{{input.Request.Relative URL}}

      • Query (object): Specify any additional query parameters that should be included in object format (key value pairs).

      • Headers (object): Specify any headers required in addition to authorization or content-type (these are already handled by this connector).

      • Body (object): Specify a request body in JSON format. Only available for POST, PUT, and PATCH requests.

      Output

      Response

      • Status Code (number): success or failure of your HTTP request. Here is a list of all status codes.
      • Headers (object): a detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will usually be a replica of the example below.

        Example: {"Content-type":"application/json"}
      • Body (object): data returned from your selected HTTP request (for example, the data from a GET request).

    • Delete Issue

      Delete an issue in Jira.

      Input

      Output

      • Response
        • Status Code (number): status of the attempt (status codes are defined here)
    • List Issues

      List all issues in a Jira project.

      Options

      • Project (drop-down): List of existing projects in your JIRA account. Select All Projects to enter the project name as an input.
      • Issue Type (drop-down): Type of issue to create. Select All Issue Types to use the issue type as an input.

      Note: Choose All Projects or All Issue Types to run different types each time the flow is executed.

      Input

      • Options
        • Limit (number): maximum number of issues to retrieve
        • Offset (number): number of issues that will be skipped before returning the list of issues

      Output

      • Result
        • Issues (list of objects): list of the issues found in the project
    • Read Issue

      Read an issue in Jira.

      Unless otherwise indicated, field types are text.

      Options

      • Project (drop-down): list of existing projects in your JIRA account; select All Projects to enter the project name as an input
      • Issue Type (drop-down): type of issue to create; select All Issue Types to use the issue type as an input

      Input

      Output

      • Issue
        • Issue ID: unique ID of the issue
        • Self: URL to the issue
        • Key: unique key of the issue
    • Search Issues

      Search for an issue in Jira.

      Unless otherwise indicated, field types are text.

      Options

      • Project (drop-down): List of existing projects in your JIRA account. Select All Projects to enter the project name as an input.
      • Issue Type (drop-down): Type of issue to create. Select All Issue Types to use the issue type as an input.
      • Result Set (drop-down): all match issues or the first match that is found

      Input

      • Options
        • Offset (number): Offset for the results. If the card finds 50 issues and you want to return the last 20, your offset is 30 and your max result is 20.
        • Max Results (number): maximum number of results to return
      • Search By
        • Assignee: assignee of the issue
        • Category: category of the issue
        • Comment: comment on the issue
        • Created: timestamp when the issue was created
        • Creator: username of the user who created the issue
        • Description: description of the issue
        • Due Date: date when the issue is due
        • Last Viewed: last time the issue was viewed

      Output

      • Issue
        • Key: key of the issue
        • Issue ID: unique ID of the issue
        • API Resource URL: URL of the API resource for the issue
        • URL: URL of the issue
    • Search Issues by JQL

      Use a Jira Query language (JQL) query to get a list of issues in Jira.

      Options

      • Enviroment (drop-down): environment where the Jira instance is hosted (On-Premise or Cloud)

      Input

      • Search By
        • JQL Query (text): JQL query to determine the issues returned
        • Limit (number): maximum number of issues returned
        • Offset (number): offset for the list of issues returned

      Output

      • Result
        • Issues (lists of objects): issues returned by the query
        • Key (text): unique issue key
        • Issue ID (number): unique ID of the issue
        • URL (text): URL of the issue
        • API Resource URL (text): URL to the API resource for the issue
    • Transition Issue

      Change the status of an issue in Jira.

      Unless otherwise indicated, field types are text.

      Input

      • Transition
        • Issue ID or Key: ID or key of the issue
        • Transition To: new status of the issue (In Progress, To Do, or Done)
        • Comment: comment about the issue

      Output

      • Response
        • Status Code (number): status of the attempt (status codes are defined here)
    • Update Issue

      Update an issue in Jira.

      Unless otherwise indicated, field types are text.

      Options

      • Project (drop-down): List of existing projects in your JIRA account. Select All Projects to enter the project name as an input.
      • Issue Type (drop-down): Type of issue to create. Select All Issue Types to use the issue type as an input.

      Note: Choose All Projects or All Issue Types to run different types each time the flow is executed.

      Input

      Input fields are dynamically generated from your Options selections. If you do not provide the project name or the issue type as an option, enter them here.

      • Issue
      • Fields
        • Issue Type: type of issue you selected in the Issue Type drop-down
        • Summary: summary of the issue
        • Components (list of text): Container or subsection of the project, used to group issues. Setting a default assignee for a component will override the project’s default assignee.
        • Description: A description of the issue. To send an email to a user, mention them (@ + accountId) here.

      Output

      • Response
        • Status Code (number): status of the attempt (status codes are defined here)