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.