From 1b959b6977249c1db198beb6e04e02fa667ebfab Mon Sep 17 00:00:00 2001
From: "Olivier Wilkinson (reivilibre)" <olivier@librepush.net>
Date: Tue, 27 Aug 2019 13:19:19 +0100
Subject: [PATCH] Document GET method for retrieving admin bit of user in admin
API
Signed-off-by: Olivier Wilkinson (reivilibre) <olivier@librepush.net>
---
docs/admin_api/user_admin_api.rst | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst
index 6ee5080eed..d0871f9438 100644
--- a/docs/admin_api/user_admin_api.rst
+++ b/docs/admin_api/user_admin_api.rst
@@ -86,6 +86,25 @@ with a body of:
including an ``access_token`` of a server admin.
+Get whether a user is a server administrator or not
+===================================================
+
+
+The api is::
+
+ GET /_synapse/admin/v1/users/<user_id>/admin
+
+including an ``access_token`` of a server admin.
+
+A response body like the following is returned:
+
+.. code:: json
+
+ {
+ "admin": true
+ }
+
+
Change whether a user is a server administrator or not
======================================================
--
GitLab