chore(docs): clarify OpenTDF OIDC relationship - #3826
Open
jrschumacher wants to merge 2 commits into
Open
Conversation
Signed-off-by: Ryan Schumacher <j.r.schumacher@gmail.com>
📝 WalkthroughWalkthroughThe documentation defines OpenTDF as an OIDC relying party, explains authentication and authorization boundaries, updates OIDC configuration guidance, and refreshes links for OIDC and ERS documentation. ChangesOIDC documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
jrschumacher
changed the title
Contributor
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
Signed-off-by: Ryan Schumacher <j.r.schumacher@gmail.com>
Contributor
Contributor
Benchmark results, click to expandBenchmark authorization.GetDecisions Results:
Benchmark authorization.v2.GetMultiResourceDecision Results:
Benchmark Statistics
Bulk Benchmark Results
TDF3 Benchmark Results:
|
Contributor
|
Contributor
jrschumacher
marked this pull request as ready for review
August 3, 2026 20:34
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/OIDC.md`:
- Around line 59-62: Update the Configuring.md YAML example referenced by the
OIDC documentation to use the runtime groups_claim key instead of group_claim,
matching PolicyConfig.GroupsClaim and its mapstructure configuration. Preserve
the surrounding authentication policy example unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: c287b538-3376-49ea-bf04-ab31e082c466
📒 Files selected for processing (4)
README.mddocs/Configuring.mddocs/Consuming.mddocs/OIDC.md
Comment on lines
+59
to
+62
| - The current auth policy configuration supports: | ||
| - `server.auth.policy.username_claim` (default `preferred_username`) | ||
| - `server.auth.policy.groups_claim` (default `realm_access.roles`) | ||
| - `server.auth.policy.client_id_claim` (default `azp`) |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Expected: one runtime claim key, with matching YAML and Markdown documentation.
rg -n -C 4 'groups_claim|group_claim|GroupsClaim|GroupClaim' \
--glob '*.go' --glob '*.yaml' --glob '*.md' .Repository: opentdf/platform
Length of output: 50372
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect the runtime policy field mapping and the documented example context.
sed -n '1,45p' service/internal/auth/authz/policy.go
sed -n '570,615p' docs/Configuring.md
sed -n '75,90p' opentdf-dev.yamlRepository: opentdf/platform
Length of output: 4456
Use the runtime groups_claim key in the Configuring.md example.
PolicyConfig.GroupsClaim maps to mapstructure:"groups_claim", and the YAML examples use groups_claim. The group_claim: key in docs/Configuring.md line 609 is ignored by the current configuration contract and can leave group membership unset.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/OIDC.md` around lines 59 - 62, Update the Configuring.md YAML example
referenced by the OIDC documentation to use the runtime groups_claim key instead
of group_claim, matching PolicyConfig.GroupsClaim and its mapstructure
configuration. Preserve the surrounding authentication policy example unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #3824
Jira: https://virtru.atlassian.net/browse/DSPX-4261
Summary by CodeRabbit