diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-06-05 17:31:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-05 17:31:05 +0100 |
| commit | 1bc00fd76d1741477ff8ae4f2cc68102d483014c (patch) | |
| tree | ab3eacc6d4bed99a6ef4b3fe20db9e7e059e0a41 /docs/admin_api/delete_group.md | |
| parent | Update to the stable SSO prefix for UI Auth. (#7630) (diff) | |
| download | synapse-1bc00fd76d1741477ff8ae4f2cc68102d483014c.tar.xz | |
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>`
Diffstat (limited to 'docs/admin_api/delete_group.md')
| -rw-r--r-- | docs/admin_api/delete_group.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/admin_api/delete_group.md b/docs/admin_api/delete_group.md index 1710488ea8..c061678e75 100644 --- a/docs/admin_api/delete_group.md +++ b/docs/admin_api/delete_group.md @@ -4,11 +4,11 @@ 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> ``` -including an `access_token` of a server admin. +To use it, you will need to authenticate by providing an `access_token` for a +server admin: see [README.rst](README.rst). |