diff options
| author | Olivier Wilkinson (reivilibre) <olivier@librepush.net> | 2019-08-27 13:19:19 +0100 |
|---|---|---|
| committer | Olivier Wilkinson (reivilibre) <olivier@librepush.net> | 2019-08-27 13:19:19 +0100 |
| commit | 1b959b6977249c1db198beb6e04e02fa667ebfab (patch) | |
| tree | 2ec079413212b3c79ddb9c7fee490c2143fbf176 /docs/admin_api/user_admin_api.rst | |
| parent | Add GET method to admin API /users/@user:dom/admin (diff) | |
| download | synapse-1b959b6977249c1db198beb6e04e02fa667ebfab.tar.xz | |
Document GET method for retrieving admin bit of user in admin API
Signed-off-by: Olivier Wilkinson (reivilibre) <olivier@librepush.net>
Diffstat (limited to 'docs/admin_api/user_admin_api.rst')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 19 |
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 ====================================================== |