Document GET method for retrieving admin bit of user in admin API

Signed-off-by: Olivier Wilkinson (reivilibre) <olivier@librepush.net>
This commit is contained in:
Olivier Wilkinson (reivilibre) 2019-08-27 13:19:19 +01:00
parent c88a119259
commit 1b959b6977

View File

@ -86,6 +86,25 @@ with a body of:
including an ``access_token`` of a server admin. 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 Change whether a user is a server administrator or not
====================================================== ======================================================