Skip to content

Document User Attributes Display Name and Name (v11.8)#9025

Open
Combs7th wants to merge 4 commits into
v11.8-documentationfrom
claude/issue-9023-20260612-0412
Open

Document User Attributes Display Name and Name (v11.8)#9025
Combs7th wants to merge 4 commits into
v11.8-documentationfrom
claude/issue-9023-20260612-0412

Conversation

@Combs7th

Copy link
Copy Markdown
Contributor

Updates the User Attributes documentation to explain that, from Mattermost v11.8, user attributes have both a Display Name and a Name.

  • Display Name is the user/admin-facing label shown in the UI.
  • Name is the internal canonical identifier used in ABAC policy expressions and API references.
  • ABAC policies continue to reference attributes using user.attributes.<name>.
  • Covers backfill, CEL-safe generated names, fallback to Name, and duplicate display names.

Resolves #9023

Engineering PRs:

Generated with Claude Code

agarciamontoro and others added 3 commits June 11, 2026 11:05
* Document Azure Blob Storage as a file storage backend

Adds Azure Blob Storage to the File storage system reference: a new
azureblob driver-name option and individual entries for the
FileSettings.AzureStorageAccount, AzureContainer, AzurePathPrefix,
AzureAccessKey, AzureEndpoint, AzureSSL, and
AzureRequestTimeoutMilliseconds settings. Extends the dedicated export
filestore list with the matching Export* variants.

Calls out the restart-required behaviour when changing file storage
settings so admins know Save in System Console isn't enough on its
own.

------
AI assisted commit

* Add walk-through page for configuring Azure Blob Storage

Folds the full prereqs, Azure portal/CLI provisioning, System Console
walk-through, Test Connection semantics, restart-required warning,
verification, optional export backend, and troubleshooting sections
into a dedicated configure/azure-blob-storage page.

Wires the new page into the configuration-settings toctree and bullet
list, and adds a seealso link from the File storage section of
environment-configuration-settings so admins can find it from the
reference page.

------
AI assisted commit

* Document migrating existing files from Amazon S3

Adds a Migrate existing files from Amazon S3 section to the Azure
Blob Storage walk-through. Covers the recommended trickle-then-cutover
pattern (long rclone sync, short AzCopy maintenance window), the
prerequisites for the migration host, phase-by-phase commands,
verification queries (object count parity, sha256 spot-check), the
rollback path, and caveats (S3 versioning, sync vs copy, prefix
rewrites, cross-region cost, Storage Mover preview status).

Updates the migration note under step 4 and the troubleshooting entry
for missing pre-cutover files to cross-reference the new section.

------
AI assisted commit

* Document AzureCloud and the updated AzureEndpoint semantics

Adds the AzureCloud setting documentation (commercial/government/custom)
to both the environment configuration reference and the Azure walkthrough,
rewrites the AzureEndpoint entry to reflect its new role as the full
Blob service URL valid only when AzureCloud is custom, and removes the
stale note that said sovereign clouds aren't configured through the
endpoint override. Adds ExportAzureCloud to the dedicated export
filestore key list.

------
AI assisted commit

* Document DefaultAzureCredential authentication mode

Restructures Step 3 of the Azure Blob Storage walk-through to cover
both shared-key and the new default_credential authentication mode.
The default_credential subsection walks an admin through picking the
identity source that matches the host (managed identity on Azure
VM/App Service/AKS, workload identity, service principal, az login)
and granting Storage Blob Data Contributor on the storage account.

Updates Step 4 to describe the new "Azure authentication" dropdown
in the System Console, including the conditional visibility of the
Azure Storage account key field. Adds AuthorizationPermissionMismatch
to the troubleshooting table and documents the propagation delay
that follows a fresh role assignment.

Adds FileSettings.AzureAuthMode to the environment-configuration
reference and to the ExportAzure* list under the dedicated export
filestore section.

------
AI assisted commit

* Simplify the docs

* Update source/administration-guide/configure/azure-blob-storage.rst

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Document Azure SAS support for presigned export downloads

