0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-24 10:14:13 +01:00
synapse/docs/admin_api/delete_group.md
Dirk Klimpel 0da2301b21
Consolidate the access_token information in the admin api (#11861)
Co-authored-by: reivilibre <olivier@librepush.net>
2022-01-31 16:24:29 +00:00

14 lines
405 B
Markdown

# Delete a local group
This API lets a server admin delete a local group. Doing so will kick all
users out of the group so that their clients will correctly handle the group
being deleted.
To use it, you will need to authenticate by providing an `access_token`
for a server admin: see [Admin API](../usage/administration/admin_api).
The API is:
```
POST /_synapse/admin/v1/delete_group/<group_id>
```