synapse/docs/admin_api
Erik Johnston d781a81e69
Allow server admin to get admin bit in rooms where local user is an admin (#8756)
This adds an admin API that allows a server admin to get power in a room if a local user has power in a room. Will also invite the user if they're not in the room and its a private room. Can specify another user (rather than the admin user) to be granted power.

Co-authored-by: Matthew Hodgson <matthew@matrix.org>
2020-12-18 15:37:19 +00:00
..
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 Combine related media admin API docs (#8839) 2020-12-09 16:19:57 +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
README.rst
register_api.rst Add displayname to Shared-Secret Registration for admins (#8722) 2020-11-05 13:55:45 +00:00
room_membership.md
rooms.md Allow server admin to get admin bit in rooms where local user is an admin (#8756) 2020-12-18 15:37:19 +00: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 Add an admin API for users' media statistics (#8700) 2020-11-05 18:59:12 +00:00
user_admin_api.rst Make search statement in List Room and User Admin API case-insensitive (#8931) 2020-12-17 10:43:37 +00:00
version_api.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.:

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.