summary refs log tree commit diff
path: root/docs/admin_api/user_admin_api.rst
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2020-09-01 16:31:59 +0100
committerGitHub <noreply@github.com>2020-09-01 16:31:59 +0100
commitb5133dd97f693ca213b30f4f3e874e9ab3958ea7 (patch)
treeebb01ede774a92e63f93a4fc7f15fb064abe57a3 /docs/admin_api/user_admin_api.rst
parentConvert additional databases to async/await part 3 (#8201) (diff)
downloadsynapse-b5133dd97f693ca213b30f4f3e874e9ab3958ea7.tar.xz
Explain better what GDPR-erased means (#8189)
Fixes https://github.com/matrix-org/synapse/issues/8185
Diffstat (limited to 'docs/admin_api/user_admin_api.rst')
-rw-r--r--docs/admin_api/user_admin_api.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst
index d6e3194cda..e21c78a9c6 100644
--- a/docs/admin_api/user_admin_api.rst
+++ b/docs/admin_api/user_admin_api.rst
@@ -214,9 +214,11 @@ 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). 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).
+password reset).
+
+It can also mark the user as GDPR-erased. This means messages sent by the
+user will still be visible by anyone that was in the room when these messages
+were sent, but hidden from users joining the room afterwards.
 
 The api is::