-
Notifications
You must be signed in to change notification settings - Fork 609
Docs: Update ABAC Channel Access Rules documentation for v11.3 #8671
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,8 @@ Channel-specific access rules | |
|
|
||
| Channel and Team Admins can self-manage access controls for their private channels directly through the Channel Settings modal, without requiring System Admin intervention. For organization-wide policies created by System Admins, see :doc:`System-wide attribute-based access policies </administration-guide/manage/admin/abac-system-wide-policies>`. | ||
|
|
||
| Each ABAC channel access policy has an explicit **active state** that determines whether the policy's rules are enforced and whether automatic member synchronization applies to the channel. Channel-level (child) ABAC policies behave independently and consistently, even when parent system-wide policies exist. | ||
|
|
||
| With channel access rules, Channel and Team Admins can: | ||
|
|
||
| - Create channel-specific access rules using a simple interface. | ||
|
|
@@ -56,13 +58,14 @@ Channel access rules use the same simple interface as system policies, allowing | |
| Auto-sync membership | ||
| ~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The **Auto-add members based on access rules** toggle controls automatic membership management: | ||
| The **Auto-add members based on access rules** toggle controls automatic membership management. Auto-sync behavior follows the channel policy's active state, reducing unexpected inheritance-related behavior: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's not about inheritance but more giving the channel admin or system admin to decide if occasionally dropped members (eg. if users are losing attributes for some time), it will re-add them. Or you want to dedicate a channel to certain attribute and you always want to make sure people are in the channel. More like an alternative for LDAP group channels. |
||
|
|
||
| - **Enabled**: Users matching the rules are automatically added to the channel, and users who no longer match are removed | ||
| - **Disabled**: Rules act as a gate (preventing unauthorized joins) but don't automatically add qualifying users | ||
|
|
||
| .. important:: | ||
|
|
||
| - Auto-sync behavior is determined by the channel policy's active state, not inherited from parent policies. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💯 |
||
| - If a system policy has auto-sync enabled, Channel and Team Admins cannot disable it at the channel level. | ||
| - If a system policy has auto-sync disabled, Channel and Team Admins can choose to enable it for their channel. | ||
| - When no rules are configured, this toggle is automatically disabled. | ||
|
|
@@ -85,12 +88,15 @@ When you save changes that affect membership, a confirmation dialog shows you: | |
| Policy inheritance | ||
| -------------------- | ||
|
|
||
| Channel-level (child) ABAC policies now behave independently and consistently, even when parent system-wide policies exist. Each policy maintains its own active state and configuration. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💯 |
||
|
|
||
| When both :doc:`system policies </administration-guide/manage/admin/abac-system-wide-policies>` and channel rules are configured: | ||
|
|
||
| 1. **System policies** are displayed in a blue banner at the top (read-only) | ||
| 2. **Channel rules** are managed in the access rules section below | ||
| 3. **Users must satisfy BOTH** system policies and channel rules to access the channel | ||
| 4. Channel rules **add restrictions** but cannot weaken system policies | ||
| 5. **Auto-sync behavior** follows the channel policy's active state, not the parent system policy | ||
|
|
||
| Use cases and recommendations | ||
| ----------------------------- | ||
|
|
@@ -199,6 +205,13 @@ The auto-sync toggle is automatically disabled when: | |
| - No access rules are configured | ||
| - A system policy with auto-sync enabled is applied (Channel and Team Admins cannot disable it) | ||
| - There are validation errors in the current rules | ||
| - The channel's access control policy is not in an active state | ||
|
|
||
| If auto-sync is not behaving as expected, verify that the channel's access control policy is active. | ||
|
|
||
| .. note:: | ||
|
|
||
| **Troubleshooting auto-sync issues**: If auto-sync functionality is not working as expected, first verify that the channel's access control policy is in an active state. An inactive policy will prevent automatic member synchronization from occurring, even if the toggle appears to be enabled. | ||
|
|
||
| Synchronization and membership | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regardless of the active state, if there is a policy applied to a channel it will be enforced. The active state indicates that the users matching to the policy will be automatically added. System-wide policies can be inherited, but they don't have an influence on whether auto-add feature also inherited or not. Only the rules are inherited, for auto-add we check the individual channel policy.