Skip to content

Add B2B concepts guide with hierarchy and terminology#5863

Open
HasiniSama wants to merge 1 commit intowso2:masterfrom
HasiniSama:b2b-concepts
Open

Add B2B concepts guide with hierarchy and terminology#5863
HasiniSama wants to merge 1 commit intowso2:masterfrom
HasiniSama:b2b-concepts

Conversation

@HasiniSama
Copy link
Contributor

@HasiniSama HasiniSama commented Jan 28, 2026

NOTE: Last two diagrams needs to be updated according to the usecase.

Screenshot 2026-02-16 at 08 59 08 Screenshot 2026-02-16 at 08 59 15 Screenshot 2026-02-16 at 09 02 26 Screenshot 2026-02-16 at 09 02 30 Screenshot 2026-02-16 at 09 02 36 Screenshot 2026-02-16 at 09 02 42 Screenshot 2026-02-16 at 09 02 54

Purpose

Comprehensive documentation covering organizations, hierarchy (root/child), ownership vs sharing, inheritance model, and Management vs Organization APIs.

Related Issue

Summary by CodeRabbit

  • Documentation
    • Added comprehensive B2B concepts documentation covering organizational structure, hierarchy, ownership vs. sharing rules, inheritance behavior, and guidance for Management vs. Organization APIs, with examples and diagrams.
    • Added an "Overview" entry under the Organizations section of the site navigation to surface the new B2B documentation.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

Adds a new Organizations overview guide across all documentation versions (7.0.0, 7.1.0, 7.2.0, and next) by creating a shared canonical documentation file and adding navigation entries. Version-specific documents include content from the shared source to avoid duplication.

Changes

Cohort / File(s) Summary
Navigation Updates
en/identity-server/{7.0.0,7.1.0,7.2.0,next}/mkdocs.yml
Added navigation entry Overview: guides/organization-management/organizations-overview.md under the Organizations section across all documentation versions.
Version-Specific Overview Documents
en/identity-server/{7.0.0,7.1.0,7.2.0,next}/docs/guides/organization-management/organizations-overview.md
Created new placeholder files containing a single include directive that references the shared canonical documentation source.
Canonical Documentation
en/includes/guides/organization-management/organizations-overview.md
New comprehensive Organizations overview guide (148 lines) covering core concepts, organization hierarchy, root/parent/child structures, resource behavior, Management APIs vs Organization APIs, and next steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A guide for organizing was born today,
With shared content showing the way,
Four versions now know where to browse,
To manage their organizational rows! 📋✨

🚥 Pre-merge checks | ✅ 2 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Merge Conflict Detection ⚠️ Warning ❌ Merge conflicts detected (97 files):

