Allow System Admins to view and update User AuthData and Username in System Console#8834
Merged
esethna merged 5 commits intov11.6-documentationfrom Apr 13, 2026
Merged
Conversation
* Update mattermost-desktop-releases.md * Update desktop-app-changelog.md * Update desktop-app-changelog.md * Update desktop-app-changelog.md
…tem Console Reflects the new capability from mattermost/mattermost#33550 where System Admins can view and update user AuthData and username directly in the System Console user detail workflow. Co-authored-by: Combs7th <[email protected]>
Contributor
Author
|
@hanzei - Do the above doc updates look accurate to you? |
Contributor
📝 WalkthroughWalkthroughUpdated user management documentation to reflect that system administrators can now view and modify user authentication data and usernames through the System Console. Added new subsections explaining how to update usernames and edit authentication data (AuthData) in the System Console. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/administration-guide/configure/user-management-configuration-settings.rst (1)
280-280: Tighten wording for readability.Line 280 reads a bit awkwardly (“username of a user”). Consider a small wording clean-up.
Suggested wording tweak
-Update the username of a user using the System Console. +Update a user's username using the System Console.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/administration-guide/configure/user-management-configuration-settings.rst` at line 280, Replace the awkward sentence "Update the username of a user using the System Console." with a tighter phrasing such as "Update a user's username using the System Console." (or "Update a user's username via the System Console.") to improve readability; locate the exact sentence in the document and update that line.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@source/administration-guide/configure/user-management-configuration-settings.rst`:
- Around line 286-295: The "Update user's authentication data" section documents
the new AuthData edit feature but lacks an explicit release-version scope;
update that section header or first paragraph to include the release in which
AuthData editability was introduced (e.g., "Introduced in vX.Y"), mirroring
nearby version-scoped sections such as the one that mentions the version for
user-related features; ensure you reference the "AuthData" term and the
"Authentication" section so readers know this applies to editing AuthData in the
System Console User Configuration UI.
---
Nitpick comments:
In
`@source/administration-guide/configure/user-management-configuration-settings.rst`:
- Line 280: Replace the awkward sentence "Update the username of a user using
the System Console." with a tighter phrasing such as "Update a user's username
using the System Console." (or "Update a user's username via the System
Console.") to improve readability; locate the exact sentence in the document and
update that line.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: cdd5abff-315e-4e07-967f-e086d91651f3
📒 Files selected for processing (1)
source/administration-guide/configure/user-management-configuration-settings.rst
Comment on lines
+286
to
+295
| Update user's authentication data | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| System admins can view and update the authentication data (AuthData) for a user directly in the System Console. AuthData is the external identifier associated with the user's authentication method, such as an LDAP Distinguished Name (DN), SAML NameID, or OAuth ID. Updating this field is useful when a user's external authentication identifier changes, for example after an identity provider migration. | ||
|
|
||
| 1. Go to **System Console > User Management > Users** to access all user accounts. | ||
| 2. Select the user to open their User Configuration page. | ||
| 3. In the **Authentication** section, view or update the user's authentication data value. | ||
| 4. Select **Save**. | ||
|
|
Contributor
There was a problem hiding this comment.
Add explicit version scope for AuthData editability.
Line 286 onward documents a new capability, but unlike nearby sections (for example, Line 46), it doesn’t state the release version. That can mislead admins on older deployments.
Suggested doc patch
Update user's authentication data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-System admins can view and update the authentication data (AuthData) for a user directly in the System Console. AuthData is the external identifier associated with the user's authentication method, such as an LDAP Distinguished Name (DN), SAML NameID, or OAuth ID. Updating this field is useful when a user's external authentication identifier changes, for example after an identity provider migration.
+From Mattermost v11.x, system admins can view and update the authentication data (AuthData) for a user directly in the System Console. AuthData is the external identifier associated with the user's authentication method, such as an LDAP Distinguished Name (DN), SAML NameID, or OAuth ID. Updating this field is useful when a user's external authentication identifier changes, for example after an identity provider migration.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Update user's authentication data | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| System admins can view and update the authentication data (AuthData) for a user directly in the System Console. AuthData is the external identifier associated with the user's authentication method, such as an LDAP Distinguished Name (DN), SAML NameID, or OAuth ID. Updating this field is useful when a user's external authentication identifier changes, for example after an identity provider migration. | |
| 1. Go to **System Console > User Management > Users** to access all user accounts. | |
| 2. Select the user to open their User Configuration page. | |
| 3. In the **Authentication** section, view or update the user's authentication data value. | |
| 4. Select **Save**. | |
| Update user's authentication data | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| From Mattermost v11.x, system admins can view and update the authentication data (AuthData) for a user directly in the System Console. AuthData is the external identifier associated with the user's authentication method, such as an LDAP Distinguished Name (DN), SAML NameID, or OAuth ID. Updating this field is useful when a user's external authentication identifier changes, for example after an identity provider migration. | |
| 1. Go to **System Console > User Management > Users** to access all user accounts. | |
| 2. Select the user to open their User Configuration page. | |
| 3. In the **Authentication** section, view or update the user's authentication data value. | |
| 4. Select **Save**. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@source/administration-guide/configure/user-management-configuration-settings.rst`
around lines 286 - 295, The "Update user's authentication data" section
documents the new AuthData edit feature but lacks an explicit release-version
scope; update that section header or first paragraph to include the release in
which AuthData editability was introduced (e.g., "Introduced in vX.Y"),
mirroring nearby version-scoped sections such as the one that mentions the
version for user-related features; ensure you reference the "AuthData" term and
the "Authentication" section so readers know this applies to editing AuthData in
the System Console User Configuration UI.
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA 49c8a5a |
Contributor
Author
|
Thanks hanzei! @esethna - Adding for your review as well. Do you think we should remove the section Ben pointed out above? |
Contributor
|
@Combs7th thanks, yes looks like that got pulled in from another branch somehow |
esethna
requested changes
Mar 25, 2026
Contributor
Author
|
Thanks @esethna! This one should be good to go now. |
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA 02d263d |
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA dddc26a |
Contributor
|
Newest code from mattermost has been published to preview environment for Git SHA 95b2827 |
esethna
approved these changes
Apr 13, 2026
amyblais
added a commit
that referenced
this pull request
Apr 16, 2026
* Update conf.py * [MM-65701] Document 7zip file blocking in file content search (#8836) Adds notes to end-user search docs and admin config docs clarifying that 7zip (.7z) files are not supported for file content search and are skipped for security reasons. Only standard ZIP files are supported when ZIP file search is enabled. Ref: mattermost/mattermost#34983 Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> * Add docs for preferred_username claim support in OpenID Connect (#8838) Adds Use preferred username setting documentation to each OpenID Connect provider section (GitLab, Google, Entra ID, OpenID Connect other) in the authentication configuration settings reference, and a corresponding note in the OpenID Connect SSO setup guide. Closes #8835 Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> * docs(auth): Clarify Google SSO username/email sync behavior (#8832) * Desktop v5.13.5 docs (#8828) * Update mattermost-desktop-releases.md * Update desktop-app-changelog.md * Update desktop-app-changelog.md * Update desktop-app-changelog.md * docs(auth): clarify Google SSO username/email sync behavior Username and email address changes made in Google Workspace are not automatically synced to Mattermost. Adds a note to the existing user-attribute warning in the Google SSO setup guide to prevent readers from incorrectly inferring that the IdP is an automatic sync source. Aligns with mattermost/mattermost#34475. Co-authored-by: Combs7th <[email protected]> * Update desktop-app-changelog.md * Update desktop-app-changelog.md * Update mattermost-desktop-releases.md --------- Co-authored-by: Amy Blais <[email protected]> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> * Update mattermost-desktop-releases.md * Update desktop-app-changelog.md * Add four newly sanitized fields to Support Packet documentation (#8874) * Improve PostgreSQL database setup discoverability in search (#8865) * Improve PostgreSQL database setup page discoverability in search Searching for "postgres" or "postgres setup" in the docs didn't surface the database preparation instructions on the preparations page. Renamed the section heading, added search metadata, and included PostgreSQL in the intro paragraph to improve Sphinx search ranking. Also fixes a sphinx-autobuild rebuild loop caused by generated agent docs being rewritten during each build cycle. Closes #8864 Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> * Address CodeRabbit review feedback - Use double quotes for --ignore glob in Makefile for Windows cmd.exe compatibility - Add legacy anchor label to preserve existing deep links to #database-preparation after heading rename Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> * docs: add four newly sanitized fields to Support Packet documentation From Mattermost v11.6.0 (mattermost/mattermost#35346), the following fields are now automatically redacted during Support Packet generation: - FileSettings.ExportAmazonS3SecretAccessKey - ElasticsearchSettings.ClientKey - ServiceSettings.GoogleDeveloperKey - ServiceSettings.GiphySdkKey Co-authored-by: Combs7th <[email protected]> * Update Makefile * Update preparations.rst --------- Co-authored-by: Stuart Doherty <[email protected]> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> * Add popout window documentation for search results (#8868) * Add popout window documentation for search results (v11.6) Documents the new Search RHS popout feature introduced in Mattermost v11.6, covering: opening search results in a popout window, query preservation, thread navigation within the popout, back button behavior, and Jump opening the source channel in the main window. Co-authored-by: Combs7th <[email protected]> * Update search-for-messages.rst * Update search-for-messages.rst --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> Co-authored-by: Eric Sethna <[email protected]> * Mobile Feat: AI rewrite (#8872) * Improve PostgreSQL database setup discoverability in search (#8865) * Improve PostgreSQL database setup page discoverability in search Searching for "postgres" or "postgres setup" in the docs didn't surface the database preparation instructions on the preparations page. Renamed the section heading, added search metadata, and included PostgreSQL in the intro paragraph to improve Sphinx search ranking. Also fixes a sphinx-autobuild rebuild loop caused by generated agent docs being rewritten during each build cycle. Closes #8864 Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> * Address CodeRabbit review feedback - Use double quotes for --ignore glob in Makefile for Windows cmd.exe compatibility - Add legacy anchor label to preserve existing deep links to #database-preparation after heading rename Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> * docs: expand mobile AI rewrite workflow in send-messages.rst Replace the one-liner Mobile tab under 'Rewrite messages with AI' with a full step-by-step workflow mirroring the existing Web/Desktop section, covering: opening rewrite from the composer, selecting an agent, choosing rewrite options (including custom prompt), the processing state, and reviewing/sending the result. Closes #8871 Co-authored-by: Combs7th <[email protected]> * Update preparations.rst * Update Makefile * Simplify --------- Co-authored-by: Stuart Doherty <[email protected]> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> Co-authored-by: Eric Sethna <[email protected]> * Rename Content Flagging to Data Spillage Handling (#8870) * Improve PostgreSQL database setup discoverability in search (#8865) * Improve PostgreSQL database setup page discoverability in search Searching for "postgres" or "postgres setup" in the docs didn't surface the database preparation instructions on the preparations page. Renamed the section heading, added search metadata, and included PostgreSQL in the intro paragraph to improve Sphinx search ranking. Also fixes a sphinx-autobuild rebuild loop caused by generated agent docs being rewritten during each build cycle. Closes #8864 Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> * Address CodeRabbit review feedback - Use double quotes for --ignore glob in Makefile for Windows cmd.exe compatibility - Add legacy anchor label to preserve existing deep links to #database-preparation after heading rename Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> * docs: rename Content Flagging to Data Spillage Handling (v11.6.0) Update user-visible and admin-visible terminology throughout the Content Flagging docs to reflect the v11.6.0 rename: - Rename page title and all feature-name references from 'Content Flagging' to 'Data Spillage Handling' - Update System Console navigation path to 'System Console > Site Configuration > Data Spillage Handling' - Replace 'flag/flagged' with 'quarantine/quarantined' where the product UI now uses that wording - Replace 'content-review bot' with 'Data Spillage Bot' in all user-facing notification and moderation queue descriptions - Update 'Flag message' menu action to 'Quarantine for Review' Internal RST cross-reference labels and API/config identifiers left unchanged per scope constraints. Closes #8869 Co-authored-by: Combs7th <[email protected]> * Update preparations.rst * Update Makefile * Update Data Spillage Handling reasons to new default categories Co-authored-by: Combs7th <[email protected]> --------- Co-authored-by: Stuart Doherty <[email protected]> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> * Allow System Admins to view and update User AuthData and Username in System Console (#8834) * Desktop v5.13.5 docs (#8828) * Update mattermost-desktop-releases.md * Update desktop-app-changelog.md * Update desktop-app-changelog.md * Update desktop-app-changelog.md * docs: add System Admin ability to update username and AuthData in System Console Reflects the new capability from mattermost/mattermost#33550 where System Admins can view and update user AuthData and username directly in the System Console user detail workflow. Co-authored-by: Combs7th <[email protected]> * Update user-management-configuration-settings.rst * Update desktop-app-changelog.md * Update mattermost-desktop-releases.md --------- Co-authored-by: Amy Blais <[email protected]> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> * Update desktop-app-changelog.md * Update mattermost-desktop-releases.md * v11.6 Changelog (#8821) * Prepare v11.6 feature release docs (April 16, 2026) Co-authored-by: Amy Blais <[email protected]> * Update important-upgrade-notes.rst * Update deprecated-features.rst * Update release-policy.md * Update mattermost-v11-changelog.md * Update software-hardware-requirements.rst * Update open-source-components.rst * Update mattermost-v11-changelog.md * Update ui-ada-changelog.rst * Update ui-ada-changelog.rst * Update mattermost-v11-changelog.md * Update mattermost-desktop-releases.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update source/product-overview/mattermost-v11-changelog.md Co-authored-by: Doug Lauder <[email protected]> * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update ui-ada-changelog.rst * Update mattermost-v11-changelog.md * Update important-upgrade-notes.rst * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update ui-ada-changelog.rst * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update ui-ada-changelog.rst * Update mattermost-v11-changelog.md * Update ui-ada-changelog.rst --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Amy Blais <[email protected]> Co-authored-by: Doug Lauder <[email protected]> --------- Co-authored-by: Christopher Poile <[email protected]> Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Co-authored-by: Combs7th <[email protected]> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Combs7th <[email protected]> Co-authored-by: Stuart Doherty <[email protected]> Co-authored-by: Eric Sethna <[email protected]> Co-authored-by: Amy Blais <[email protected]> Co-authored-by: Doug Lauder <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reflects the new capability from mattermost/mattermost#33550 where System Admins can view and update user AuthData and username directly in the System Console user detail workflow.
Closes #8833
Generated with Claude Code