mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-25 11:49:22 -05:00
73636cab69
So that they render nicely in mdbook (see #10086), and so that we no longer have a mix of structured text languages in our documentation (excluding files outside of `docs/`). |
||
|---|---|---|
| .. | ||
| account_validity.md | ||
| delete_group.md | ||
| event_reports.md | ||
| media_admin_api.md | ||
| purge_history_api.md | ||
| purge_room.md | ||
| README.rst | ||
| register_api.md | ||
| room_membership.md | ||
| rooms.md | ||
| server_notices.md | ||
| shutdown_room.md | ||
| statistics.md | ||
| user_admin_api.md | ||
| version_api.md | ||
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>`_.