summary refs log tree commit diff
path: root/docs/admin_api/user_admin_api.rst
diff options
context:
space:
mode:
authorOlivier Wilkinson (reivilibre) <olivier@librepush.net>2019-08-29 15:02:09 +0100
committerOlivier Wilkinson (reivilibre) <olivier@librepush.net>2019-08-29 15:02:09 +0100
commit60481031f2f1e43aaedc96a33441bfcf15262330 (patch)
treeb7f1e9e461e3034b1ca0fd75e6ea4ea185986cfb /docs/admin_api/user_admin_api.rst
parentCount total_events and total_event_bytes within the loop. (diff)
parentMerge branch 'develop' into rei/rss_target (diff)
downloadsynapse-60481031f2f1e43aaedc96a33441bfcf15262330.tar.xz
Merge branch 'rei/rss_target' into rei/rss_inc5 github/rei/rss_inc5 rei/rss_inc5
Diffstat (limited to 'docs/admin_api/user_admin_api.rst')
-rw-r--r--docs/admin_api/user_admin_api.rst19
1 files changed, 19 insertions, 0 deletions
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 ======================================================