docs(OAuth feature): create documentation for UMA features#14238
docs(OAuth feature): create documentation for UMA features#14238palaksrivastava2311 wants to merge 4 commits into
Conversation
Added documentation for the UMA RPT Endpoint, including overview, server properties, and configuration instructions. Signed-off-by: palaksrivastava2311 <palaksri8135@gmail.com>
Added documentation for the UMA Claims Gathering Endpoint, including overview, script details, and configuration steps. Signed-off-by: palaksrivastava2311 <palaksri8135@gmail.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
📝 WalkthroughWalkthroughThis PR adds two new documentation files that describe UMA (User-Managed Access) flow endpoints for the Janssen authentication server. The Claims Gathering Endpoint documentation covers the interactive web flow for collecting user claims, including script configuration and feature flag setup. The RPT Endpoint documentation describes the Requesting Party Token endpoint, including configurable properties and TUI-based configuration instructions. ChangesUMA Endpoint Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
coderabbitai
Bot
added
area-documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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/script-catalog/uma_rpt_claims/uma-claims-gathering.md`:
- Line 4: Summary: Replace the redundant phrase "API interface" with "API" in
the UMA Claims Gathering Endpoint description. Locate the sentence starting "The
UMA Claims Gathering Endpoint provides an interactive web flow or API
interface..." and edit it to read "...interactive web flow or API..." so that
"API interface" is shortened to "API" for clarity and concision.
- Line 3: Add a blank line immediately after each Markdown heading in this
document to satisfy MD022; specifically insert an empty line after "## Overview"
and after the other section headings in this file so every heading is followed
by a blank line.
- Line 1: The document titled "UMA Claims Gathering Endpoint Documentation" was
added in the wrong section; move or mirror this markdown into the repository
location specified by issue `#4860` (the auth-server UMA claims-gathering IA path)
so the issue can be closed; when moving, update the document
front-matter/heading and any internal links or table-of-contents references to
reflect the new location, and keep or remove the original copy in script-catalog
per repo conventions (or add a redirect note) to avoid broken links.
In `@docs/script-catalog/uma_rpt_claims/uma-rpt-endpoint.md`:
- Line 3: Add a blank line after each Markdown heading to satisfy markdownlint
MD022: insert an empty line immediately following the "## Overview" heading and
likewise after the other headings referenced (the headings at the other reported
locations) so every heading is followed by a single blank line.
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 865de0b2-a980-44fe-816c-b04e31c627dc
📒 Files selected for processing (2)
docs/script-catalog/uma_rpt_claims/uma-claims-gathering.mddocs/script-catalog/uma_rpt_claims/uma-rpt-endpoint.md
| @@ -0,0 +1,20 @@ | |||
| # UMA Claims Gathering Endpoint Documentation | |||
There was a problem hiding this comment.
Document location does not match linked issue acceptance path.
Issue #4860 asks for this content under docs/janssen-server/auth-server/uma-features/claims-gathering-endpoint/, but this PR adds it under docs/script-catalog/uma_rpt_claims/. Please move or mirror it in the required path so the issue is actually closed with the expected IA.
🤖 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/script-catalog/uma_rpt_claims/uma-claims-gathering.md` at line 1, The
document titled "UMA Claims Gathering Endpoint Documentation" was added in the
wrong section; move or mirror this markdown into the repository location
specified by issue `#4860` (the auth-server UMA claims-gathering IA path) so the
issue can be closed; when moving, update the document front-matter/heading and
any internal links or table-of-contents references to reflect the new location,
and keep or remove the original copy in script-catalog per repo conventions (or
add a redirect note) to avoid broken links.
| @@ -0,0 +1,20 @@ | |||
| # UMA Claims Gathering Endpoint Documentation | |||
|
|
|||
| ## Overview | |||
There was a problem hiding this comment.
Fix heading spacing to satisfy markdownlint MD022.
Add blank lines after these headings to clear the reported lint warnings.
Also applies to: 8-8, 15-15
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 3-3: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 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/script-catalog/uma_rpt_claims/uma-claims-gathering.md` at line 3, Add a
blank line immediately after each Markdown heading in this document to satisfy
MD022; specifically insert an empty line after "## Overview" and after the other
section headings in this file so every heading is followed by a blank line.
Source: Linters/SAST tools
| # UMA Claims Gathering Endpoint Documentation | ||
|
|
||
| ## Overview | ||
| The UMA Claims Gathering Endpoint provides an interactive web flow or API interface where the authorization server interacts with the requesting party to gather claims required by the relevant UMA scopes and policies. |
There was a problem hiding this comment.
Use “API” instead of “API interface”.
“API interface” is redundant; use “API”.
🧰 Tools
🪛 LanguageTool
[style] ~4-~4: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ...int provides an interactive web flow or API interface where the authorization server interact...
(ACRONYM_TAUTOLOGY)
🤖 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/script-catalog/uma_rpt_claims/uma-claims-gathering.md` at line 4,
Summary: Replace the redundant phrase "API interface" with "API" in the UMA
Claims Gathering Endpoint description. Locate the sentence starting "The UMA
Claims Gathering Endpoint provides an interactive web flow or API interface..."
and edit it to read "...interactive web flow or API..." so that "API interface"
is shortened to "API" for clarity and concision.
Source: Linters/SAST tools
| @@ -0,0 +1,25 @@ | |||
| # UMA RPT Endpoint Documentation | |||
|
|
|||
| ## Overview | |||
There was a problem hiding this comment.
Fix heading spacing to satisfy markdownlint MD022.
Add blank lines after these headings to resolve the lint warnings.
Also applies to: 8-8, 18-18, 21-21
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 3-3: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 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/script-catalog/uma_rpt_claims/uma-rpt-endpoint.md` at line 3, Add a
blank line after each Markdown heading to satisfy markdownlint MD022: insert an
empty line immediately following the "## Overview" heading and likewise after
the other headings referenced (the headings at the other reported locations) so
every heading is followed by a single blank line.
Source: Linters/SAST tools
ossdhaval
left a comment
ossdhaval
left a comment
There was a problem hiding this comment.
@palaksrivastava2311 I have made a few review comments. I request you to address these comments for both the documents.
| * **Recommended Value:** `false` (or set to `true` if JWT-based inspection is desired by the resource server). | ||
|
|
||
| ## How to Configure via TUI / Command Line | ||
| Administrators can modify these configurations using the Janssen Text User Interface (TUI) or the command-line utility. |
There was a problem hiding this comment.
I suggest to provide links to TUI and CMD documentation.
| ## Janssen Server Properties & Configuration | ||
| The RPT Endpoint behavior is controlled via specific configuration keys within the Janssen Auth Server configuration properties. | ||
|
|
||
| * **Property Name:** `umaRptLifetime` |
There was a problem hiding this comment.
It'll be better to link properties to it's listing. Like what we have done here. Reduces duplication of the information.
| ### Using Janssen TUI: | ||
| 1. Launch the Janssen Text UI (`jans-cli` or `jans-tui`). | ||
| 2. Navigate to **Auth Server Settings** > **UMA Configurations**. | ||
| 3. Locate the `RPT Lifetime` or `RPT as JWT` fields to update your preferences. |
There was a problem hiding this comment.
@palaksrivastava2311 Could you please confirm that this path exists in TUI. TUI navigation has gone through some changes.
|
Thank you 🤝 for taking the time and submit this PR contribution. I have reviewed the changes and have added comments that need changes. I also see valid AI review comments on this PR. Once you have addressed the comments, we should be good to merge. 👍 |
3 participants
Prepare
Description
Target issue
closes #4860
Implementation Details
Test and Document the changes
Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with
docs:to indicate documentation changes or if the below checklist is not selected.Summary by CodeRabbit