Install: TruSTAR for Jira

Updated 2 months ago by Elvis Hovor

This document explains how to install and configure the TruSTAR Workflow App for Jira Cloud and Jira Enterprise.

Time to Install: 30 minutes

How TruSTAR Works with Jira

With the TruSTAR Workflow App, you can automatically or manually send Jira issues to TruSTAR for enrichment. Any information, such as deep links, priority Indicators, or correlated Indicators, found in TruSTAR is loaded back into the Jira issue for deeper investigation. 

To keep information in sync between Jira and TruSTAR, you can configure the TruSTAR App to automatically submit new Jira issues to create TruSTAR Reports, update both Jira issues and TruSTAR Reports, and delete TruSTAR Reports when you delete a Jira issue.

Components

TruSTAR offers two Workflow Apps for Jira, depending on the type of Jira installation you have:

  • Jira Cloud
  • Jira Server (Enterprise)

Installing on Jira Cloud

Requirements

To install the plug-in for Jira Cloud, you need:

Installation Procedure

  1. Connect to the Atlassian Marketplace website from the Atlassian administration console.
  2. Navigate to Jira Settings, then Add-ons-> Find New Add-Ons.
  3. Enter TruSTAR in the search box. 
  4. Download the App and install it.

Accessing the Configuration Settings

  • Go to Jira Settings, then Add-Ons, then Manage Add-Ons.
  • Select TruSTAR Jira Cloud, then click Configure
Jira_Install_Figure1

Installing on Jira Server

Requirements

To install the plug-in for Jira Server, you need:

Installation Procedure

  1. Connect to the Atlassian Marketplace website from the Atlassian administration console.
  2. Select the Find New Add-ons link from the Settings drop-down menu.
    Jira_Install_Figure2
  3. Enter TruSTAR in the Search the Marketplace box.
  4. Click Install for TruSTAR in the search results.

Accessing the Configuration Settings

  • Select TruSTAR Configuration in the Manage Add-ons section.
Jira_Install_Figure3

Configuring the App

After you install the TruStar App, you are ready to configure it for use.

The Parameters page is where you supply the details that the TruSTAR App requires in order to work with your TruSTAR Enclaves.

You must have Administrator permissions to configure the TruSTAR Workflow App in Jira. 
Jira_Install_Figure4

Parameter

Required

Description

TruSTAR URL

Yes

The TruSTAR Web App URL from which data is collected by executing API calls. Set this parameter to https://station.trustar.co 

API Key

Yes

Used to make API calls. Finding your API Key

API Secret

Yes

Used when making API calls. Finding your API Secret

Enclave IDs 

Yes

The TruSTAR Enclave IDs where your submitted Jira issues are created as TruSTAR Reports.To use multiple Enclaves, separate each Enclave ID with a comma and no spaces:

Retrieving Enclave IDs

Fields

No

Custom fields to be included in the TruSTAR Report. By default, status and key are included.

To specify multiple fields, separate fields with commas. For example, id,summary,status,comments

Excluded Projects

No

Issues with project keys listed here will not be submitted to TruSTAR. To specify multiple projects, separate the project keys with commas. Leave this field blank to submit all Jira issues to TruSTAR. 

Jira Final Status

No

If you supply a value here, then when a Jira issue is changed to this status, that issue is synced one final time with the related TruSTAR Report. For example, if you used “Closed” as the final status for your JIRA issues, then supplying the value “Closed” here will ensure the issue is synced one last time with TruSTAR. 

Auto Submission

No

Automatically sends Jira Issues to TruSTAR.Note: If the Jira issues is in an Excluded Project, it will not be submitted to TruSTAR.

Proxy Setup

No

If you use a proxy, you must specify the following information: 

  • IP/Hostname (do not include http/https)
  • Port

Best Practices

To optimize using the TruSTAR App with Jira, here are some suggestions. 

  • Create an email account specifically for use with TruSTAR (ex: soc_trustar_jira_integration@customercompany.com).
  • Create a TruSTAR Web App account tied to that email address. You will need access to that email account so you can open the account verification email TruSTAR will send to it.  Your JIra instance will use this TruSTAR account’s API credentials. 
  • Check that the the TruSTAR Web App URL is not blocked by your firewall or proxy rules. The URL is station.trustar.co.
  • Check your TruSTAR API limits.. You can see these limits listed under your API Key in the TruSTAR Web App.
  • Avoid importing from more Enclaves than you need to, as each one takes time to process.


How Did We Do?