Add ExportAzurePresignExpiresSeconds to the dedicated export filestore
key list, and generalize the presigned-download note so it reflects that
exports can now be downloaded via an Azure Blob Storage SAS URL, not just
an Amazon S3 presigned URL.

------
AI assisted commit

* Address review comments

* Add missing new line

* Fix malformed quotes

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Add notes to the AD/LDAP ID attribute, AD/LDAP Group ID attribute, and
SAML ID attribute settings explaining that values are matched verbatim
with no case normalization. Under PostgreSQL's default case-sensitive
collation, a change in casing is treated as a new user or unlinked
group, so the identity provider must return these attributes with
consistent casing.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com>
Explain that from Mattermost v11.8 user attributes have both a
Display Name (user/admin-facing label) and a Name (internal canonical
identifier used in ABAC policy expressions and API references).

Refs mattermost/mattermost#36247, mattermost/mattermost#36363

Co-authored-by: Combs7th <Combs7th@users.noreply.github.com>
@Combs7th Combs7th added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor labels Jun 12, 2026
@Combs7th Combs7th changed the base branch from master to v11.8-documentation June 12, 2026 04:18
@Combs7th Combs7th requested a review from marianunez June 12, 2026 04:18
@Combs7th Combs7th added this to the v11.8.0 milestone Jun 12, 2026
@Combs7th

Copy link
Copy Markdown
Contributor Author

@marianunez - Do the above doc updates look accurate to you?

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7dff36d9-967e-4b12-8841-16b8d9ff506e

📥 Commits

Reviewing files that changed from the base of the PR and between eb35cda and 5db8287.

📒 Files selected for processing (1)
  • source/administration-guide/manage/admin/user-attributes.rst

📝 Walkthrough

Walkthrough

Added documentation for Mattermost v11.8 user attributes enhancement: Display Name is the user/admin-facing label, while Name is the internal identifier used in ABAC expressions. Name is generated from Display Name as a CEL-safe identifier. Includes explanation of backfilling and uniqueness rules.

Changes

User Attribute Display Names Documentation

Layer / File(s) Summary
Document user attribute display names and naming rules
source/administration-guide/manage/admin/user-attributes.rst
Added explanation that user attributes include both Display Name (shown to users/admins) and Name (internal identifier used in ABAC policies). Clarified that Name is generated from Display Name as a CEL-safe identifier and that ABAC policies reference attributes via user.attributes.<name>. Added note on backfilling existing attributes, fallback display behaviour when Display Name is unavailable, and the rule that duplicate Display Names are permitted while internal Names remain unique.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: documenting the new User Attributes Display Name and Name feature for Mattermost v11.8.
Description check ✅ Passed The description is directly related to the changeset, clearly explaining the new Display Name and Name distinction and referencing the linked issue #9023.
Linked Issues check ✅ Passed The pull request meets all coding requirements from issue #9023: updates existing user-attributes.rst file with Display Name/Name distinction, ABAC policy references, backfill notes, CEL-safe identifiers, fallback behavior, and unique name constraints.
Out of Scope Changes check ✅ Passed All changes are directly in scope: the PR updates only the user-attributes.rst documentation file as required, with no unrelated modifications to other files or systems.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-9023-20260612-0412

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.

@github-actions

Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 5db8287

@Combs7th

Copy link
Copy Markdown
Contributor Author

@marianunez - Please ignore the unintended commits pulled in for Azure Blob storage, and anything in the "Configure" folder. I'll get those removed.

Only relevant update here is to the user-attributes.rst page.

@Combs7th

Copy link
Copy Markdown
Contributor Author

@marianunez - Unintended config commits have been reverted, and this one is ready for review now. :)

@github-actions

Copy link
Copy Markdown
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 6d8417c

@Combs7th Combs7th requested a review from wiersgallak June 13, 2026 02:12
@Combs7th

Copy link
Copy Markdown
Contributor Author

@wiersgallak - Can you help with the editor review on this one so we can get it across the finish line by Tuesday?

Still need a dev review from Maria as well.

@Combs7th Combs7th requested a review from amyblais June 15, 2026 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document User Attribute display names

4 participants