synapse

History

Richard van der Hoff cea7839911 Document some of the admin APIs (#2143 ) I haven't (yet) documented all of the user-list APIs introduced in https://github.com/matrix-org/synapse/pull/1784 because the API shape seems very odd, given the functionality.		2017-04-21 11:55:07 +01:00
..
README.rst	Add some basic admin API docs	2016-07-28 14:56:09 +01:00
purge_history_api.rst	Add some basic admin API docs	2016-07-28 14:56:09 +01:00
purge_remote_media.rst	fix doc for purge_media_cache	2017-01-20 12:15:50 +00:00
user_admin_api.rst	Document some of the admin APIs (#2143 )	2017-04-21 11:55:07 +01:00

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.