diff options
author | clokep <clokep@users.noreply.github.com> | 2023-08-25 11:26:42 +0000 |
---|---|---|
committer | clokep <clokep@users.noreply.github.com> | 2023-08-25 11:26:42 +0000 |
commit | 155c8f3a97830c92961a02655667224947cfe34d (patch) | |
tree | 748f43816138f1ce723d444453e167e2b3215cef /develop/print.html | |
parent | deploy: 5856a8ba4243a11f0d5f97ed2fe742ae31341452 (diff) | |
download | synapse-155c8f3a97830c92961a02655667224947cfe34d.tar.xz |
deploy: 5c9402b9fdaad3141b0a9d05614535705a14e65d
Diffstat (limited to 'develop/print.html')
-rw-r--r-- | develop/print.html | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/develop/print.html b/develop/print.html index fcc375a988..5b9389a169 100644 --- a/develop/print.html +++ b/develop/print.html @@ -11786,6 +11786,7 @@ information from the Admin API.</p> <p>For more details on access tokens in Matrix, please refer to the complete <a href="https://matrix.org/docs/spec/client_server/r0.6.1#using-access-tokens">matrix spec documentation</a>.</p> <div style="break-before: page; page-break-before: always;"></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> @@ -12356,6 +12357,7 @@ a purge id:</p> <code>VACUUM FULL;</code> on the database.</p> <p><a href="https://www.postgresql.org/docs/current/sql-vacuum.html">https://www.postgresql.org/docs/current/sql-vacuum.html</a></p> <div style="break-before: page; page-break-before: always;"></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> @@ -12430,6 +12432,7 @@ def generate_mac(nonce, user, password, admin=False, user_type=None): return mac.hexdigest() </code></pre> <div style="break-before: page; page-break-before: always;"></div><h1 id="registration-tokens"><a class="header" href="#registration-tokens">Registration Tokens</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 you to manage tokens which can be used to authenticate registration requests, as proposed in <a href="https://github.com/matrix-org/matrix-doc/blob/main/proposals/3231-token-authenticated-registration.md">MSC3231</a> @@ -14009,7 +14012,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 @@ -14178,6 +14181,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/<user_id> @@ -14191,6 +14195,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/<user_id>/admin </code></pre> @@ -14200,6 +14205,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/<user_id>/admin @@ -14453,6 +14459,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> |