diff options
| author | Jan Christian Grünhage <jan.christian@gruenhage.xyz> | 2022-06-06 13:10:13 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-06 12:10:13 +0100 |
| commit | fcd8703508ce5bfe481fc2f1510b05731477ce32 (patch) | |
| tree | 47180b0b22960d9bcf0e1daa4b92c26b8062ef36 /docs | |
| parent | Reduce the amount of state we pull from the DB (#12811) (diff) | |
| download | synapse-fcd8703508ce5bfe481fc2f1510b05731477ce32.tar.xz | |
Allow updating passwords using the admin api without logging out devices (#12952)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index c8794299e7..62f89e8cba 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -115,7 +115,9 @@ URL parameters: Body parameters: - `password` - string, optional. If provided, the user's password is updated and all - devices are logged out. + devices are logged out, unless `logout_devices` is set to `false`. +- `logout_devices` - bool, optional, defaults to `true`. If set to false, devices aren't + logged out even when `password` is provided. - `displayname` - string, optional, defaults to the value of `user_id`. - `threepids` - array, optional, allows setting the third-party IDs (email, msisdn) - `medium` - string. Kind of third-party ID, either `email` or `msisdn`. |