forked-synapse/docs/admin_api
2019-09-13 08:50:17 +01:00
..
account_validity.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
delete_group.md Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
media_admin_api.md Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
purge_history_api.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
purge_remote_media.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
README.rst add explanations on how to actually include an access_token (#6031) 2019-09-13 08:50:17 +01:00
register_api.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
server_notices.md Fix spelling in server notices admin API docs (#5142) 2019-05-06 22:15:02 +01:00
user_admin_api.rst Clarify that the admin change password endpoint logs them out (#5303) 2019-05-31 09:45:46 +01:00
version_api.rst Remove the requirement to authenticate for /admin/server_version. (#5122) 2019-05-07 09:29:30 +01:00

Admin APIs
==========

This directory includes documentation for the various synapse specific admin
APIs available.

Only users that are server admins can use these APIs. A user can be marked as a
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>`_.