synapse

History

Travis Ralston a8ffc27db7 Update the admin register documentation to return a real user ID Presumably this is the intention anyways. I've also updated the domain part to be something more along the lines of what people might expect.		2018-08-17 02:46:25 -06:00
..
README.rst	Add some basic admin API docs	2016-07-28 14:56:09 +01:00
media_admin_api.md	Add admin api documentation for list media endpoint	2018-01-31 08:15:59 -07:00
purge_history_api.rst	Update purge_history_api.rst	2018-03-15 11:05:42 +00:00
purge_remote_media.rst	fix doc for purge_media_cache	2017-01-20 12:15:50 +00:00
register_api.rst	Update the admin register documentation to return a real user ID	2018-08-17 02:46:25 -06:00
user_admin_api.rst	update doc for deactivate API	2018-06-26 10:42:50 +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.