diff options
author | Erik Johnston <erik@matrix.org> | 2016-07-28 14:56:09 +0100 |
---|---|---|
committer | Erik Johnston <erik@matrix.org> | 2016-07-28 14:56:09 +0100 |
commit | 367b594183c553436bb0338e9f26e42fa46424dc (patch) | |
tree | 3ea4ce1cee7367553655cdcc7eaa5d1378363d46 /docs/admin_api/README.rst | |
parent | Add authors to changelog (diff) | |
download | synapse-367b594183c553436bb0338e9f26e42fa46424dc.tar.xz |
Add some basic admin API docs
Diffstat (limited to 'docs/admin_api/README.rst')
-rw-r--r-- | docs/admin_api/README.rst | 12 |
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. |