MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-15 00:53:52 +01:00
Code Issues Projects Releases Wiki Activity
synapse/docs/admin_api/delete_group.md
Richard van der Hoff 1bc00fd76d
Clarifications to the admin api documentation (#7647) 
* Clarify how to authenticate
* path params are not the same thing as query params
* Fix documentation for `/_synapse/admin/v2/users/<user_id>`
2020-06-05 17:31:05 +01:00

383 B
Raw Blame History

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.

The API is:

POST /_synapse/admin/v1/delete_group/<group_id>

To use it, you will need to authenticate by providing an access_token for a server admin: see README.rst.