synadm/doc/source/features/users.csv

5.2 KiB

1`Query User Account <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#query-user-account>`_:option:`synadm user details USER_ID`
2`Create or modify account <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#create-or-modify-account>`_:option:`synadm user modify USER_ID`
3`List Accounts <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-accounts>`_---
4|indent| `List Accounts (V2) <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-accounts-v2>`_:option:`synadm user list -f`
5|indent| `List Accounts (V3) <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-accounts-v3>`_
6`Query current sessions for a user <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#query-current-sessions-for-a-user>`_:option:`synadm user whois USER_ID`
7`Deactivate Account <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#deactivate-account>`_:option:`synadm user deactivate USER_ID`
8`Reset password <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#reset-password>`_:option:`synadm user password USER_ID`
9`Get whether a user is a server administrator or not <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#get-whether-a-user-is-a-server-administrator-or-not>`_
10`Change whether a user is a server administrator or not <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#change-whether-a-user-is-a-server-administrator-or-not>`_
11`List room memberships of a user <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-room-memberships-of-a-user>`_:option:`synadm user membership USER_ID`
12`Account Data <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#account-data>`_
13`User media <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#user-media>`_---
14|indent| `List media uploaded by a user <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-media-uploaded-by-a-user>`_:option:`synadm user media -f` :option:`synadm media list -u`
15|indent| `Delete media uploaded by a user <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#delete-media-uploaded-by-a-user>`_
16`Login as a user <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#login-as-a-user>`_:option:`synadm user login USER_ID`
17`Allow replacing master cross-signing key without... <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#allow-replacing-master-cross-signing-key-without-user-interactive-auth>`_
18`User devices <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#user-devices>`_---
19|indent| `List all devices <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-all-devices>`_:option:`synadm user prune-devices --list-only`
20|indent| `Create a device <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#create-a-device>`_
21|indent| `Delete multiple devices <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#delete-multiple-devices>`_:option:`synadm user prune-devices -d` :option:`synadm user prune-devices -s`
22|indent| `Show a device <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#show-a-device>`_:option:`synadm user prune-devices --list-only` (-i)
23|indent| `Update a device <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#update-a-device>`_
24|indent| `Delete a device <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#delete-a-device>`_:option:`synadm user prune-devices -i`
25`List all pushers <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-all-pushers>`_
26`Controlling whether a user is shadow-banned <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#controlling-whether-a-user-is-shadow-banned>`_:option:`synadm user shadow-ban USER_ID` :option:`synadm user shadow-ban --unban`
27`Override ratelimiting for users <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#override-ratelimiting-for-users>`_---
28|indent| `Get status of ratelimit <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#get-status-of-ratelimit>`_
29|indent| `Set ratelimit <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#set-ratelimit>`_
30|indent| `Delete ratelimit <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#delete-ratelimit>`_
31`Check username availability <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#check-username-availability>`_
32`Find a user based on their ID in an auth provider <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#find-a-user-based-on-their-id-in-an-auth-provider>`_:option:`synadm user 3pid ADDRESS`
33`Find a user based on their Third Party ID <https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#find-a-user-based-on-their-third-party-id-threepid-or-3pid>`_:option:`synadm user auth-provider EXTERNAL_USER_ID`