Jira Cloud

GitGuardian provides an integration with Jira Cloud to empower users to synchronize their GitGuardian incidents with Jira Cloud issues. This integration aims to streamline incident remediation processes and strengthen alignment with your Software Development Lifecycle (SDLC).

Benefits

This feature streamlines the process of creating issues from GitGuardian incidents:

• Supports both manual and automatic issue creation upon incident detection.
• Enables issue creation directly in the Jira project linked to the GitGuardian Team.
• Provides customizable templates that utilize Jira custom fields and GitGuardian variables for tailored issue descriptions.
• Includes an auto-resolve feature that automatically closes GitGuardian incidents when the corresponding Jira issues are resolved.

Requirements

The Jira integration uses Jira OAuth and requires installation with a Jira user account possessing these permissions across all projects:

• Manage: Jira-configuration, Jira-webhook
• View: Jira-user, Jira-work
• Update: Jira-work

info

We recommend creating a dedicated Jira user, GitGuardian, for the integration. This prevents issues if the user who set up the integration leaves the company or loses Jira admin access. The reporter for issues in Jira will be the account name used during setup.

Installation

The integration is available on the Integrations > Destinations page, under the Issue Tracking section. Do not confuse it with the Jira Cloud integration for secret scanning.

Authentication with Jira

1. Ensure you're logged into Jira with a user account that meets the requirements.
2. Click Install your first site.
3. If multiple Jira Cloud sites are available, select the desired one for integration.

Repeat this process for multiple Jira sites, if needed. Note that the same Jira site cannot be installed on multiple GitGuardian workspaces.

caution

If you had installed the initial version of our integration (without auto-creation and auto-resolve features), you will need to reinstall to meet additional scope requirements.

Project selection

Select Jira projects for synchronization.

• Choose only projects necessary for GitGuardian.
• Avoid creating overly long project lists to simplify selection during manual issue creation.
• Prevent issues in unrelated projects by refining project choices.

Creating templates and configuring Jira for teams

The integration allows you to create templates for automatic issue creation, tailored to your workspace plan:

• Free Plan Users: One template applicable to all incidents.
• Business Plan Users: Create multiple templates, each assigned to specific teams.

Templates automatically apply to new incidents. A team-specific template is used only for incidents linked to that team. To apply a template across all incidents, associate it with the "All-incidents team".

Template functionality

The templates are automatically generated based on the Jira template defined for the selected issue type.

• Required Fields: Clearly marked as mandatory in the GitGuardian template.
• Optional Fields: Can be added as needed.
• Dynamic UI: Automatically adjusts based on the type of each field.

Supported Jira custom fields

The integration supports the following Jira custom fields:

• Selection Fields: Single/multiple choice, Radio Buttons, Checkboxes
• Date & Labels: Date Picker, Labels
• Text Fields: Single-line, Multi-line
• Special Fields: URL Field, User Picker (single user), Priority

For unsupported fields, contact our support team.

Steps to create a template

1. Begin by adding an integration to the desired team.

   

2. Choose the Jira project and the corresponding issue type for the template.

   

3. Adjust fields as needed and save the template by clicking Add Integration.

   

4. View the configured template under the selected team, including its association with the chosen Jira project.

   

Additional features

Issue update

By default, updates from GitGuardian incidents (e.g., status changes, comments, severity changes) are added as comments in Jira issues. This feature can be disabled.

Auto-resolve

When enabled, specify the Jira status that triggers automatic closure of associated incidents. The incident will be marked as resolved when the Jira issue reaches the defined status.

Note: Reopening Jira issues will not reopen incidents.

Manual issue creation

It is possible to manually create Jira tickets for incidents that were created before the Jira/GitGuardian integration was configured to automatically create tickets for new incidents. Users can do this from either the incident page or the incident list page, provided that a template is assigned to the user’s team.

The Jira issue will be accessible from the incident page.

caution

Bulk issue creation is not supported.

Uninstallation

1. Navigate to Settings > Integrations > Destinations > Jira Cloud.
2. Click Delete in the site configuration panel.
3. Remove the GitGuardian application from your Jira site's profile.

4. Remove access for the GitGuardian app under Apps with access to your accounts.
5. Confirm removal in GitGuardian.

Warning

The GitGuardian app is shared across integrations. Ensure no Jira Cloud site is installed on the platform before removing the app.

Troubleshooting

If issue creation fails, verify:

• Jira integration user permissions.
• Existence of project/issue types in templates.
• Mandatory fields added to Jira projects after template creation.
• Fields in templates that were deleted from Jira.

For assistance, contact support.