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/experimental_features.html | 227 ++++++++++++++++++++++++++++ 1 file changed, 227 insertions(+) create mode 100644 latest/admin_api/experimental_features.html (limited to 'latest/admin_api/experimental_features.html') 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 -- cgit 1.5.1