summary refs log tree commit diff
path: root/docs/admin_api/user_admin_api.rst
diff options
context:
space:
mode:
authorreivilibre <38398653+reivilibre@users.noreply.github.com>2019-08-27 10:14:00 +0100
committerGitHub <noreply@github.com>2019-08-27 10:14:00 +0100
commit1a7e6eb63387704ef379bf962318f710ce5ae5f3 (patch)
treed758ab954a9fbad9db495f76e0c59ef43ea7b766 /docs/admin_api/user_admin_api.rst
parentPropagate opentracing contexts through EDUs (#5852) (diff)
downloadsynapse-1a7e6eb63387704ef379bf962318f710ce5ae5f3.tar.xz
Add Admin API capability to set adminship of a user (#5878)
Admin API: Set adminship of a user
Diffstat (limited to 'docs/admin_api/user_admin_api.rst')
-rw-r--r--docs/admin_api/user_admin_api.rst20
1 files changed, 20 insertions, 0 deletions
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.