Skip to main content

Jira Data Center

GitGuardian provides an integration with Jira Data Center to empower users to synchronize their GitGuardian incidents with Jira Data Center 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.

Installation

  1. Make sure you're logged as an administrator in the Jira Data Center site you want to install
  2. Go to the Profile page Jira Data Center profile
  3. Go to the Personal Access Tokens section and click Create token to create a new PAT Jira Data Center PAT
  4. Provide a Token Name, an optional Expiry date and click CreateJira Data Center PAT form
  5. Copy your new PAT and click CloseJira Data Center PAT copy
  6. The integration is available in the settings under Integrations > Destinations. It's located in the Issue Tracking section at the bottom of the page. Be careful not to confuse it with the Jira Data Center integration for secret scanning. Install1
  7. Paste your Jira Data Center site URL, your Administrator Personal Access Token and click AddInstall2
info

Jira allows the creation of up to 10 PATs. GitGuardian automatically renews PATs before they expire. To do this, you must have at least 2 PAT slots free. Otherwise, an error message will warn you that the integration is no longer functional.

Project selection

Select Jira projects for synchronization.

Project Selection

  • 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.

    Template Creation Step 1

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

    Template Creation Step 2

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

    Template Creation Step 3

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

    Template Visualization

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.

Auto-Resolve

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.

Issue Creation

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 Data Center.
  2. Click Delete in the site configuration panel.

Uninstallation Step

  1. Confirm removal in GitGuardian.

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.