diff options
| author | Erik Johnston <erikj@element.io> | 2024-07-05 13:02:35 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-07-05 13:02:35 +0100 |
| commit | 57538eb4d9fef09f4c3a234d51e34478f45b7917 (patch) | |
| tree | 14073356b279fed335a5ce57511dfa1dfb9ecadd /docs | |
| parent | Fix links to MSC3916 (#17397) (diff) | |
| download | synapse-57538eb4d9fef09f4c3a234d51e34478f45b7917.tar.xz | |
Finish up work to allow per-user feature flags (#17392)
Follows on from @H-Shay's great work at https://github.com/matrix-org/synapse/pull/15344 and MSC4026. Also enables its use for MSC3881, mainly as an easy but concrete example of how to use it.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/experimental_features.md | 17 |
1 files changed, 6 insertions, 11 deletions
diff --git a/docs/admin_api/experimental_features.md b/docs/admin_api/experimental_features.md index 07b630915d..250cfc13a3 100644 --- a/docs/admin_api/experimental_features.md +++ b/docs/admin_api/experimental_features.md @@ -1,21 +1,16 @@ # 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](https://github.com/matrix-org/matrix-spec-proposals/pull/3026): busy -presence state enabled -- [MSC3881](https://github.com/matrix-org/matrix-spec-proposals/pull/3881): enable remotely toggling push notifications -for another client -- [MSC3967](https://github.com/matrix-org/matrix-spec-proposals/pull/3967): do not require -UIA when first uploading cross-signing keys. - +basis. The currently supported features are: +- [MSC3881](https://github.com/matrix-org/matrix-spec-proposals/pull/3881): enable remotely toggling push notifications +for another client To use it, you will need to authenticate by providing an `access_token` for a server admin: see [Admin API](../usage/administration/admin_api/). ## Enabling/Disabling Features -This API allows a server administrator to enable experimental features for a given user. The request must +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: ```json { @@ -35,7 +30,7 @@ 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: ``` @@ -52,4 +47,4 @@ user like so: "msc3967": false } } -``` \ No newline at end of file +``` |