Snyk Security in Jira Cloud integration
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
Snyk Security in Jira Cloud helps developers identify, prioritize, and triage security vulnerabilities related to their code repositories directly from the Jira interface.
The Snyk Security in Jira Cloud integration mirrors your Snyk scan results from the Snyk platform to Jira. You can view Snyk results in your native Jira environment and create Jira issues for your results as needed. You can see which Snyk Organizations are connected and which Snyk Targets are associated with your Jira projects.
Snyk Security in Jira Cloud is a Jira app.
To install and configure the Jira app, you must be a Jira Cloud administrator in the site-admins, administrators, or jira-administrators group. Contact your IT team to support your effort in installing the Snyk Security in Jira Cloud app.
To connect the Jira app to Snyk, you must be a Snyk Organization administrator.
To activate Security in Jira Cloud in Jira, navigate to Project Settings > Features > Development > Security and toggle Security ON.
Ensure you have the following permission scopes in Jira, which are required for the integration to operate.
Write data to the host application
Synchronize vulnerabilities in Snyk with Jira so they appear in the Security tab in Jira.
Read data from the host application
Read vulnerabilities from Jira to optimize the issues synchronization process.
Delete data from the host application
Remove vulnerabilities from Jira when a Snyk Organization is removed from Jira.
To add containers, you must have the project admin Jira permissions.
Follow these steps to install Snyk Security in Jira Cloud from the Atlassian Marketplace.
In Jira, navigate to Apps > Find new apps.
Search for Snyk Security in Jira Cloud. If you are installing Jira for EU or AU you must install the dedicated EU or AU app from the Atlassian app marketplace. If you are installing Jira and are using SNYK-US-02 (https://app.us.snyk.io/) you must install the SNYK-US-02 app from the Atlassian app marketplace.
Click the app and then select Get it now.
Review the information about the app, and select Get it now.
Follow the instructions to install the app.
Go to Apps > Manage apps.
In the left menu, select Snyk Security in Jira.
Log in to your Snyk account, or sign up for a new Snyk account.
In Snyk, select Grant access to allow Snyk to read your Jira Software account information.
Select the specific Snyk Organizations to connect to your Jira site, and select Grant app access.
When you have completed the following steps to connect Snyk to Jira, you can start triaging security issues in Jira.
In Jira, navigate to Project settings > Toolchain and find Snyk in the list of tools. See What is the project toolchain in Jira Software?
Select the Add connection plus sign button for Snyk.
Choose the container code repository from the list and select Connect security containers. This is a Snyk Target. You can connect more than one code repository to Jira.
Developers can now use the security feature to view recent vulnerabilities found in the linked code repositories and start creating Jira issues from those vulnerabilities or linking them to existing Jira issues.
To delete a target or repository from Snyk that you have connected to Jira, you must first delete the container code repository in Jira, through the Security panel in each Jira Project. Then you can remove the target or repository from Snyk.
The following steps describe how to use Jira automation to automatically create tickets for Snyk Vulnerabilities:
In Jira, in your project, navigate to Project Settings and then Automation.
Click Create Rule.
Set Vulnerability Found as the Trigger. Choose a minimum ticket severity.
Click Add Component, Then, and select Create Issue. Select a project and issue type.
In the summary field add “Fix {{vulnerability.displayName}}”. In the Description put {{vulnerability.description.wiki}}.
Click Add Component, Then, and select Link vulnerability to issue under Security.
Select Turn on rule.
After installing and configuring the Snyk Security in Jira Cloud app, you can view vulnerabilities on the security tab on the Jira project page.
To find vulnerabilities, navigate to the Vulnerabilities section. Snyk shows the severity, status, and identifiers. Click the title to see the details in Snyk Web UI.
Use the search bar and filters in the Vulnerabilities section to customize the list of vulnerabilities to show those relevant to your Organization.
Ignored and closed vulnerabilities are not shown in the Vulnerabilities section by default, but you can view them using the Vuln. status filter.
Select the title of a column in the table to sort all vulnerabilities by that attribute.
When triaging issues, you can add a Jira issue to the sprint or backlog to ensure the required work for resolving the vulnerability is planned and tracked.
Snyk provides vulnerability information to Jira, enabling users to have comprehensive data for resolving issues.
To add a Jira issue, navigate to the Snyk Security tab, find a vulnerability, and click Create issue.
If the vulnerability already has a Jira issue, you can link the vulnerability to the existing Jira issue by clicking the three dots in the Actions column and selecting Link issue.
These steps describe how to use Jira automation and JQL to automatically close or change the status of tickets for vulnerabilities that are now in a closed state.
In Jira on your Project, navigate to Project Settings and then Automation.
Click he Create Rule button.
Click Scheduled and then Scheduled.
Select the checkbox that says Run a JQL search and enter status != Done AND vulnerability[status] = CLOSED in the field. Then click Next.
Add a new component and choose THEN: Add an action. Select Issue actionsandchoose Transition issue.
Set the Destination status to Done or another status depending on your workflow.
Now that the setup is complete, give it a name and click on Turn on rule.
Now, according to your schedule, Jira will search for any issues for which the vulnerability is closed, but the issues are not closed, and close each Jira issue.
Uninstalling Snyk Security in Jira Cloud will disconnect Snyk vulnerabilities from their associated Jira issues. To uninstall a Jira app, you must be an administrator in the site-admins, administrators, or jira-administrators groups.
In Jira, navigate to Apps in the main menu and select Manage your apps.
Select Snyk Security in Jira.
Click the Uninstall button.