Integrating StorageGuard with Atlassian Jira

[ Applies to ] StorageGuard 9.x and later   /   Jira Software Cloud, Jira Service Management Cloud   /   ITSM Systems interface

StorageGuard can open, update, and close issues in Atlassian Jira Software and Jira Service Management for the risks it finds, so your team can triage StorageGuard findings in the same projects and workflows it already uses. This article explains how to import the StorageGuard Jira connector, point it at your Jira site, choose how risks are forwarded, and confirm that issues are created.

Before you begin

Make sure you have the following:

• A StorageGuard account with administrative privileges.
• A Jira account for the integration. We recommend a dedicated service account rather than a personal account, so the integration keeps working when people change roles.
• Permissions for that account in the target Jira project to browse the project and to create, edit, and transition issues.
• The project key of the target Jira project and the exact name of the issue type StorageGuard should create. The issue type must be available in that project.
• An Atlassian API token for the integration account. See the procedure below.
• Outbound HTTPS (port 443) access from the StorageGuard master server to your Jira site.
• The StorageGuard Atlassian Jira Connector JSON file attached to this article.

Create an Atlassian API token

StorageGuard authenticates to Jira with the integration account's email address and an API token instead of a password.

1. Sign in to id.atlassian.com with the integration account.
2. Go to Profile > Account settings > Security.
3. Under API tokens, click Create and manage API tokens.
4. Click Create API token, enter a label such as StorageGuard Integration, set an expiration date if prompted, and create the token.
5. Copy the token and store it somewhere secure, such as your organization's password manager.

Configure the StorageGuard Jira connector

The connector file contains a ready-made Jira provider with placeholder values. You import it once, then replace the placeholders with your own Jira details.

Import the connector

1. Download the StorageGuard Atlassian Jira Connector JSON file attached to this article.
2. Log in to StorageGuard with an administrative account.
3. Go to Settings > Interfaces > ITSM Systems.
4. In the top-right corner, click Import ITSM Provider and select the JSON file you downloaded. A new Jira provider appears in the list.
5. Right-click the Jira provider and select Edit.

Enter the integration credentials

6. Under Authentication:
   • In the User field, replace user@company.com with the email address of the Jira integration account.
   • In the Password field, paste the API token you created.

Point the connector to your Jira project

7. Under API Calls - Global, in the Host field, replace yourcompany.atlassian.net with your Jira site host name, in the same format as the placeholder.
8. Under API Calls - Open and API Calls - Update, in each Body field:
   • Replace SGPRJ with your target Jira project key.
   • Replace SG-Risk with your target issue type name.

Choose how risks are forwarded

9. Choose a forwarding mode:
   • Automatic: Select Automatic sending mode. Optionally, add risk forwarding filters so only matching risks are sent, for example by severity, label, system type, or CI group.
   • Manual: Leave Automatic sending mode cleared. Users send individual risks with Send to ITSM from the Risk view.

Enable the provider

10. Select the Enabled checkbox to activate the provider.
11. Click Apply to save your changes.

Summary of values to replace

Verify the integration

Send one risk to Jira manually to confirm that the connector works:

1. Go to Baseline Configuration > Risks and double-click an open risk.
2. On the Activity tab, click Send to ITSM System and select Atlassian JIRA.
3. In Jira, open the target project and confirm that a new issue was created with the expected issue type, summary, and priority.

If no issue appears, see Troubleshooting.

Keep Jira issues in sync

By default, StorageGuard only opens issues. You can also have it update and close them as findings change. Both settings are under Risk Handling in the provider settings.

Update Jira issues automatically

To update the Jira issue whenever the related StorageGuard finding changes, select Send Update Events.

Close Jira issues automatically

To close the Jira issue when the related StorageGuard finding is closed:

1. Select Send Close Events.
2. Under API Calls - Close, in the Body field, enter the ID of the Jira workflow transition that closes the issue.

curl -u integration@company.com:<API_TOKEN> \
  -H "Accept: application/json" \
  "https://yourcompany.atlassian.net/rest/api/3/issue/SGPRJ-123/transitions"

Customize what StorageGuard sends to Jira

API call bodies

The Body fields in API Calls - Open, API Calls - Update, and API Calls - Close control which fields StorageGuard sends to Jira and what they contain. Click the (i) icon next to a field to see the template variables you can use.

Priority and severity mapping

Use Priority Field Customization and Severity Field Customization to map StorageGuard priority and severity values to the values your Jira project uses.

Troubleshooting