diff options
| author | Matthew Hodgson <matthew@matrix.org> | 2018-06-26 10:42:50 +0100 |
|---|---|---|
| committer | Matthew Hodgson <matthew@matrix.org> | 2018-06-26 10:42:50 +0100 |
| commit | 9570aa82ebf0d8dc01c8094df232ce16e683c905 (patch) | |
| tree | a28406464c3c74b8e05fc1470338812220bf477d | |
| parent | add GDPR erase param to deactivate API (diff) | |
| download | synapse-9570aa82ebf0d8dc01c8094df232ce16e683c905.tar.xz | |
update doc for deactivate API
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 17 | ||||
| -rw-r--r-- | synapse/rest/client/v1/admin.py | 2 |
2 files changed, 16 insertions, 3 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 diff --git a/synapse/rest/client/v1/admin.py b/synapse/rest/client/v1/admin.py index 3f231e6b29..8fb08dc526 100644 --- a/synapse/rest/client/v1/admin.py +++ b/synapse/rest/client/v1/admin.py @@ -249,7 +249,7 @@ class DeactivateAccountRestServlet(ClientV1RestServlet): @defer.inlineCallbacks def on_POST(self, request, target_user_id): - body = parse_json_object_from_request(request) + body = parse_json_object_from_request(request, allow_empty_body=True) erase = body.get("erase", False) if not isinstance(erase, bool): raise SynapseError( |