Jira Ticketing

To manage vulnerabilities through Jira tickets, head to the integrations page.

Configuration¶

Create a new Jira integration¶

1. Go to the Integrations page page from the left navigation menu.
2. Click on the Jira integrations card from the Ticketing section at the bottom of the page.
3. Click on + Create new integration to access the Jira integration creation page.
4. Fill in the form with the following information:
   • Name: Give your integration a name to help you identify it later.
   • Jira instance's URL: This is the url prefix you use to access your JIRA tickets in your browser (e.g. https://\.atlassian.net). You can find this information in your browser's address bar when accessing Jira.
   • Jira API key: Generate an API token from your Jira account and copy it. For more details, refer to the Atlassian's guide on API tokens.
   • Jira account email: The email used by your Jira account to generate the API token.
5. Click on Validate Credentials to verify your Jira connection.
6. Once validated, you can configure templates to automate issue creation:
   • Template Name: A descriptive name for your template.
   • Project: Select the Jira project where issues will be created.
   • Issue Type: Select the type of issue to create (e.g., Bug, Task).
   • Property Mapping: Map Escape properties to Jira fields:
     • Escape Property: Select a property from Escape (e.g., Severity).
     • Level: For severity, select which severity level this mapping applies to.
     • Jira Field: Select the Jira field to map to.
     • Value: For select fields, choose the specific value to use.
7. Click on Connect with JIRA to create your Jira integration.

To find your organization name, go to the Atlassian administration page > Click on Settings, then search for "Organization name".

Edit a Jira integration¶

1. Go to the Integrations page page from the left navigation menu.
2. Click on the Jira integrations card from the Ticketing section at the bottom of the page.
3. Click on the Edit (Pen) Icon button of the integration you want to edit at the right of the integration line.
4. Update the fields you want to change.
   • Note: When editing an existing integration, the Jira instance URL, API key, and account email fields cannot be modified.
   • You can add, edit, or remove templates and their property mappings.
5. Click on Update JIRA Integration to save your changes.

Delete a Jira integration¶

1. Go to the Integrations page page from the left navigation menu.
2. Click on the Jira integrations card from the Ticketing section at the bottom of the page.
3. Click on the Delete (Trash) Icon button of the integration you want to delete at the right of the integration line.

Templates¶

Templates allow you to define how issues are created in Jira based on vulnerabilities found in Escape. Each template includes:

• A project and issue type selection
• Property mappings that define how Escape data is mapped to Jira fields

Property Mappings¶

Property mappings let you customize how Escape data is translated to Jira fields:

• Severity Mapping: Map different severity levels (Critical, High, Medium, Low, Info) to specific Jira fields and values (By default, Jira uses a Priority field to manage severity).
• Other Escape Properties: Currently, Severity is the only available property for mapping. Additional properties will be added in future updates to enhance integration capabilities.

Usage¶

Once configured, you can create new Jira tickets directly from the Ticketing sidepanel sub-tab on any issue from the following pages:

• Scan alert
• Issue alert
• Compliance alert

To create a Jira ticket for a vulnerability:

1. Navigate to an issue in any of the pages listed above
2. Open the Ticketing sidepanel
3. Select your Jira integration from the dropdown menu
4. Select a template to use for ticket creation (templates must be configured in advance)
5. Click Create Ticket to generate a Jira issue for the vulnerability

If no templates have been configured for your integration, you'll need to add at least one template before you can create tickets.