diff options
| author | Amber Brown <hawkowl@atleastfornow.net> | 2018-09-03 21:08:35 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-03 21:08:35 +1000 |
| commit | 4fc4b881c58fd638db5f4dac0863721111b67af0 (patch) | |
| tree | cc1604f5e3b4e0a263e0e11a55b62ef4006a64a1 /docs/admin_api/user_admin_api.rst | |
| parent | The project `matrix-synapse-auto-deploy` does not seem to be maintained anymore. (diff) | |
| parent | Merge pull request #3777 from matrix-org/neilj/fix_register_user_registration (diff) | |
| download | synapse-4fc4b881c58fd638db5f4dac0863721111b67af0.tar.xz | |
Merge branch 'develop' into develop
Diffstat (limited to 'docs/admin_api/user_admin_api.rst')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst index 1c9c5a6bde..d17121a188 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst @@ -44,13 +44,26 @@ Deactivate Account This API deactivates an account. It removes active access tokens, resets the password, and deletes third-party IDs (to prevent the user requesting a -password reset). +password reset). It can also mark the user as GDPR-erased (stopping their data +from distributed further, and deleting it entirely if there are no other +references to it). The api is:: POST /_matrix/client/r0/admin/deactivate/<user_id> -including an ``access_token`` of a server admin, and an empty request body. +with a body of: + +.. code:: json + + { + "erase": true + } + +including an ``access_token`` of a server admin. + +The erase parameter is optional and defaults to 'false'. +An empty body may be passed for backwards compatibility. Reset password |