summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorManuel Stahl <37705355+awesome-manuel@users.noreply.github.com>2020-08-25 15:18:14 +0200
committerGitHub <noreply@github.com>2020-08-25 14:18:14 +0100
commit97962ad17b204be0a88ef0cd3026f11c359fdb4a (patch)
treeceda09bc574fec63d8fe1df247a911b342eeda41 /docs
parentAdd type hints for state. (#8140) (diff)
downloadsynapse-97962ad17b204be0a88ef0cd3026f11c359fdb4a.tar.xz
Search in columns 'name' and 'displayname' in the admin users endpoint (#7377)
* Search in columns 'name' and 'displayname' in the admin users endpoint

Signed-off-by: Manuel Stahl <manuel.stahl@awesome-technologies.de>
Diffstat (limited to '')
-rw-r--r--docs/admin_api/user_admin_api.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst
index be05128b3e..99948ec061 100644
--- a/docs/admin_api/user_admin_api.rst
+++ b/docs/admin_api/user_admin_api.rst
@@ -119,8 +119,10 @@ from a previous call.
 The parameter ``limit`` is optional but is used for pagination, denoting the
 maximum number of items to return in this call. Defaults to ``100``.
 
-The parameter ``user_id`` is optional and filters to only users with user IDs
-that contain this value.
+The parameter ``user_id`` is optional and can be used to filter by user id.
+
+The parameter ``name`` is optional and can be used to list only users with the
+local part of the user ID or display name that contain this value.
 
 The parameter ``guests`` is optional and if ``false`` will **exclude** guest users.
 Defaults to ``true`` to include guest users.