Selaa lähdekoodia

Fix-up deactivated notes in docs. (#16355)

tags/v1.94.0rc1
Patrick Cloke 8 kuukautta sitten
committed by GitHub
vanhempi
commit
9fabde6ead
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 muutettua tiedostoa jossa 2 lisäystä ja 1 poistoa
  1. +1
    -0
      changelog.d/16355.doc
  2. +1
    -1
      docs/admin_api/user_admin_api.md

+ 1
- 0
changelog.d/16355.doc Näytä tiedosto

@@ -0,0 +1 @@
Fix rendering of user admin API documentation around deactivation. This was broken in Synapse 1.91.0.

+ 1
- 1
docs/admin_api/user_admin_api.md Näytä tiedosto

@@ -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`.


Ladataan…
Peruuta
Tallenna