-
Notifications
You must be signed in to change notification settings - Fork 615
Document v11.8.0 membership policies, recommended channels, leave confirmation, and policy simulation #9036
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 2 commits
d6d3dd0
620c38c
56a7ce9
dfb361e
0e58f35
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -20,7 +20,7 @@ Prerequisites | |||||
|
|
||||||
| - :doc:`Attribute-Based Access Control (ABAC) </administration-guide/manage/admin/attribute-based-access-control>` must be enabled by a System Admin in **System Console > System Attributes > Attribute-Based Access**. | ||||||
| - You need Channel Admin permissions and the ``manage_channel_access_rules`` permission. | ||||||
| - Channel access rules are available only for private channels. | ||||||
| - Self-service channel access rules in the **Access Control** tab in Channel Settings are configured for private channels. Membership policies apply to both public and private channels, with different behavior by channel type. See :ref:`Public and private channel behavior <administration-guide/manage/admin/abac-channel-access-rules:public and private channel behavior>`. | ||||||
|
|
||||||
| Access Channel Settings | ||||||
| ~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
@@ -86,6 +86,36 @@ When you save changes that affect membership, a confirmation dialog shows you: | |||||
| - Option to view the specific users affected | ||||||
| - Confirmation required before applying changes | ||||||
|
|
||||||
| Public and private channel behavior | ||||||
| ----------------------------------- | ||||||
|
|
||||||
| Membership policies behave differently depending on the type of channel they're applied to: | ||||||
|
|
||||||
| - **Private channels**: Membership policies are enforced. Users who match the policy's rules are added, and users who don't match the rules are removed during synchronization. | ||||||
| - **Public channels**: Membership policies are advisory. Matching users may be automatically added when auto-add is enabled, but non-matching members are not removed. | ||||||
| - When auto-add is disabled for a public channel, matching channels are surfaced as **recommended** rather than enforcing membership. | ||||||
| - Direct messages and group messages aren't eligible for membership policies. | ||||||
| - Default channels such as **Town Square** and **Off-Topic** are excluded. | ||||||
|
|
||||||
| .. note:: | ||||||
|
|
||||||
| Public channels with membership policies may appear in **Browse Channels** under **Recommended**, and matching users may be marked **Recommended** in the channel invite flow. See :doc:`Browse channels </end-user-guide/collaborate/browse-channels>` and :doc:`Manage channel members </end-user-guide/collaborate/manage-channel-members>` for the end-user experience. | ||||||
|
|
||||||
| Channel-level permission policies | ||||||
| --------------------------------- | ||||||
|
|
||||||
| From Mattermost v11.8.0, admins can define channel-level permission rules for file upload and file download based on user attributes and channel role. Applicable roles include **channel admin**, **channel member**, and **channel guest**. | ||||||
|
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.
Suggested change
|
||||||
|
|
||||||
| For system-wide permission policies that restrict file upload and download actions, see :ref:`Permission policies <administration-guide/manage/admin/abac-system-wide-policies:permission policies>`. | ||||||
|
|
||||||
| Simulate access | ||||||
| ---------------- | ||||||
|
|
||||||
| From Mattermost v11.8.0, admins can use **Simulate access** in Channel Settings to preview whether selected users can perform actions such as joining a channel, uploading files, or downloading files before saving policy changes. | ||||||
|
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.
Suggested change
|
||||||
|
|
||||||
| - Simulation can evaluate draft rules before they're saved, so you can confirm the intended scope without affecting live channel access. | ||||||
| - Some denied results may indicate that the decision came from another policy. In that case, Mattermost shows that access was denied by another policy without exposing policy details you aren't authorized to see. | ||||||
|
|
||||||
| Manage team-scoped membership policies in Team Settings | ||||||
| ------------------------------------------------------- | ||||||
|
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,11 +62,21 @@ You can add multiple rules to a single policy, and each rule can include multipl | |
|
|
||
| Select the **Validate syntax** bar to check the syntax of your rule. If the syntax is valid, the bar will turn green and display a message indicating that the syntax is valid. If there are any issues, the bar will turn red and display an error message. | ||
|
|
||
| Test rules | ||
| ~~~~~~~~~~ | ||
| Simulate access | ||
|
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. Should we explain these require enabling feature flags? |
||
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| Select **Test access rule** to test the rule against your user base to return how many users would be granted access to the channel based on the current rule. Test your rules to ensure the intended scope and avoid unexpected access changes. | ||
|
|
||
| From Mattermost v11.8.0, you can use **Simulate access** to preview allowed and denied outcomes for specific users before saving policy changes: | ||
|
|
||
| 1. Open the policy editor in the System Console. | ||
| 2. Select **Simulate access**. | ||
| 3. Choose the users you want to test. | ||
| 4. Review the allowed and denied outcomes by action, such as joining a channel or uploading and downloading files. | ||
| 5. Adjust the rules before saving. | ||
|
|
||
| Simulation can test draft policy changes before they affect live channel access or file permissions. Detailed rule and attribute information is shown only when the denial comes from the policy or scope you're editing; otherwise, Mattermost may show that access was denied by another policy. | ||
|
Combs7th marked this conversation as resolved.
|
||
|
|
||
| Manage rules | ||
| ~~~~~~~~~~~~ | ||
|
|
||
|
|
||
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.
@Combs7th This sentence is really clunky. Can you please give it another review?
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.
Good callout here! I agree.
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.
@claude - Please analyze the sentence above through the lense of Editor Evie, and commit the best possible alternative version that's more clear, concise, and less clunky.
Uh oh!
There was an error while loading. Please reload this page.
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.
Claude finished @Combs7th's task in 1m 9s —— View job
Editor Evie review — line 23 rewrite
56a7ce9)What was clunky
Through Evie's lens, the original had three issues:
Committed rewrite
Changes: dropped the redundant channel, swapped the second in for of, and replaced the passive "are configured for" with the crisp, accurate "apply only to" — which makes the public/private distinction in the next sentence land cleanly. Also tightened "with different behavior by channel type" → "with behavior that varies by channel type." The
:ref:link is unchanged.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.
@amyblais @wiersgallak - Do you think that wording clean-up above will suffice?
We will still need a dev review from @isacikgoz as well whenever able.