diff options
| author | Richard van der Hoff <richard@matrix.org> | 2018-07-12 09:56:28 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2018-07-12 09:56:28 +0100 |
| commit | 482d17b58b55e4a62c1b4df9484d1c3af80d94ff (patch) | |
| tree | d936edf00491834d76c7c7aa651d2f884e0c307b /docs/admin_api | |
| parent | Enforce the specified API for report_event (diff) | |
| parent | Merge pull request #3505 from matrix-org/erikj/receipts_cahce (diff) | |
| download | synapse-482d17b58b55e4a62c1b4df9484d1c3af80d94ff.tar.xz | |
Merge branch 'develop' into rav/enforce_report_api
Diffstat (limited to 'docs/admin_api')
| -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 |