kaslo/synapse
1
0
Fork 0
Code Packages Releases 124 Wiki Activity

deactivated flag refactored to filter deactivated users. (#16874)

Browse Source 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
This commit is contained in:
Alexander Fechler
2024-03-11 17:08:04 +01:00
committed by GitHub
parent 696cc9e802
commit 48f59d3806
6 changed files with 95 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/admin_api/user_admin_api.md
View File

@@ -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.