⚔️ .vale/styles/Microsoft/Acronyms.yml (content)
⚔️ .vale/styles/Microsoft/Vocab.yml (content)
⚔️ .vale/styles/WSO2-IAM/SentenceStyleTitles.yml (content)
⚔️ en/asgardeo/docs/apis/organization-apis/restapis/application.yaml (content)
⚔️ en/asgardeo/docs/apis/organization-apis/restapis/org-application-mgt.yaml (content)
⚔️ en/asgardeo/docs/apis/restapis/application-management.yaml (content)
⚔️ en/asgardeo/docs/get-started/try-samples/index.md (content)
⚔️ en/asgardeo/docs/get-started/try-samples/qsg-oidc-webapp-java-ee.md (content)
⚔️ en/asgardeo/docs/get-started/try-samples/qsg-saml-webapp-java-ee.md (content)
⚔️ en/asgardeo/docs/get-started/try-samples/qsg-spa-javascript.md (content)
⚔️ en/asgardeo/docs/get-started/try-samples/qsg-spa-react.md (content)
⚔️ en/asgardeo/docs/guides/authentication/configure-token-exchange.md (content)
⚔️ en/asgardeo/docs/references/app-native-authentication.md (content)
⚔️ en/asgardeo/docs/references/grant-types.md (content)
⚔️ en/asgardeo/mkdocs.yml (content)
⚔️ en/base.yml (content)
⚔️ en/identity-server/5.11.0/docs/administer/product-level-security-guidelines.md (content)
⚔️ en/identity-server/6.0.0/docs/deploy/security/product-level-security-guidelines.md (content)
⚔️ en/identity-server/6.0.0/docs/guides/passwordless/fido.md (content)
⚔️ en/identity-server/6.1.0/docs/deploy/security/product-level-security-guidelines.md (content)
⚔️ en/identity-server/6.1.0/docs/deploy/token-persistence.md (content)
⚔️ en/identity-server/7.0.0/docs/deploy/environment-compatibility.md (content)
⚔️ en/identity-server/7.0.0/docs/deploy/security/security-guidelines/product-level-security-guidelines.md (content)
⚔️ en/identity-server/7.0.0/docs/get-started/try-samples/index.md (content)
⚔️ en/identity-server/7.0.0/docs/get-started/try-samples/qsg-oidc-webapp-java-ee.md (content)
⚔️ en/identity-server/7.0.0/docs/get-started/try-samples/qsg-saml-webapp-java-ee.md (content)
⚔️ en/identity-server/7.0.0/docs/get-started/try-samples/qsg-spa-javascript.md (content)
⚔️ en/identity-server/7.0.0/docs/get-started/try-samples/qsg-spa-react.md (content)
⚔️ en/identity-server/7.0.0/docs/get-started/try-samples/ws-federation-webapp.md (content)
⚔️ en/identity-server/7.0.0/docs/guides/authentication/configure-jwt-bearer-grant.md (content)
⚔️ en/identity-server/7.0.0/mkdocs.yml (content)
⚔️ en/identity-server/7.1.0/docs/deploy/configure/databases/carbon-database/change-to-postgresql.md (content)
⚔️ en/identity-server/7.1.0/docs/deploy/monitor/monitor-logs.md (content)
⚔️ en/identity-server/7.1.0/docs/deploy/product-compatibility.md (content)
⚔️ en/identity-server/7.1.0/docs/deploy/security/security-guidelines/product-level-security-guidelines.md (content)
⚔️ en/identity-server/7.1.0/docs/get-started/try-samples/index.md (content)
⚔️ en/identity-server/7.1.0/docs/get-started/try-samples/qsg-oidc-webapp-java-ee.md (content)
⚔️ en/identity-server/7.1.0/docs/get-started/try-samples/qsg-saml-webapp-java-ee.md (content)
⚔️ en/identity-server/7.1.0/docs/get-started/try-samples/qsg-spa-javascript.md (content)
⚔️ en/identity-server/7.1.0/docs/get-started/try-samples/qsg-spa-react.md (content)
⚔️ en/identity-server/7.1.0/docs/get-started/try-samples/ws-federation-webapp.md (content)
⚔️ en/identity-server/7.1.0/docs/guides/authentication/configure-jwt-bearer-grant.md (content)
⚔️ en/identity-server/7.1.0/mkdocs.yml (content)
⚔️ en/identity-server/7.2.0/docs/deploy/monitor/monitor-logs.md (content)
⚔️ en/identity-server/7.2.0/docs/deploy/product-compatibility.md (content)
⚔️ en/identity-server/7.2.0/docs/deploy/security/security-guidelines/product-level-security-guidelines.md (content)
⚔️ en/identity-server/7.2.0/docs/get-started/try-samples/index.md (content)
⚔️ en/identity-server/7.2.0/docs/get-started/try-samples/qsg-oidc-webapp-java-ee.md (content)
⚔️ en/identity-server/7.2.0/docs/get-started/try-samples/qsg-saml-webapp-java-ee.md (content)
⚔️ en/identity-server/7.2.0/docs/get-started/try-samples/qsg-spa-javascript.md (content)
⚔️ en/identity-server/7.2.0/docs/get-started/try-samples/qsg-spa-react.md (content)
⚔️ en/identity-server/7.2.0/docs/get-started/try-samples/ws-federation-webapp.md (content)
⚔️ en/identity-server/7.2.0/docs/guides/authentication/configure-jwt-bearer-grant.md (content)
⚔️ en/identity-server/7.2.0/docs/tutorials/index.md (content)
⚔️ en/identity-server/7.2.0/mkdocs.yml (content)
⚔️ en/identity-server/next/docs/apis/organization-apis/restapis/application.yaml (content)
⚔️ en/identity-server/next/docs/apis/organization-apis/restapis/org-application-mgt.yaml (content)
⚔️ en/identity-server/next/docs/apis/restapis/application.yaml (content)
⚔️ en/identity-server/next/docs/apis/restapis/configs.yaml (content)
⚔️ en/identity-server/next/docs/deploy/monitor/monitor-logs.md (content)
⚔️ en/identity-server/next/docs/deploy/product-compatibility.md (content)
⚔️ en/identity-server/next/docs/deploy/security/security-guidelines/product-level-security-guidelines.md (content)
⚔️ en/identity-server/next/docs/get-started/try-samples/index.md (content)
⚔️ en/identity-server/next/docs/get-started/try-samples/qsg-oidc-webapp-java-ee.md (content)
⚔️ en/identity-server/next/docs/get-started/try-samples/qsg-saml-webapp-java-ee.md (content)
⚔️ en/identity-server/next/docs/get-started/try-samples/qsg-spa-javascript.md (content)
⚔️ en/identity-server/next/docs/get-started/try-samples/qsg-spa-react.md (content)
⚔️ en/identity-server/next/docs/get-started/try-samples/ws-federation-webapp.md (content)
⚔️ en/identity-server/next/docs/get-started/try-your-own-app/index.md (content)
⚔️ en/identity-server/next/docs/guides/authentication/configure-jwt-bearer-grant.md (content)
⚔️ en/identity-server/next/docs/references/app-native-authentication.md (content)
⚔️ en/identity-server/next/mkdocs.yml (content)
⚔️ en/includes/apis/scim2/scim2-batch-operations.md (content)
⚔️ en/includes/connectors/onfido/set-up.md (content)
⚔️ en/includes/deploy/configure/configure-cors.md (content)
⚔️ en/includes/guides/authentication/configure-jwt-bearer-grant.md (content)
⚔️ en/includes/guides/authentication/mfa/add-totp-login.md (content)
⚔️ en/includes/guides/authentication/mfa/add-x509-login.md (content)
⚔️ en/includes/guides/authentication/oidc/encrypt-decrypt-id-tokens.md (content)
⚔️ en/includes/guides/authentication/oidc/validate-id-tokens.md (content)
⚔️ en/includes/guides/authentication/oidc/validate-jwt-with-jwks.md (content)
⚔️ en/includes/guides/authentication/saml/saml-artifact-binding.md (content)
⚔️ en/includes/guides/authentication/saml/saml-back-channel-logout.md (content)
⚔️ en/includes/guides/authorization/rich-authorization-requests.md (content)
⚔️ en/includes/guides/fragments/add-login/eid-login/add-franceconnect-login.md (content)
⚔️ en/includes/guides/fragments/manage-app/oidc-settings/access-token.md (content)
⚔️ en/includes/guides/service-extensions/in-flow-extensions/custom-authentication.md (content)
⚔️ en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-issue-access-token-action-v1.x.md (content)
⚔️ en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-password-action-v1.x.md (content)
⚔️ en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-password-action-v2.x.md (content)
⚔️ en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-profile-action-v1.x.md (content)
⚔️ en/includes/references/app-settings/oidc-settings-for-app.md (content)
⚔️ en/includes/references/extend/user-stores/write-a-custom-user-store-manager.md (content)
⚔️ en/includes/references/grant-types.md (content)
⚔️ en/includes/tutorials/secure-agentic-ai-systems.md (content)
⚔️ en/package-lock.json (content)
⚔️ en/theme/material/templates/connectors.html (content)

