From 4b36b11f119ec7451a050b0cd759bdead2f1bf11 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 5 Dec 2023 13:16:01 +0000 Subject: deploy: 3c83d8f0afcaa8461516321d49a64906e0ec865b --- v1.98/admin_api/experimental_features.html | 230 +++++++++++++++++++++++++++++ 1 file changed, 230 insertions(+) create mode 100644 v1.98/admin_api/experimental_features.html (limited to 'v1.98/admin_api/experimental_features.html') diff --git a/v1.98/admin_api/experimental_features.html b/v1.98/admin_api/experimental_features.html new file mode 100644 index 0000000000..00b32d6429 --- /dev/null +++ b/v1.98/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 -- cgit 1.5.1