synadm
v0.39
Contents:
Command Line Reference
Scripting Examples
Python Package Documentation
synadm
Index
Edit on GitHub
Index
Symbols
|
_
|
A
|
B
|
C
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
Symbols
--activate
synadm-user-modify command line option
--admin
synadm-user-modify command line option
--admin-path
synadm-config command line option
--aliases
synadm-user-membership command line option
--all
synadm-media-delete command line option
--all-details
synadm-room-power-levels command line option
--avatar-url
synadm-user-modify command line option
--base-url
synadm-config command line option
--batch
synadm command line option
--before
synadm-history-purge command line option
synadm-media-delete command line option
synadm-media-purge command line option
--before-days
synadm-history-purge command line option
synadm-media-delete command line option
synadm-media-purge command line option
--before-event-id
synadm-history-purge command line option
--before-ts
synadm-history-purge command line option
synadm-media-delete command line option
synadm-media-purge command line option
--block
synadm-room-block command line option
synadm-room-delete command line option
--config-file
synadm command line option
--data
synadm-matrix-raw command line option
--data-file
synadm-matrix-raw command line option
--datetime
synadm-media-list command line option
synadm-regtok-details command line option
synadm-regtok-list command line option
synadm-user-media command line option
synadm-user-prune-devices command line option
--deactivate
synadm-user-modify command line option
--deactivated
synadm-user-list command line option
--delete-local
synadm-history-purge command line option
--delete-profiles
synadm-media-delete command line option
--device-id
synadm-user-prune-devices command line option
--display-name
synadm-user-modify command line option
--dt
synadm-media-list command line option
synadm-regtok-details command line option
synadm-regtok-list command line option
synadm-user-media command line option
synadm-user-prune-devices command line option
--expire
synadm-user-login command line option
--expire-at
synadm-regtok-new command line option
synadm-regtok-update command line option
--expire-days
synadm-user-login command line option
--expire-never
synadm-user-login command line option
--expire-ts
synadm-user-login command line option
--expiry-ts
synadm-regtok-new command line option
synadm-regtok-update command line option
--from
synadm-media-list command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-search command line option
synadm-user-list command line option
synadm-user-media command line option
synadm-user-search command line option
--from-file
synadm-notice-send command line option
--gdpr-erase
synadm-user-deactivate command line option
--guests
synadm-user-list command line option
--homeserver
synadm-config command line option
--ids
synadm-user-membership command line option
--invalid
synadm-regtok-list command line option
--kib
synadm-media-delete command line option
--length
synadm-regtok-new command line option
--limit
synadm-media-list command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-search command line option
synadm-user-list command line option
synadm-user-media command line option
synadm-user-search command line option
--list-only
synadm-user-prune-devices command line option
--matrix-path
synadm-config command line option
--media-id
synadm-media-delete command line option
synadm-media-quarantine command line option
synadm-media-unquarantine command line option
--medium
synadm-user-3pid command line option
--message
synadm-room-delete command line option
--method
synadm-matrix-raw command line option
--min-days
synadm-user-prune-devices command line option
--min-surviving
synadm-user-prune-devices command line option
--name
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-user-list command line option
--new-room-user-id
synadm-room-delete command line option
--no-admin
synadm-user-modify command line option
--no-guests
synadm-user-list command line option
--no-logout
synadm-user-password command line option
--no-purge
synadm-room-delete command line option
--non-interactive
synadm command line option
--output
synadm command line option
synadm-config command line option
--paginate
synadm-notice-send command line option
--password
synadm-matrix-login command line option
synadm-user-modify command line option
synadm-user-password command line option
--password-prompt
synadm-user-modify command line option
--preview-length
synadm-notice-send command line option
--prompt
synadm-matrix-raw command line option
--provider
synadm-user-auth-provider command line option
--regex
synadm-notice-send command line option
--reverse
synadm-media-list command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-resolve command line option
synadm-room-search command line option
synadm-user-media command line option
--room-id
synadm-media-list command line option
synadm-media-quarantine command line option
synadm-room-power-levels command line option
--room-name
synadm-room-delete command line option
--scripting
synadm command line option
--server-discovery
synadm-config command line option
--server-name
synadm-media-quarantine command line option
synadm-media-unquarantine command line option
--silent
synadm-notice-send command line option
--size
synadm-media-delete command line option
--sort
synadm-media-list command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-search command line option
synadm-user-media command line option
--threepid
synadm-user-modify command line option
--timeout
synadm-config command line option
--timestamp
synadm-media-list command line option
synadm-regtok-details command line option
synadm-regtok-list command line option
synadm-user-media command line option
synadm-user-prune-devices command line option
--token
synadm-config command line option
synadm-matrix-raw command line option
synadm-regtok-new command line option
--ts
synadm-media-list command line option
synadm-regtok-details command line option
synadm-regtok-list command line option
synadm-user-media command line option
synadm-user-prune-devices command line option
--unban
synadm-user-shadow-ban command line option
--unblock
synadm-room-block command line option
--user
synadm-config command line option
--user-id
synadm-media-list command line option
synadm-media-quarantine command line option
synadm-room-make-admin command line option
synadm-user-list command line option
--uses-allowed
synadm-regtok-new command line option
synadm-regtok-update command line option
--valid
synadm-regtok-list command line option
--verbose
synadm command line option
--yes
synadm command line option
-a
synadm-room-power-levels command line option
synadm-user-modify command line option
-b
synadm-config command line option
synadm-media-delete command line option
synadm-media-purge command line option
synadm-room-block command line option
synadm-room-delete command line option
-c
synadm command line option
-d
synadm-config command line option
synadm-history-purge command line option
synadm-matrix-raw command line option
synadm-media-delete command line option
synadm-media-purge command line option
synadm-user-list command line option
synadm-user-login command line option
synadm-user-prune-devices command line option
-e
synadm-regtok-new command line option
synadm-regtok-update command line option
synadm-user-deactivate command line option
-f
synadm-matrix-raw command line option
synadm-media-list command line option
synadm-notice-send command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-search command line option
synadm-user-list command line option
synadm-user-media command line option
synadm-user-search command line option
-G
synadm-user-list command line option
-g
synadm-user-list command line option
-i
synadm-history-purge command line option
synadm-media-delete command line option
synadm-media-quarantine command line option
synadm-media-unquarantine command line option
synadm-room-power-levels command line option
synadm-user-list command line option
synadm-user-prune-devices command line option
-l
synadm-media-list command line option
synadm-notice-send command line option
synadm-regtok-new command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-search command line option
synadm-user-list command line option
synadm-user-media command line option
synadm-user-prune-devices command line option
synadm-user-search command line option
-m
synadm-config command line option
synadm-matrix-raw command line option
synadm-room-delete command line option
synadm-user-3pid command line option
-n
synadm-config command line option
synadm-regtok-new command line option
synadm-room-delete command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-user-list command line option
synadm-user-modify command line option
synadm-user-password command line option
-o
synadm command line option
synadm-config command line option
-P
synadm-user-modify command line option
-p
synadm-config command line option
synadm-matrix-login command line option
synadm-matrix-raw command line option
synadm-notice-send command line option
synadm-user-auth-provider command line option
synadm-user-modify command line option
synadm-user-password command line option
-R
synadm-media-list command line option
-r
synadm-media-list command line option
synadm-media-quarantine command line option
synadm-notice-send command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-resolve command line option
synadm-room-search command line option
synadm-user-media command line option
-s
synadm-media-list command line option
synadm-media-quarantine command line option
synadm-media-unquarantine command line option
synadm-notice-send command line option
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-room-search command line option
synadm-user-media command line option
synadm-user-prune-devices command line option
-t
synadm-config command line option
synadm-matrix-raw command line option
synadm-media-delete command line option
synadm-media-purge command line option
synadm-regtok-new command line option
synadm-regtok-update command line option
synadm-user-modify command line option
-u
synadm-config command line option
synadm-media-list command line option
synadm-media-quarantine command line option
synadm-regtok-new command line option
synadm-regtok-update command line option
synadm-room-block command line option
synadm-room-delete command line option
synadm-room-make-admin command line option
synadm-user-modify command line option
synadm-user-shadow-ban command line option
-V
synadm-regtok-list command line option
-v
synadm command line option
synadm-regtok-list command line option
synadm-user-modify command line option
-w
synadm-config command line option
_
_datetime_from_timestamp() (synadm.api.ApiRequest method)
_format_datetime() (synadm.api.ApiRequest method)
_set_formatter() (synadm.cli.APIHelper method)
_timestamp_from_datetime() (synadm.api.ApiRequest method)
_timestamp_from_days_ago() (synadm.api.ApiRequest method)
_timestamp_from_days_ahead() (synadm.api.ApiRequest method)
A
ADDRESS
synadm-user-3pid command line option
APIHelper (class in synadm.cli)
ApiRequest (class in synadm.api)
B
block_room() (synadm.api.SynapseAdmin method)
C
CONFIG (synadm.cli.APIHelper attribute)
E
ENDPOINT
synadm-matrix-raw command line option
EXTERNAL_USER_ID
synadm-user-auth-provider command line option
F
federation_uri_well_known() (synadm.api.MiscRequest method)
FORMATTED
synadm-notice-send command line option
FORMATTERS (synadm.cli.APIHelper attribute)
G
generate_mxid() (synadm.cli.APIHelper method)
group_delete() (synadm.api.SynapseAdmin method)
GROUP_ID
synadm-group-delete command line option
I
init_logger() (synadm.cli.APIHelper method)
L
load() (synadm.cli.APIHelper method)
M
Matrix (class in synadm.api)
media_delete() (synadm.api.SynapseAdmin method)
media_delete_by_date_or_size() (synadm.api.SynapseAdmin method)
MEDIA_ID
synadm-media-protect command line option
media_protect() (synadm.api.SynapseAdmin method)
media_quarantine() (synadm.api.SynapseAdmin method)
media_unquarantine() (synadm.api.SynapseAdmin method)
MiscRequest (class in synadm.api)
module
synadm.api
synadm.cli
N
notice_send() (synadm.api.SynapseAdmin method)
O
output() (synadm.cli.APIHelper method)
P
PLAIN
synadm-notice-send command line option
purge_history() (synadm.api.SynapseAdmin method)
purge_history_status() (synadm.api.SynapseAdmin method)
PURGE_ID
synadm-history-purge-status command line option
purge_media_cache() (synadm.api.SynapseAdmin method)
Q
query() (synadm.api.ApiRequest method)
R
raw_request() (synadm.api.Matrix method)
regtok_delete() (synadm.api.SynapseAdmin method)
regtok_details() (synadm.api.SynapseAdmin method)
regtok_list() (synadm.api.SynapseAdmin method)
regtok_new() (synadm.api.SynapseAdmin method)
regtok_update() (synadm.api.SynapseAdmin method)
retrieve_homeserver_name() (synadm.cli.APIHelper method)
room_block_status() (synadm.api.SynapseAdmin method)
room_delete() (synadm.api.SynapseAdmin method)
room_details() (synadm.api.SynapseAdmin method)
room_get_aliases() (synadm.api.Matrix method)
room_get_id() (synadm.api.Matrix method)
ROOM_ID
synadm-history-purge command line option
synadm-room-block command line option
synadm-room-block-status command line option
synadm-room-delete command line option
synadm-room-details command line option
synadm-room-make-admin command line option
synadm-room-members command line option
synadm-room-state command line option
ROOM_ID_OR_ALIAS
synadm-room-join command line option
synadm-room-resolve command line option
room_join() (synadm.api.SynapseAdmin method)
room_list() (synadm.api.SynapseAdmin method)
room_make_admin() (synadm.api.SynapseAdmin method)
room_media_list() (synadm.api.SynapseAdmin method)
room_media_quarantine() (synadm.api.SynapseAdmin method)
room_members() (synadm.api.SynapseAdmin method)
room_power_levels() (synadm.api.SynapseAdmin method)
room_state() (synadm.api.SynapseAdmin method)
S
SEARCH_TERM
synadm-room-search command line option
synadm-user-search command line option
server_name_keys_api() (synadm.api.Matrix method)
synadm command line option
--batch
--config-file
--non-interactive
--output
--scripting
--verbose
--yes
-c
-o
-v
synadm-config command line option
--admin-path
--base-url
--homeserver
--matrix-path
--output
--server-discovery
--timeout
--token
--user
-b
-d
-m
-n
-o
-p
-t
-u
-w
synadm-group-delete command line option
GROUP_ID
synadm-history-purge command line option
--before
--before-days
--before-event-id
--before-ts
--delete-local
-d
-i
ROOM_ID
synadm-history-purge-status command line option
PURGE_ID
synadm-matrix-login command line option
--password
-p
USER_ID
synadm-matrix-raw command line option
--data
--data-file
--method
--prompt
--token
-d
-f
-m
-p
-t
ENDPOINT
synadm-media-delete command line option
--all
--before
--before-days
--before-ts
--delete-profiles
--kib
--media-id
--size
-b
-d
-i
-t
synadm-media-list command line option
--datetime
--dt
--from
--limit
--reverse
--room-id
--sort
--timestamp
--ts
--user-id
-f
-l
-r
-R
-s
-u
synadm-media-protect command line option
MEDIA_ID
synadm-media-purge command line option
--before
--before-days
--before-ts
-b
-d
-t
synadm-media-quarantine command line option
--media-id
--room-id
--server-name
--user-id
-i
-r
-s
-u
synadm-media-unquarantine command line option
--media-id
--server-name
-i
-s
synadm-notice-send command line option
--from-file
--paginate
--preview-length
--regex
--silent
-f
-l
-p
-r
-s
FORMATTED
PLAIN
TO
synadm-regtok-delete command line option
TOKEN
synadm-regtok-details command line option
--datetime
--dt
--timestamp
--ts
TOKEN
synadm-regtok-list command line option
--datetime
--dt
--invalid
--timestamp
--ts
--valid
-v
-V
synadm-regtok-new command line option
--expire-at
--expiry-ts
--length
--token
--uses-allowed
-e
-l
-n
-t
-u
synadm-regtok-update command line option
--expire-at
--expiry-ts
--uses-allowed
-e
-t
-u
TOKEN
synadm-room-block command line option
--block
--unblock
-b
-u
ROOM_ID
synadm-room-block-status command line option
ROOM_ID
synadm-room-delete command line option
--block
--message
--new-room-user-id
--no-purge
--room-name
-b
-m
-n
-u
ROOM_ID
synadm-room-details command line option
ROOM_ID
synadm-room-join command line option
ROOM_ID_OR_ALIAS
USER_ID
synadm-room-list command line option
--from
--limit
--name
--reverse
--sort
-f
-l
-n
-r
-s
synadm-room-make-admin command line option
--user-id
-u
ROOM_ID
synadm-room-members command line option
ROOM_ID
synadm-room-power-levels command line option
--all-details
--from
--limit
--name
--reverse
--room-id
--sort
-a
-f
-i
-l
-n
-r
-s
synadm-room-resolve command line option
--reverse
-r
ROOM_ID_OR_ALIAS
synadm-room-search command line option
--from
--limit
--reverse
--sort
-f
-l
-r
-s
SEARCH_TERM
synadm-room-state command line option
ROOM_ID
synadm-user-3pid command line option
--medium
-m
ADDRESS
synadm-user-auth-provider command line option
--provider
-p
EXTERNAL_USER_ID
synadm-user-deactivate command line option
--gdpr-erase
-e
USER_ID
synadm-user-details command line option
USER_ID
synadm-user-list command line option
--deactivated
--from
--guests
--limit
--name
--no-guests
--user-id
-d
-f
-g
-G
-i
-l
-n
synadm-user-login command line option
--expire
--expire-days
--expire-never
--expire-ts
-d
USER_ID
synadm-user-media command line option
--datetime
--dt
--from
--limit
--reverse
--sort
--timestamp
--ts
-f
-l
-r
-s
USER_ID
synadm-user-membership command line option
--aliases
--ids
USER_ID
synadm-user-modify command line option
--activate
--admin
--avatar-url
--deactivate
--display-name
--no-admin
--password
--password-prompt
--threepid
-a
-n
-p
-P
-t
-u
-v
USER_ID
synadm-user-password command line option
--no-logout
--password
-n
-p
USER_ID
synadm-user-prune-devices command line option
--datetime
--device-id
--dt
--list-only
--min-days
--min-surviving
--timestamp
--ts
-d
-i
-l
-s
USER_ID
synadm-user-search command line option
--from
--limit
-f
-l
SEARCH_TERM
synadm-user-shadow-ban command line option
--unban
-u
USER_ID
synadm-user-whois command line option
USER_ID
synadm.api
module
synadm.cli
module
SynapseAdmin (class in synadm.api)
T
TO
synadm-notice-send command line option
TOKEN
synadm-regtok-delete command line option
synadm-regtok-details command line option
synadm-regtok-update command line option
U
user_3pid_search() (synadm.api.SynapseAdmin method)
user_auth_provider_search() (synadm.api.SynapseAdmin method)
user_deactivate() (synadm.api.SynapseAdmin method)
user_details() (synadm.api.SynapseAdmin method)
user_devices() (synadm.api.SynapseAdmin method)
user_devices_delete() (synadm.api.SynapseAdmin method)
user_devices_get_todelete() (synadm.api.SynapseAdmin method)
USER_ID
synadm-matrix-login command line option
synadm-room-join command line option
synadm-user-deactivate command line option
synadm-user-details command line option
synadm-user-login command line option
synadm-user-media command line option
synadm-user-membership command line option
synadm-user-modify command line option
synadm-user-password command line option
synadm-user-prune-devices command line option
synadm-user-shadow-ban command line option
synadm-user-whois command line option
user_list() (synadm.api.SynapseAdmin method)
user_login() (synadm.api.Matrix method)
(synadm.api.SynapseAdmin method)
user_media() (synadm.api.SynapseAdmin method)
user_media_quarantine() (synadm.api.SynapseAdmin method)
user_membership() (synadm.api.SynapseAdmin method)
user_modify() (synadm.api.SynapseAdmin method)
user_password() (synadm.api.SynapseAdmin method)
user_shadow_ban() (synadm.api.SynapseAdmin method)
user_whois() (synadm.api.SynapseAdmin method)
V
version() (synadm.api.SynapseAdmin method)
W
write_config() (synadm.cli.APIHelper method)
Read the Docs
v: v0.39
Versions
latest
v0.39
v0.38
v0.37.1
v0.36
v0.35
v0.34
v0.33.1
v0.33
v0.32
v0.31
v0.30
dev
Downloads
On Read the Docs
Project Home
Builds