From 15d32be7d41bf535f7c83a261a1ae5a70bdab33f Mon Sep 17 00:00:00 2001 From: MatMaul Date: Tue, 9 May 2023 17:43:57 +0000 Subject: deploy: 64a11fb61fac47f652858d7e2109d077874135e0 --- 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 +- 12 files changed, 276 insertions(+), 15 deletions(-) create mode 100644 latest/admin_api/experimental_features.html (limited to 'latest/admin_api') 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.