diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2021-11-16 07:43:53 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-16 12:43:53 +0000 |
| commit | 24b61f379ac1fc740e1b569b85363e2a0411883a (patch) | |
| tree | c60704d0e349d73b0dd39caf45c61c087f143f3b /docs | |
| parent | Misc typing fixes for tests, part 2 of N (#11330) (diff) | |
| download | synapse-24b61f379ac1fc740e1b569b85363e2a0411883a.tar.xz | |
Add ability to un-shadow-ban via the admin API. (#11347)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index 16ec33b3c1..ba574d795f 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -948,7 +948,7 @@ The following fields are returned in the JSON response body: See also the [Client-Server API Spec on pushers](https://matrix.org/docs/spec/client_server/latest#get-matrix-client-r0-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, @@ -961,16 +961,22 @@ 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](../usage/administration/admin_api) -An empty JSON dict is returned. +An empty JSON dict is returned in both cases. **Parameters** |