From 7b4c532ab70079bfda251f9ef1e44aa70e726249 Mon Sep 17 00:00:00 2001 From: babolivier Date: Tue, 30 Nov 2021 14:28:51 +0000 Subject: deploy: e713855dca17a7605bae99ea8d71bc7f8657e4b8 --- latest/admin_api/user_admin_api.html | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'latest/admin_api/user_admin_api.html') diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index 0efa1f241f..f9291da868 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -99,7 +99,7 @@ @@ -1000,7 +1000,7 @@ Max length, 512 bytes.

See also the Client-Server API Spec on pushers.

-

Shadow-banning users

+

Controlling whether a user is shadow-banned

Shadow-banning is a useful tool for moderating malicious or egregiously abusive users. A shadow-banned users receives successful responses to their client-server API requests, but the events are not propagated into rooms. This can be an effective tool as it @@ -1010,12 +1010,15 @@ pivoting to another account.

or broken behaviour for the client. A shadow-banned user will not receive any notification and it is generally more appropriate to ban or kick abusive users. A shadow-banned user will be unable to contact anyone on the server.

-

The API is:

+

To shadow-ban a user the API is:

POST /_synapse/admin/v1/users/<user_id>/shadow_ban
+

To un-shadow-ban a user the API is:

+
DELETE /_synapse/admin/v1/users/<user_id>/shadow_ban
+

To use it, you will need to authenticate by providing an access_token for a server admin: Admin API

-

An empty JSON dict is returned.

+

An empty JSON dict is returned in both cases.

Parameters

The following parameters should be set in the URL: