Skip to content

Conversation

@wso2-engineering-bot
Copy link

@wso2-engineering-bot wso2-engineering-bot commented Dec 16, 2025

This PR was automatically generated by Claude AI.

Changes Made

This PR addresses the missing documentation about the Enable Group Unique ID configuration requirement for LDAP user stores. Starting from WSO2 Identity Server 7.0.0, this configuration is mandatory to retrieve group lists from both read-write and read-only LDAP user stores.

Files Modified

  1. en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md
  2. en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md
  3. en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md
  4. en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md
  5. en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md
  6. en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md
  7. en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md
  8. en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md

What Was Added

Added a new section "Configure group unique ID support" in all affected files with:

  • Clear explanation of why this configuration is required (mandatory for retrieving group lists in IS 7.0.0+)
  • Code example showing how to configure GroupIDEnabled and GroupIdAttribute
  • Detailed notes explaining each configuration parameter
  • Reference to optional timestamp tracking configurations

Style Scope Verification

Microsoft Style Guidelines have been applied to the newly added content. The new section uses sentence case for headings, active voice, clear and concise language, and proper formatting for code elements and configuration parameters. Existing content was not modified for style purposes.

Verification

  • Documentation builds successfully for all affected versions (7.0.0, 7.1.0, 7.2.0, next)
  • No build errors introduced by these changes
  • Pre-existing warnings in the repository remain unchanged

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.5 [email protected]

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guidance for configuring group unique ID support in LDAP user stores across Identity Server versions 7.0.0 and later, including deployment configuration examples and optional date attribute settings.
    • Minor formatting improvements to existing documentation.

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

