diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2021-02-17 21:19:23 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-17 15:19:23 -0500 |
| commit | c8d9383cfb0985a99bf10756ea2dcb0b6329859d (patch) | |
| tree | 9941bb1acc72e621b361c0609b5c93d0d2a32c28 /docs | |
| parent | Remove dead notify_for_states presence method (#9408) (diff) | |
| download | synapse-c8d9383cfb0985a99bf10756ea2dcb0b6329859d.tar.xz | |
Add the shadow-banning status to the display user admin API. (#9400)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst index 1eb674939e..33dfbcfb49 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst @@ -29,8 +29,9 @@ It returns a JSON body like the following: } ], "avatar_url": "<avatar_url>", - "admin": false, - "deactivated": false, + "admin": 0, + "deactivated": 0, + "shadow_banned": 0, "password_hash": "$2b$12$p9B4GkqYdRTPGD", "creation_ts": 1560432506, "appservice_id": null, @@ -150,6 +151,7 @@ A JSON body is returned with the following shape: "admin": 0, "user_type": null, "deactivated": 0, + "shadow_banned": 0, "displayname": "<User One>", "avatar_url": null }, { @@ -158,6 +160,7 @@ A JSON body is returned with the following shape: "admin": 1, "user_type": null, "deactivated": 0, + "shadow_banned": 0, "displayname": "<User Two>", "avatar_url": "<avatar_url>" } @@ -262,7 +265,7 @@ The following actions are performed when deactivating an user: - Reject all pending invites - Remove all account validity information related to the user -The following additional actions are performed during deactivation if``erase`` +The following additional actions are performed during deactivation if ``erase`` is set to ``true``: - Remove the user's display name |