synadm
v0.33
Contents:
Command Line Reference
Python Package Documentation
synadm
»
Index
Edit on GitHub
Index
Symbols
|
_
|
A
|
C
|
E
|
F
|
G
|
I
|
L
|
M
|
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 <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 <avatar_url>
synadm-user-modify command line option
--base-url <base_url>
synadm-config command line option
--batch
synadm command line option
--before <before>
synadm-history-purge command line option
synadm-media-delete command line option
synadm-media-purge command line option
--before-days <before_days>
synadm-history-purge command line option
synadm-media-delete command line option
synadm-media-purge command line option
--before-event-id <before_event_id>
synadm-history-purge command line option
--before-ts <before_ts>
synadm-history-purge command line option
synadm-media-delete command line option
synadm-media-purge command line option
--block
synadm-room-delete command line option
--config-file <config_file>
synadm command line option
--data <data>
synadm-matrix-raw command line option
--data-file <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 <device_id>
synadm-user-prune-devices command line option
--display-name <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 <expire>
synadm-user-login command line option
--expire-at <expire_at>
synadm-regtok-new command line option
synadm-regtok-update command line option
--expire-days <expire_days>
synadm-user-login command line option
--expire-never
synadm-user-login command line option
--expire-ts <expire_ts>
synadm-user-login command line option
--expiry-ts <expiry_ts>
synadm-regtok-new command line option
synadm-regtok-update command line option
--from <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
--gdpr-erase
synadm-user-deactivate command line option
--guests
synadm-user-list command line option
--ids
synadm-user-membership command line option
--invalid
synadm-regtok-list command line option
--kib <size>
synadm-media-delete command line option
--length <length>
synadm-regtok-new command line option
--limit <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 <matrix_path>
synadm-config command line option
--media-id <media_id>
synadm-media-delete command line option
synadm-media-quarantine command line option
--message <message>
synadm-room-delete command line option
--method <method>
synadm-matrix-raw command line option
--min-days <min_days>
synadm-user-prune-devices command line option
--min-surviving <min_surviving>
synadm-user-prune-devices command line option
--name <name>
synadm-room-list command line option
synadm-room-power-levels command line option
synadm-user-list command line option
--new-room-user-id <new_room_user_id>
synadm-room-delete command line option
--no-admin
synadm-user-modify command line option
--no-batch
synadm 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
--output <output>
synadm command line option
synadm-config command line option
--password <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
--prompt
synadm-matrix-raw 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 <room_id>
synadm-media-list command line option
synadm-media-quarantine command line option
synadm-room-power-levels command line option
--room-name <room_name>
synadm-room-delete command line option
--server-name <server_name>
synadm-media-quarantine command line option
--size
synadm-media-delete command line option
--sort <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 <threepid>
synadm-user-modify command line option
--timeout <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 <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
--user <user>
synadm-config command line option
--user-id <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 <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
-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-delete command line option
-c
synadm command line option
-d
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-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-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-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
-n
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-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-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-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-delete command line option
synadm-room-make-admin command line option
synadm-user-modify 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
APIHelper (class in synadm.cli)
ApiRequest (class in synadm.api)
C
CONFIG (synadm.cli.APIHelper attribute)
E
ENDPOINT
synadm-matrix-raw command line option
F
FORMATTERS (synadm.cli.APIHelper attribute)
G
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)
module
synadm.api
synadm.cli
O
output() (synadm.cli.APIHelper method)
P
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)
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-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() (synadm.api.Matrix method)
synadm command line option
--batch
--config-file <config_file>
--no-batch
--output <output>
--verbose
-c
-o
-v
synadm-config command line option
--admin-path <admin_path>
--base-url <base_url>
--matrix-path <matrix_path>
--output <output>
--timeout <timeout>
--token <token>
--user <user>
-b
-m
-o
-p
-t
-u
-w
synadm-group-delete command line option
GROUP_ID
synadm-history-purge command line option
--before <before>
--before-days <before_days>
--before-event-id <before_event_id>
--before-ts <before_ts>
--delete-local
-d
-i
ROOM_ID
synadm-history-purge-status command line option
PURGE_ID
synadm-matrix-login command line option
--password <password>
-p
USER_ID
synadm-matrix-raw command line option
--data <data>
--data-file <data_file>
--method <method>
--prompt
--token <token>
-d
-f
-m
-p
-t
ENDPOINT
synadm-media-delete command line option
--all
--before <before>
--before-days <before_days>
--before-ts <before_ts>
--delete-profiles
--kib <size>
--media-id <media_id>
--size
-b
-d
-i
-t
synadm-media-list command line option
--datetime
--dt
--from <from_>
--limit <limit>
--reverse
--room-id <room_id>
--sort <sort>
--timestamp
--ts
--user-id <user_id>
-f
-l
-r
-R
-s
-u
synadm-media-protect command line option
MEDIA_ID
synadm-media-purge command line option
--before <before>
--before-days <before_days>
--before-ts <before_ts>
-b
-d
-t
synadm-media-quarantine command line option
--media-id <media_id>
--room-id <room_id>
--server-name <server_name>
--user-id <user_id>
-i
-r
-s
-u
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 <expire_at>
--expiry-ts <expiry_ts>
--length <length>
--token <token>
--uses-allowed <uses_allowed>
-e
-l
-n
-t
-u
synadm-regtok-update command line option
--expire-at <expire_at>
--expiry-ts <expiry_ts>
--uses-allowed <uses_allowed>
-e
-t
-u
TOKEN
synadm-room-delete command line option
--block
--message <message>
--new-room-user-id <new_room_user_id>
--no-purge
--room-name <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 <from_>
--limit <limit>
--name <name>
--reverse
--sort <sort>
-f
-l
-n
-r
-s
synadm-room-make-admin command line option
--user-id <user_id>
-u
ROOM_ID
synadm-room-members command line option
ROOM_ID
synadm-room-power-levels command line option
--all-details
--from <from_>
--limit <limit>
--name <name>
--reverse
--room-id <room_id>
--sort <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 <from_>
--limit <limit>
--reverse
--sort <sort>
-f
-l
-r
-s
SEARCH_TERM
synadm-room-state command line option
ROOM_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 <from_>
--guests
--limit <limit>
--name <name>
--no-guests
--user-id <user_id>
-d
-f
-g
-G
-i
-l
-n
synadm-user-login command line option
--expire <expire>
--expire-days <expire_days>
--expire-never
--expire-ts <expire_ts>
-d
USER_ID
synadm-user-media command line option
--datetime
--dt
--from <from_>
--limit <limit>
--reverse
--sort <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 <avatar_url>
--deactivate
--display-name <display_name>
--no-admin
--password <password>
--password-prompt
--threepid <threepid>
-a
-n
-p
-P
-t
-u
-v
USER_ID
synadm-user-password command line option
--no-logout
--password <password>
-n
-p
USER_ID
synadm-user-prune-devices command line option
--datetime
--device-id <device_id>
--dt
--list-only
--min-days <min_days>
--min-surviving <min_surviving>
--timestamp
--ts
-d
-i
-l
-s
USER_ID
synadm-user-search command line option
--from <from_>
--limit <limit>
-f
-l
SEARCH_TERM
synadm-user-whois command line option
USER_ID
synadm.api
module
synadm.cli
module
SynapseAdmin (class in synadm.api)
T
TOKEN
synadm-regtok-delete command line option
synadm-regtok-details command line option
synadm-regtok-update command line option
U
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-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_whois() (synadm.api.SynapseAdmin method)
V
version() (synadm.api.SynapseAdmin method)
W
write_config() (synadm.cli.APIHelper method)
Read the Docs
v: v0.33
Versions
latest
v0.33
v0.32
v0.31
v0.30
room_power_levels
room_empty
Downloads
On Read the Docs
Project Home
Builds