summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorreivilibre <oliverw@matrix.org>2022-01-24 13:37:00 +0000
committerGitHub <noreply@github.com>2022-01-24 13:37:00 +0000
commitdf54c8485a286dbefaa038319399ef8985d5344e (patch)
tree57e998b3db672ff95260d7567e81bf7b755023b1 /docs/admin_api
parentDrop support for and remove references to EOL Python 3.6 (#11683) (diff)
downloadsynapse-df54c8485a286dbefaa038319399ef8985d5344e.tar.xz
Remove account data (including client config, push rules and ignored users) upon user deactivation. (#11621)
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/user_admin_api.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index c514cadb9d..fdc1f2d1cf 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/docs/admin_api/user_admin_api.md
@@ -353,6 +353,11 @@ The following actions are performed when deactivating an user:
 - Remove the user from the user directory
 - Reject all pending invites
 - Remove all account validity information related to the user
+- Remove the arbitrary data store known as *account data*. For example, this includes:
+    - list of ignored users;
+    - push rules;
+    - secret storage keys; and
+    - cross-signing keys.
 
 The following additional actions are performed during deactivation if `erase`
 is set to `true`:
@@ -366,7 +371,6 @@ The following actions are **NOT** performed. The list may be incomplete.
 - Remove mappings of SSO IDs
 - [Delete media uploaded](#delete-media-uploaded-by-a-user) by user (included avatar images)
 - Delete sent and received messages
-- Delete E2E cross-signing keys
 - Remove the user's creation (registration) timestamp
 - [Remove rate limit overrides](#override-ratelimiting-for-users)
 - Remove from monthly active users