From b3a94fed48e44dacf34c7dcefa24cf318850df89 Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Mon, 4 Aug 2025 12:36:49 +0000 Subject: [PATCH] deploy: edac7a471f92479bed1143c8fa8b7719fef05112 --- latest/404.html | 2 +- latest/CAPTCHA_SETUP.html | 2 +- latest/admin_api/account_validity.html | 2 +- .../client_server_api_extensions.html | 221 ++++++++++++++++++ latest/admin_api/event_reports.html | 2 +- latest/admin_api/experimental_features.html | 2 +- latest/admin_api/media_admin_api.html | 2 +- latest/admin_api/purge_history_api.html | 2 +- latest/admin_api/register_api.html | 2 +- latest/admin_api/room_membership.html | 2 +- latest/admin_api/rooms.html | 2 +- latest/admin_api/scheduled_tasks.html | 2 +- latest/admin_api/server_notices.html | 2 +- latest/admin_api/statistics.html | 2 +- latest/admin_api/user_admin_api.html | 18 +- latest/admin_api/version_api.html | 2 +- latest/application_services.html | 2 +- latest/auth_chain_difference_algorithm.html | 2 +- latest/code_style.html | 2 +- latest/consent_tracking.html | 2 +- latest/delegate.html | 2 +- latest/deprecation_policy.html | 2 +- latest/development/cas.html | 2 +- latest/development/contributing_guide.html | 2 +- latest/development/database_schema.html | 2 +- latest/development/demo.html | 2 +- latest/development/dependencies.html | 2 +- latest/development/experimental_features.html | 2 +- latest/development/git.html | 2 +- .../internal_documentation/index.html | 2 +- latest/development/releases.html | 2 +- latest/development/reviews.html | 2 +- latest/development/room-dag-concepts.html | 2 +- latest/development/saml.html | 2 +- .../synapse_architecture/cancellation.html | 2 +- .../synapse_architecture/faster_joins.html | 2 +- .../synapse_architecture/streams.html | 2 +- latest/federate.html | 2 +- latest/index.html | 2 +- latest/jwt.html | 2 +- latest/log_contexts.html | 2 +- latest/manhole.html | 6 +- latest/media_repository.html | 2 +- latest/message_retention_policies.html | 2 +- latest/metrics-howto.html | 2 +- latest/modules/account_data_callbacks.html | 2 +- .../modules/account_validity_callbacks.html | 2 +- ...xtra_fields_to_client_events_unsigned.html | 2 +- ...ackground_update_controller_callbacks.html | 2 +- latest/modules/index.html | 2 +- .../modules/media_repository_callbacks.html | 2 +- .../password_auth_provider_callbacks.html | 2 +- latest/modules/porting_legacy_module.html | 2 +- latest/modules/presence_router_callbacks.html | 2 +- latest/modules/ratelimit_callbacks.html | 2 +- latest/modules/spam_checker_callbacks.html | 2 +- .../modules/third_party_rules_callbacks.html | 2 +- latest/modules/writing_a_module.html | 2 +- latest/openid.html | 2 +- latest/opentracing.html | 2 +- ...ing_synapse_on_single_board_computers.html | 2 +- latest/password_auth_providers.html | 2 +- latest/postgres.html | 2 +- latest/print.html | 104 +++++++-- latest/replication.html | 2 +- latest/reverse_proxy.html | 2 +- latest/room_and_user_statistics.html | 2 +- latest/schema/synapse-config.schema.json | 63 ++++- latest/searchindex.js | 2 +- latest/searchindex.json | 2 +- latest/server_notices.html | 2 +- latest/setup/forward_proxy.html | 2 +- latest/setup/installation.html | 2 +- latest/setup/turn/coturn.html | 2 +- latest/setup/turn/eturnal.html | 2 +- latest/sso_mapping_providers.html | 2 +- latest/structured_logging.html | 2 +- latest/synctl_workers.html | 2 +- latest/systemd-with-workers/index.html | 2 +- latest/tcp_replication.html | 2 +- latest/templates.html | 2 +- latest/turn-howto.html | 2 +- latest/upgrade.html | 9 +- .../admin_api/background_updates.html | 2 +- .../administration/admin_api/federation.html | 6 +- .../usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- latest/usage/administration/admin_faq.html | 2 +- latest/usage/administration/backups.html | 2 +- .../database_maintenance_tools.html | 2 +- latest/usage/administration/index.html | 2 +- ...reporting_homeserver_usage_statistics.html | 2 +- .../administration/monthly_active_users.html | 2 +- latest/usage/administration/request_log.html | 2 +- latest/usage/administration/state_groups.html | 2 +- ...anding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../configuration/config_documentation.html | 44 +++- .../homeserver_sample_config.html | 2 +- latest/usage/configuration/index.html | 2 +- .../configuration/logging_sample_config.html | 2 +- .../user_authentication/index.html | 2 +- .../user_authentication/refresh_tokens.html | 2 +- .../single_sign_on/cas.html | 2 +- .../single_sign_on/index.html | 2 +- .../single_sign_on/saml.html | 2 +- latest/user_directory.html | 2 +- latest/welcome_and_overview.html | 2 +- latest/workers.html | 22 +- 109 files changed, 548 insertions(+), 145 deletions(-) create mode 100644 latest/admin_api/client_server_api_extensions.html diff --git a/latest/404.html b/latest/404.html index 830ba7276e..7d51986819 100644 --- a/latest/404.html +++ b/latest/404.html @@ -78,7 +78,7 @@ diff --git a/latest/CAPTCHA_SETUP.html b/latest/CAPTCHA_SETUP.html index 743f99b690..62376738a1 100644 --- a/latest/CAPTCHA_SETUP.html +++ b/latest/CAPTCHA_SETUP.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index fd9bb9ed32..bf9a7400ea 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/client_server_api_extensions.html b/latest/admin_api/client_server_api_extensions.html new file mode 100644 index 0000000000..c28f6af4ca --- /dev/null +++ b/latest/admin_api/client_server_api_extensions.html @@ -0,0 +1,221 @@ + + + + + + Client-Server API Extensions - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + +
+
+ +
+ +
+ +