…fected versions (product-is#20283)

This commit adds clear documentation about configuring the Enable Group Unique ID
feature for LDAP user stores, which is required to retrieve group lists starting
from WSO2 Identity Server 7.0.0.

Changes:
- Added new section 'Configure group unique ID support' to both read-write and
  read-only LDAP user store configuration guides
- Updated versions: 7.0.0, 7.1.0, 7.2.0, and next
- Provided clear instructions with code examples and explanatory notes

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link

coderabbitai bot commented Dec 16, 2025

Walkthrough

Documentation additions across multiple WSO2 Identity Server version branches introduce a new "Configure group unique ID support" section for LDAP user stores. The section provides deployment.toml configuration examples for enabling Group Unique ID (GroupIDEnabled, GroupIdAttribute) with accompanying explanatory notes. Minor whitespace cleanup applied across affected documents.

Changes

Cohort / File(s) Summary
Read-only LDAP user store docs across versions
en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md, en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md, en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md, en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md
Added "Configure group unique ID support" section with GroupIDEnabled and GroupIdAttribute configuration. Includes deployment.toml examples, default value documentation, and optional GroupCreatedDateAttribute/GroupLastModifiedDateAttribute notes. Minor trailing-whitespace cleanup in existing warning line.
Read-write LDAP user store docs across versions
en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md, en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md, en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md, en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md
Added "Configure group unique ID support" section with GroupIDEnabled and GroupIdAttribute deployment.toml configuration. Includes accompanying notes on feature purpose, defaults, and optional date attributes. Minor formatting adjustment to existing timestamp attributes note.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Rationale: Documentation-only changes with highly repetitive additions applied across 8 files (same section added to parallel version branches). Minor whitespace corrections require minimal verification. Changes are straightforward configuration examples with no logic, behavioral impact, or public API modifications.

Poem

🐰 A carrot for each LDAP thread,
Group IDs now in docs are spread,
Across the versions, row by row—
Configuration fields aglow!
Identity stores, now they know. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers purpose, changes, files modified, and verification details; however, it lacks required template sections for test environment and security checks. Complete the PR description by adding Test environment section (JDK versions, OS, databases, browsers tested) and confirming security checks (secure coding standards, FindSecurityBugs, no secrets committed).
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding documentation about Group Unique ID configuration for LDAP user stores across affected versions, directly addressing the product issue referenced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fixing-product-is-issue-20283-1765865103

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2eb1e51 and 98e649f.

📒 Files selected for processing (8)
  • en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (1 hunks)
  • en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (2 hunks)
  • en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (1 hunks)
  • en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (2 hunks)
  • en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (1 hunks)
  • en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (1 hunks)
  • en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (1 hunks)
  • en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-01T15:31:14.922Z
Learnt from: Thisara-Welmilla
Repo: wso2/docs-is PR: 5732
File: en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-profile-action-v1.x.md:273-273
Timestamp: 2025-12-01T15:31:14.922Z
Learning: In the wso2/docs-is repository documentation files, prefer unhyphenated compound adjectives (e.g., "SCIM API compliant", "Admin initiated profile update") over hyphenated versions for better readability and natural flow.

Applied to files:

  • en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md
🔇 Additional comments (14)
en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (1)

28-43: Documentation addition is well-structured and accurate. The new "Configure group unique ID support" section clearly explains the Group Unique ID feature requirement, provides a complete deployment.toml configuration example, and notes all essential parameters with their purposes and defaults. Placement after the timestamp attributes section and before server configuration guidance is logical and maintains good document flow.

en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (2)

17-17: Whitespace cleanup is appreciated. Removing the trailing space in the note about timestamp attributes (line 17) improves consistency without affecting content.


28-43: Consistent documentation across versions. The "Configure group unique ID support" section maintains the same high-quality structure and accuracy as other version branches, ensuring uniform guidance for operators managing different IS versions.

en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (2)

23-24: Whitespace cleanup in warning note. Removing trailing space from line 24 improves consistency across documentation files without altering content or meaning.


26-41: Group Unique ID documentation is clear and well-placed. The section properly explains the requirement for group retrieval from LDAP, provides a complete configuration example, and clearly documents all parameters and optional attributes. Placement after the immutable attributes warning ensures logical document flow.

en/identity-server/next/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (1)

28-43: Configuration section is accurate and well-documented. The Group Unique ID support section provides clear guidance for read-write LDAP stores, with complete deployment.toml examples and properly explained parameters. Consistency with the read-only variant ensures operators receive aligned guidance regardless of store type.

en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (2)

24-24: Whitespace cleanup improves documentation consistency. Removing the trailing space in the immutable_attributes warning note (line 24) maintains formatting standards across versions.


26-41: 7.0.0 documentation properly addresses feature requirement. Since this is the version that introduced the Group Unique ID requirement for LDAP group retrieval, documenting this section is essential. The explanation is clear, the configuration example is complete, and all parameters are properly described.

en/identity-server/7.2.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (2)

24-24: Whitespace correction improves consistency. Removing trailing space from the immutable_attributes warning (line 24) aligns with documentation formatting standards.


26-41: Documentation for read-only LDAP stores is clear and complete. The Group Unique ID configuration section properly explains the feature, provides a working TOML example, and documents all parameters with defaults and optional attributes. Placement maintains logical document flow.

en/identity-server/7.0.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-write-ldap-user-store.md (2)

17-17: Whitespace cleanup maintains documentation consistency. Removing the trailing space in the timestamp attributes note (line 17) aligns with formatting standards across all version branches.


28-43: 7.0.0 read-write LDAP documentation is accurate and essential. Documenting the Group Unique ID feature requirement in the 7.0.0 branch (where the requirement was introduced) is critical. The section clearly explains the configuration, provides a complete TOML example, and documents all parameters. Consistency with the read-only variant ensures comprehensive coverage for both store types.

en/identity-server/7.1.0/docs/guides/users/user-stores/primary-user-store/configure-a-read-only-ldap-user-store.md (2)

24-24: Whitespace improvement for consistency. Removing the trailing space from the immutable_attributes warning (line 24) maintains formatting alignment across all version branches.


26-41: Read-only LDAP documentation is clear and comprehensive. The Group Unique ID support section properly documents the feature, provides working configuration examples, and explains all parameters. Placement and formatting are consistent with other version branches.


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.

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.

3 participants