From ebb96fbe4f270dd2e13b24c9daf882592a5a50cc Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Tue, 17 Oct 2023 16:38:03 -0400 Subject: [PATCH 1/3] Corrected link text (#6718) * Corrected link text * Update source/guides/deployment-guides.rst --- source/guides/deployment-guides.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/guides/deployment-guides.rst b/source/guides/deployment-guides.rst index c5dd5dec0b9..ad52d0cecc4 100644 --- a/source/guides/deployment-guides.rst +++ b/source/guides/deployment-guides.rst @@ -12,4 +12,4 @@ These deployment guides are for administrators who are ready to integrate Matter Desktop and mobile app deployment * :doc:`Server deployment ` - Guides for admins setting up a self-hosted deployment. -* :doc:`Server deployment ` - Guides for admins deploying the desktop and mobile apps. \ No newline at end of file +* :doc:`Desktop and mobile app deployment ` - Guides for admins deploying the desktop and mobile apps. From ee73ed03054cc19aec6949e09045dee2b4b6cd1c Mon Sep 17 00:00:00 2001 From: Tomer Ben-Rachel Date: Wed, 18 Oct 2023 15:52:38 +0300 Subject: [PATCH 2/3] 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) <74422101+cwarnermm@users.noreply.github.com> --- source/collaborate/learn-about-roles.rst | 2 +- ...user-management-configuration-settings.rst | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/source/collaborate/learn-about-roles.rst b/source/collaborate/learn-about-roles.rst index c2eae2f7bce..a967bffbe0a 100644 --- 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. \ No newline at end of file + 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 index 738c9edb1d7..3925a933557 100644 --- 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 ~~~~~~~~~~~~~~~~~~~~~~~~ From 28606e0e1d3dd25eba6aaa85a1cee4bb6517e39d Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Wed, 18 Oct 2023 09:12:15 -0400 Subject: [PATCH 3/3] Clarified conditions based on MM-54482 (#6719) --- .../experimental-configuration-settings.rst | 2 +- .../preferences/manage-advanced-options.rst | 40 +++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/source/configure/experimental-configuration-settings.rst b/source/configure/experimental-configuration-settings.rst index 16599b03c36..b8429503e1d 100644 --- a/source/configure/experimental-configuration-settings.rst +++ b/source/configure/experimental-configuration-settings.rst @@ -203,7 +203,7 @@ Specify the color of the email login button text for white labeling purposes. Us Enable account deactivation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -**True**: Ability for users to deactivate their own account from **Settings > Advanced**. If a user deactivates their own account, they will get an email notification confirming they were deactivated. +**True**: Ability for users to deactivate their own account from **Settings > Advanced > Deactivate Account**. If a user deactivates their own account, they will get an email notification confirming they were deactivated. Available only when authentication is set to use email/password. Not available when authentication uses SAML or AD/LDAP. **False**: Ability for users to deactivate their own account is disabled. diff --git a/source/preferences/manage-advanced-options.rst b/source/preferences/manage-advanced-options.rst index de2a8748207..379abf795a3 100644 --- a/source/preferences/manage-advanced-options.rst +++ b/source/preferences/manage-advanced-options.rst @@ -65,6 +65,26 @@ By default, Mattermost shows you system messages when users join or leave channe This option isn't something you can set using the mobile app. +Deactivate account +------------------ + +You can deactivate your account if you access Mattermost using an email address and password, and when your system admin has `enabled your ability to do so `__. Deactivating your account removes your ability to access Mattermost, and disables all email and mobile notifications. + +.. important:: + + - If you deactive your account, you must contact your system admin to have it reactivated. + - If you access Mattermost using another authentication method, such as AD/LDAP or SAML, or use accounts that don't have this setting available, contact your system admin to deactivate your account in the System Console. + +.. tabs:: + + .. tab:: Web/Desktop + + Select **Deactivate Account** to deactivate your Mattermost user account. + + .. tab:: Mobile + + This option isn't applicable to the mobile app. + Performance debugging --------------------- @@ -116,26 +136,6 @@ By default, `message drafts `__ are synchron This option isn't applicable to the mobile app. -Deactivate account -~~~~~~~~~~~~~~~~~~ - -You can deactivate your account if you access Mattermost using an email address, and when your system admin has `enabled your ability to do so `__. Deactivating your account removes your ability to access Mattermost, and disables all email and mobile notifications. - -.. important:: - - - If you deactive your account, you must contact your system admin to have it reactivated. - - If you access Mattermost using another authentication method, such as AD/LDAP or SAML, or use accounts that don't have this setting available, contact your system admin to deactivate your account in the System Console. - -.. tabs:: - - .. tab:: Web/Desktop - - Select **Deactivate Account** to deactivate your Mattermost user account. - - .. tab:: Mobile - - This option isn't applicable to the mobile app. - Delete local files ------------------