diff options
| author | Alexander Fechler <141915399+afechler@users.noreply.github.com> | 2023-08-18 13:26:38 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-18 12:26:38 +0100 |
| commit | 54317d34b76adb1e8f694acd91f631b3abe38947 (patch) | |
| tree | 172fedb2e2460e569abf0a7ea5cc4e101954ae31 /docs/admin_api | |
| parent | Add response time metrics for introspection requests (#16131) (diff) | |
| download | synapse-54317d34b76adb1e8f694acd91f631b3abe38947.tar.xz | |
Allow filtering for admins in the list accounts admin API (#16114)
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index c269ce6af0..99abfea3a0 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md @@ -219,6 +219,8 @@ The following parameters should be set in the URL: **or** displaynames that contain this value. - `guests` - string representing a bool - Is optional and if `false` will **exclude** guest users. Defaults to `true` to include guest users. +- `admins` - Optional flag to filter admins. If `true`, only admins are queried. If `false`, admins are excluded from + the query. When the flag is absent (the default), **both** admins and non-admins are included in the search results. - `deactivated` - string representing a bool - Is optional and if `true` will **include** deactivated users. Defaults to `false` to exclude deactivated users. - `limit` - string representing a positive integer - Is optional but is used for pagination, |