Client-Server API Extensions

+

Server administrators can set special account data to change how the Client-Server API behaves for +their clients. Setting the account data, or having it already set, as a non-admin has no effect.

+

All configuration options can be set through the io.element.synapse.admin_client_config global +account data on the admin's user account.

+

Example:

+
PUT /_matrix/client/v3/user/{adminUserId}/account_data/io.element.synapse.admin_client_config
+{
+    "return_soft_failed_events": true
+}
+
+

See soft failed events

+

Learn more about soft failure from the spec.

+

To receive soft failed events in APIs like /sync and /messages, set return_soft_failed_events +to true in the admin client config. When false, the normal behaviour of these endpoints is to +exclude soft failed events.

+

Default: false

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index 13c834721e..93bf122f82 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/experimental_features.html b/latest/admin_api/experimental_features.html index eb5f6689e5..fe991c99ab 100644 --- a/latest/admin_api/experimental_features.html +++ b/latest/admin_api/experimental_features.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index 52f8d51309..5fbc7f2125 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/purge_history_api.html b/latest/admin_api/purge_history_api.html index 69e20823a5..46f0776464 100644 --- a/latest/admin_api/purge_history_api.html +++ b/latest/admin_api/purge_history_api.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/register_api.html b/latest/admin_api/register_api.html index 9c04a0f432..a8c516b383 100644 --- a/latest/admin_api/register_api.html +++ b/latest/admin_api/register_api.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/room_membership.html b/latest/admin_api/room_membership.html index e5b5937e96..2e5dfaa0d0 100644 --- a/latest/admin_api/room_membership.html +++ b/latest/admin_api/room_membership.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index 87bb73bcd8..9fa1b771c5 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/scheduled_tasks.html b/latest/admin_api/scheduled_tasks.html index 9cffdba9e3..a6acfafb32 100644 --- a/latest/admin_api/scheduled_tasks.html +++ b/latest/admin_api/scheduled_tasks.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/server_notices.html b/latest/admin_api/server_notices.html index b06c9720db..349c7982bd 100644 --- a/latest/admin_api/server_notices.html +++ b/latest/admin_api/server_notices.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/statistics.html b/latest/admin_api/statistics.html index 0234a382b2..550d5c0568 100644 --- a/latest/admin_api/statistics.html +++ b/latest/admin_api/statistics.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index 7c5ce3e1ee..8b5fc4485b 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -77,7 +77,7 @@ @@ -1247,7 +1247,7 @@ Max length, 512 bytes.

