summary refs log tree commit diff
path: root/docs/admin_api/README.rst
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2016-08-02 17:07:54 +0100
committerErik Johnston <erik@matrix.org>2016-08-02 17:07:54 +0100
commit59a2c6d60e3c1e03f86e88ad81ac093c8109942d (patch)
treeef5a7b0722f1d2890df706ac6f42d6dda5986645 /docs/admin_api/README.rst
parentTypo (diff)
parentMerge pull request #971 from matrix-org/erikj/fed_state (diff)
downloadsynapse-59a2c6d60e3c1e03f86e88ad81ac093c8109942d.tar.xz
Merge branch 'develop' of github.com:matrix-org/synapse into release-v0.17.0
Diffstat (limited to '')
-rw-r--r--docs/admin_api/README.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/admin_api/README.rst b/docs/admin_api/README.rst
new file mode 100644

index 0000000000..d4f564cfae --- /dev/null +++ b/docs/admin_api/README.rst
@@ -0,0 +1,12 @@ +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.