diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2020-07-15 11:00:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-15 11:00:21 -0400 |
| commit | 8c7d0f163d8247297dbcfd5f257b652ebe417fff (patch) | |
| tree | c3df5390d9919b2d9f2740a3c254f220f853bd7b /docs/admin_api/user_admin_api.rst | |
| parent | Fix client reader sharding tests (#7853) (diff) | |
| download | synapse-8c7d0f163d8247297dbcfd5f257b652ebe417fff.tar.xz | |
Allow accounts to be re-activated from the admin APIs. (#7847)
Diffstat (limited to 'docs/admin_api/user_admin_api.rst')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst index 7b030a6285..be05128b3e 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst @@ -91,10 +91,14 @@ Body parameters: - ``admin``, optional, defaults to ``false``. -- ``deactivated``, optional, defaults to ``false``. +- ``deactivated``, optional. If unspecified, deactivation state will be left + unchanged on existing accounts and set to ``false`` for new accounts. If the user already exists then optional parameters default to the current value. +In order to re-activate an account ``deactivated`` must be set to ``false``. If +users do not login via single-sign-on, a new ``password`` must be provided. + List Accounts ============= |