summary refs log tree commit diff
diff options
context:
space:
mode:
authoraxel simon <github@axelsimon.net>2019-09-13 09:50:17 +0200
committerRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2019-09-13 08:50:17 +0100
commit1c7df13e7b26f249726380cbec5a6bc7bb3daeb6 (patch)
treed48f6bbece0f47d9c254f142204faf4b8d602610
parentREADME: link to reverse_proxy.rst (#6027) (diff)
downloadsynapse-1c7df13e7b26f249726380cbec5a6bc7bb3daeb6.tar.xz
add explanations on how to actually include an access_token (#6031)
-rw-r--r--docs/admin_api/README.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/admin_api/README.rst b/docs/admin_api/README.rst
index d4f564cfae..191806c5b4 100644
--- a/docs/admin_api/README.rst
+++ b/docs/admin_api/README.rst
@@ -10,3 +10,15 @@ server admin by updating the database directly, e.g.:
 ``UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'``
 
 Restarting may be required for the changes to register.
+
+Using an admin access_token
+###########################
+
+Many of the API calls listed in the documentation here will require to include an admin `access_token`.
+Finding your user's `access_token` is client-dependent, but will usually be shown in the client's settings.
+
+Once you have your `access_token`, to include it in a request, the best option is to add the token to a request header:
+
+``curl --header "Authorization: Bearer <access_token>" <the_rest_of_your_API_request>``
+
+Fore more details, please refer to the complete `matrix spec documentation <https://matrix.org/docs/spec/client_server/r0.5.0#using-access-tokens>`_.