MatrixSynapse/docs/admin_api
Richard van der Hoff a090b86209
Add `force_purge` option to delete-room admin api. (#8843)
2020-11-30 16:48:12 +00:00
..
README.rst
account_validity.rst
delete_group.md
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 Clarify documentation of the admin list media API (#8795) 2020-11-24 09:04:51 -05:00
purge_history_api.rst
purge_remote_media.rst
purge_room.md
register_api.rst Add `displayname` to Shared-Secret Registration for admins (#8722) 2020-11-05 13:55:45 +00:00
room_membership.md
rooms.md Add `force_purge` option to delete-room admin api. (#8843) 2020-11-30 16:48:12 +00:00
server_notices.md
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 Remove deprecated `/_matrix/client/*/admin` endpoints (#8785) 2020-11-25 16:26:11 -05:00
version_api.rst

README.rst

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