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: 1e2d261510
Ramas Etiquetas
synapse
/
docs
/
admin_api
Brendan Abolivier baf12bc02a Merge branch 'master' into develop %!s(int64=5) %!d(string=hai) anos
..
README.rst 1c7df13e7b add explanations on how to actually include an access_token (#6031) %!s(int64=5) %!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 8e9ca83537 Move admin API to a new prefix %!s(int64=5) %!d(string=hai) anos
media_admin_api.md 8e9ca83537 Move admin API to a new prefix %!s(int64=5) %!d(string=hai) anos
purge_history_api.rst 8e9ca83537 Move admin API to a new prefix %!s(int64=5) %!d(string=hai) anos
purge_remote_media.rst 8e9ca83537 Move admin API to a new prefix %!s(int64=5) %!d(string=hai) anos
purge_room.md 119aa31b10 Servlet to purge old rooms (#5845) %!s(int64=5) %!d(string=hai) anos
register_api.rst 8e9ca83537 Move admin API to a new prefix %!s(int64=5) %!d(string=hai) anos
server_notices.md 3fdff14207 Fix spelling in server notices admin API docs (#5142) %!s(int64=5) %!d(string=hai) anos
user_admin_api.rst 1b959b6977 Document GET method for retrieving admin bit of user in admin API %!s(int64=5) %!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.

Only users that are server admins can use these APIs. A user can be marked as a
server admin by updating the database directly, e.g.:

``UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'``

Restarting may be required for the changes to register.

Using an admin access_token
###########################

Many of the API calls listed in the documentation here will require to include an admin `access_token`.
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 `_.