diff options
| author | Mathieu Velten <mathieuv@matrix.org> | 2023-08-10 11:10:55 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-10 09:10:55 +0000 |
| commit | dac97642e41f3f4bc0deff0c80b6a3f7acb4dbc0 (patch) | |
| tree | d13c5ad7f19ee84223129dd1693331f8866d952c /docs | |
| parent | Support MSC3814: Dehydrated Devices Part 2 (#16010) (diff) | |
| download | synapse-dac97642e41f3f4bc0deff0c80b6a3f7acb4dbc0.tar.xz | |
Implements admin API to lock an user (MSC3939) (#15870)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 1 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 2 |
2 files changed, 3 insertions, 0 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index ac4f635099..c269ce6af0 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -146,6 +146,7 @@ Body parameters: - `admin` - **bool**, optional, defaults to `false`. Whether the user is a homeserver administrator, granting them access to the Admin API, among other things. - `deactivated` - **bool**, optional. If unspecified, deactivation state will be left unchanged. +- `locked` - **bool**, optional. If unspecified, locked state will be left unchanged. Note: the `password` field must also be set if both of the following are true: - `deactivated` is set to `false` and the user was previously deactivated (you are reactivating this user) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 2987c9332d..a17a8c2900 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3631,6 +3631,7 @@ This option has the following sub-options: * `prefer_local_users`: Defines whether to prefer local users in search query results. If set to true, local users are more likely to appear above remote users when searching the user directory. Defaults to false. +* `show_locked_users`: Defines whether to show locked users in search query results. Defaults to false. Example configuration: ```yaml @@ -3638,6 +3639,7 @@ user_directory: enabled: false search_all_users: true prefer_local_users: true + show_locked_users: true ``` --- ### `user_consent` |