summary refs log tree commit diff
path: root/docs/admin_api/room_membership.md
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2020-06-05 17:31:05 +0100
committerGitHub <noreply@github.com>2020-06-05 17:31:05 +0100
commit1bc00fd76d1741477ff8ae4f2cc68102d483014c (patch)
treeab3eacc6d4bed99a6ef4b3fe20db9e7e059e0a41 /docs/admin_api/room_membership.md
parentUpdate to the stable SSO prefix for UI Auth. (#7630) (diff)
downloadsynapse-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/room_membership.md')
-rw-r--r--docs/admin_api/room_membership.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/admin_api/room_membership.md b/docs/admin_api/room_membership.md
index 16736d3d37..b6746ff5e4 100644
--- a/docs/admin_api/room_membership.md
+++ b/docs/admin_api/room_membership.md
@@ -23,7 +23,8 @@ POST /_synapse/admin/v1/join/<room_id_or_alias>
 }
 ```
 
-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).
 
 Response: