Skip to content

Allow System Admins to view and update User AuthData and Username in System Console#8834

Open
Combs7th wants to merge 2 commits intov11.6-documentationfrom
claude/issue-8833-20260324-2343
Open

Allow System Admins to view and update User AuthData and Username in System Console#8834
Combs7th wants to merge 2 commits intov11.6-documentationfrom
claude/issue-8833-20260324-2343

Conversation

@Combs7th
Copy link
Contributor

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

amyblais and others added 2 commits March 24, 2026 18:34
* 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 <Combs7th@users.noreply.github.com>
@Combs7th Combs7th changed the base branch from master to v11.6-documentation March 24, 2026 23:49
@Combs7th Combs7th requested a review from hanzei March 24, 2026 23:49
@Combs7th Combs7th added 1: Dev Review Requires review by a core commiter 2: Editor Review Requires review by an editor Guidance labels Mar 24, 2026
@Combs7th Combs7th added this to the v11.6.0 milestone Mar 24, 2026
@Combs7th
Copy link
Contributor Author

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

@coderabbitai
Copy link

coderabbitai bot commented Mar 24, 2026

📝 Walkthrough

Walkthrough

Updated 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

Cohort / File(s) Summary
User Management Documentation
source/administration-guide/configure/user-management-configuration-settings.rst
Added sections documenting system admin capabilities to update usernames and view/edit user AuthData through the System Console, including explanations that AuthData represents the external identifier for authentication methods.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately describes the primary change: documentation updates reflecting the new capability for System Admins to view and update user AuthData and username in the System Console.
Description check ✅ Passed The description is directly related to the changeset; it explains that the documentation reflects a new capability from the referenced engineering PR and closes the linked issue.
Linked Issues check ✅ Passed The PR fully addresses the requirements in issue #8833: documentation updates on user management configuration reflecting System Admin capabilities to view and update user AuthData and username in System Console.
Out of Scope Changes check ✅ Passed All changes are within scope; the PR contains only documentation updates to user management configuration reflecting the stated objective, with no unrelated modifications.
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-8833-20260324-2343

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8162094 and 49c8a5a.

📒 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**.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 49c8a5a

Copy link
Contributor

@hanzei hanzei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs LGTM 👍

But 8162094 doesn't seem right in this PR. Should we remove it?

@Combs7th
Copy link
Contributor Author

Thanks hanzei! @esethna - Adding for your review as well. Do you think we should remove the section Ben pointed out above?

@Combs7th Combs7th requested a review from esethna March 25, 2026 18:10
@esethna
Copy link
Contributor

esethna commented Mar 25, 2026

@Combs7th thanks, yes looks like that got pulled in from another branch somehow

Update user's username
~~~~~~~~~~~~~~~~~~~~~~

Update the username of a user using the System Console.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs "From Mattermost x.x, ..."

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs "From Mattermost x.x, ..."

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 Guidance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow System Admins to view and update User AuthData and Username in System Console

4 participants