Inicio Explorar Axuda
Iniciar sesión
RISCI_ATOM
/
synapse
réplica de https://github.com/matrix-org/synapse.git
1
0
Fork 0
Ficheiros Incidencias 3 Wiki
Árbore: 31b1905e13
Ramas Etiquetas
synapse
/
docs
/
admin_api
Erik Johnston d781a81e69 Allow server admin to get admin bit in rooms where local user is an admin (#8756) %!s(int64=3) %!d(string=hai) anos
..
README.rst 1bc00fd76d Clarifications to the admin api documentation (#7647) %!s(int64=4) %!d(string=hai) anos
account_validity.rst 8e9ca83537 Move admin API to a new prefix %!s(int64=5) %!d(string=hai) anos
delete_group.md 1bc00fd76d Clarifications to the admin api documentation (#7647) %!s(int64=4) %!d(string=hai) anos
event_reports.md 023f791143 Migrate documentation `docs/admin_api/event_reports` to markdown (#8742) %!s(int64=4) %!d(string=hai) anos
media_admin_api.md 43bf3c5178 Combine related media admin API docs (#8839) %!s(int64=3) %!d(string=hai) anos
purge_history_api.rst 1bc00fd76d Clarifications to the admin api documentation (#7647) %!s(int64=4) %!d(string=hai) anos
purge_room.md a5f7aff5e5 Deprecate Shutdown Room and Purge Room Admin API (#8829) %!s(int64=3) %!d(string=hai) anos
register_api.rst e4676bd877 Add `displayname` to Shared-Secret Registration for admins (#8722) %!s(int64=4) %!d(string=hai) anos
room_membership.md 1bc00fd76d Clarifications to the admin api documentation (#7647) %!s(int64=4) %!d(string=hai) anos
rooms.md d781a81e69 Allow server admin to get admin bit in rooms where local user is an admin (#8756) %!s(int64=3) %!d(string=hai) anos
server_notices.md 3fdff14207 Fix spelling in server notices admin API docs (#5142) %!s(int64=5) %!d(string=hai) anos
shutdown_room.md a5f7aff5e5 Deprecate Shutdown Room and Purge Room Admin API (#8829) %!s(int64=3) %!d(string=hai) anos
statistics.md c3119d1536 Add an admin API for users' media statistics (#8700) %!s(int64=4) %!d(string=hai) anos
user_admin_api.rst 06006058d7 Make search statement in List Room and User Admin API case-insensitive (#8931) %!s(int64=3) %!d(string=hai) anos
version_api.rst 59e2d2694d Remove the requirement to authenticate for /admin/server_version. (#5122) %!s(int64=5) %!d(string=hai) anos

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 " ``

Fore more details, please refer to the complete `matrix spec documentation `_.