Skip to main content

Module list_users

Module list_users 

Source

Structsยง

ListParams ๐Ÿ”’
Filter and pagination parameters shared by the v2 and v3 list endpoints.

Enumsยง

DeactivatedFilter ๐Ÿ”’
The deactivated query filter, whose semantics differ between v2 and v3.

Functionsยง

admin_list_users_v2_route ๐Ÿ”’
GET /_synapse/admin/v2/users
admin_list_users_v3_route ๐Ÿ”’
GET /_synapse/admin/v3/users
list_users ๐Ÿ”’
Returns the filtered, name-ordered and paginated user page, the next_token (present only while the page does not reach the end of the filtered set) and the filtered total. order_by beyond name is not backed by stored fields, so the name ordering (reversed for dir=b) is the only one applied.
user_minor_details ๐Ÿ”’
Applies the substring, admin, locked and deactivated filters to one user and builds its UserMinorDetails, or returns None when the user is filtered out.