diff options
| author | Alexander Fechler <141915399+afechler@users.noreply.github.com> | 2024-03-11 17:08:04 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-11 16:08:04 +0000 |
| commit | 48f59d3806477d575350fa4dc093e02cf0eca901 (patch) | |
| tree | 220d8edae91593a935d72d1763e73438fc73c6d6 /docs | |
| parent | Stabilize support for Retry-After header (MSC4014) (#16947) (diff) | |
| download | synapse-48f59d3806477d575350fa4dc093e02cf0eca901.tar.xz | |
deactivated flag refactored to filter deactivated users. (#16874)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index 9dc600b875..9736fe3021 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -164,6 +164,7 @@ Body parameters: Other allowed options are: `bot` and `support`. ## List Accounts +### List Accounts (V2) This API returns all local user accounts. By default, the response is ordered by ascending user ID. @@ -287,6 +288,19 @@ The following fields are returned in the JSON response body: *Added in Synapse 1.93:* the `locked` query parameter and response field. +### List Accounts (V3) + +This API returns all local user accounts (see v2). In contrast to v2, the query parameter `deactivated` is handled differently. + +``` +GET /_synapse/admin/v3/users +``` + +**Parameters** +- `deactivated` - Optional flag to filter deactivated users. If `true`, only deactivated users are returned. + If `false`, deactivated users are excluded from the query. When the flag is absent (the default), + users are not filtered by deactivation status. + ## Query current sessions for a user This API returns information about the active sessions for a specific user. |