diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2020-10-26 15:07:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-26 14:07:51 +0000 |
| commit | 913f8a06e43da760ccef329d43c139ec3c7fd7d5 (patch) | |
| tree | 377eedebad84886f8ae59bed279060094179770e /docs/admin_api/user_admin_api.rst | |
| parent | Check status codes that profile handler returns (#8580) (diff) | |
| download | synapse-913f8a06e43da760ccef329d43c139ec3c7fd7d5.tar.xz | |
Add field `total` to device list in admin API (#8644)
Diffstat (limited to 'docs/admin_api/user_admin_api.rst')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst index 7ca902faba..0f3d99c826 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst @@ -375,7 +375,8 @@ A response body like the following is returned: "last_seen_ts": 1474491775025, "user_id": "<user_id>" } - ] + ], + "total": 2 } **Parameters** @@ -400,6 +401,8 @@ The following fields are returned in the JSON response body: devices was last seen. (May be a few minutes out of date, for efficiency reasons). - ``user_id`` - Owner of device. +- ``total`` - Total number of user's devices. + Delete multiple devices ------------------ Deletes the given devices for a specific ``user_id``, and invalidates |