summary refs log tree commit diff
path: root/develop/admin_api
diff options
context:
space:
mode:
authorclokep <clokep@users.noreply.github.com>2023-08-25 11:26:42 +0000
committerclokep <clokep@users.noreply.github.com>2023-08-25 11:26:42 +0000
commit155c8f3a97830c92961a02655667224947cfe34d (patch)
tree748f43816138f1ce723d444453e167e2b3215cef /develop/admin_api
parentdeploy: 5856a8ba4243a11f0d5f97ed2fe742ae31341452 (diff)
downloadsynapse-155c8f3a97830c92961a02655667224947cfe34d.tar.xz
deploy: 5c9402b9fdaad3141b0a9d05614535705a14e65d
Diffstat (limited to 'develop/admin_api')
-rw-r--r--develop/admin_api/account_validity.html1
-rw-r--r--develop/admin_api/register_api.html1
-rw-r--r--develop/admin_api/user_admin_api.html6
3 files changed, 7 insertions, 1 deletions
diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html

index cafea79756..f6552ca2df 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html
@@ -147,6 +147,7 @@ </div> <h1 id="account-validity-api"><a class="header" href="#account-validity-api">Account validity API</a></h1> +<p><strong>Note:</strong> This API is disabled when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p> <p>This API allows a server administrator to manage the validity of an account. To use it, you must enable the account validity feature (under <code>account_validity</code>) in Synapse's configuration.</p> diff --git a/develop/admin_api/register_api.html b/develop/admin_api/register_api.html
index 3a6d44811f..b3e4cbe917 100644 --- a/develop/admin_api/register_api.html +++ b/develop/admin_api/register_api.html
@@ -147,6 +147,7 @@ </div> <h1 id="shared-secret-registration"><a class="header" href="#shared-secret-registration">Shared-Secret Registration</a></h1> +<p><strong>Note:</strong> This API is disabled when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p> <p>This API allows for the creation of users in an administrative and non-interactive way. This is generally used for bootstrapping a Synapse instance with administrator accounts.</p> diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html
index 20043020a8..6ff8503f0e 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html
@@ -368,7 +368,7 @@ that contain this value. This parameter is ignored when using the <code>name</co </li> <li> <p><code>guests</code> - string representing a bool - Is optional and if <code>false</code> will <strong>exclude</strong> guest users. -Defaults to <code>true</code> to include guest users.</p> +Defaults to <code>true</code> to include guest users. This parameter is not supported when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p> </li> <li> <p><code>admins</code> - Optional flag to filter admins. If <code>true</code>, only admins are queried. If <code>false</code>, admins are excluded from @@ -537,6 +537,7 @@ is set to <code>true</code>:</p> <li>Remove user's consent information (consent version and timestamp)</li> </ul> <h2 id="reset-password"><a class="header" href="#reset-password">Reset password</a></h2> +<p><strong>Note:</strong> This API is disabled when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p> <p>Changes the password of another user. This will automatically log the user out of all their devices.</p> <p>The api is:</p> <pre><code>POST /_synapse/admin/v1/reset_password/&lt;user_id&gt; @@ -550,6 +551,7 @@ is set to <code>true</code>:</p> <p>The parameter <code>new_password</code> is required. The parameter <code>logout_devices</code> is optional and defaults to <code>true</code>.</p> <h2 id="get-whether-a-user-is-a-server-administrator-or-not"><a class="header" href="#get-whether-a-user-is-a-server-administrator-or-not">Get whether a user is a server administrator or not</a></h2> +<p><strong>Note:</strong> This API is disabled when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p> <p>The api is:</p> <pre><code>GET /_synapse/admin/v1/users/&lt;user_id&gt;/admin </code></pre> @@ -559,6 +561,7 @@ The parameter <code>logout_devices</code> is optional and defaults to <code>true } </code></pre> <h2 id="change-whether-a-user-is-a-server-administrator-or-not"><a class="header" href="#change-whether-a-user-is-a-server-administrator-or-not">Change whether a user is a server administrator or not</a></h2> +<p><strong>Note:</strong> This API is disabled when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p> <p>Note that you cannot demote yourself.</p> <p>The api is:</p> <pre><code>PUT /_synapse/admin/v1/users/&lt;user_id&gt;/admin @@ -812,6 +815,7 @@ after deleting media the remaining media have a new order.</p> With the parameters you can for example limit the number of files to delete at once or delete largest/smallest or newest/oldest files first.</p> <h2 id="login-as-a-user"><a class="header" href="#login-as-a-user">Login as a user</a></h2> +<p><strong>Note:</strong> This API is disabled when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p> <p>Get an access token that can be used to authenticate as that user. Useful for when admins wish to do actions on behalf of a user.</p> <p>The API is:</p>