Skip to content

Commit bcca5a0

Browse files
paulOsinskiPaul OsinskiMaffoochdogboatcneill
authored
Docs updates: 2.44.2 (#11985)
* rm Hugo taxonomy pages from docs: the unused 'https://docs.defectdojo.com/tags' page for example * Pro Release notes : 2.44.1 (#11983) * update changelog 2.44 * 2.44.1 release notes --------- Co-authored-by: Paul Osinski <paul.m.osinski@gmail.com> * document permissions overhaul * add audit log documentation * Apply suggestions from code review * Rename odic.png to oidc.png * Update docs/content/en/changelog/changelog.md Co-authored-by: Sean Reid <dogboat@users.noreply.github.com> * Update docs/content/en/customize_dojo/user_management/audit_logging.md Co-authored-by: Charles Neill <1749665+cneill@users.noreply.github.com> --------- Co-authored-by: Paul Osinski <paul.m.osinski@gmail.com> Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.com> Co-authored-by: Sean Reid <dogboat@users.noreply.github.com> Co-authored-by: Charles Neill <1749665+cneill@users.noreply.github.com>
1 parent 4242be7 commit bcca5a0

11 files changed

Lines changed: 60 additions & 7 deletions

File tree

118 KB
Loading
171 KB
Loading
272 KB
Loading

docs/config/_default/hugo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ baseurl = "http://localhost/"
33
canonifyURLs = false
44
disableAliases = true
55
disableHugoGeneratorInject = true
6-
# disableKinds = ["taxonomy", "term"]
6+
disableKinds = ["taxonomy", "term"]
77
enableEmoji = true
88
enableGitInfo = false
99
enableRobotsTXT = true

docs/content/en/changelog/changelog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ For Open Source release notes, please see the [Releases page on GitHub](https://
1414

1515
- **(Beta UI)** Added a field in the View Engagement page which allows a user to navigate to the linked Jira Epic, if one exists.
1616
- **(Universal Parser)** XML is now a supported file type for Universal Parser.
17-
- **(SSO)** SSO can now be set up with any kind of [OIDC Configuration](https://auth0.com/docs/authenticate/protocols/openid-connect-protocol). See ODIC Settings in the Beta UI:
17+
- **(SSO)** SSO can now be set up with any kind of [OIDC Configuration](https://auth0.com/docs/authenticate/protocols/openid-connect-protocol). See OIDC Settings in the Beta UI:
1818

19-
![image](images/odic.png)
19+
![image](images/oidc.png)
2020

2121
### Mar 3, 2025: v2.44.0
2222

docs/content/en/customize_dojo/user_management/about_perms_and_roles.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
title: "User permissions & Roles"
2+
title: "Permissions in DefectDojo"
33
description: "Summary of all DefectDojo permission options, in detail"
4-
weight: 1
4+
weight: 2
55
---
66

77
If you have a team of users working in DefectDojo, it's important to set up Role\-Based Access Control (RBAC) appropriately so that users can only access specific data. Security data is highly sensitive, and DefectDojo's options for access control allow you to be specific about each team member’s access to information.
88

9+
This article is an overview of how permissions in DefectDojo work. If you would prefer to see a detailed breakdown of **each action** that can be controlled by Permissions, see our **[Permissions Chart](../user_permission_chart/)** article.
10+
911
## Types of Permissions
1012

1113
DefectDojo manages four different kinds of permissions:
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Audit Logs"
3+
description: "Access audit logs for DefectDojo objects"
4+
weight: 1
5+
---
6+
7+
Audit logs for DefectDojo can be accessed in a few different ways.
8+
9+
## Individual Object Logs
10+
* DefectDojo objects each have an associated Object History, which can be accessed through the UI. These histories are recorded for Products, Engagements, Tests, Findings and Endpoints, as well as Risk Acceptances.
11+
12+
In the Classic (Open-Source) UI, this history is found under the '☰' (hamburger) menu on an object. In the Pro UI, this history is found under the blue '⚙️' (gear) menu for the object in question.
13+
14+
![image](images/view_history_ui.png)
15+
16+
## Object History Endpoint (Pro Only)
17+
18+
<span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Pro</span> users have access to a `/history` API path for these objects to view similar data. For example: `/api/v2/findings/{id}/history/`.
19+
20+
## Audit Log Endpoint (Pro Only)
21+
22+
<span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Pro</span> users also have access to a dedicated `/audit_log` endpoint for their entire instance. This log can only be accessed by users or API tokens with superuser permissions.
23+
24+
This API returns 31 days of audit logs.
25+
26+
* Sending default or empty parameters will return the last 31 days of audit logs.
27+
* Parameter `window_month` which will take a month and year in the format MM-YYYY and provide the audit logs for that month.
28+
* You can set the `window_start` parameter to limit these logs to a shorter window, rather than returning the entire month.
29+
30+
For more information, see the API documentation, located in your instance: `your-instance.cloud.defectdojo.com/api/v2/oa3/swagger-ui/`

docs/content/en/customize_dojo/user_management/create_user_group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Create a User Group for shared permissions"
2+
title: "Share permissions: User Groups"
33
description: "Share and maintain permissions for many users"
44
weight: 3
55
---
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "🟧 Set Permissions in Pro"
3+
description: "Overhaul, pro feature"
4+
weight: 3
5+
---
6+
7+
Permissions in <span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Pro</span> have been simplified, to make it easier to assign object access. This feature can be accessed through the [Beta UI](/en/about_defectdojo/ui_pro_vs_os/).
8+
9+
### Opening the Permissions window
10+
11+
![image](images/pro_permissions.png)
12+
13+
When looking at Product Type or Product, you can open the Permissions window to set permissions quickly. This menu can be found in a Table by clicking the horizontal dots **"⋮"**. IF looking at an individual **Product** or **Product Type** page, this menu can be found under the blue gear ‘⚙️’.
14+
15+
## Setting Permissions through the permissions window
16+
17+
![image](images/pro_permissions_2.png)
18+
19+
1. At the top of this window, you can choose to manage permissions for an individual user or for a [user group](../create_user_group).
20+
2. Here, you can select a user or group to add to the Product, and select the [Role](../about_perms_and_roles) that you want that user to have.
21+
3. On the lower table, you can see a list of all users or groups who have access to this object. You can also quickly assign a new role for one of these users or groups from the drop-down menu.

0 commit comments

Comments
 (0)