forked-synapse/docs/admin_api
Dirk Klimpel 023f791143
Migrate documentation docs/admin_api/event_reports to markdown (#8742)
Related to #8714. `event_reports.rst` was introduced in Synapse 1.21.0.
2020-11-13 13:57:55 +00: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 Add an admin api to delete local media. (#8519) 2020-10-26 17:02:28 +00:00
purge_history_api.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
purge_remote_media.rst Clarifications to the admin api documentation (#7647) 2020-06-05 17:31:05 +01:00
purge_room.md Add delete room admin endpoint (#7613) 2020-07-14 12:36:23 +01: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 Remove the "draft" status of the Room Details Admin API (#8702) 2020-11-03 12:48:25 +00:00
server_notices.md Fix spelling in server notices admin API docs (#5142) 2019-05-06 22:15:02 +01:00
shutdown_room.md Clarify that undoing a shutdown might not be possible (#8010) 2020-08-07 17:16:24 +01:00
statistics.md Add an admin API for users' media statistics (#8700) 2020-11-05 18:59:12 +00:00
user_admin_api.rst Add an admin APIs to allow server admins to list users' pushers (#8610) 2020-10-28 15:02:42 +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>`_.