summary refs log tree commit diff
path: root/docs/admin_api/user_admin_api.md
diff options
context:
space:
mode:
authorHubert Chathi <hubertc@matrix.org>2025-05-28 07:20:27 -0400
committerGitHub <noreply@github.com>2025-05-28 12:20:27 +0100
commit2436512a2522c480f33dcf5ce54f8d5f9371ba54 (patch)
treef0e5e609ce2bd2a19c63610c5f0b6956fcbe81a2 /docs/admin_api/user_admin_api.md
parentBump lxml from 5.3.0 to 5.4.0 (#18480) (diff)
downloadsynapse-2436512a2522c480f33dcf5ce54f8d5f9371ba54.tar.xz
Mark dehydrated devices in admin get devices endpoint (#18252)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Diffstat (limited to 'docs/admin_api/user_admin_api.md')
-rw-r--r--docs/admin_api/user_admin_api.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md

index 875876081f..ee22b0db50 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md
@@ -954,7 +954,8 @@ A response body like the following is returned: "last_seen_ip": "1.2.3.4", "last_seen_user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0", "last_seen_ts": 1474491775024, - "user_id": "<user_id>" + "user_id": "<user_id>", + "dehydrated": false }, { "device_id": "AUIECTSRND", @@ -962,7 +963,8 @@ A response body like the following is returned: "last_seen_ip": "1.2.3.5", "last_seen_user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:103.0) Gecko/20100101 Firefox/103.0", "last_seen_ts": 1474491775025, - "user_id": "<user_id>" + "user_id": "<user_id>", + "dehydrated": false } ], "total": 2 @@ -992,6 +994,7 @@ The following fields are returned in the JSON response body: - `last_seen_ts` - The timestamp (in milliseconds since the unix epoch) when this devices was last seen. (May be a few minutes out of date, for efficiency reasons). - `user_id` - Owner of device. + - `dehydrated` - Whether the device is a dehydrated device. - `total` - Total number of user's devices.