synapse/docs/admin_api/README.rst
Richard van der Hoff 1bc00fd76d
Clarifications to the admin api documentation (#7647)
* Clarify how to authenticate
* path params are not the same thing as query params
* Fix documentation for `/_synapse/admin/v2/users/<user_id>`
2020-06-05 17:31:05 +01:00

1 KiB

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.:

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.