Feature: Document how to determine a user ID (#6689)

* feature/document-user-id adding section at end of page about determining user id * feature/document-user-id adding styling for sub sections * feature/document-user-id removing extra line * feature/document-user-id reverting documentation as it is needed to be placed elsewhere * feature/document-user-id placing documentation in required place and applying some formatting * Update source/configure/user-management-configuration-settings.rst * Update source/configure/user-management-configuration-settings.rst * Update source/configure/user-management-configuration-settings.rst * Update source/configure/user-management-configuration-settings.rst * Update source/configure/user-management-configuration-settings.rst * Update source/configure/user-management-configuration-settings.rst * Update source/configure/user-management-configuration-settings.rst * Update source/configure/user-management-configuration-settings.rst * feature/document-user-id removing lines that are unnecessary * Update source/configure/user-management-configuration-settings.rst * Update source/collaborate/learn-about-roles.rst --------- Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
mattermost · Oct 18, 2023 · ee73ed0 · ee73ed0
1 parent ebb96fb
commit ee73ed0
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/source/collaborate/learn-about-roles.rst b/source/collaborate/learn-about-roles.rst
@@ -86,4 +86,4 @@ Mattermost is designed as a system-of-record, so there isn't an option to delete
 
 .. note::
 
-    AD/LDAP user accounts can't be deactivated from Mattermost; they must be deactivated from your Active Directory.
+    AD/LDAP user accounts can't be deactivated from Mattermost; they must be deactivated from your Active Directory.
diff --git a/source/configure/user-management-configuration-settings.rst b/source/configure/user-management-configuration-settings.rst
@@ -36,6 +36,25 @@ Getting people set up with a Mattermost account is typically something that syst
 | **Note**: You can search for users by partial first name, last name, nickname, or username.                                 |
 +---------------------------------------------------------------+-------------------------------------------------------------+
 
+Identify a User's ID
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Users can be specified in Mattermost by username or user ID. Usernames automatically resolve when a match is detected.
+System admins can identify a user's ID using the Mattermost API or mmctl. 
+
+Using the API
+^^^^^^^^^^^^^^^^
+
+Use this method if you need to automate user-related tasks or integrate with external systems.
+Make an HTTP GET request to the following endpoint: ``https://your-mattermost-url/api/v4/users/username/username_here``.
+Replace ``your-mattermost-url`` with the URL of your Mattermost instance and ``username_here`` with the username you are looking for.
+The API response contains a JSON object that includes the user's ID among other details.
+
+Using mmctl
+^^^^^^^^^^^^^^^^
+
+If you prefer command-line tools, Mattermost offers mmctl for system administration.
+In a terminal window, use the following command to list all users and their IDs: ``mmctl user list`` to return a list of user IDs.
+
 Deactivate user accounts
 ~~~~~~~~~~~~~~~~~~~~~~~~
Original file line number	Diff line number	Diff line change
Expand Up		@@ -86,4 +86,4 @@ Mattermost is designed as a system-of-record, so there isn't an option to delete

		.. note::

		AD/LDAP user accounts can't be deactivated from Mattermost; they must be deactivated from your Active Directory.
		AD/LDAP user accounts can't be deactivated from Mattermost; they must be deactivated from your Active Directory.