MatrixSynapse/docs/admin_api
Andrew Morgan e9df3f496b
Link to the List user's media admin API from media Admin API docs (#9571)
Earlier [I was convinced](https://github.com/matrix-org/synapse/issues/9565) that we didn't have an Admin API for listing media uploaded by a user. Foolishly I was looking under the Media Admin API documentation, instead of the User Admin API documentation.

I thought it'd be helpful to link to the latter so others don't hit the same dead end :)
2021-03-09 15:15:52 +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 Link to the List user's media admin API from media Admin API docs (#9571) 2021-03-09 15:15:52 +00:00
purge_history_api.rst
purge_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
register_api.rst
room_membership.md
rooms.md Merge pull request #9150 from Yoric/develop-context 2021-02-08 15:53:44 +01:00
server_notices.md
shutdown_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
statistics.md
user_admin_api.rst Add an `order_by` field to list users' media admin API. (#8978) 2021-02-22 14:38:51 -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>`_.