Skip to content

Update IdP Group Sync#478

Open
danciaclara wants to merge 2 commits into
masterfrom
update-idp-group-sync
Open

Update IdP Group Sync#478
danciaclara wants to merge 2 commits into
masterfrom
update-idp-group-sync

Conversation

@danciaclara

@danciaclara danciaclara commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Expanded IdP group synchronization guidance to cover workspace roles, project access, and private collection access.
    • Added setup instructions for login-based and scheduled synchronization, including key configuration options and provider limitations.
    • Clarified access mapping behavior (workspace, project, and private collection), revocation order, safeguards, seat-limit handling, and how sync errors affect sign-in.
    • Updated availability details and common use cases for supported editions.

@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 22, 2026 5:08pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The Group Sync guide now covers IdP-based workspace role provisioning, project access, and private collection access, with updated provider support, configuration options, mapping workflows, synchronization behavior, revocation rules, safeguards, and use cases.

Changes

IdP Group Sync

Layer / File(s) Summary
Provider scope and prerequisites
docs/authentication/group-sync.md
Updates page metadata, supported editions and providers, synchronization constraints, and group-claim prerequisites.
Sync configuration
docs/authentication/group-sync.md
Documents sync-on-login, offline sync limitations, automatic removal, group attributes, and default workspace roles.
Access mappings and sync behavior
docs/authentication/group-sync.md
Adds workspace role, project role, and private collection mappings, plus synchronization ordering, revocation behavior, safeguards, and expanded use cases.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: pablohashescobar

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and clearly describes the main change: expanding and revising IdP Group Sync documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-idp-group-sync

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/authentication/group-sync.md`:
- Line 142: Update the Contractor offboarding documentation to remove the
promise of immediate access revocation and state that revocation occurs at the
next SAML login or OIDC/LDAP scheduled sync.
- Line 57: Update both the Auto remove entry and its corresponding later rule in
group-sync documentation to state that removal revokes access granted by each
group mapping when that mapping no longer matches, including workspace, project,
and private-collection access. Ensure the wording no longer implies removal
happens only when no group matches.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6855590d-4d34-41e8-966a-230b669933dd

📥 Commits

Reviewing files that changed from the base of the PR and between ddd4dce and 38f65f5.

📒 Files selected for processing (1)
  • docs/authentication/group-sync.md

Comment thread docs/authentication/group-sync.md Outdated
| --- | --- | --- |
| **Sync on login** | Update the user's group membership and access when they sign in | Enabled |
| **Offline sync** | Run a sync every six hours automatically, without waiting for users to log in (OIDC and LDAP only) | Disabled |
| **Auto remove** | Remove users from the workspace and projects when no group matches | Disabled |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Clarify Auto remove scope and semantics.

The description omits private collection access and says removal occurs only when “no group matches,” while the later rules revoke group-synced access when any mapping no longer matches. Update both entries to describe per-mapping revocation across workspace, project, and private-collection access.

Also applies to: 109-109

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/authentication/group-sync.md` at line 57, Update both the Auto remove
entry and its corresponding later rule in group-sync documentation to state that
removal revokes access granted by each group mapping when that mapping no longer
matches, including workspace, project, and private-collection access. Ensure the
wording no longer implies removal happens only when no group matches.

Comment thread docs/authentication/group-sync.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/authentication/group-sync.md (1)

8-12: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Clarify why IdP Group Sync is tagged as Enterprise Grid.

The availability notes state this is supported on self-hosted Commercial and Airgapped Editions, but the badge labels it as “Enterprise Grid”. Align the badge text with the availability text or add a short clarification if Enterprise Grid is a prerequisite/scope, not the edition.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/authentication/group-sync.md` around lines 8 - 12, Update the IdP Group
Sync heading badge and availability note so they describe the same supported
scope; either change the “Enterprise Grid” badge to match the self-hosted
Commercial and Airgapped Editions, or add a concise clarification explaining
Enterprise Grid’s prerequisite or scope.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@docs/authentication/group-sync.md`:
- Around line 8-12: Update the IdP Group Sync heading badge and availability
note so they describe the same supported scope; either change the “Enterprise
Grid” badge to match the self-hosted Commercial and Airgapped Editions, or add a
concise clarification explaining Enterprise Grid’s prerequisite or scope.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d13a7586-0985-493c-a5c4-a80fc5ab4b8e

📥 Commits

Reviewing files that changed from the base of the PR and between 38f65f5 and e20e60c.

📒 Files selected for processing (1)
  • docs/authentication/group-sync.md

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.

1 participant