Skip to content

docs: add permissions roles table and enterprise OIDC mapping guidance#6033

Open
balaakasam wants to merge 3 commits into
DependencyTrack:masterfrom
balaakasam:docs/oidc-permissions-roles-documentation
Open

docs: add permissions roles table and enterprise OIDC mapping guidance#6033
balaakasam wants to merge 3 commits into
DependencyTrack:masterfrom
balaakasam:docs/oidc-permissions-roles-documentation

Conversation

@balaakasam
Copy link
Copy Markdown

Description

Adds a complete permissions roles table to the OIDC configuration documentation, explaining what each Dependency-Track permission grants to authenticated users. Also adds a recommended enterprise role structure and guidance on mapping OIDC groups in Microsoft Entra ID, Keycloak, and Okta.

Addressed Issue

closes #5841

Additional Details

The existing documentation explained how to configure OIDC but did not describe what permissions are available in Dependency-Track or how to structure teams for enterprise deployments. This left administrators without guidance on which permissions to assign when mapping identity provider groups to Dependency-Track teams.

This change is documentation only - no code changes.

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

Signed-off-by: balaakasam <thripuraavula@gmail.com>
@owasp-dt-bot
Copy link
Copy Markdown

owasp-dt-bot commented Apr 20, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@codacy-production
Copy link
Copy Markdown

codacy-production Bot commented Apr 20, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@balaakasam
Copy link
Copy Markdown
Author

Hi, just following up on this PR. Happy to make any adjustments if needed, please let me know. Thanks for your time!

@balaakasam
Copy link
Copy Markdown
Author

Hi approver/maintainer team, just checking on this PR if any changes are needed from me. Please let me know. Thank you!

Comment thread docs/_docs/getting-started/openidconnect-configuration.md Outdated
Comment thread docs/_docs/getting-started/openidconnect-configuration.md Outdated
Comment thread docs/_docs/getting-started/openidconnect-configuration.md Outdated
Comment thread docs/_docs/getting-started/openidconnect-configuration.md Outdated
Comment thread docs/_docs/getting-started/openidconnect-configuration.md Outdated
Signed-off-by: balaakasam <thripuraavula@gmail.com>
Signed-off-by: balaakasam <thripuraavula@gmail.com>
@balaakasam
Copy link
Copy Markdown
Author

balaakasam commented May 19, 2026

Hi @nscuro, thank you for the detailed review and feedback. I went ahead and addressed all the feedback:

  1. Replaced the permissions table with a link to the existing Users and Permissions page
  2. Changed "Recommended" to "Example" role structure with updated wording to clarify
  3. Added VIEW_PORTFOLIO to all roles in the example table
  4. Removed the duplicate Keycloak and Entra ID sections
  5. Expanded the existing UUID note in the Entra ID section with actionable guidance

Please let me know if any further changes are needed, I will be happy to make any changes.

@balaakasam balaakasam requested a review from nscuro May 19, 2026 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

missing info in docs

3 participants