deploy: 5df6d1be65

develop/admin_api/user_admin_api.html

@@ -37,7 +37,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-93781aa7.js";
+            window.path_to_searchindex_js = "../searchindex-dac38eb4.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-4dc10a98.js"></script>
@@ -428,7 +428,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. This parameter is not supported when MSC3861 is enabled. <a href="https://github.com/matrix-org/synapse/pull/15582">See #15582</a></p>
+Defaults to <code>true</code> to include guest users. This parameter is not supported when Matrix Authentication Service integration 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
@@ -632,7 +632,7 @@ prohibited from sending invites, joining or knocking on rooms, sending messages,
 }
 </code></pre>
 <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><strong>Note:</strong> This API is disabled when Matrix Authentication Service integration is enabled. Use the <a href="https://element-hq.github.io/matrix-authentication-service/topics/admin-api.html">MAS Admin API</a> or <a href="https://element-hq.github.io/matrix-authentication-service/reference/cli/manage.html#manage-set-password">the MAS CLI</a> instead. An easy way to make use of this functionality is provided by <a href="https://element.io/en/server-suite/admin">Element Admin</a> as part of <a href="https://element.io/en/server-suite">ESS</a> Community and Pro.</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;
@@ -646,7 +646,7 @@ prohibited from sending invites, joining or knocking on rooms, sending messages,
 <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><strong>Note:</strong> This API is disabled when Matrix Authentication Service integration is enabled. Use the <a href="https://element-hq.github.io/matrix-authentication-service/topics/admin-api.html">MAS Admin API</a> instead. An easy way to make use of this functionality is provided by <a href="https://element.io/en/server-suite/admin">Element Admin</a> as part of <a href="https://element.io/en/server-suite">ESS</a> Community and Pro.</p>
 <p>The api is:</p>
 <pre><code>GET /_synapse/admin/v1/users/&lt;user_id&gt;/admin
 </code></pre>
@@ -656,7 +656,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><strong>Note:</strong> This API is disabled when Matrix Authentication Service integration is enabled. Use the <a href="https://element-hq.github.io/matrix-authentication-service/topics/admin-api.html">MAS Admin API</a> or <a href="https://element-hq.github.io/matrix-authentication-service/reference/cli/manage.html#manage-promote-admin">the MAS CLI</a> instead. An easy way to make use of this functionality is provided by <a href="https://element.io/en/server-suite/admin">Element Admin</a> as part of <a href="https://element.io/en/server-suite">ESS</a> Community and Pro.</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
@@ -1006,7 +1006,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><strong>Note:</strong> This API is disabled when Matrix Authentication Service integration is enabled. Use <a href="https://element-hq.github.io/matrix-authentication-service/topics/authorization.html#personal-sessions-personal-access-tokens">Personal sessions</a> through the <a href="https://element-hq.github.io/matrix-authentication-service/topics/admin-api.html">MAS Admin API</a> instead. An easy way to make use of this functionality is provided by <a href="https://element.io/en/server-suite/admin">Element Admin</a> as part of <a href="https://element.io/en/server-suite">ESS</a> Community and Pro.</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>