diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2021-07-22 16:05:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-22 16:05:16 +0200 |
| commit | 89c4ca81bb597159e456449c548ba3f166843ddc (patch) | |
| tree | e0c0c739697c4adc1bcb7f47e04f827fcd3bdc70 /docs | |
| parent | Replace `or_ignore` in `simple_insert` with `simple_upsert` (#10442) (diff) | |
| download | synapse-89c4ca81bb597159e456449c548ba3f166843ddc.tar.xz | |
Add `creation_ts` to list users admin API (#10448)
Signed-off-by: Dirk Klimpel dirk@klimpel.org
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index 4a65d0c3bc..160899754e 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -144,7 +144,8 @@ A response body like the following is returned: "deactivated": 0, "shadow_banned": 0, "displayname": "<User One>", - "avatar_url": null + "avatar_url": null, + "creation_ts": 1560432668000 }, { "name": "<user_id2>", "is_guest": 0, @@ -153,7 +154,8 @@ A response body like the following is returned: "deactivated": 0, "shadow_banned": 0, "displayname": "<User Two>", - "avatar_url": "<avatar_url>" + "avatar_url": "<avatar_url>", + "creation_ts": 1561550621000 } ], "next_token": "100", @@ -197,11 +199,12 @@ The following parameters should be set in the URL: - `shadow_banned` - Users are ordered by `shadow_banned` status. - `displayname` - Users are ordered alphabetically by `displayname`. - `avatar_url` - Users are ordered alphabetically by avatar URL. + - `creation_ts` - Users are ordered by when the users was created in ms. - `dir` - Direction of media order. Either `f` for forwards or `b` for backwards. Setting this value to `b` will reverse the above sort order. Defaults to `f`. -Caution. The database only has indexes on the columns `name` and `created_ts`. +Caution. The database only has indexes on the columns `name` and `creation_ts`. This means that if a different sort order is used (`is_guest`, `admin`, `user_type`, `deactivated`, `shadow_banned`, `avatar_url` or `displayname`), this can cause a large load on the database, especially for large environments. @@ -222,6 +225,7 @@ The following fields are returned in the JSON response body: - `shadow_banned` - bool - Status if that user has been marked as shadow banned. - `displayname` - string - The user's display name if they have set one. - `avatar_url` - string - The user's avatar URL if they have set one. + - `creation_ts` - integer - The user's creation timestamp in ms. - `next_token`: string representing a positive integer - Indication for pagination. See above. - `total` - integer - Total number of media. |