diff --git a/static/images/help/deactivate-user-email.png b/static/images/help/deactivate-user-email.png deleted file mode 100644 index 378b119b59..0000000000 Binary files a/static/images/help/deactivate-user-email.png and /dev/null differ diff --git a/static/js/settings_users.js b/static/js/settings_users.js index 0bd2008a41..c36494620d 100644 --- a/static/js/settings_users.js +++ b/static/js/settings_users.js @@ -465,7 +465,7 @@ export function confirm_deactivation(user_id, handle_confirm, loading_spinner) { {defaultMessage: "Deactivate {name}?"}, {name: user.full_name}, ), - help_link: "/help/deactivate-or-reactivate-a-user#deactivate-ban-a-user", + help_link: "/help/deactivate-or-reactivate-a-user#deactivating-a-user", html_body, html_submit_button: $t_html({defaultMessage: "Deactivate"}), id: "deactivate-user-modal", @@ -536,7 +536,7 @@ export function confirm_reactivation(user_id, handle_confirm, loading_spinner) { confirm_dialog.launch({ html_heading: $t_html({defaultMessage: "Reactivate {name}"}, {name: user.full_name}), - help_link: "/help/deactivate-or-reactivate-a-user#reactivate-a-user", + help_link: "/help/deactivate-or-reactivate-a-user#reactivating-a-user", html_body, on_click: handle_confirm, loading_spinner, diff --git a/static/templates/confirm_dialog/confirm_deactivate_user.hbs b/static/templates/confirm_dialog/confirm_deactivate_user.hbs index 7b0930892a..630e8ab9a5 100644 --- a/static/templates/confirm_dialog/confirm_deactivate_user.hbs +++ b/static/templates/confirm_dialog/confirm_deactivate_user.hbs @@ -24,7 +24,6 @@ Notify this user by email? {{/tr}} - {{> ../help_link_widget link="/help/deactivate-or-reactivate-a-user#notify-users-of-their-deactivation" }}

diff --git a/templates/zerver/help/deactivate-or-reactivate-a-user.md b/templates/zerver/help/deactivate-or-reactivate-a-user.md index b9881b8cfa..6b7b46bd3b 100644 --- a/templates/zerver/help/deactivate-or-reactivate-a-user.md +++ b/templates/zerver/help/deactivate-or-reactivate-a-user.md @@ -1,16 +1,34 @@ # Deactivate or reactivate a user +## Deactivating a user + {!admin-only.md!} -## Deactivate (ban) a user +When you deactivate a user: -To properly remove a user’s access to a Zulip organization, it does not -suffice to change their password or deactivate their account in an external -email system, since the user’s API key and bot API keys will still be -active. Instead, you need to deactivate the user’s account using the Zulip -administrative interface. +* The user will be immediately logged out of all Zulip sessions, including + desktop, web and mobile apps. -Note that organization administrators cannot deactivate organization owners. +* The user's credentials for logging in will no longer work, including password + login and [any other login options](/help/configure-authentication-methods) + enabled in your organization. + +* The user's [bots](/help/bots-and-integrations) will be deactivated. + +* [Email invitations and invite links](/help/invite-new-users) created by the + user will be disabled. + +* Even if your organization [allows users to join without an + invitation](/help/restrict-account-creation#set-whether-invitations-are-required-to-join), + this user will not be able to rejoin with the same email account. + +!!! warn "" + You must go through the deactivation process below to fully remove a user's + access to your Zulip organization. Changing a user's password or removing + their single sign-on account will not log them out of their open Zulip + sessions, or disable their API keys. + +### Deactivate a user {start_tabs} @@ -18,7 +36,10 @@ Note that organization administrators cannot deactivate organization owners. {!manage-this-user.md!} -1. Click the **Deactivate user** button at the bottom. +1. Click **Deactivate user** at the bottom of the **Manage user** menu. + +1. *(optional)* Select **Notify this user by email?** if desired, and enter a + custom comment to include in the notification email. 1. Approve by clicking **Deactivate**. @@ -26,54 +47,36 @@ Note that organization administrators cannot deactivate organization owners. {settings_tab|user-list-admin} -1. Click the **Deactivate** button to the right of the user account that you - want to deactivate. +1. In the **Actions** column, click the **deactivate** () icon for the user you want to deactivate. -1. Approve by clicking **Deactivate**. +2. *(optional)* Select **Notify this user by email?** if desired, and enter a + custom comment to include in the notification email. + +3. Approve by clicking **Deactivate**. {end_tabs} -The user will be logged out immediately and not be able to log back in. The -user's bots will also be deactivated. Lastly, the user will be unable to -create a new Zulip account in your organization using their deactivated -email address. +!!! tip "" + Organization administrators cannot deactivate organization owners. -## Notify users of their deactivation +## Reactivating a user -Zulip can optionally send the user an email notification that their account was deactivated. +{!admin-only.md!} -{start_tabs} +A reactivated user will have the same role, stream subscriptions, user group +memberships, and other settings and permissions as they did prior to +deactivation. They will also have the same API key and bot API keys, but their +bots will be deactivated until the user manually +[reactivates](deactivate-or-reactivate-a-bot) them again. -{settings_tab|user-list-admin} - - 2. Click the **Deactivate** button to the right of the user account that you -want to deactivate. - - 3. Check the checkbox labeled **"Notify this user by email?"**. - - 4. Optional: Enter a custom message for the user in the provided textbox. - - 3. Approve by clicking **Confirm**. - -{end_tabs} - -Here is a sample notification email: - -view-of-admin - -## Reactivate a user - -Organization administrators can reactivate a deactivated user. The reactivated -user will have the same role, stream subscriptions, user group memberships, and -other settings and permissions as they did prior to deactivation. They will also -have the same API key and bot API keys, but the bots will be deactivated until -the user manually [reactivates](deactivate-or-reactivate-a-bot) them again. +### Reactivate a user {start_tabs} {settings_tab|deactivated-users-admin} -4. Click the **Reactivate** button to the right of the user account that you +1. Click the **Reactivate** button to the right of the user account that you want to reactivate. {end_tabs} @@ -85,3 +88,6 @@ want to reactivate. ## Related articles * [Mute a user](/help/mute-a-user) +* [Change a user's role](/help/change-a-users-role) +* [Change a user's name](/help/change-a-users-name) +* [Deactivate your account](/help/deactivate-your-account) diff --git a/templates/zerver/help/deactivate-your-account.md b/templates/zerver/help/deactivate-your-account.md index e8946c210c..103aac84f2 100644 --- a/templates/zerver/help/deactivate-your-account.md +++ b/templates/zerver/help/deactivate-your-account.md @@ -40,4 +40,5 @@ * [Logging in](logging-in) * [Logging out](logging-out) * [Switching between organizations](switching-between-organizations) +* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user) * [Deactivate your organization](/help/deactivate-your-organization) diff --git a/templates/zerver/help/setting-up-zulip-for-a-class.md b/templates/zerver/help/setting-up-zulip-for-a-class.md index c40aa2aa21..5032bd1eef 100644 --- a/templates/zerver/help/setting-up-zulip-for-a-class.md +++ b/templates/zerver/help/setting-up-zulip-for-a-class.md @@ -357,4 +357,4 @@ HTML archive](https://github.com/zulip/zulip-archive) to archive the information [make-private]: /help/change-the-privacy-of-a-stream [add-to-stream]: /help/add-or-remove-users-from-a-stream -[deactivate-user]: /help/deactivate-or-reactivate-a-user#deactivate-ban-a-user +[deactivate-user]: /help/deactivate-or-reactivate-a-user#deactivate-a-user diff --git a/templates/zerver/help/zulip-cloud-billing.md b/templates/zerver/help/zulip-cloud-billing.md index b065291bb7..f904bf869c 100644 --- a/templates/zerver/help/zulip-cloud-billing.md +++ b/templates/zerver/help/zulip-cloud-billing.md @@ -28,9 +28,9 @@ you will need to sign up for an annual plan. ### What is the difference between automatic and manual billing? -With automatic billing, you automatically purchase a Zulip license -for each user in your organization at the start of each billing period -(month or year). Deactivating a user frees up their license for reuse. +With automatic billing, you automatically purchase a Zulip license for each user +in your organization at the start of each billing period (month or year). +[Deactivating a user][deactivate-user] frees up their license for reuse. Additional licenses are purchased automatically as needed. With manual billing, you choose and pay for a preset user limit. If @@ -44,9 +44,8 @@ have a specific reason to do otherwise. ### How will I be charged for temporary users (e.g. limited-time clients)? -Users [can be -deactivated](/help/deactivate-or-reactivate-a-user#deactivate-ban-a-user) any -time. Deactivating a user frees up their license for reuse. +Users [can be deactivated][deactivate-user] any time. Deactivating a user frees +up their license for reuse. ### How are guest accounts billed? Is there special pricing? @@ -61,3 +60,5 @@ guest. * [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) * [Migrating from other chat tools](/help/migrating-from-other-chat-tools) * [Contact support](/help/contact-support) + +[deactivate-user]: /help/deactivate-or-reactivate-a-user#deactivate-a-user