docs: Add user guide for *Deactivate or reactivate a user* feature

docs: Add user guide for *Deactivate or reactivate a user* feature
This commit is contained in:
Cynthia Lin 2016-12-24 09:43:20 -08:00 committed by showell
parent 2fd1316d70
commit 38b0b3ffb5
6 changed files with 82 additions and 21 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

View File

@ -20,26 +20,10 @@ We'd be sorry to see you go, but you can follow the following steps to deactivat
6. After clicking the **Deactivate now** button, you will be logged out and returned to the Zulip login page. 6. After clicking the **Deactivate now** button, you will be logged out and returned to the Zulip login page.
Please note that you cannot register a Zulip account using the email address of a deactivated account. However, you can ask a Zulip realm administrator to reactivate your account. Please note that you cannot register a Zulip account using the email address of a deactivated account.
In addition, if you're the only administrator in the realm, you cannot deactivate your account; you need to make another user an administrator first before you can deactivate your account.
## Reactivating an account ## Reactivating an account
Zulip realm administrators can choose to reactivate a user's deactivated account by following the following steps. If you regret deactivating your account, you can ask a Zulip realm administrator to [reactivate](/help/deactivate-reactivate#reactivate-a-user) your account.
1. Click the cog (![cog](/static/images/help/cog.png)) in the upper right corner of the right sidebar.
2. Select **Administration** from the dropdown menu that appears.
![Administration dropdown](/static/images/help/administration.png)
3. Upon clicking **Administration**, your view will be replaced with the **Administration** page. Click the **Deactivated Users** tab at the top of the panel; it turns gray upon hover.
![Administration](/static/images/help/admin-panel-deactivated-users.png)
4. In the **Deactivated users** section, click the orange **Reactivate** button to the right of the user account that you want to reactivate.
![Deactivated Users](/static/images/help/deactivate-panel.png)
5. After clicking the **Reactivate** button, the button will transform into a red **Deactivate** button, confirming the success of the account's reactivation.
![Reactivate success](/static/images/help/reactivate-success.png)

View File

@ -0,0 +1,77 @@
# Deactivate or reactivate a user
Zulip realm administrators have the ability to deactivate or reactivate any
user's account in their realm.
## Deactivate a user
To properly remove a users access to a Zulip orgnanization, it does not
suffice to change their password or deactivate their account in the SSO system,
since neither of those actions prevents authentication with the users API key
or any API keys of the bots the user has created.
Instead, you should deactivate the users account using the Zulip administration
interface; this will also automatically deactivate any bots the user has
created.
1. Click the cog (![cog](/static/images/help/cog.png)) in the upper right corner
of the right sidebar.
2. Select **Administration** from the dropdown menu that appears.
![Administration dropdown](/static/images/help/administration.png)
3. Upon clicking **Administration**, your view will be replaced with the
**Administration** page. Click the **Users** tab at the top of the
panel; it turns gray upon hover.
![Administration](/static/images/help/admin-panel-users.png)
4. In the **Users** section, click the red **Deactivate** button
to the right of the user account that you want to deactivate.
![Deactivated Users](/static/images/help/deactivate-panel-admin.png)
4. After clicking the **Deactivate Account** button, a modal window titled
**Deactivate (user's email address)** will appear.
![Deactivate your account modal](/static/images/help/deactivate-modal-admin.png)
5. To confirm the deletion of the user's account, click the red **Deactivate now**
button. Please note that any bots that the user maintains will be
disabled.
6. After clicking the **Deactivate now** button, the button will transform into
a orange **Reactivate** button, and the **Make admin** button will also
disappear, confirming the success of the account's deactivation.
The user will be logged out immediately and returned to the Zulip login page
and will not be able to log back in.
## Reactivate a user
Zulip realm administrators can choose to reactivate a user's deactivated account
by following the following steps.
1. Click the cog (![cog](/static/images/help/cog.png)) in the upper right corner
of the right sidebar.
2. Select **Administration** from the dropdown menu that appears.
![Administration dropdown](/static/images/help/administration.png)
3. Upon clicking **Administration**, your view will be replaced with the
**Administration** page. Click the **Deactivated Users** tab at the top of the
panel; it turns gray upon hover.
![Administration](/static/images/help/admin-panel.png)
4. In the **Deactivated users** section, click the orange **Reactivate** button
to the right of the user account that you want to reactivate.
![Deactivated Users](/static/images/help/deactivate-panel.png)
5. After clicking the **Reactivate** button, the button will transform into a
red **Deactivate** button, confirming the success of the account's reactivation.
![Reactivate success](/static/images/help/reactivate-success.png)

View File

@ -140,7 +140,7 @@ as a “**realm**”.
* Delete your organization (not implemented) * Delete your organization (not implemented)
## Users & Bots ## Users & Bots
* Deactivate or reactivate a user * [Deactivate or reactivate a user](/help/deactivate-reactivate)
* Deactivate or reactivate a bot * Deactivate or reactivate a bot
* [Make a user an administrator](/help/make-a-user-an-administrator) * [Make a user an administrator](/help/make-a-user-an-administrator)
* Change a user's name * Change a user's name