synapse-product/docs/admin_api
Jason Robinson e2c16edc78 Add changelog and admin API docs
Signed-off-by: Jason Robinson <jasonr@matrix.org>
2021-01-09 22:58:29 +02:00
..
account_validity.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
delete_group.md Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
event_reports.md Migrate documentation docs/admin_api/event_reports to markdown (#8742) 2020-11-13 13:57:55 +00:00
media_admin_api.md Combine related media admin API docs (#8839) 2020-12-09 16:19:57 +00:00
purge_history_api.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
purge_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
README.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
register_api.rst Add displayname to Shared-Secret Registration for admins (#8722) 2020-11-05 13:55:45 +00:00
room_membership.md Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
rooms.md Add changelog and admin API docs 2021-01-09 22:58:29 +02:00
server_notices.md Fix spelling in server notices admin API docs (#5142) 2019-05-06 22:15:02 +01:00
shutdown_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
statistics.md Add an admin API for users' media statistics (#8700) 2020-11-05 18:59:12 +00:00
user_admin_api.rst Make search statement in List Room and User Admin API case-insensitive (#8931) 2020-12-17 10:43:37 +00: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.

Authenticating as a server admin
--------------------------------

Many of the API calls in the admin api will require an `access_token` for a
server admin. (Note that a server admin is distinct from a room admin.)

A user can be marked as a server admin by updating the database directly, e.g.:

.. code-block:: sql

    UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';

A new server admin user can also be created using the
``register_new_matrix_user`` script.

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>`_.