summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2020-02-21 11:31:28 +0000
committerAndrew Morgan <andrew@amorgan.xyz>2020-02-21 11:31:28 +0000
commita7a669b4de5582c07bab9ff09a82127d1247f1d1 (patch)
tree18e0f8260db3a705365545c215aaa1f4baabd504 /docs
parentPropagate opentracing contexts through EDUs (#5852) (diff)
parentAdd Admin API capability to set adminship of a user (#5878) (diff)
downloadsynapse-a7a669b4de5582c07bab9ff09a82127d1247f1d1.tar.xz
Add Admin API capability to set adminship of a user (#5878)
Diffstat (limited to 'docs')
-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.