Add docs for B2B user sharing#6020
Merged
pavinduLakshan merged 6 commits intowso2:masterfrom Apr 7, 2026
Merged
Conversation
Contributor
|
Caution Review failedPull request was closed or merged during review 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:
WalkthroughMoved the "Filter users" section earlier in the manage-users guide, added a new "Share user with organizations" console workflow, demoted a label to Changes
Sequence Diagram(s)sequenceDiagram
participant Admin as Admin Console
participant API as Identity Server API
participant OrgDB as Organizations Store
participant UserDB as User Store
rect rgba(135,206,250,0.5)
Admin->>API: Open user → Edit → Open "Shared Access"
end
rect rgba(144,238,144,0.5)
Admin->>API: Choose "Do not share" / "Share with all" / "Share with selected"
API->>OrgDB: Query organizations (if selecting orgs)
API->>UserDB: Prepare role assignments for selected orgs
end
rect rgba(255,182,193,0.5)
Admin->>API: Save
API-->>Admin: Confirm update
API->>OrgDB: Persist sharing metadata
API->>UserDB: Persist role assignments
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 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.
🧹 Nitpick comments (3)
en/identity-server/next/docs/guides/users/manage-users.md (3)
79-79: Address the reader as "you" instead of "an administrator."The coding guidelines specify addressing the reader as "you." Line 79 uses "An administrator can share..." which distances the reader from the action.
✏️ Proposed revision
-An administrator can share a user with an organization (or multiple organizations) via the WSO2 Identity Server Console. +You can share a user with one or more organizations via the WSO2 Identity Server Console.As per coding guidelines: "Address the reader as 'you'"; also, "Use 'multiple' only when it adds clarity about behavior, constraints, or guarantees" (the plural form "organizations" already conveys plurality).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/docs/guides/users/manage-users.md` at line 79, Replace the impersonal sentence "An administrator can share a user with an organization (or multiple organizations) via the WSO2 Identity Server Console." with a direct address using "you", e.g. "You can share a user with an organization or organizations via the WSO2 Identity Server Console." — remove the parenthetical "or multiple" per the guideline and keep the rest of the sentence intact.
20-26: Consider reducing repetitive sentence structure.The bullet points at lines 20-25 all begin with "Filters users," which reduces readability. Consider varying the structure or omitting the redundant phrase.
✏️ Proposed revision for variety
- **Locked**: Filters users with locked accounts. - - **Disabled**: Filters users with deactivated accounts. - - **Pending password reset**: Filters users for whom the administrator has initiated a forced password reset, but the users haven't yet reset their passwords. - - **Pending initial password setup**: Filters users an administrator invited to set their own password during initial account creation but who haven't done so yet. - - **Pending email verification**: Filters users who haven't yet verified their primary email addresses. - - **Pending mobile verification**: Filters users who haven't yet verified their primary mobile numbers. + - **Disabled**: Shows users with deactivated accounts. + - **Pending password reset**: Shows users for whom the administrator has initiated a forced password reset, but the users haven't yet reset their passwords. + - **Pending initial password setup**: Shows users an administrator invited to set their own password during initial account creation but who haven't done so yet. + - **Pending email verification**: Shows users who haven't yet verified their primary email addresses. + - **Pending mobile verification**: Shows users who haven't yet verified their primary mobile numbers.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/docs/guides/users/manage-users.md` around lines 20 - 26, The six bullet descriptions repeat the phrase "Filters users," making them verbose; update the bullets in the manage-users.md section so each starts with the status term (e.g., "Locked:", "Disabled:") followed by a concise, varied description without the redundant "Filters users" prefix — for example "Locked: accounts that are locked," "Disabled: deactivated accounts," "Pending password reset: administratively initiated reset not yet completed," "Pending initial password setup: invited users who haven't set a password," "Pending email verification: primary email not yet verified," and "Pending mobile verification: primary mobile not yet verified."
13-13: Consider addressing the reader as "you."Line 13 uses "Administrators can filter..." which could be more direct. The coding guidelines specify addressing the reader as "you."
✏️ Proposed revision
-Administrators can filter users based on their account status from the {{ product_name }} Console. +You can filter users based on their account status from the {{ product_name }} Console.As per coding guidelines: "Address the reader as 'you'."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/docs/guides/users/manage-users.md` at line 13, Replace the third-person sentence "Administrators can filter users based on their account status from the {{ product_name }} Console." with a second-person phrasing that addresses the reader (for example, "You can filter users based on their account status from the {{ product_name }} Console.") and update any similar occurrences of "Administrators can..." in manage-users.md to use "You" for consistency with the coding guidelines.
🤖 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/identity-server/next/docs/guides/users/manage-users.md`:
- Line 79: Replace the impersonal sentence "An administrator can share a user
with an organization (or multiple organizations) via the WSO2 Identity Server
Console." with a direct address using "you", e.g. "You can share a user with an
organization or organizations via the WSO2 Identity Server Console." — remove
the parenthetical "or multiple" per the guideline and keep the rest of the
sentence intact.
- Around line 20-26: The six bullet descriptions repeat the phrase "Filters
users," making them verbose; update the bullets in the manage-users.md section
so each starts with the status term (e.g., "Locked:", "Disabled:") followed by a
concise, varied description without the redundant "Filters users" prefix — for
example "Locked: accounts that are locked," "Disabled: deactivated accounts,"
"Pending password reset: administratively initiated reset not yet completed,"
"Pending initial password setup: invited users who haven't set a password,"
"Pending email verification: primary email not yet verified," and "Pending
mobile verification: primary mobile not yet verified."
- Line 13: Replace the third-person sentence "Administrators can filter users
based on their account status from the {{ product_name }} Console." with a
second-person phrasing that addresses the reader (for example, "You can filter
users based on their account status from the {{ product_name }} Console.") and
update any similar occurrences of "Administrators can..." in manage-users.md to
use "You" for consistency with the coding guidelines.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 72539a58-d480-4da9-a45c-4557b24435a7
⛔ Files ignored due to path filters (1)
en/identity-server/next/docs/assets/img/guides/users/share-user-with-all-organizations.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/identity-server/next/docs/guides/users/manage-users.mden/includes/guides/organization-management/share-user-profiles.md
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (3)
en/includes/guides/organization-management/share-user-profiles.md (1)
13-13: Polish the sentence for smoother flowThe new conditional option is correct, but the phrase “or using the” reads awkwardly. Consider “or by using the” (or reordering the clause) to keep the procedure text natural and concise.
As per coding guidelines, "Use plain language and short sentences" and "Use precise nouns and strong verbs."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/organization-management/share-user-profiles.md` at line 13, The sentence reads awkwardly where the conditional clause inserts a choice; update the wording to improve flow by replacing "or {% endif %} using the" with "or {% endif %} by using the" (or alternatively reorder to "or by using the [User Sharing API]..." so the clause reads: "An admin can share users of an organization with other organizations lower in the hierarchy {% if is_version > "7.2.0" %}[through the {{product_name}} Console]({{base_path}}/guides/users/manage-users/#share-user-with-organizations) or by using the [User Sharing API]({{base_path}}/apis/organization-user-share-rest-api)." Ensure the template variables ({{product_name}}, {{base_path}}) and the conditional {% if is_version > "7.2.0" %} remain intact.en/identity-server/next/docs/guides/users/manage-users.md (2)
78-78: Remove redundant "multiple" qualifier.The phrase "(or multiple organizations)" is unnecessary because "organizations" (plural) already conveys that the user can be shared with one or more organizations. As per coding guidelines, use "multiple" only when it adds clarity about specific behavior, constraints, or guarantees.
Proposed simplification
-An administrator can share a user with an organization (or multiple organizations) via the WSO2 Identity Server Console. +An administrator can share a user with organizations via the WSO2 Identity Server Console.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/docs/guides/users/manage-users.md` at line 78, Summary: The sentence in manage-users.md redundantly uses "(or multiple organizations)"; remove the parenthetical so the plural "organizations" covers one or more. Fix: edit the sentence "An administrator can share a user with an organization (or multiple organizations) via the WSO2 Identity Server Console." in the manage-users.md content and replace it with "An administrator can share a user with an organization via the WSO2 Identity Server Console." but better: "An administrator can share a user with organizations via the WSO2 Identity Server Console." Ensure no other occurrences of the same redundant parenthetical remain in the file.
82-98: Use consistent product name template and consider more active voice.Product name consistency:
Line 82 uses "WSO2 Identity Server Console" while the file consistently uses{{ product_name }} Consoleelsewhere (lines 13, 17, 277, 302). Using the template variable improves maintainability.Active voice:
Lines 92 and 96 use passive constructions ("user is shared", "should be assigned") that could be more direct and user-focused. As per coding guidelines, prefer active voice when the actor is known.Proposed improvements
-1. On the WSO2 Identity Server Console, go to **User Management** > **Users**. +1. On the {{ product_name }} Console, go to **User Management** > **Users**. - **Do not share user with any organization** - user will not be shared with any organizations. - - **Share user with all organizations** - user is shared with all current and future organizations. When the user is shared, administrators can also configure which roles should be assigned to the user in the shared organizations. + - **Share user with all organizations** - shares the user with all current and future organizations. You can also assign roles to the user in the shared organizations. {: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} - - **Share user with selected organizations** - user is shared with a specific set of existing organizations, but they are not shared with the future organizations. Administrators can configure which roles should be assigned to the user in the shared organizations. + - **Share user with selected organizations** - shares the user with specific existing organizations only (not future organizations). You can assign roles to the user in the shared organizations.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/docs/guides/users/manage-users.md` around lines 82 - 98, Replace the hard-coded product name "WSO2 Identity Server Console" with the template variable "{{ product_name }} Console" for consistency, and rewrite the passive-voice lines in the "Shared Access" bullet descriptions to active voice (update the three bullets: "Do not share user with any organization", "Share user with all organizations", and "Share user with selected organizations") so they read clearly (e.g., "Do not share the user with any organization", "Share the user with all current and future organizations; administrators can also configure which roles administrators assign to the user in shared organizations", "Share the user with selected existing organizations; administrators can configure which roles they assign in those organizations"). Ensure the "Shared Access" tab and option labels remain unchanged except for product name and voice edits.
🤖 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/identity-server/next/docs/guides/users/manage-users.md`:
- Line 78: Summary: The sentence in manage-users.md redundantly uses "(or
multiple organizations)"; remove the parenthetical so the plural "organizations"
covers one or more. Fix: edit the sentence "An administrator can share a user
with an organization (or multiple organizations) via the WSO2 Identity Server
Console." in the manage-users.md content and replace it with "An administrator
can share a user with an organization via the WSO2 Identity Server Console." but
better: "An administrator can share a user with organizations via the WSO2
Identity Server Console." Ensure no other occurrences of the same redundant
parenthetical remain in the file.
- Around line 82-98: Replace the hard-coded product name "WSO2 Identity Server
Console" with the template variable "{{ product_name }} Console" for
consistency, and rewrite the passive-voice lines in the "Shared Access" bullet
descriptions to active voice (update the three bullets: "Do not share user with
any organization", "Share user with all organizations", and "Share user with
selected organizations") so they read clearly (e.g., "Do not share the user with
any organization", "Share the user with all current and future organizations;
administrators can also configure which roles administrators assign to the user
in shared organizations", "Share the user with selected existing organizations;
administrators can configure which roles they assign in those organizations").
Ensure the "Shared Access" tab and option labels remain unchanged except for
product name and voice edits.
In `@en/includes/guides/organization-management/share-user-profiles.md`:
- Line 13: The sentence reads awkwardly where the conditional clause inserts a
choice; update the wording to improve flow by replacing "or {% endif %} using
the" with "or {% endif %} by using the" (or alternatively reorder to "or by
using the [User Sharing API]..." so the clause reads: "An admin can share users
of an organization with other organizations lower in the hierarchy {% if
is_version > "7.2.0" %}[through the {{product_name}}
Console]({{base_path}}/guides/users/manage-users/#share-user-with-organizations)
or by using the [User Sharing
API]({{base_path}}/apis/organization-user-share-rest-api)." Ensure the template
variables ({{product_name}}, {{base_path}}) and the conditional {% if is_version
> "7.2.0" %} remain intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7fadc510-b568-4264-bc4c-fb7790dda341
📒 Files selected for processing (2)
en/identity-server/next/docs/guides/users/manage-users.mden/includes/guides/organization-management/share-user-profiles.md
pavinduLakshan
commented
Apr 7, 2026
Malith-19
approved these changes
Apr 7, 2026
Malith-19
approved these changes
Apr 7, 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
$subject
Related PRs
Test environment
Security checks
Summary by CodeRabbit
New Features
Documentation
Chores