Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Timo Ley
synapse
Commits
9570aa82
Commit
9570aa82
authored
6 years ago
by
Matthew Hodgson
Browse files
Options
Downloads
Patches
Plain Diff
update doc for deactivate API
parent
1e788db4
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/admin_api/user_admin_api.rst
+15
-2
15 additions, 2 deletions
docs/admin_api/user_admin_api.rst
synapse/rest/client/v1/admin.py
+1
-1
1 addition, 1 deletion
synapse/rest/client/v1/admin.py
with
16 additions
and
3 deletions
docs/admin_api/user_admin_api.rst
+
15
−
2
View file @
9570aa82
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
synapse/rest/client/v1/admin.py
+
1
−
1
View file @
9570aa82
...
...
@@ -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
(
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment