You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/renovate.json
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,7 @@
26
26
"description": "Update renovate weekly (sundays) - They are releasing new versions too often, so it is a bit noisy, and keeping renovating a bit older does not create vulnerabilities in DD",
27
27
"matchDatasources": "github-releases",
28
28
"matchPackageNames": "renovatebot/renovate",
29
+
"separateMinorPatch": false,
29
30
"schedule": ["* * * * 0"]
30
31
},{
31
32
"description": "Minikube does not like freshly released k8s. We need to wait some time so it will be adopted",
Copy file name to clipboardExpand all lines: docs/content/en/share_your_findings/jira_guide.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@ description: "Work with the Jira integration"
4
4
weight: 1
5
5
---
6
6
7
-
DefectDojo's Jira integration can be used to push Finding data to one or more Jira Projects. By doing so, you can integrate DefectDojo into your standard development workflow. Here are some examples of how this can work:
7
+
DefectDojo's Jira integration can be used to push Finding data to one or more Jira Spaces. By doing so, you can integrate DefectDojo into your standard development workflow. Here are some examples of how this can work:
8
8
9
-
* The AppSec team can selectively push Findings to a Jira Project used by developers, so that issue remediation can be appropriately prioritized alongside regular development. Developers on this board don't need to access DefectDojo - they can keep all their work in one place.
10
-
* DefectDojo can push ALL Findings to a bidirectional Jira Project which the AppSec team uses, which allows them to split up issue validation. This board keeps in sync with DefectDojo and allows for complex remediation workflows.
11
-
* DefectDojo can selectively push Findings from separate Products &/or Engagements to separate Jira Projects, to keep things in their proper context.
9
+
* The AppSec team can selectively push Findings to a Jira Space used by developers, so that issue remediation can be appropriately prioritized alongside regular development. Developers on this board don't need to access DefectDojo - they can keep all their work in one place.
10
+
* DefectDojo can push ALL Findings to a bidirectional Jira Space which the AppSec team uses, which allows them to split up issue validation. This board keeps in sync with DefectDojo and allows for complex remediation workflows.
11
+
* DefectDojo can selectively push Findings from separate Products &/or Engagements to separate Jira Spaces, to keep things in their proper context.
12
12
13
13
# Setting Up Jira
14
14
Setting Up Jira requires the following steps:
@@ -40,7 +40,7 @@ Optionally, you can map:
40
40
* Jira Transitions to trigger Re-Opening and Closing Findings
41
41
* Jira Resolutions which can apply Risk Acceptance and False Positive statuses to Findings (optional)
42
42
43
-
Multiple Jira Projects can be handled by a single Jira Instance connection, as long as the Jira account / token used by DefectDojo has permission to create Issues in the associated Jira Project.
43
+
Multiple Jira Spaces can be handled by a single Jira Instance connection, as long as the Jira account / token used by DefectDojo has permission to create Issues in the associated Jira Space.
44
44
45
45
### Add a Jira Instance (Pro UI)
46
46
@@ -62,7 +62,7 @@ Multiple Jira Projects can be handled by a single Jira Instance connection, as l
62
62
Note that the user associated with this connection have permission to create Issues and access data in your Jira instance.
63
63
64
64
6. You will need to provide values for an Epic Name ID, Re-open Transition ID and Close Transition ID. These values can be changed later. While logged into Jira, you can access these values from the following URLs:
65
-
-**Epic Name ID**: visit `https://<YOUR JIRA URL>/rest/api/2/field` and search for Epic Name. Copy the number out of `number` and paste it here.
65
+
-**Epic Name ID**: visit `https://<YOUR JIRA URL>/rest/api/2/field` and search for Epic Name. Copy the number out of `number` and paste it here. If you do not have an Epic Name ID associated with your Space in Jira (due to using a Team-Managed Space, for example), enter 0 on this field.
66
66
-**Re-open Transition ID**: visit `https://<YOUR JIRA URL>/rest/api/latest/issue/<ANY VALID ISSUE KEY>/transitions?expand-transitions.fields` to find the ID for your Jira instance. Paste it in the Reopen Transition ID field.
67
67
-**Close Transition ID**: Visit `https://<YOUR JIRA URL>/rest/api/latest/issue/<ANY VALID ISSUE KEY>/transitions?expand-transitions.fields` to find the ID for your Jira instance. Paste it in the Close Transition ID field.
68
68
@@ -88,11 +88,11 @@ The form can be submitted from here. If you wish, you can further customize you
88
88
89
89

90
90
91
-
3. You will see a list of all currently configured Jira Projects which are linked to DefectDojo. To add a new Project Configuration, click the wrench icon and choose either the **Add Jira Configuration (Express)** or **Add Jira Configuration** options.
91
+
3. You will see a list of all currently configured Jira Spaces which are linked to DefectDojo. To add a new Project Configuration, click the wrench icon and choose either the **Add Jira Configuration (Express)** or **Add Jira Configuration** options.
92
92
93
93
#### Add Jira Configuration (Express)
94
94
95
-
The Express method allows for a quicker method of linking a Project. Use the Express method if you simply want to connect a Jira Project quickly, and you aren’t dealing with a complex Jira workflow.
95
+
The Express method allows for a quicker method of linking a Space. Use the Express method if you simply want to connect a Jira Space quickly, and you aren’t dealing with a complex Jira workflow.
96
96
97
97

98
98
@@ -122,7 +122,7 @@ If you leave this field blank, it will default to **Jira\_full.**
122
122
123
123
9. Decide whether you wish to automatically sync Findings with Jira. If this is enabled, Jira Issues will automatically be kept in sync with the related Findings. If this is not enabled, you will need to manually push any changes made to a Finding after the Issue has been created in Jira.
124
124
125
-
10. Select your Issue key. In Jira, this is the string associated with an Issue (e.g. the word **‘EXAMPLE’** in an issue called **EXAMPLE\-123**). If you don’t know your issue key, create a new Issue in the Jira Project. In the screenshot below, we can see that the issue key on our Jira Project is **DEF**.
125
+
10. Select your Issue key. In Jira, this is the string associated with an Issue (e.g. the word **‘EXAMPLE’** in an issue called **EXAMPLE\-123**). If you don’t know your issue key, create a new Issue in the Jira Space. In the screenshot below, we can see that the issue key on our Jira Space is **DEF**.
126
126
127
127

128
128
@@ -154,23 +154,23 @@ Comments (in Jira) and Notes (in DefectDojo) can be kept in sync. This setting c
154
154
155
155
## Step 2: Connect a Product or Engagement to Jira
156
156
157
-
Each Product or Engagement in DefectDojo has its own settings which govern how Findings are converted to JIRA Issues. From here, you can decide the associated JIRA Project and set the default behaviour for creating Issues, Epics, Labels and other JIRA metadata.
157
+
Each Product or Engagement in DefectDojo has its own settings which govern how Findings are converted to JIRA Issues. From here, you can decide the associated Jira Space and set the default behaviour for creating Issues, Epics, Labels and other JIRA metadata.
158
158
159
159
### Add Jira to a Product or Engagement (Pro UI)
160
160
161
-
You can find this page by clicking the Gear menu on a Product or Engagement - ⚙️ and opening the Jira Project Settings page.
161
+
You can find this page by clicking the Gear menu on a Product or Engagement - ⚙️ and opening the Jira Space Settings page.
162
162
163
163

164
164
165
165
#### Jira Instance
166
166
167
-
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Project you want DefectDojo to create Issues in. Select a Project from the drop\-down menu.
167
+
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Space you want DefectDojo to create Issues in. Select a Space from the drop\-down menu.
168
168
169
-
If this menu doesn't list any Jira instances, confirm that those Projects are connected in your global Jira Configuration for DefectDojo \- yourcompany.defectdojo.com/jira.
169
+
If this menu doesn't list any Jira instances, confirm that those Space are connected in your global Jira Configuration for DefectDojo \- yourcompany.defectdojo.com/jira.
170
170
171
171
#### Project key
172
172
173
-
This is the key of the Project that you want to use with DefectDojo. The Project Key for a given project can be found in the URL.
173
+
This is the key of the Space that you want to use with DefectDojo. The Space Key for a given Space can be found in the URL. (This was previously referred to as a **Jira Project Key**, but as of Sepetember 2025, this is now referred to in Jira as the **Space Key**).
@@ -192,15 +192,15 @@ Here is an example of a **jira\_full** Issue:
192
192
193
193
#### Component
194
194
195
-
If you manage your Jira project using Components, you can assign the appropriate Component for DefectDojo here.
195
+
If you manage your Jira Space using Components, you can assign the appropriate Component for DefectDojo here.
196
196
197
197
**Custom fields**
198
198
199
199
If you don’t need to use Custom Fields with DefectDojo issues, you can leave this field as ‘null’.
200
200
201
-
However, if your Jira Project Settings **require you** to use Custom Fields on new Issues, you will need to hard-code these mappings.
201
+
However, if your Jira Space Settings **require you** to use Custom Fields on new Issues, you will need to hard-code these mappings.
202
202
203
-
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your JIRA Project**requires that these Custom Fields exist** in every Issue in your project.
203
+
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your Jira Space**requires that these Custom Fields exist** in every Issue in your Space.
204
204
205
205
Follow **[this guide](#custom-fields-in-jira)** to get started working with Custom Fields.
206
206
@@ -212,7 +212,7 @@ Select the relevant labels that you want the Issue to be created with in Jira, e
212
212
213
213
#### Default assignee
214
214
215
-
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Project when creating Issues.
215
+
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Space when creating Issues.
216
216
217
217
### Add Jira to a Product or Engagement (Classic UI / Open-Source)
218
218
@@ -228,13 +228,13 @@ Jira settings are located near the bottom of the Product Settings page.
228
228
229
229
#### Jira Instance
230
230
231
-
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Project you want DefectDojo to create Issues in. Select a Project from the drop\-down menu.
231
+
If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Space you want DefectDojo to create Issues in. Select a Project from the drop\-down menu.
232
232
233
233
If this menu doesn't list any Jira instances, confirm that those Projects are connected in your global Jira Configuration for DefectDojo \- yourcompany.defectdojo.com/jira.
234
234
235
235
#### Project key
236
236
237
-
This is the key of the Project that you want to use with DefectDojo. The Project Key for a given project can be found in the URL.
237
+
This is the key of the Space that you want to use with DefectDojo. The Space Key for a given project can be found in the URL, or under "Space key" listed in Space Settings.
@@ -256,17 +256,17 @@ Here is an example of a **jira\_full** Issue:
256
256
257
257
#### Component
258
258
259
-
If you manage your Jira project using Components, you can assign the appropriate Component for DefectDojo here.
259
+
If you manage your Jira Space using Components, you can assign the appropriate Component for DefectDojo here.
260
260
261
261
**Custom fields**
262
262
263
263
If you don’t need to use Custom Fields with DefectDojo issues, you can leave this field as ‘null’.
264
264
265
-
However, if your Jira Project Settings **require you** to use Custom Fields on new Issues, you will need to hard\-code these mappings.
265
+
However, if your Jira Space Settings **require you** to use Custom Fields on new Issues, you will need to hard\-code these mappings.
266
266
267
267
**Jira Cloud now allows you to create a default Custom Field value directly in\-app. [See Atlassian's documentation on Custom Fields](https://support.atlassian.com/jira-cloud-administration/docs/configure-a-custom-field/) for more information on how to configure this.**
268
268
269
-
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your JIRA Project**requires that these Custom Fields exist** in every Issue in your project.
269
+
Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields, only a default value. This section should only be set up if your Jira Space**requires that these Custom Fields exist** in every Issue in your Space.
270
270
271
271
Follow **[this guide](#custom-fields-in-jira)** to get started working with Custom Fields.
272
272
@@ -278,11 +278,11 @@ Select the relevant labels that you want the Issue to be created with in Jira, e
278
278
279
279
#### Default assignee
280
280
281
-
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Project when creating Issues.
281
+
The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Space when creating Issues.
282
282
283
283
### Additional Form Options
284
284
285
-
#### Enable Connection With Jira Project
285
+
#### Enable Connection With Jira Space
286
286
287
287
Jira integrations can be removed from your instance only if no related Issues have been created. If Issues have been created, there is no way to completely remove a Jira Instance from DefectDojo.
288
288
@@ -373,7 +373,7 @@ Add whatever title severity and description you wish, and then click “Finished
373
373
374
374
If Jira Issues are not being created correctly, check your Notifications for error codes.
375
375
376
-
* Confirm that the Jira User associated with DefectDojo's Jira Configuration has permission to create and update issues on that particular Jira Project.
376
+
* Confirm that the Jira User associated with DefectDojo's Jira Configuration has permission to create and update issues on that particular Jira Space.
377
377
378
378
#### Test 2: Jira Webhooks send to DefectDojo
379
379
@@ -389,7 +389,7 @@ If this doesn’t work correctly, it could be due to a Firewall issue on your Ji
389
389
390
390
Jira integrations can be removed from your instance only if no related Issues have been created. If Issues have been created, there is no way to completely remove a Jira Instance from DefectDojo.
391
391
392
-
However, you can disable your Jira integration by disabling it at the Product level. From the **Edit Product** form (Classic UI) or from the **Jira Product Settings** (Pro UI) you can uncheck the "Enable Connection With Jira Project" option. This will not delete or change any existing Jira tickets created by DefectDojo, but will disable any further updates.
392
+
However, you can disable your Jira integration by disabling it at the Product level. From the **Edit Product** form (Classic UI) or from the **Jira Product Settings** (Pro UI) you can uncheck the "Enable Connection With Jira Space" option. This will not delete or change any existing Jira tickets created by DefectDojo, but will disable any further updates.
Certain Spaces in Jira, such as Team-Managed Spaces, do not use Epics and therefore will not have an Epic Name ID. In this case, set Epic Name ID to 0 in DefectDojo.
56
58
57
59
## Findings that I 'Push To Jira' do not appear in Jira
58
60
Using the 'Push To Jira' workflow triggers an asynchronous process, however an Issue should be created in Jira fairly quickly after 'Push To Jira' is triggered.
59
61
60
62
* Check your DefectDojo notifications to see if the process was successful. If the push failed, you will get an error response from Jira in your notifications.
61
63
62
64
Common reasons issues are not created:
63
-
* The Default Issue Type you have selected is not usable with the Jira Project
64
-
* Issues in the Project have required attributes that prevent them from being created via DefectDojo (see our guide to [Custom Fields](../jira_guide/#custom-fields-in-jira))
65
+
* The Default Issue Type you have selected is not usable with the Jira Space
66
+
* Issues in the Space have required attributes that prevent them from being created via DefectDojo (see our guide to [Custom Fields](../jira_guide/#custom-fields-in-jira))
65
67
66
68
67
69
## Error: Product Misconfigured or no permissions in Jira?
68
70
69
71
This error message can appear when attempting to add a created Jira configuration to a Product. DefectDojo will attempt to validate a connection to Jira, and if that connection fails, it will raise this error message.
70
72
71
-
* Check to see if your Jira credentials are allowed to create issues in the given Jira Project you have selected.
72
-
* The "Project Key" field needs to be a valid Jira Project. Jira issues can use many different Keys within a single Project; the easiest way to confirm your Project Key is to look at the URL for that particular Jira Project: generally this will look like `https://xyz.atlassian.net/jira/core/projects/JTV/board`. In this case `JTV` is the Project Key.
73
+
* Check to see if your Jira credentials are allowed to create issues in the given Jira Space you have selected.
74
+
* The "Project Key" field needs to be a valid Jira Space. Jira issues can use many different Keys within a single Space; the easiest way to confirm your Project Key is to look at the URL for that particular Jira Space: generally this will look like `https://xyz.atlassian.net/jira/core/projects/JTV/board`. In this case `JTV` is the Space Key.
73
75
74
76
## Changes made to Jira issues are not updating Findings in DefectDojo
75
77
@@ -87,7 +89,7 @@ This error message can appear when attempting to add a created Jira configuratio
87
89
88
90
DefectDojo's Jira integration needs a customfield value for 'Epic Name'. However, your Project settings might not actually use 'Epic Name' as a field when creating Epics. Atlassian made a change in [August 2023](https://community.atlassian.com/t5/Jira-articles/Upcoming-changes-to-epic-fields-in-company-managed-projects/ba-p/1997562) which combined the 'Epic Name' and 'Epic Summary' fields.
89
91
90
-
Newer Jira Projects might not use this field when creating Epics by default, which results in this error message.
92
+
Newer Jira Spaces might not use this field when creating Epics by default, which results in this error message.
91
93
92
94
To correct this issue, you can add the 'Epic Name' field to your Project's issue creation screen:
0 commit comments