Adding docs for console enterprise login#6003
Adding docs for console enterprise login#6003bhagyasakalanka wants to merge 3 commits intowso2:masterfrom
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAdds a new user guide that documents configuring enterprise (SAML/OIDC) IdP login for the Asgardeo Console, including group claims, JIT provisioning, group-role mappings, Home Realm Identifier/direct Console URL, troubleshooting, and removal; also updates MkDocs navigation to include the guide. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
en/asgardeo/docs/guides/users/configure-enterprise-login.md (2)
99-99: Address the TODO comment.A TODO comment indicates a missing screenshot for the Home Realm Identifier configuration. Since the documentation references this configuration step, consider whether the screenshot is necessary for users to complete the task successfully.
If a screenshot would help users locate the setting, would you like me to help draft descriptive text as an alternative, or would you prefer to add the screenshot before merging?
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md` at line 99, Replace the TODO placeholder for the "Home Realm Identifier" configuration with a concrete asset: either add the missing screenshot file (named e.g. home-realm-identifier.png) and embed it with descriptive alt text and a short caption near the "Home Realm Identifier configuration" heading, or remove the TODO and add clear step-by-step descriptive text that tells users exactly where to find the setting in the Asgardeo console (menu/navigation path), what fields to populate, example values, and any cautions; update the document to reference the added screenshot filename or the new descriptive instructions and remove the TODO comment.
85-85: Use active voice.The phrase "Once saved" uses passive voice. Since the actor (the user) is known and important, rewrite in active voice to align with the style guide.
✍️ Suggested revision
-Once saved, users who belong to the mapped IdP groups can sign in to the Asgardeo Console using your enterprise IdP. +After you save the configuration, users who belong to the mapped IdP groups can sign in to the Asgardeo Console using your enterprise IdP.As per coding guidelines: Use active voice and present tense; use passive voice only when the actor is unknown or unimportant.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md` at line 85, Summary: Rewrite the passive phrase "Once saved" into active voice. Replace the sentence "Once saved, users who belong to the mapped IdP groups can sign in to the Asgardeo Console using your enterprise IdP." by explicitly naming the actor—e.g., "After you save the configuration, users in the mapped IdP groups can sign in to the Asgardeo Console using your enterprise IdP."—so the sentence uses active voice and present tense while preserving meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md`:
- Line 99: Replace the TODO placeholder for the "Home Realm Identifier"
configuration with a concrete asset: either add the missing screenshot file
(named e.g. home-realm-identifier.png) and embed it with descriptive alt text
and a short caption near the "Home Realm Identifier configuration" heading, or
remove the TODO and add clear step-by-step descriptive text that tells users
exactly where to find the setting in the Asgardeo console (menu/navigation
path), what fields to populate, example values, and any cautions; update the
document to reference the added screenshot filename or the new descriptive
instructions and remove the TODO comment.
- Line 85: Summary: Rewrite the passive phrase "Once saved" into active voice.
Replace the sentence "Once saved, users who belong to the mapped IdP groups can
sign in to the Asgardeo Console using your enterprise IdP." by explicitly naming
the actor—e.g., "After you save the configuration, users in the mapped IdP
groups can sign in to the Asgardeo Console using your enterprise IdP."—so the
sentence uses active voice and present tense while preserving meaning.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 08780078-ddc5-437e-8ce1-6670d515dbef
⛔ Files ignored due to path filters (1)
en/asgardeo/docs/assets/img/guides/users/enterprise-login-configurations.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/asgardeo/docs/guides/users/configure-enterprise-login.mden/asgardeo/mkdocs.yml
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md`:
- Around line 7-134: Add a short "Troubleshooting" subsection after "Remove
enterprise login" that lists 3–4 common issues (e.g., groups not mapped, JIT
provisioning not creating users, missing groups claim/scope, Home Realm
Identifier not working) with quick checks and fixes, and insert a brief "Outcome
confirmation" line stating what success looks like (users from mapped IdP groups
can sign in and have expected Console roles). Then append a concise "Next steps"
section suggesting actions (verify mappings, monitor sign-ins/audit logs,
document IdP claim formats, and share the direct access URL) after the Outcome
confirmation; place both sections before the final warning so they conclude the
guide.
- Line 79: The embedded screenshot markdown ()
must be removed or replaced with text-only guidance; delete that image tag and
instead add plain step-by-step instructions describing the Enterprise Login
configuration (e.g., where to click, fields to fill, expected values, and any
validation or post-save checks), ensuring all references to {{base_path}} or
image filenames are eliminated so the guide is fully self-contained and no
external images are required.
- Line 97: Locate the HTML comment "<!-- TODO: Add screenshot of the Home Realm
Identifier configuration -->" in configure-enterprise-login.md and remove the
screenshot TODO; instead replace the placeholder with a concise, text-only
walkthrough that explains how to configure the Home Realm Identifier (describe
which field to edit, expected values, example input and the outcome) so the doc
contains no image placeholders and remains compliant with the "no new
screenshots" guideline.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d6196eda-6226-46ad-bf66-a28b5826b467
📒 Files selected for processing (1)
en/asgardeo/docs/guides/users/configure-enterprise-login.md
bhagyasakalanka
force-pushed
the
enterprise-login-doc
branch
from
89dd5be to
9f9d41f
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (2)
en/asgardeo/docs/guides/users/configure-enterprise-login.md (2)
79-79:⚠️ Potential issue | 🟠 MajorRemove the embedded screenshot or replace it with text-only guidance.
This guide includes an image without confirmation that it is available and required. Please convert this to text instructions (or remove it) to keep the task self-contained.
As per coding guidelines: "Do not add, generate, or request new images or screenshots; do not reference an image unless the user explicitly confirms it exists and is accessible; do not make images required to complete a task."
📝 Suggested text-only replacement
- {: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + You will see the configured enterprise connection and group-role mappings displayed in the Enterprise Login section.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md` at line 79, Remove the embedded screenshot line that references "Configure Enterprise Login" and replace it with text-only step-by-step instructions explaining the enterprise login configuration (e.g., required fields, dropdown selections, toggles, and example values) so the guide is self-contained; specifically update the markdown image tag line containing the alt text "Configure Enterprise Login" to a short, clear bulleted or numbered walkthrough covering the actions a user must take and any expected outcomes or validations.
7-133:⚠️ Potential issue | 🟠 MajorAdd a short troubleshooting section and a final Next steps section.
This is task-based content, but it currently does not include troubleshooting guidance and does not end with next actions for the reader.
As per coding guidelines: "Task-based documentation must follow ... outcome confirmation, troubleshooting (if applicable), and next steps" and "end with a Next steps section when appropriate."
📋 Suggested structure
Add the following sections before the "Remove enterprise login" section:
Troubleshooting section (3-4 common issues with quick checks):
- Groups not mapped correctly
- JIT provisioning not creating users
- Missing groups claim/scope
- Home Realm Identifier not working
Next steps section (after outcome confirmation, before the warning):
- Verify mappings work as expected
- Monitor sign-ins in audit logs
- Document IdP claim formats
- Share the direct access URL with enterprise users
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md` around lines 7 - 133, Add a short "Troubleshooting" section (3–4 common issues with quick checks) and a "Next steps" section as required: insert the Troubleshooting section before the "Remove enterprise login" heading and include checks for "Groups not mapped correctly" (verify connection group names and claim mapping), "JIT provisioning not creating users" (verify JIT enabled on connection and provisioning logs), "Missing groups claim/scope" (confirm groups claim mapping and that the groups scope is requested), and "Home Realm Identifier not working" (verify configured identifier and the direct URL). Then add a concise "Next steps" section after the outcome confirmation (before the warning) listing actionable follow-ups: "Verify mappings work as expected", "Monitor sign-ins in audit logs", "Document IdP claim formats", and "Share the direct access URL with enterprise users" so readers have clear post-configuration actions; place these new headings near the existing "Sign in with enterprise login" / "Direct console access" sections for context.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md`:
- Line 79: Remove the embedded screenshot line that references "Configure
Enterprise Login" and replace it with text-only step-by-step instructions
explaining the enterprise login configuration (e.g., required fields, dropdown
selections, toggles, and example values) so the guide is self-contained;
specifically update the markdown image tag line containing the alt text
"Configure Enterprise Login" to a short, clear bulleted or numbered walkthrough
covering the actions a user must take and any expected outcomes or validations.
- Around line 7-133: Add a short "Troubleshooting" section (3–4 common issues
with quick checks) and a "Next steps" section as required: insert the
Troubleshooting section before the "Remove enterprise login" heading and include
checks for "Groups not mapped correctly" (verify connection group names and
claim mapping), "JIT provisioning not creating users" (verify JIT enabled on
connection and provisioning logs), "Missing groups claim/scope" (confirm groups
claim mapping and that the groups scope is requested), and "Home Realm
Identifier not working" (verify configured identifier and the direct URL). Then
add a concise "Next steps" section after the outcome confirmation (before the
warning) listing actionable follow-ups: "Verify mappings work as expected",
"Monitor sign-ins in audit logs", "Document IdP claim formats", and "Share the
direct access URL with enterprise users" so readers have clear
post-configuration actions; place these new headings near the existing "Sign in
with enterprise login" / "Direct console access" sections for context.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f9620c33-243a-481b-ba98-d27bbce9f912
📒 Files selected for processing (1)
en/asgardeo/docs/guides/users/configure-enterprise-login.md
bhagyasakalanka
force-pushed
the
enterprise-login-doc
branch
from
92683b9 to
f9b17d5
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
en/asgardeo/docs/guides/users/configure-enterprise-login.md (1)
79-79:⚠️ Potential issue | 🟠 MajorRemove the screenshot and keep this guide text-only.
This image reference makes the task depend on a visual asset. Replace it with concise written steps only.
Suggested edit
- {: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}As per coding guidelines: "Do not add, generate, or request new images or screenshots; do not reference an image unless the user explicitly confirms it exists and is accessible; do not make images required to complete a task."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md` at line 79, Remove the inline image markdown that displays "Configure Enterprise Login" (the line starting with ![Configure Enterprise Login] and its asset reference and style attributes) and replace it with concise, text-only instructions (bullet or numbered steps) that describe how to configure enterprise login end-to-end; ensure no image tags, asset references, or HTML attributes remain and that the new content is purely textual and self-contained.
🧹 Nitpick comments (1)
en/asgardeo/docs/guides/users/configure-enterprise-login.md (1)
134-153: PlaceNext stepsas the final section.To match the repository doc structure, move
## Remove enterprise loginbefore## Next steps(or move## Next stepsto the end).As per coding guidelines: "Output must be Markdown ... and end with a Next steps section when appropriate."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md` around lines 134 - 153, Reorder the two headings so the "Next steps" section is the final section: move the entire "## Remove enterprise login" block (including its numbered steps and the "!!! warning" admonition) to appear before the "## Next steps" heading, or alternatively move the "## Next steps" block to the end of the file; ensure the headings "## Remove enterprise login" and "## Next steps" remain intact and that the file ends with the "## Next steps" section.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md`:
- Line 79: Remove the inline image markdown that displays "Configure Enterprise
Login" (the line starting with ![Configure Enterprise Login] and its asset
reference and style attributes) and replace it with concise, text-only
instructions (bullet or numbered steps) that describe how to configure
enterprise login end-to-end; ensure no image tags, asset references, or HTML
attributes remain and that the new content is purely textual and self-contained.
---
Nitpick comments:
In `@en/asgardeo/docs/guides/users/configure-enterprise-login.md`:
- Around line 134-153: Reorder the two headings so the "Next steps" section is
the final section: move the entire "## Remove enterprise login" block (including
its numbered steps and the "!!! warning" admonition) to appear before the "##
Next steps" heading, or alternatively move the "## Next steps" block to the end
of the file; ensure the headings "## Remove enterprise login" and "## Next
steps" remain intact and that the file ends with the "## Next steps" section.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8179c26f-3c5f-4666-8943-7d74abffdb8c
⛔ Files ignored due to path filters (1)
en/asgardeo/docs/assets/img/guides/users/enterprise-login-configurations.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/asgardeo/docs/guides/users/configure-enterprise-login.mden/asgardeo/mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
- en/asgardeo/mkdocs.yml
1 participant
Purpose
Adding docs for console enterprise login feature
Related PRs
wso2/identity-apps#9671
Test environment
Security checks
Summary by CodeRabbit