These conflicts must be resolved before merging into master.
Resolve conflicts locally and push changes to this branch.
Description check ⚠️ Warning The PR description is largely incomplete and deviates from the repository's template structure, missing critical sections. Add the following sections: Purpose (with issue links in 'Resolves issue' format), Related PRs, Test environment, and complete Security checks with checkboxes marked. Replace diagram images with descriptive text of proposed changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding B2B concepts documentation covering organizations, hierarchy, and terminology, which aligns with the primary addition of the organizations-overview guide across multiple versions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
⚔️ Resolve merge conflicts (beta)
  • Auto-commit resolved conflicts to branch b2b-concepts
  • Post resolved changes as copyable diffs in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@en/includes/concepts/b2b-concepts.md`:
- Around line 248-268: The example endpoint strings in the Root organization
section (`https://api.example.com/management/v1/organizations`) and Organization
APIs section (`https://api.example.com/o/{org-id}/users`) are misleading; update
them to either the realistic documented paths (e.g.,
`https://{{host}}/api/server/v1/organizations` for root org APIs and
`https://{{host}}/o/api/server/v1/applications` or
`https://{{host}}/o/scim/Users` for org-scoped APIs) or explicitly mark the
examples as non-functional placeholders (e.g., prefix with "Example
placeholder:"), replacing the incorrect `/management/v1/organizations` and
`/o/{org-id}/users` strings in en/includes/concepts/b2b-concepts.md so readers
won’t copy-paste the wrong endpoints.
🧹 Nitpick comments (1)
en/includes/concepts/b2b-concepts.md (1)

42-45: Clarify “root organization” vs “tenant.”

The parenthetical “(also called tenant)” could be confusing in multitenant IS deployments. Consider a short clarification (or a link to the multitenancy guide) to explain how “tenant” maps to “root organization.”

@HasiniSama HasiniSama force-pushed the b2b-concepts branch 2 times, most recently from 22ea4cf to 9642bf7 Compare January 30, 2026 09:17
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@en/includes/concepts/b2b-concepts.md`:
- Line 70: Replace the typo in the sentence "Sets heirarchy-vise policies." by
updating the phrase to "Sets hierarchy-wise policies." — locate the exact line
containing "Sets heirarchy-vise policies." in the b2b-concepts content and
change "heirarchy-vise" to "hierarchy-wise".
- Line 68: The sentence "Creates their own child organizations." uses the plural
pronoun "their" for the singular subject "Root organization"; update the text in
en/includes/concepts/b2b-concepts.md replacing "their" with "its" so the line
reads "Creates its own child organizations." to fix pronoun-antecedent
agreement.
🧹 Nitpick comments (3)
en/includes/concepts/b2b-concepts.md (3)

27-27: Complete the section heading.

The heading "Choose B2B when you [Need to be updated]" has an incomplete placeholder. Please finalize this section with the appropriate criteria.

Would you like me to suggest completion options based on the list items that follow (lines 29-32)?


91-91: Use plural form for consistency.

All other items in the list use plural forms ("applications, roles, and users" in line 47; "roles" and "users" in this line). Change "application" to "applications" for parallelism.

📝 Proposed fix
-- Manages its own application, roles, and users.
+- Manages its own applications, roles, and users.

153-153: Complete the section heading.

The heading "⑥ Putting it all together [Need to be updated]" has a placeholder marker. Please finalize this heading to remove the TODO note.

If the current heading is acceptable, simply remove "[Need to be updated]". Otherwise, let me know if you'd like suggestions for alternative titles.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@en/includes/concepts/organizations-overview.md`:
- Around line 39-44: Fix the typo in the text snippet in
en/includes/concepts/organizations-overview.md by replacing "heirarchy-vise"
with the correct phrase "hierarchy-wise" in the line containing "- Sets
heirarchy-vise policies." so the bullet reads "- Sets hierarchy-wise policies."
- Around line 62-67: Update the pluralization in the bullet list by changing the
phrase "Manages its own application, roles, and users." to "Manages its own
applications, roles, and users." so it matches the other plural nouns; locate
this string in en/includes/concepts/organizations-overview.md and replace
"application" with "applications" in the list item.
🧹 Nitpick comments (1)
en/includes/concepts/organizations-overview.md (1)

75-78: Consider splitting the dense resource table for readability.

The "Resources" row on line 78 packs a large number of items into two cells, which makes the source hard to review and maintain. Consider using sub-tables or bullet lists within each column, or breaking this into separate tables per resource behavior type.


An **organization** represents one entity in your system.

Each organization has its own applications, roles, APIs, and users. Organizations can customize login pages, branding, and have dedicated administrators with isolated data and configurations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we remove APIs from this list, as we don't have the capability to define APIs in the child orgs.
Update the image as well

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.

2 participants