Skip to content

11.7: Document ABAC permission policies and team-scoped membership policy workflows #8950

@Combs7th

Description

@Combs7th

@claude - Let's update the Mattermost Product Documentation to reflect the ABAC policy management workflow experience from Mattermost v11.7.0 onward captured via the following PRs:

Goal:
Create one cohesive docs update PR, not separate docs PRs, because these PRs all affect the same ABAC/policy documentation area and should read as one unified admin workflow.

Scope and constraints:

  • Do not modify changelogs, upgrade notes, version archives, deprecated/removed feature docs, or unsupported-release docs.
  • Focus only on end-user/admin-facing Mattermost Product Documentation at docs.mattermost.com.
  • Do not document implementation details, backend architecture, algorithms, internal API mechanics, database migrations, or test coverage.
  • Do document visible admin behavior, user-visible file access effects, validation messages/constraints, sync status/actions, and required permissions where relevant.
  • Use Mattermost v11.7.0 as the version because the linked PR metadata uses the v11.7.0 milestone.
  • Keep the update minimal and workflow-focused.

Required doc touchpoints:

  1. Update the main Attribute-Based Access Control overview page:

    • Mention that ABAC includes system-wide policies, team-scoped membership policies, channel-specific access rules, and permission policies where applicable.
    • Clarify who can manage each policy type: System Admins vs Team Admins vs Channel Admins, based only on PR evidence.
  2. Update System-wide attribute-based access policies:

    • Add/adjust guidance for permission policies introduced in #36003.
    • Explain that permission policies can restrict file upload and file download behavior through ABAC.
    • Include only user/admin-visible behavior. Avoid API or implementation details.
    • Add a note that policy names must be unique for parent access control policies, and that duplicate names surface a user-friendly error, based on #35676.
  3. Update or create a Team Settings / team-scoped ABAC membership policy section:

    • Document that Team Admins can create, edit, and delete channel membership policies directly from Team Settings when ABAC is enabled and they have the appropriate permission.
    • Document the Membership Policies / Access Policies tab naming exactly as confirmed in the current UI strings from the PRs.
    • Explain the Team Admin workflow at a high level: create policy, define attribute rules, assign applicable private channels, save, and review sync behavior.
    • Include the manage_team_access_rules permission only as an admin-facing permission requirement, not as an implementation detail.
  4. Update sync behavior guidance:

    • Document the Team Settings sync status footer added in #35729, including last sync time and Sync now action.
    • Explain that team-scoped sync is limited to the team admin’s team scope.
    • Note that after team admin ABAC policy creation, sync jobs run automatically where auto-add/sync behavior applies, based on #36276.
    • Avoid describing job payloads, validation branches, or backend job architecture.
  5. Add or update end-user-facing behavior only where necessary:

    • Briefly explain that users may see file attachments unavailable/redacted when file upload/download permission policies restrict access, based on #36003.
    • Do not create a large end-user page unless the existing docs structure clearly requires it. Prefer a short note in the most relevant existing ABAC or file-access section.

Output requirements:

  • Provide a list of exact docs pages/files to update.
  • Provide proposed before/after text or full replacement snippets for each touched section.
  • Include a short PR summary and testing checklist for the docs PR.
  • Keep the draft concise and avoid duplicating the same ABAC explanation across multiple pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions