mirror of
https://github.com/element-hq/synapse.git
synced 2025-03-14 09:45:51 +00:00
Document suspension Admin API (#18162)
Missed in the transition from experimental to stable. Fixes #18160
This commit is contained in:
parent
1525a3b4d4
commit
6b4cc9f3f6
2 changed files with 27 additions and 0 deletions
1
changelog.d/18162.misc
Normal file
1
changelog.d/18162.misc
Normal file
|
@ -0,0 +1 @@
|
|||
Document suspension Admin API.
|
|
@ -414,6 +414,32 @@ The following actions are **NOT** performed. The list may be incomplete.
|
|||
- Remove from monthly active users
|
||||
- Remove user's consent information (consent version and timestamp)
|
||||
|
||||
## Suspend/Unsuspend Account
|
||||
|
||||
This API allows an admin to suspend/unsuspend an account. While an account is suspended, the user is
|
||||
prohibited from sending invites, joining or knocking on rooms, sending messages, changing profile data, and redacting messages other than their own.
|
||||
|
||||
The api is:
|
||||
|
||||
```
|
||||
PUT /_synapse/admin/v1/suspend/<user_id>
|
||||
```
|
||||
|
||||
with a body of:
|
||||
|
||||
```json
|
||||
{
|
||||
"suspend": true
|
||||
}
|
||||
```
|
||||
|
||||
To unsuspend a user, use the same endpoint with a body of:
|
||||
```json
|
||||
{
|
||||
"suspend": false
|
||||
}
|
||||
```
|
||||
|
||||
## Reset password
|
||||
|
||||
**Note:** This API is disabled when MSC3861 is enabled. [See #15582](https://github.com/matrix-org/synapse/pull/15582)
|
||||
|
|
Loading…
Add table
Reference in a new issue