summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-04-04 14:43:57 +0100
committerErik Johnston <erik@matrix.org>2019-04-04 14:43:57 +0100
commit8467756dc124e305a7d2d5cd211c98ea3ea2d469 (patch)
tree61df74bd18b107866f413f3a249492025033f390 /docs/admin_api
parentMerge branch 'develop' of github.com:matrix-org/synapse into matrix-org-hotfixes (diff)
parentClean up the database pagination code (#5007) (diff)
downloadsynapse-8467756dc124e305a7d2d5cd211c98ea3ea2d469.tar.xz
Merge branch 'develop' of github.com:matrix-org/synapse into matrix-org-hotfixes
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/delete_group.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/admin_api/delete_group.md b/docs/admin_api/delete_group.md
new file mode 100644

index 0000000000..d703d108b0 --- /dev/null +++ b/docs/admin_api/delete_group.md
@@ -0,0 +1,14 @@ +# 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 /_matrix/client/r0/admin/delete_group/<group_id> +``` + +including an `access_token` of a server admin.