summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorMichael Weimann <michaelw@element.io>2023-07-05 00:03:20 +0200
committerGitHub <noreply@github.com>2023-07-04 15:03:20 -0700
commitc8e81898b66086ee8bdfd18bd24452c26033e480 (patch)
tree2507e343e7ac6363c97fd76c1dea6409a66c5c5f /docs/admin_api
parentMerge branch 'master' into develop (diff)
downloadsynapse-c8e81898b66086ee8bdfd18bd24452c26033e480.tar.xz
Add not_user_type param to the list accounts admin API (#15844)
Signed-off-by: Michael Weimann <michaelw@element.io>
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/user_admin_api.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index 229942b311..f17e60b1cb 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/docs/admin_api/user_admin_api.md
@@ -242,6 +242,9 @@ The following parameters should be set in the URL:
 
 - `dir` - Direction of media order. Either `f` for forwards or `b` for backwards.
   Setting this value to `b` will reverse the above sort order. Defaults to `f`.
+- `not_user_type` - Exclude certain user types, such as bot users, from the request.
+   Can be provided multiple times. Possible values are `bot`, `support` or "empty string".
+   "empty string" here means to exclude users without a type.
 
 Caution. The database only has indexes on the columns `name` and `creation_ts`.
 This means that if a different sort order is used (`is_guest`, `admin`,