From d642385b2d2ec169dbd8c54801b1da133a59acd8 Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Mon, 14 Jul 2025 15:57:56 +0000 Subject: [PATCH] deploy: 51296684498012217d6104deb5509f15dad93864 --- develop/404.html | 2 +- develop/CAPTCHA_SETUP.html | 2 +- develop/admin_api/account_validity.html | 2 +- .../client_server_api_extensions.html | 221 ++++++++++++++++++ develop/admin_api/event_reports.html | 2 +- develop/admin_api/experimental_features.html | 2 +- develop/admin_api/media_admin_api.html | 2 +- develop/admin_api/purge_history_api.html | 2 +- develop/admin_api/register_api.html | 2 +- develop/admin_api/room_membership.html | 2 +- develop/admin_api/rooms.html | 2 +- develop/admin_api/scheduled_tasks.html | 2 +- develop/admin_api/server_notices.html | 2 +- develop/admin_api/statistics.html | 2 +- develop/admin_api/user_admin_api.html | 2 +- develop/admin_api/version_api.html | 2 +- develop/application_services.html | 2 +- develop/auth_chain_difference_algorithm.html | 2 +- develop/code_style.html | 2 +- develop/consent_tracking.html | 2 +- develop/delegate.html | 2 +- develop/deprecation_policy.html | 2 +- develop/development/cas.html | 2 +- develop/development/contributing_guide.html | 2 +- develop/development/database_schema.html | 2 +- develop/development/demo.html | 2 +- develop/development/dependencies.html | 2 +- .../development/experimental_features.html | 2 +- develop/development/git.html | 2 +- .../internal_documentation/index.html | 2 +- develop/development/releases.html | 2 +- develop/development/reviews.html | 2 +- develop/development/room-dag-concepts.html | 2 +- develop/development/saml.html | 2 +- .../synapse_architecture/cancellation.html | 2 +- .../synapse_architecture/faster_joins.html | 2 +- .../synapse_architecture/streams.html | 2 +- develop/federate.html | 2 +- develop/index.html | 2 +- develop/jwt.html | 2 +- develop/log_contexts.html | 2 +- develop/manhole.html | 6 +- develop/media_repository.html | 2 +- develop/message_retention_policies.html | 2 +- develop/metrics-howto.html | 2 +- develop/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 +- develop/modules/index.html | 2 +- .../modules/media_repository_callbacks.html | 2 +- .../password_auth_provider_callbacks.html | 2 +- develop/modules/porting_legacy_module.html | 2 +- .../modules/presence_router_callbacks.html | 2 +- develop/modules/ratelimit_callbacks.html | 2 +- develop/modules/spam_checker_callbacks.html | 2 +- .../modules/third_party_rules_callbacks.html | 2 +- develop/modules/writing_a_module.html | 2 +- develop/openid.html | 2 +- develop/opentracing.html | 2 +- ...ing_synapse_on_single_board_computers.html | 2 +- develop/password_auth_providers.html | 2 +- develop/postgres.html | 2 +- develop/print.html | 19 +- develop/replication.html | 2 +- develop/reverse_proxy.html | 2 +- develop/room_and_user_statistics.html | 2 +- develop/searchindex.js | 2 +- develop/searchindex.json | 2 +- develop/server_notices.html | 2 +- develop/setup/forward_proxy.html | 2 +- develop/setup/installation.html | 2 +- develop/setup/turn/coturn.html | 2 +- develop/setup/turn/eturnal.html | 2 +- develop/sso_mapping_providers.html | 2 +- develop/structured_logging.html | 2 +- develop/synctl_workers.html | 2 +- develop/systemd-with-workers/index.html | 2 +- develop/tcp_replication.html | 2 +- develop/templates.html | 2 +- develop/turn-howto.html | 2 +- develop/upgrade.html | 2 +- .../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 +- develop/usage/administration/admin_faq.html | 2 +- develop/usage/administration/backups.html | 2 +- .../database_maintenance_tools.html | 2 +- develop/usage/administration/index.html | 2 +- ...reporting_homeserver_usage_statistics.html | 2 +- .../administration/monthly_active_users.html | 2 +- develop/usage/administration/request_log.html | 2 +- .../usage/administration/state_groups.html | 2 +- ...anding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../configuration/config_documentation.html | 2 +- .../homeserver_sample_config.html | 2 +- develop/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 +- develop/user_directory.html | 2 +- develop/welcome_and_overview.html | 2 +- develop/workers.html | 2 +- 108 files changed, 349 insertions(+), 111 deletions(-) create mode 100644 develop/admin_api/client_server_api_extensions.html diff --git a/develop/404.html b/develop/404.html index 830ba7276e..7d51986819 100644 --- a/develop/404.html +++ b/develop/404.html @@ -78,7 +78,7 @@ diff --git a/develop/CAPTCHA_SETUP.html b/develop/CAPTCHA_SETUP.html index 743f99b690..62376738a1 100644 --- a/develop/CAPTCHA_SETUP.html +++ b/develop/CAPTCHA_SETUP.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html index fd9bb9ed32..bf9a7400ea 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/client_server_api_extensions.html b/develop/admin_api/client_server_api_extensions.html new file mode 100644 index 0000000000..c28f6af4ca --- /dev/null +++ b/develop/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/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index 13c834721e..93bf122f82 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/experimental_features.html b/develop/admin_api/experimental_features.html index eb5f6689e5..fe991c99ab 100644 --- a/develop/admin_api/experimental_features.html +++ b/develop/admin_api/experimental_features.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index 52f8d51309..5fbc7f2125 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html index 69e20823a5..46f0776464 100644 --- a/develop/admin_api/purge_history_api.html +++ b/develop/admin_api/purge_history_api.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/register_api.html b/develop/admin_api/register_api.html index 9c04a0f432..a8c516b383 100644 --- a/develop/admin_api/register_api.html +++ b/develop/admin_api/register_api.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html index e5b5937e96..2e5dfaa0d0 100644 --- a/develop/admin_api/room_membership.html +++ b/develop/admin_api/room_membership.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html index 87bb73bcd8..9fa1b771c5 100644 --- a/develop/admin_api/rooms.html +++ b/develop/admin_api/rooms.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/scheduled_tasks.html b/develop/admin_api/scheduled_tasks.html index 9cffdba9e3..a6acfafb32 100644 --- a/develop/admin_api/scheduled_tasks.html +++ b/develop/admin_api/scheduled_tasks.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/server_notices.html b/develop/admin_api/server_notices.html index b06c9720db..349c7982bd 100644 --- a/develop/admin_api/server_notices.html +++ b/develop/admin_api/server_notices.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/statistics.html b/develop/admin_api/statistics.html index 0234a382b2..550d5c0568 100644 --- a/develop/admin_api/statistics.html +++ b/develop/admin_api/statistics.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html index 7c5ce3e1ee..bf57ba663d 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/version_api.html b/develop/admin_api/version_api.html index c270dc9d6e..8325f1741a 100644 --- a/develop/admin_api/version_api.html +++ b/develop/admin_api/version_api.html @@ -77,7 +77,7 @@ diff --git a/develop/application_services.html b/develop/application_services.html index 6bd8f56425..e88dbda82c 100644 --- a/develop/application_services.html +++ b/develop/application_services.html @@ -77,7 +77,7 @@ diff --git a/develop/auth_chain_difference_algorithm.html b/develop/auth_chain_difference_algorithm.html index cf87f5313f..a9f7566cfa 100644 --- a/develop/auth_chain_difference_algorithm.html +++ b/develop/auth_chain_difference_algorithm.html @@ -77,7 +77,7 @@ diff --git a/develop/code_style.html b/develop/code_style.html index bbfeddceb4..0c50348c91 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -77,7 +77,7 @@ diff --git a/develop/consent_tracking.html b/develop/consent_tracking.html index 3c59271226..b02457df52 100644 --- a/develop/consent_tracking.html +++ b/develop/consent_tracking.html @@ -77,7 +77,7 @@ diff --git a/develop/delegate.html b/develop/delegate.html index 9bb7226a68..7fd4a56f91 100644 --- a/develop/delegate.html +++ b/develop/delegate.html @@ -77,7 +77,7 @@ diff --git a/develop/deprecation_policy.html b/develop/deprecation_policy.html index 3f539fa064..7aa9ecf784 100644 --- a/develop/deprecation_policy.html +++ b/develop/deprecation_policy.html @@ -77,7 +77,7 @@ diff --git a/develop/development/cas.html b/develop/development/cas.html index 8ac21e05f7..bfa22feb22 100644 --- a/develop/development/cas.html +++ b/develop/development/cas.html @@ -77,7 +77,7 @@ diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index 30b24854f3..f599ec1121 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -77,7 +77,7 @@ diff --git a/develop/development/database_schema.html b/develop/development/database_schema.html index 86a1dbd739..13f47ecdf1 100644 --- a/develop/development/database_schema.html +++ b/develop/development/database_schema.html @@ -77,7 +77,7 @@ diff --git a/develop/development/demo.html b/develop/development/demo.html index df5aa0887a..d2d9468627 100644 --- a/develop/development/demo.html +++ b/develop/development/demo.html @@ -77,7 +77,7 @@ diff --git a/develop/development/dependencies.html b/develop/development/dependencies.html index cf8f4c5b58..78bb7f3fb1 100644 --- a/develop/development/dependencies.html +++ b/develop/development/dependencies.html @@ -77,7 +77,7 @@ diff --git a/develop/development/experimental_features.html b/develop/development/experimental_features.html index f9bddbb6d6..58947d0e4e 100644 --- a/develop/development/experimental_features.html +++ b/develop/development/experimental_features.html @@ -77,7 +77,7 @@ diff --git a/develop/development/git.html b/develop/development/git.html index 4352118abb..a8978ec6ff 100644 --- a/develop/development/git.html +++ b/develop/development/git.html @@ -77,7 +77,7 @@ diff --git a/develop/development/internal_documentation/index.html b/develop/development/internal_documentation/index.html index 8c29601add..50b8697fe3 100644 --- a/develop/development/internal_documentation/index.html +++ b/develop/development/internal_documentation/index.html @@ -77,7 +77,7 @@ diff --git a/develop/development/releases.html b/develop/development/releases.html index 2aab8417d6..83394ce86c 100644 --- a/develop/development/releases.html +++ b/develop/development/releases.html @@ -77,7 +77,7 @@ diff --git a/develop/development/reviews.html b/develop/development/reviews.html index 633f1f8dc4..3a5dde0598 100644 --- a/develop/development/reviews.html +++ b/develop/development/reviews.html @@ -77,7 +77,7 @@ diff --git a/develop/development/room-dag-concepts.html b/develop/development/room-dag-concepts.html index f56e91adef..deccc2dc91 100644 --- a/develop/development/room-dag-concepts.html +++ b/develop/development/room-dag-concepts.html @@ -77,7 +77,7 @@ diff --git a/develop/development/saml.html b/develop/development/saml.html index 4143146696..5dea958c19 100644 --- a/develop/development/saml.html +++ b/develop/development/saml.html @@ -77,7 +77,7 @@ diff --git a/develop/development/synapse_architecture/cancellation.html b/develop/development/synapse_architecture/cancellation.html index a36f3a0669..e79151145a 100644 --- a/develop/development/synapse_architecture/cancellation.html +++ b/develop/development/synapse_architecture/cancellation.html @@ -77,7 +77,7 @@ diff --git a/develop/development/synapse_architecture/faster_joins.html b/develop/development/synapse_architecture/faster_joins.html index 1500ddbf37..fad002eb85 100644 --- a/develop/development/synapse_architecture/faster_joins.html +++ b/develop/development/synapse_architecture/faster_joins.html @@ -77,7 +77,7 @@ diff --git a/develop/development/synapse_architecture/streams.html b/develop/development/synapse_architecture/streams.html index f178e742bc..aee801544d 100644 --- a/develop/development/synapse_architecture/streams.html +++ b/develop/development/synapse_architecture/streams.html @@ -77,7 +77,7 @@ diff --git a/develop/federate.html b/develop/federate.html index 6363e5b1b8..3e16141760 100644 --- a/develop/federate.html +++ b/develop/federate.html @@ -77,7 +77,7 @@ diff --git a/develop/index.html b/develop/index.html index ee6153d347..4be1bce340 100644 --- a/develop/index.html +++ b/develop/index.html @@ -77,7 +77,7 @@ diff --git a/develop/jwt.html b/develop/jwt.html index 734ff4b5fb..90f8b834c6 100644 --- a/develop/jwt.html +++ b/develop/jwt.html @@ -77,7 +77,7 @@ diff --git a/develop/log_contexts.html b/develop/log_contexts.html index 4286037c6e..611eaa5958 100644 --- a/develop/log_contexts.html +++ b/develop/log_contexts.html @@ -77,7 +77,7 @@ diff --git a/develop/manhole.html b/develop/manhole.html index a9aa8b23a9..6c83a4218f 100644 --- a/develop/manhole.html +++ b/develop/manhole.html @@ -77,7 +77,7 @@ @@ -233,7 +233,7 @@ parts of the process.