summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorOlivier Wilkinson (reivilibre) <olivier@librepush.net>2019-08-27 13:54:38 +0100
committerOlivier Wilkinson (reivilibre) <olivier@librepush.net>2019-08-27 13:54:38 +0100
commitbc754cdeed38be79fac33e84fc2a78307d799676 (patch)
treeaf78f1d2dd225c1fb376684d4efed2e306c0d269 /docs/admin_api
parentHandle state deltas and turn them into stats deltas (diff)
parentDon't include the room & user stats docs in this PR. (diff)
downloadsynapse-bc754cdeed38be79fac33e84fc2a78307d799676.tar.xz
Merge branch 'rei/rss_inc2' into rei/rss_inc3
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/purge_room.md18
-rw-r--r--docs/admin_api/user_admin_api.rst20
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/admin_api/purge_room.md b/docs/admin_api/purge_room.md
new file mode 100644
index 0000000000..64ea7b6a64
--- /dev/null
+++ b/docs/admin_api/purge_room.md
@@ -0,0 +1,18 @@
+Purge room API
+==============
+
+This API will remove all trace of a room from your database.
+
+All local users must have left the room before it can be removed.
+
+The API is:
+
+```
+POST /_synapse/admin/v1/purge_room
+
+{
+    "room_id": "!room:id"
+}
+```
+
+You must authenticate using the access token of an admin user.
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst
index 213359d0c0..6ee5080eed 100644
--- a/docs/admin_api/user_admin_api.rst
+++ b/docs/admin_api/user_admin_api.rst
@@ -84,3 +84,23 @@ with a body of:
    }
 
 including an ``access_token`` of a server admin.
+
+
+Change whether a user is a server administrator or not
+======================================================
+
+Note that you cannot demote yourself.
+
+The api is::
+
+    PUT /_synapse/admin/v1/users/<user_id>/admin
+
+with a body of:
+
+.. code:: json
+
+    {
+        "admin": true
+    }
+
+including an ``access_token`` of a server admin.