From 15d32be7d41bf535f7c83a261a1ae5a70bdab33f Mon Sep 17 00:00:00 2001 From: MatMaul Date: Tue, 9 May 2023 17:43:57 +0000 Subject: deploy: 64a11fb61fac47f652858d7e2109d077874135e0 --- latest/404.html | 2 +- latest/CAPTCHA_SETUP.html | 2 +- latest/admin_api/account_validity.html | 2 +- latest/admin_api/event_reports.html | 6 +- latest/admin_api/experimental_features.html | 227 +++++++++++++++++++++ latest/admin_api/media_admin_api.html | 6 +- 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/server_notices.html | 2 +- latest/admin_api/statistics.html | 36 +++- latest/admin_api/user_admin_api.html | 2 +- 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 | 31 +-- latest/development/demo.html | 2 +- latest/development/dependencies.html | 2 +- latest/development/experimental_features.html | 2 +- latest/development/git.html | 2 +- .../development/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 +- latest/federate.html | 2 +- latest/index.html | 2 +- latest/jwt.html | 2 +- latest/log_contexts.html | 2 +- latest/manhole.html | 2 +- latest/media_repository.html | 2 +- latest/message_retention_policies.html | 2 +- latest/metrics-howto.html | 2 +- latest/modules/account_data_callbacks.html | 2 +- latest/modules/account_validity_callbacks.html | 2 +- .../background_update_controller_callbacks.html | 2 +- latest/modules/index.html | 2 +- .../modules/password_auth_provider_callbacks.html | 2 +- latest/modules/porting_legacy_module.html | 2 +- latest/modules/presence_router_callbacks.html | 2 +- latest/modules/spam_checker_callbacks.html | 2 +- latest/modules/third_party_rules_callbacks.html | 2 +- latest/modules/writing_a_module.html | 2 +- latest/openid.html | 2 +- latest/opentracing.html | 2 +- .../running_synapse_on_single_board_computers.html | 2 +- latest/password_auth_providers.html | 2 +- latest/postgres.html | 2 +- latest/print.html | 166 ++++++++++++--- latest/replication.html | 2 +- latest/reverse_proxy.html | 2 +- latest/room_and_user_statistics.html | 2 +- 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 | 2 +- .../admin_api/background_updates.html | 2 +- .../usage/administration/admin_api/federation.html | 2 +- latest/usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- latest/usage/administration/admin_faq.html | 2 +- .../administration/database_maintenance_tools.html | 2 +- latest/usage/administration/index.html | 2 +- .../reporting_homeserver_usage_statistics.html | 2 +- .../usage/administration/monthly_active_users.html | 2 +- latest/usage/administration/request_log.html | 2 +- latest/usage/administration/state_groups.html | 2 +- ...derstanding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../usage/configuration/config_documentation.html | 2 +- .../configuration/homeserver_sample_config.html | 2 +- latest/usage/configuration/index.html | 2 +- .../usage/configuration/logging_sample_config.html | 2 +- .../configuration/user_authentication/index.html | 2 +- .../user_authentication/refresh_tokens.html | 2 +- .../user_authentication/single_sign_on/cas.html | 2 +- .../user_authentication/single_sign_on/index.html | 2 +- .../user_authentication/single_sign_on/saml.html | 2 +- latest/user_directory.html | 2 +- latest/welcome_and_overview.html | 2 +- latest/workers.html | 65 +++++- 101 files changed, 559 insertions(+), 166 deletions(-) create mode 100644 latest/admin_api/experimental_features.html diff --git a/latest/404.html b/latest/404.html index e300ccf7e3..e4cdd912a2 100644 --- a/latest/404.html +++ b/latest/404.html @@ -77,7 +77,7 @@ diff --git a/latest/CAPTCHA_SETUP.html b/latest/CAPTCHA_SETUP.html index a047d318e3..ed7e8c4ffc 100644 --- a/latest/CAPTCHA_SETUP.html +++ b/latest/CAPTCHA_SETUP.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index 660867c5f2..8c73efd2bf 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -76,7 +76,7 @@ diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index 8357ecd2c8..79bf44a935 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -76,7 +76,7 @@ @@ -317,7 +317,7 @@ will be an empty JSON object.

-
@@ -329,7 +329,7 @@ will be an empty JSON object.

- diff --git a/latest/admin_api/experimental_features.html b/latest/admin_api/experimental_features.html new file mode 100644 index 0000000000..00efb0f9a6 --- /dev/null +++ b/latest/admin_api/experimental_features.html @@ -0,0 +1,227 @@ + + + + + + Experimental Features - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + +
+
+ +
+ +
+ +

Experimental Features API

+

This API allows a server administrator to enable or disable some experimental features on a per-user +basis. Currently supported features are msc3026: busy +presence state enabled, msc2654: enable unread counts, +msc3881: enable remotely toggling push notifications +for another client, and msc3967: do not require +UIA when first uploading cross-signing keys.

+

To use it, you will need to authenticate by providing an access_token +for a server admin: see Admin API.

+

Enabling/Disabling Features

+

This API allows a server administrator to enable experimental features for a given user. The request must +provide a body containing the user id and listing the features to enable/disable in the following format:

+
{
+   "features": {
+      "msc3026":true,
+      "msc2654":true
+   }
+}
+
+

where true is used to enable the feature, and false is used to disable the feature.

+

The API is:

+
PUT /_synapse/admin/v1/experimental_features/<user_id>
+
+

Listing Enabled Features

+

To list which features are enabled/disabled for a given user send a request to the following API:

+
GET /_synapse/admin/v1/experimental_features/<user_id>
+
+

It will return a list of possible features and indicate whether they are enabled or disabled for the +user like so:

+
{
+   "features": {
+      "msc3026": true,
+      "msc2654": true,
+      "msc3881": false,
+      "msc3967": false
+   }
+}
+
+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index baa64e9f25..e26846a1f3 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -76,7 +76,7 @@ @@ -369,7 +369,7 @@ from the originating server.