diff options
| author | reivilibre <38398653+reivilibre@users.noreply.github.com> | 2019-08-28 09:44:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-28 09:44:22 +0100 |
| commit | a3f06356860de1ff727a8df1f38ea4afd5d70bd5 (patch) | |
| tree | 9894346894a293b4214fc723890af1593eb18c5f /docs | |
| parent | Typographical corrections in docker/README (#5921) (diff) | |
| parent | Document GET method for retrieving admin bit of user in admin API (diff) | |
| download | synapse-a3f06356860de1ff727a8df1f38ea4afd5d70bd5.tar.xz | |
Merge pull request #5914 from matrix-org/rei/admin_getadmin
Add GET method to admin API /users/@user:dom/admin
Diffstat (limited to 'docs')
| -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 ====================================================== |