diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2020-03-18 07:50:00 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-18 07:50:00 -0400 |
| commit | 88b41986dbc54e8601ad4d889f4ebff952858b4f (patch) | |
| tree | de3e5df88c1388266b34621994c04fba71dba099 /docs | |
| parent | Update INSTALL.md updated CentOS8 install instructions (#6925) (diff) | |
| download | synapse-88b41986dbc54e8601ad4d889f4ebff952858b4f.tar.xz | |
Add an option to the set password API to choose whether to logout other devices. (#7085)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst index 6b02d963e6..9ce10119ff 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst @@ -38,6 +38,7 @@ The parameter ``threepids`` is optional. The parameter ``avatar_url`` is optional. The parameter ``admin`` is optional and defaults to 'false'. The parameter ``deactivated`` is optional and defaults to 'false'. +The parameter ``password`` is optional. If provided the user's password is updated and all devices are logged out. If the user already exists then optional parameters default to the current value. List Accounts @@ -168,11 +169,14 @@ with a body of: .. code:: json { - "new_password": "<secret>" + "new_password": "<secret>", + "logout_devices": true, } including an ``access_token`` of a server admin. +The parameter ``new_password`` is required. +The parameter ``logout_devices`` is optional and defaults to ``true``. Get whether a user is a server administrator or not =================================================== |