Jira Cloud
GitGuardian provides an integration with Jira Cloud, designed to empower our users to synchronize their GitGuardian incidents with Jira Cloud issues. The primary goal of this integration is to streamline their incident remediation processes and strengthen our alignment with their Software Development Lifecycle (SDLC).
Benefits
- Facilitates the creation of issues from GitGuardian incidents.
- Allows for manual issue creation or automatic issue creation upon incident detection.
- Create issues directly in the Jira project associated with the GitGuardian Team.
- Customizable templates leveraging Jira custom fields and GitGuardian variables.
- Auto-resolve feature that closes GitGuardian incidents when related Jira issues are closed.
Requirements
The Jira integration utilizes Jira OAuth. Additionally, you need to install it with a Jira user account that has at least the following permissions across all projects on your Jira site:
- Manage: Jira-configuration, Jira-webhook
- View: Jira-user, Jira-work
- Update: Jira-work
We recommend creating a dedicated Jira user 'GitGuardian' specifically for this integration. This helps prevent any issues if the user who performed the setup leaves the company or loses their admin access in Jira. Additionally, the reporter of the issues in Jira will be the name of the person who set up Jira. If you've been using a Jira user named 'GitGuardian', the issues will be reported by 'GitGuardian'.
The GitGuardian Jira integration is exclusively compatible with Jira Cloud. Currently, we do not support Jira Data Center.
Installation
The integration is available in the Integrations page. It's located in the Issue Tracking section at the bottom of the page. Be careful not to confuse it with the Jira Cloud integration for secret scanning.
Authentication with Jira
- Make sure you're connected in Jira using the GitGuardian account with enough permission - cf Requirements
- Click on
- If you have several Jira Cloud site available with your user, select the one you want to connect with GitGuardian.
You can repeat this process as many times as you want. There's no limit to the number of Jira sites you can install. Just remember, you can't install the same Jira site on multiple GitGuardian workspaces.
If you have installed our initial version of the Jira integration (lacking the automatic creation and auto-resolve features), you'll need to reinstall it to accommodate the additional scope requirements.
Projects selection
Select the Jira projects for synchronization.
We recommend selecting only the projects necessary for GitGuardian. The list of chosen projects will be visible in the issue creation form. Additionally, it's advisable to avoid:
- Including a very long list, which may complicate project selection - especially for manual creation
- Risking the creation of issues in projects unrelated to the GitGuardian incidents.
Manual creation of issues from GitGuardian
Issues can be created from the incident page or incidents list page.
In the creation form, you need to:
- Select the Jira project where the issue will be created
- Choose the issue type from this project
- Then the form provides you with all the fields related to this specific issue type of the selected project
Default fields include:
- Title
- Description
- Labels
- Assignee
- Any mandatory custom fields in Jira.
Additional Jira custom fields can be added - The feature support the following Jira custom fields:
- Short text
- Paragraph
- Labels
- Dropdown
- Checkbox
- People
- URL
After creation, the Jira issue becomes visible on the incident page for quick access.
Bulk issue creation from the incidents table is not supported.
Automatic template
The GitGuardian Jira Cloud integration offers the ability to create templates for automatic issue creation. Workspaces under the Free plan can create a single template applied to all incidents. Workspace under Business plan and business trial can create templates per team.
The template functions identically to manual creation, automatically applying to all newly generated incidents from your dashboard. If you've created a template for a specific team, only incidents linked with that team will be pushed to the corresponding Jira project.
If you want the template to apply to all incidents, use it in the 'all-incidents team'. If you prefer to send incidents from a specific team to a particular Jira project, create the template within that team. You can set this up in the global integration settings or directly from the team's alerting section.
The automatic issue creation is currently only available for incidents that originate from a VCS
Additional features
At the bottom of the creation/template form, you'll find some options that can be activated.
Issue update
By default, we automatically push the updates from the GitGuardian incident (up to 10 new occurrences, status changes, comments, severity changes, assignation) as comments in the Jira issue. You can deactivate this feature by unchecking the option.
Auto-resolve
We provide an automatic closure feature for GitGuardian incidents. When activated, you'll need to specify the closed status that should be considered to resolve the incident in Jira. When the issue will reach this status, we'll mark the associated incident as Resolved and consider the secret as revoked.
It's important to note that we won't reopen the incident if the issue is reopened.
How to uninstall
- Navigate to the integrations page: Settings > Integrations,
- Click on the button on the top right of the Site configuration panel,
- You'll be asked to remove the GitGuardian application in your Jira site's profile - a link is provided. This is mandatory in order to properly remove the integration,
- Click for the GitGuardian App in the Apps with access to your accounts section,
- Get back to GitGuardian and click Yes. It's over!
The GitGuardian app is shared with the Jira Cloud ticketing integration. Removing the app from your Jira Cloud site will break any existing integration in the GitGuardian platform. Make sure your Jira Cloud site is no longer installed on the GitGuardian platform before removing the GitGuardian app manually.
Troubleshooting
Several issues can occur with your Jira integration, particularly regarding the automatic template. If a template is broken, we'll promptly display it in the user interface when an issue creation fails. To resolve the problem, please consider the following:
- Check user permissions for the Jira integration setup.
- Ensure project/issue types used in templates still exist.
- Check for any newly added mandatory fields in Jira projects. Update the GitGuardian template accordingly.
- Check for fields used in the templates that have been deleted from the Jira issue type.
Was this page helpful?
