Add documentation for configuring the home realm identifier#6037
Merged
DilshanSenarath merged 3 commits intowso2:masterfrom Apr 8, 2026
Merged
Add documentation for configuring the home realm identifier#6037DilshanSenarath merged 3 commits intowso2:masterfrom
DilshanSenarath merged 3 commits intowso2:masterfrom
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughConditional rendering in the federated login guide was changed: for Changes
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/includes/guides/fragments/manage-connection/home-realm-identifier.md`:
- Around line 17-24: The fenced code block that begins with the
authorization-request URL "https://<host_name>/t/<org_name>/oauth2/authorize?"
should include a language tag; update the opening fence from ``` to ```text so
the snippet is marked as plain text (e.g., change the code block containing the
response_type/client_id/redirect_uri/scope/fidp lines to use ```text).
- Line 11: Remove the inserted image reference line containing ""
from manage-connection/home-realm-identifier.md and replace it with a brief,
text-only instruction or step describing the Home Realm Identifier configuration
(e.g., a one-sentence description of what to enter or where to find the setting)
so the task flow contains no new screenshots and remains fully text-based.
🪄 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: CHILL
Plan: Pro
Run ID: 208abf6f-1f6b-4d9d-b884-7eaa6a165a0d
⛔ Files ignored due to path filters (3)
en/asgardeo/docs/assets/img/guides/connections/home-realm-identifier.pngis excluded by!**/*.pngen/identity-server/7.2.0/docs/assets/img/guides/connections/home-realm-identifier.pngis excluded by!**/*.pngen/identity-server/next/docs/assets/img/guides/connections/home-realm-identifier.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/includes/guides/authentication/federated-login/index.mden/includes/guides/fragments/manage-connection/home-realm-identifier.md
en/includes/guides/fragments/manage-connection/home-realm-identifier.md
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (2)
en/includes/guides/fragments/manage-connection/home-realm-identifier.md (2)
11-11:⚠️ Potential issue | 🟠 MajorRemove the screenshot from the task flow.
This adds a new image to procedural documentation, which is disallowed by the documentation rules.
🧹 Suggested change
- {: 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.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/fragments/manage-connection/home-realm-identifier.md` at line 11, Remove the added image markdown line referencing "Home realm identifier configuration" (the entire {: ...} line) from manage-connection/home-realm-identifier.md; if visual context is required, replace it with a short textual description of the UI step rather than adding or referencing any new image, ensuring the file no longer introduces or links to a screenshot.
17-24:⚠️ Potential issue | 🟡 MinorUse
textinstead ofbashfor the URL template block.The snippet is not a shell command, so
bashis misleading.📝 Suggested change
-```bash +```text https://<host_name>/t/<org_name>/oauth2/authorize? response_type=code &client_id=<client_id> &redirect_uri=<redirect_uri> &scope=openid &fidp=<home_realm_identifier></details> As per coding guidelines: “Use fenced code blocks with a language tag when known.” <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@en/includes/guides/fragments/manage-connection/home-realm-identifier.md
around lines 17 - 24, Replace the misleading fenced code block language tag
"bash" with "text" in the URL template block (the triple-backtick opening that
currently readsbash) so the snippet is correctly marked as plain text; update the opening fence totext and leave the URL content unchanged (the
block that begins with "https://<host_name>/t/<org_name>/oauth2/authorize?").</details> </blockquote></details> </blockquote></details> <details> <summary>🧹 Nitpick comments (1)</summary><blockquote> <details> <summary>en/includes/guides/fragments/manage-connection/home-realm-identifier.md (1)</summary><blockquote> `1-1`: **Split the opening paragraph into shorter sentences.** This sentence is too long for quick scanning and fails the short-sentence style rule. <details> <summary>✂️ Suggested rewrite</summary> ```diff -The home realm identifier is a unique value that identifies a connection when routing users directly to a specific external IdP during login. When a user initiates login, your application can include this identifier as the `fidp` query parameter in the authorization request, which causes {{ product_name }} to skip the login page and route the user directly to the specified external IdP. +The home realm identifier is a unique value for a connection. +When a user starts login, your application can pass this value as the `fidp` query parameter in the authorization request. +{{ product_name }} then skips the login page and routes the user directly to the specified external IdP. ``` </details> As per coding guidelines: “Use plain language and short sentences.” <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/fragments/manage-connection/home-realm-identifier.md` at line 1, Split the long opening sentence in manage-connection/home-realm-identifier.md into two or three short sentences for readability: keep the first sentence to define the home realm identifier as a unique value that identifies a connection for routing users to an external IdP, then start a new sentence explaining how your application can include this identifier as the `fidp` query parameter in the authorization request, and finish with a short sentence stating that this causes {{ product_name }} to skip the login page and route the user directly to the specified external IdP. ``` </details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In@en/includes/guides/fragments/manage-connection/home-realm-identifier.md:
- Line 11: Remove the added image markdown line referencing "Home realm
identifier configuration" (the entire{:
...} line) from manage-connection/home-realm-identifier.md; if visual context is
required, replace it with a short textual description of the UI step rather than
adding or referencing any new image, ensuring the file no longer introduces or
links to a screenshot.- Around line 17-24: Replace the misleading fenced code block language tag
"bash" with "text" in the URL template block (the triple-backtick opening that
currently readsbash) so the snippet is correctly marked as plain text; update the opening fence totext and leave the URL content unchanged (the
block that begins with "https://<host_name>/t/<org_name>/oauth2/authorize?").
Nitpick comments:
In@en/includes/guides/fragments/manage-connection/home-realm-identifier.md:
- Line 1: Split the long opening sentence in
manage-connection/home-realm-identifier.md into two or three short sentences for
readability: keep the first sentence to define the home realm identifier as a
unique value that identifies a connection for routing users to an external IdP,
then start a new sentence explaining how your application can include this
identifier as thefidpquery parameter in the authorization request, and
finish with a short sentence stating that this causes {{ product_name }} to skip
the login page and route the user directly to the specified external IdP.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Path: .coderabbit.yml **Review profile**: CHILL **Plan**: Pro **Run ID**: `b64ca1c3-2786-4d9b-99f7-4168b52a0145` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 1b8b2f2f0ba58a7b055124f47c2f38c22d51cfb6 and 643953ac835619c8f8beecbbaa08488bf975afae. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `en/includes/guides/authentication/federated-login/index.md` * `en/includes/guides/fragments/manage-connection/home-realm-identifier.md` </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary> * en/includes/guides/authentication/federated-login/index.md </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
ZiyamSanthosh
approved these changes
Apr 8, 2026
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
2 participants
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.
Purpose
Related PRs
Test environment
Security checks
Screenshot