summary refs log tree commit diff
path: root/develop/admin_api
diff options
context:
space:
mode:
Diffstat (limited to 'develop/admin_api')
-rw-r--r--develop/admin_api/README.rst4
-rw-r--r--develop/admin_api/delete_group.html2
-rw-r--r--develop/admin_api/event_reports.html4
-rw-r--r--develop/admin_api/media_admin_api.html4
-rw-r--r--develop/admin_api/purge_history_api.html2
-rw-r--r--develop/admin_api/room_membership.html2
-rw-r--r--develop/admin_api/rooms.html2
-rw-r--r--develop/admin_api/statistics.html2
-rw-r--r--develop/admin_api/user_admin_api.html40
9 files changed, 31 insertions, 31 deletions
diff --git a/develop/admin_api/README.rst b/develop/admin_api/README.rst

index 37cee87d32..8d6e76580a 100644 --- a/develop/admin_api/README.rst +++ b/develop/admin_api/README.rst
@@ -2,7 +2,7 @@ Admin APIs ========== **Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_. -See `docs/README.md <../docs/README.md>`_ for more information. +See `docs/README.md <../README.md>`_ for more information. **Please update links to point to the website instead.** Existing files in this directory are preserved to maintain historical links, but may be moved in the future. @@ -10,5 +10,5 @@ are preserved to maintain historical links, but may be moved in the future. This directory includes documentation for the various synapse specific admin APIs available. Updates to the existing Admin API documentation should still be made to these files, but any new documentation files should instead be placed under -`docs/usage/administration/admin_api <../docs/usage/administration/admin_api>`_. +`docs/usage/administration/admin_api <../usage/administration/admin_api>`_. diff --git a/develop/admin_api/delete_group.html b/develop/admin_api/delete_group.html
index df4409e2b2..9183f1f65f 100644 --- a/develop/admin_api/delete_group.html +++ b/develop/admin_api/delete_group.html
@@ -190,7 +190,7 @@ being deleted.</p> <pre><code>POST /_synapse/admin/v1/delete_group/&lt;group_id&gt; </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> </main> diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html
index 868d6b1bf0..fd38d12967 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html
@@ -188,7 +188,7 @@ <pre><code>GET /_synapse/admin/v1/event_reports?from=0&amp;limit=10 </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <p>It returns a JSON body like the following:</p> <pre><code class="language-json">{ &quot;event_reports&quot;: [ @@ -266,7 +266,7 @@ have a canonical alias set.</li> <pre><code>GET /_synapse/admin/v1/event_reports/&lt;report_id&gt; </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <p>It returns a JSON body like the following:</p> <pre><code class="language-jsonc">{ &quot;event_id&quot;: &quot;$bNUFCwGzWca1meCGkjp-zwslF-GfVcXukvRLI1_FaVY&quot;, diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html
index 86a4c64a79..1f15479ba0 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html
@@ -217,7 +217,7 @@ However, it only shows media from unencrypted events or rooms.</p> <pre><code>GET /_synapse/admin/v1/room/&lt;room_id&gt;/media </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <p>The API returns a JSON body like the following:</p> <pre><code class="language-json">{ &quot;local&quot;: [ @@ -414,7 +414,7 @@ All cached media that was last accessed before this timestamp will be removed.</ <li><code>deleted</code>: integer - The number of media items successfully deleted</li> </ul> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <p>If the user re-requests purged remote media, synapse will re-request the media from the originating server.</p> diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html
index dc411ec5a7..4d307efc66 100644 --- a/develop/admin_api/purge_history_api.html +++ b/develop/admin_api/purge_history_api.html
@@ -194,7 +194,7 @@ delete the last message in a room.</p> <pre><code>POST /_synapse/admin/v1/purge_history/&lt;room_id&gt;[/&lt;event_id&gt;] </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>By default, events sent by local users are not deleted, as they may represent the only copies of this content in existence. (Events sent by remote users are deleted.)</p> diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html
index 08bec4be62..a372df2279 100644 --- a/develop/admin_api/room_membership.html +++ b/develop/admin_api/room_membership.html
@@ -202,7 +202,7 @@ invite users.</p> } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <p>Response:</p> <pre><code>{ &quot;room_id&quot;: &quot;!636q39766251:server.com&quot; diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html
index 2c1b5752ba..d5f8515d8a 100644 --- a/develop/admin_api/rooms.html +++ b/develop/admin_api/rooms.html
@@ -575,7 +575,7 @@ the new room. Users on other servers will be unaffected.</p> } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;kicked_users&quot;: [ diff --git a/develop/admin_api/statistics.html b/develop/admin_api/statistics.html
index 79309cc3ec..70aa7e14f1 100644 --- a/develop/admin_api/statistics.html +++ b/develop/admin_api/statistics.html
@@ -189,7 +189,7 @@ possibility to filter them by time and user.</p> <pre><code>GET /_synapse/admin/v1/statistics/users/media </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> -for a server admin: see <a href="../../usage/administration/admin_api">Admin API</a>.</p> +for a server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;users&quot;: [ diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html
index 7a1cc1143c..cb06b53576 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html
@@ -189,7 +189,7 @@ <pre><code>GET /_synapse/admin/v2/users/&lt;user_id&gt; </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>It returns a JSON body like the following:</p> <pre><code class="language-json">{ &quot;displayname&quot;: &quot;User&quot;, @@ -244,7 +244,7 @@ specific <code>user_id</code>.</p> } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>URL parameters:</p> <ul> <li><code>user_id</code>: fully-qualified user id: for example, <code>@user:server.com</code>.</li> @@ -285,7 +285,7 @@ By default, the response is ordered by ascending user ID.</p> <pre><code>GET /_synapse/admin/v2/users?from=0&amp;limit=10&amp;guests=false </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;users&quot;: [ @@ -406,7 +406,7 @@ This allows user type specific behaviour. There are also types <code>support</co <p>See also: <a href="https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-admin-whois-userid">Client Server API Whois</a>.</p> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>It returns a JSON body like the following:</p> <pre><code class="language-json">{ &quot;user_id&quot;: &quot;&lt;user_id&gt;&quot;, @@ -449,7 +449,7 @@ were sent, but hidden from users joining the room afterwards.</p> } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>The erase parameter is optional and defaults to <code>false</code>. An empty body may be passed for backwards compatibility.</p> <p>The following actions are performed when deactivating an user:</p> @@ -483,7 +483,7 @@ is set to <code>true</code>:</p> } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></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> @@ -491,7 +491,7 @@ The parameter <code>logout_devices</code> is optional and defaults to <code>true <pre><code>GET /_synapse/admin/v1/users/&lt;user_id&gt;/admin </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;admin&quot;: true @@ -508,14 +508,14 @@ server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <h2 id="list-room-memberships-of-a-user"><a class="header" href="#list-room-memberships-of-a-user">List room memberships of a user</a></h2> <p>Gets a list of all <code>room_id</code> that a specific <code>user_id</code> is member.</p> <p>The API is:</p> <pre><code>GET /_synapse/admin/v1/users/&lt;user_id&gt;/joined_rooms </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json"> { &quot;joined_rooms&quot;: [ @@ -548,7 +548,7 @@ The newest media is on top. You can change the order with parameters <pre><code>GET /_synapse/admin/v1/users/&lt;user_id&gt;/media </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;media&quot;: [ @@ -699,7 +699,7 @@ same.</p> <pre><code>GET /_synapse/admin/v2/users/&lt;user_id&gt;/devices </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;devices&quot;: [ @@ -761,7 +761,7 @@ any access token associated with them.</p> } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>An empty JSON dict is returned.</p> <p><strong>Parameters</strong></p> <p>The following parameters should be set in the URL:</p> @@ -778,7 +778,7 @@ server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> <pre><code>GET /_synapse/admin/v2/users/&lt;user_id&gt;/devices/&lt;device_id&gt; </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;device_id&quot;: &quot;&lt;device_id&gt;&quot;, @@ -816,7 +816,7 @@ devices was last seen. (May be a few minutes out of date, for efficiency reasons } </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>An empty JSON dict is returned.</p> <p><strong>Parameters</strong></p> <p>The following parameters should be set in the URL:</p> @@ -838,7 +838,7 @@ and invalidates any access token associated with it.</p> {} </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>An empty JSON dict is returned.</p> <p><strong>Parameters</strong></p> <p>The following parameters should be set in the URL:</p> @@ -852,7 +852,7 @@ server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> <pre><code>GET /_synapse/admin/v1/users/&lt;user_id&gt;/pushers </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;pushers&quot;: [ @@ -949,7 +949,7 @@ A shadow-banned user will be unable to contact anyone on the server.</p> <pre><code>POST /_synapse/admin/v1/users/&lt;user_id&gt;/shadow_ban </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>An empty JSON dict is returned.</p> <p><strong>Parameters</strong></p> <p>The following parameters should be set in the URL:</p> @@ -965,7 +965,7 @@ There are specific APIs to set, get and delete a ratelimit.</p> <pre><code>GET /_synapse/admin/v1/users/&lt;user_id&gt;/override_ratelimit </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;messages_per_second&quot;: 0, @@ -994,7 +994,7 @@ being limited.</li> <pre><code>POST /_synapse/admin/v1/users/&lt;user_id&gt;/override_ratelimit </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>A response body like the following is returned:</p> <pre><code class="language-json">{ &quot;messages_per_second&quot;: 0, @@ -1028,7 +1028,7 @@ being limited.</li> <pre><code>DELETE /_synapse/admin/v1/users/&lt;user_id&gt;/override_ratelimit </code></pre> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a -server admin: <a href="../../usage/administration/admin_api">Admin API</a></p> +server admin: <a href="../usage/administration/admin_api">Admin API</a></p> <p>An empty JSON dict is returned.</p> <pre><code class="language-json">{} </code></pre>