From 7a63821b16f8cf90e9b1bf995759990b683210bf Mon Sep 17 00:00:00 2001 From: squahtx Date: Wed, 3 May 2023 14:24:25 +0000 Subject: deploy: 8aee823393d6a60740f5e9990626c823f8b46eec --- develop/404.html | 2 +- develop/CAPTCHA_SETUP.html | 2 +- develop/admin_api/account_validity.html | 2 +- develop/admin_api/event_reports.html | 6 +- develop/admin_api/experimental_features.html | 230 +++++++++++++++++++++ develop/admin_api/media_admin_api.html | 6 +- 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/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 +- develop/development/experimental_features.html | 2 +- develop/development/git.html | 2 +- .../development/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 +- develop/federate.html | 2 +- develop/index.html | 2 +- develop/jwt.html | 2 +- develop/log_contexts.html | 2 +- develop/manhole.html | 2 +- develop/media_repository.html | 2 +- develop/message_retention_policies.html | 2 +- develop/metrics-howto.html | 2 +- develop/modules/account_data_callbacks.html | 2 +- develop/modules/account_validity_callbacks.html | 2 +- .../background_update_controller_callbacks.html | 2 +- develop/modules/index.html | 2 +- .../modules/password_auth_provider_callbacks.html | 2 +- develop/modules/porting_legacy_module.html | 2 +- develop/modules/presence_router_callbacks.html | 2 +- develop/modules/spam_checker_callbacks.html | 2 +- develop/modules/third_party_rules_callbacks.html | 2 +- develop/modules/writing_a_module.html | 2 +- develop/openid.html | 2 +- develop/opentracing.html | 2 +- .../running_synapse_on_single_board_computers.html | 2 +- develop/password_auth_providers.html | 2 +- develop/postgres.html | 2 +- develop/print.html | 43 +++- 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 +- .../usage/administration/admin_api/federation.html | 2 +- develop/usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- develop/usage/administration/admin_faq.html | 2 +- .../administration/database_maintenance_tools.html | 2 +- develop/usage/administration/index.html | 2 +- .../reporting_homeserver_usage_statistics.html | 2 +- .../usage/administration/monthly_active_users.html | 2 +- develop/usage/administration/request_log.html | 2 +- develop/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 +- develop/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 +- develop/user_directory.html | 2 +- develop/welcome_and_overview.html | 2 +- develop/workers.html | 2 +- 101 files changed, 375 insertions(+), 104 deletions(-) create mode 100644 develop/admin_api/experimental_features.html diff --git a/develop/404.html b/develop/404.html index e300ccf7e3..e4cdd912a2 100644 --- a/develop/404.html +++ b/develop/404.html @@ -77,7 +77,7 @@ diff --git a/develop/CAPTCHA_SETUP.html b/develop/CAPTCHA_SETUP.html index a047d318e3..ed7e8c4ffc 100644 --- a/develop/CAPTCHA_SETUP.html +++ b/develop/CAPTCHA_SETUP.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html index 660867c5f2..8c73efd2bf 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html @@ -76,7 +76,7 @@ diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index 8357ecd2c8..79bf44a935 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/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/develop/admin_api/experimental_features.html b/develop/admin_api/experimental_features.html new file mode 100644 index 0000000000..046c6874da --- /dev/null +++ b/develop/admin_api/experimental_features.html @@ -0,0 +1,230 @@ + + + + + + Experimental Features - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + +
+
+ +
+ +
+ +

Experimental Features API

+

This API allows a server administrator to enable or disable some experimental features on a per-user +basis. The currently supported features are:

+
    +
  • MSC3026: busy +presence state enabled
    • +
  • MSC3881: enable remotely toggling push notifications +for another client
    • +
  • 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,
+      "msc3881":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,
+      "msc3881": false,
+      "msc3967": false
+   }
+}
+
+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index baa64e9f25..e26846a1f3 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -76,7 +76,7 @@ @@ -369,7 +369,7 @@ from the originating server.