See also the Client-Server API Spec on pushers.

Controlling whether a user is shadow-banned

-

Shadow-banning is a useful tool for moderating malicious or egregiously abusive users. +

Shadow-banning is a useful tool for moderating malicious or egregiously abusive users. A shadow-banned users receives successful responses to their client-server API requests, but the events are not propagated into rooms. This can be an effective tool as it (hopefully) takes longer for the user to realise they are being moderated before @@ -1404,8 +1404,11 @@ for more information.

Added in Synapse 1.72.0.

Redact all the events of a user

-

This endpoint allows an admin to redact the events of a given user. There are no restrictions on redactions for a -local user. By default, we puppet the user who sent the message to redact it themselves. Redactions for non-local users are issued using the admin user, and will fail in rooms where the admin user is not admin/does not have the specified power level to issue redactions.

+

This endpoint allows an admin to redact the events of a given user. There are no restrictions on +redactions for a local user. By default, we puppet the user who sent the message to redact it themselves. +Redactions for non-local users are issued using the admin user, and will fail in rooms where the +admin user is not admin/does not have the specified power level to issue redactions. An option +is provided to override the default and allow the admin to issue the redactions in all cases.

The API is 

POST /_synapse/admin/v1/user/$user_id/redact
 
@@ -1413,7 +1416,7 @@ local user. By default, we puppet the user who sent the message to redact it the
   "rooms": ["!roomid1", "!roomid2"]
 }
-

If an empty list is provided as the key for rooms, all events in all the rooms the user is member of will be redacted, +

If an empty list is provided as the key for rooms, all events in all the rooms the user is member of will be redacted, otherwise all the events in the rooms provided in the request will be redacted.

The API starts redaction process running, and returns immediately with a JSON body with a redact id which can be used to query the status of the redaction process:

@@ -1434,7 +1437,10 @@ the user is a member of will be redacted

The following JSON body parameters are optional:

Added in Synapse 1.116.0.

Check the status of a redaction process

