diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2023-09-19 08:05:33 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-19 08:05:33 -0400 |
| commit | 9fabde6eadea526c92a9ca7cd960b879e8995db6 (patch) | |
| tree | 22f1d58c501d47ce7d0b808e0da0ae818d822cc5 /docs/admin_api | |
| parent | Use string for federation_client_minimum_tls_version documentation examples (... (diff) | |
| download | synapse-9fabde6eadea526c92a9ca7cd960b879e8995db6.tar.xz | |
Fix-up deactivated notes in docs. (#16355)
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index f83facabe4..b91848dd27 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -148,7 +148,6 @@ 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) @@ -158,6 +157,7 @@ Body parameters: Note: a user cannot be erased with this API. For more details on deactivating and erasing users see [Deactivate Account](#deactivate-account). +- `locked` - **bool**, optional. If unspecified, locked state will be left unchanged. - `user_type` - **string** or null, optional. If not provided, the user type will be not be changed. If `null` is given, the user type will be cleared. Other allowed options are: `bot` and `support`. |