diff --git a/latest/admin_api/version_api.html b/latest/admin_api/version_api.html index c270dc9d6e..8325f1741a 100644 --- a/latest/admin_api/version_api.html +++ b/latest/admin_api/version_api.html @@ -77,7 +77,7 @@ diff --git a/latest/application_services.html b/latest/application_services.html index 6bd8f56425..e88dbda82c 100644 --- a/latest/application_services.html +++ b/latest/application_services.html @@ -77,7 +77,7 @@ diff --git a/latest/auth_chain_difference_algorithm.html b/latest/auth_chain_difference_algorithm.html index cf87f5313f..a9f7566cfa 100644 --- a/latest/auth_chain_difference_algorithm.html +++ b/latest/auth_chain_difference_algorithm.html @@ -77,7 +77,7 @@ diff --git a/latest/code_style.html b/latest/code_style.html index bbfeddceb4..0c50348c91 100644 --- a/latest/code_style.html +++ b/latest/code_style.html @@ -77,7 +77,7 @@ diff --git a/latest/consent_tracking.html b/latest/consent_tracking.html index 3c59271226..b02457df52 100644 --- a/latest/consent_tracking.html +++ b/latest/consent_tracking.html @@ -77,7 +77,7 @@ diff --git a/latest/delegate.html b/latest/delegate.html index 9bb7226a68..7fd4a56f91 100644 --- a/latest/delegate.html +++ b/latest/delegate.html @@ -77,7 +77,7 @@ diff --git a/latest/deprecation_policy.html b/latest/deprecation_policy.html index 3f539fa064..7aa9ecf784 100644 --- a/latest/deprecation_policy.html +++ b/latest/deprecation_policy.html @@ -77,7 +77,7 @@ diff --git a/latest/development/cas.html b/latest/development/cas.html index 8ac21e05f7..bfa22feb22 100644 --- a/latest/development/cas.html +++ b/latest/development/cas.html @@ -77,7 +77,7 @@ diff --git a/latest/development/contributing_guide.html b/latest/development/contributing_guide.html index 30b24854f3..f599ec1121 100644 --- a/latest/development/contributing_guide.html +++ b/latest/development/contributing_guide.html @@ -77,7 +77,7 @@ diff --git a/latest/development/database_schema.html b/latest/development/database_schema.html index 86a1dbd739..13f47ecdf1 100644 --- a/latest/development/database_schema.html +++ b/latest/development/database_schema.html @@ -77,7 +77,7 @@ diff --git a/latest/development/demo.html b/latest/development/demo.html index df5aa0887a..d2d9468627 100644 --- a/latest/development/demo.html +++ b/latest/development/demo.html @@ -77,7 +77,7 @@ diff --git a/latest/development/dependencies.html b/latest/development/dependencies.html index cf8f4c5b58..78bb7f3fb1 100644 --- a/latest/development/dependencies.html +++ b/latest/development/dependencies.html @@ -77,7 +77,7 @@ diff --git a/latest/development/experimental_features.html b/latest/development/experimental_features.html index f9bddbb6d6..58947d0e4e 100644 --- a/latest/development/experimental_features.html +++ b/latest/development/experimental_features.html @@ -77,7 +77,7 @@ diff --git a/latest/development/git.html b/latest/development/git.html index 4352118abb..a8978ec6ff 100644 --- a/latest/development/git.html +++ b/latest/development/git.html @@ -77,7 +77,7 @@ diff --git a/latest/development/internal_documentation/index.html b/latest/development/internal_documentation/index.html index 8c29601add..50b8697fe3 100644 --- a/latest/development/internal_documentation/index.html +++ b/latest/development/internal_documentation/index.html @@ -77,7 +77,7 @@ diff --git a/latest/development/releases.html b/latest/development/releases.html index 2aab8417d6..83394ce86c 100644 --- a/latest/development/releases.html +++ b/latest/development/releases.html @@ -77,7 +77,7 @@ diff --git a/latest/development/reviews.html b/latest/development/reviews.html index 633f1f8dc4..3a5dde0598 100644 --- a/latest/development/reviews.html +++ b/latest/development/reviews.html @@ -77,7 +77,7 @@ diff --git a/latest/development/room-dag-concepts.html b/latest/development/room-dag-concepts.html index f56e91adef..deccc2dc91 100644 --- a/latest/development/room-dag-concepts.html +++ b/latest/development/room-dag-concepts.html @@ -77,7 +77,7 @@ diff --git a/latest/development/saml.html b/latest/development/saml.html index 4143146696..5dea958c19 100644 --- a/latest/development/saml.html +++ b/latest/development/saml.html @@ -77,7 +77,7 @@ diff --git a/latest/development/synapse_architecture/cancellation.html b/latest/development/synapse_architecture/cancellation.html index a36f3a0669..e79151145a 100644 --- a/latest/development/synapse_architecture/cancellation.html +++ b/latest/development/synapse_architecture/cancellation.html @@ -77,7 +77,7 @@ diff --git a/latest/development/synapse_architecture/faster_joins.html b/latest/development/synapse_architecture/faster_joins.html index 1500ddbf37..fad002eb85 100644 --- a/latest/development/synapse_architecture/faster_joins.html +++ b/latest/development/synapse_architecture/faster_joins.html @@ -77,7 +77,7 @@ diff --git a/latest/development/synapse_architecture/streams.html b/latest/development/synapse_architecture/streams.html index f178e742bc..aee801544d 100644 --- a/latest/development/synapse_architecture/streams.html +++ b/latest/development/synapse_architecture/streams.html @@ -77,7 +77,7 @@ diff --git a/latest/federate.html b/latest/federate.html index 6363e5b1b8..3e16141760 100644 --- a/latest/federate.html +++ b/latest/federate.html @@ -77,7 +77,7 @@ diff --git a/latest/index.html b/latest/index.html index ee6153d347..4be1bce340 100644 --- a/latest/index.html +++ b/latest/index.html @@ -77,7 +77,7 @@ diff --git a/latest/jwt.html b/latest/jwt.html index 734ff4b5fb..90f8b834c6 100644 --- a/latest/jwt.html +++ b/latest/jwt.html @@ -77,7 +77,7 @@ diff --git a/latest/log_contexts.html b/latest/log_contexts.html index 4286037c6e..611eaa5958 100644 --- a/latest/log_contexts.html +++ b/latest/log_contexts.html @@ -77,7 +77,7 @@ diff --git a/latest/manhole.html b/latest/manhole.html index a9aa8b23a9..6c83a4218f 100644 --- a/latest/manhole.html +++ b/latest/manhole.html @@ -77,7 +77,7 @@ @@ -233,7 +233,7 @@ parts of the process.