diff options
author | anoadragon453 <anoadragon453@users.noreply.github.com> | 2024-01-16 16:12:52 +0000 |
---|---|---|
committer | anoadragon453 <anoadragon453@users.noreply.github.com> | 2024-01-16 16:12:52 +0000 |
commit | 6f837065541a3f50ee81a89affafe0b5ff1db744 (patch) | |
tree | 34f5bfe3e6ead663a511e638732958502296eb04 /latest/admin_api | |
parent | deploy: 13e3740f7043858815790d128cf8fb37fff37ce6 (diff) | |
download | synapse-6f837065541a3f50ee81a89affafe0b5ff1db744.tar.xz |
deploy: 2927008e48ecb6ea5d24e622d7b2fffe94c45c44
Diffstat (limited to 'latest/admin_api')
-rw-r--r-- | latest/admin_api/README.rst | 3 | ||||
-rw-r--r-- | latest/admin_api/account_validity.html | 6 | ||||
-rw-r--r-- | latest/admin_api/event_reports.html | 6 | ||||
-rw-r--r-- | latest/admin_api/experimental_features.html | 6 | ||||
-rw-r--r-- | latest/admin_api/media_admin_api.html | 6 | ||||
-rw-r--r-- | latest/admin_api/purge_history_api.html | 6 | ||||
-rw-r--r-- | latest/admin_api/register_api.html | 6 | ||||
-rw-r--r-- | latest/admin_api/room_membership.html | 6 | ||||
-rw-r--r-- | latest/admin_api/rooms.html | 6 | ||||
-rw-r--r-- | latest/admin_api/server_notices.html | 6 | ||||
-rw-r--r-- | latest/admin_api/statistics.html | 6 | ||||
-rw-r--r-- | latest/admin_api/user_admin_api.html | 25 | ||||
-rw-r--r-- | latest/admin_api/version_api.html | 6 |
13 files changed, 47 insertions, 47 deletions
diff --git a/latest/admin_api/README.rst b/latest/admin_api/README.rst index 8d6e76580a..db141732f9 100644 --- a/latest/admin_api/README.rst +++ b/latest/admin_api/README.rst @@ -1,7 +1,7 @@ Admin APIs ========== -**Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_. +**Note**: The latest documentation can be viewed `here <https://element-hq.github.io/synapse>`_. See `docs/README.md <../README.md>`_ for more information. **Please update links to point to the website instead.** Existing files in this directory @@ -11,4 +11,3 @@ 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 <../usage/administration/admin_api>`_. - diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index 5872506c87..c9b4e6b202 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/account_validity.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/account_validity.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index ca22310610..f9aaf304fd 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/event_reports.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/event_reports.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/experimental_features.html b/latest/admin_api/experimental_features.html index 70c8b0f8af..548b905727 100644 --- a/latest/admin_api/experimental_features.html +++ b/latest/admin_api/experimental_features.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/experimental_features.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/experimental_features.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index 075f7cd149..26e5ae5ef7 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/media_admin_api.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/media_admin_api.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/purge_history_api.html b/latest/admin_api/purge_history_api.html index 15eff63660..49f845cabb 100644 --- a/latest/admin_api/purge_history_api.html +++ b/latest/admin_api/purge_history_api.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/purge_history_api.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/purge_history_api.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/register_api.html b/latest/admin_api/register_api.html index 0383cba0e0..ecbde22113 100644 --- a/latest/admin_api/register_api.html +++ b/latest/admin_api/register_api.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/register_api.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/register_api.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/room_membership.html b/latest/admin_api/room_membership.html index 39b7fe1c95..7757c44047 100644 --- a/latest/admin_api/room_membership.html +++ b/latest/admin_api/room_membership.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/room_membership.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/room_membership.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index 9a83df2352..8f12d6db5e 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/rooms.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/rooms.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/server_notices.html b/latest/admin_api/server_notices.html index 05749499cc..bcb2254e16 100644 --- a/latest/admin_api/server_notices.html +++ b/latest/admin_api/server_notices.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/server_notices.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/server_notices.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/statistics.html b/latest/admin_api/statistics.html index 68cd0ab232..5b59fc0b42 100644 --- a/latest/admin_api/statistics.html +++ b/latest/admin_api/statistics.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/statistics.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/statistics.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index 0dbba7ed61..8cf6850bc0 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/user_admin_api.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/user_admin_api.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> @@ -311,11 +311,12 @@ granting them access to the Admin API, among other things.</p> </li> <li> <p><code>deactivated</code> - <strong>bool</strong>, optional. If unspecified, deactivation state will be left unchanged.</p> -<p>Note: the <code>password</code> field must also be set if both of the following are true:</p> +<p>Note:</p> <ul> -<li><code>deactivated</code> is set to <code>false</code> and the user was previously deactivated (you are reactivating this user)</li> -<li>Users are allowed to set their password on this homeserver (both <code>password_config.enabled</code> and -<code>password_config.localdb_enabled</code> config options are set to <code>true</code>). +<li>For the password field there is no strict check of the necessity for its presence. +It is possible to have active users without a password, e.g. when authenticating with OIDC is configured. +You must check yourself whether a password is required when reactivating a user or not.</li> +<li>It is not possible to set a password if the config option <code>password_config.localdb_enabled</code> is set <code>false</code>. Users' passwords are wiped upon account deactivation, hence the need to set a new one here.</li> </ul> <p>Note: a user cannot be erased with this API. For more details on @@ -388,7 +389,7 @@ that contain this value. This parameter is ignored when using the <code>name</co 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 +<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 the query. When the flag is absent (the default), <strong>both</strong> admins and non-admins are included in the search results.</p> </li> <li> @@ -451,7 +452,7 @@ User objects contain the following fields:</p> <li><code>is_guest</code> - bool - Status if that user is a guest account.</li> <li><code>admin</code> - bool - Status if that user is a server administrator.</li> <li><code>user_type</code> - string - Type of the user. Normal users are type <code>None</code>. -This allows user type specific behaviour. There are also types <code>support</code> and <code>bot</code>. </li> +This allows user type specific behaviour. There are also types <code>support</code> and <code>bot</code>.</li> <li><code>deactivated</code> - bool - Status if that user has been marked as deactivated.</li> <li><code>erased</code> - bool - Status if that user has been marked as erased.</li> <li><code>shadow_banned</code> - bool - Status if that user has been marked as shadow banned.</li> @@ -959,7 +960,7 @@ devices was last seen. (May be a few minutes out of date, for efficiency reasons </li> </ul> <h3 id="create-a-device"><a class="header" href="#create-a-device">Create a device</a></h3> -<p>Creates a new device for a specific <code>user_id</code> and <code>device_id</code>. Does nothing if the <code>device_id</code> +<p>Creates a new device for a specific <code>user_id</code> and <code>device_id</code>. Does nothing if the <code>device_id</code> exists already.</p> <p>The API is:</p> <pre><code>POST /_synapse/admin/v2/users/<user_id>/devices @@ -1261,10 +1262,10 @@ being limited.</li> be local.</li> </ul> <h2 id="check-username-availability"><a class="header" href="#check-username-availability">Check username availability</a></h2> -<p>Checks to see if a username is available, and valid, for the server. See <a href="https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available">the client-server +<p>Checks to see if a username is available, and valid, for the server. See <a href="https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available">the client-server API</a> for more information.</p> -<p>This endpoint will work even if registration is disabled on the server, unlike +<p>This endpoint will work even if registration is disabled on the server, unlike <code>/_matrix/client/r0/register/available</code>.</p> <p>The API is:</p> <pre><code>GET /_synapse/admin/v1/username_available?username=$localpart diff --git a/latest/admin_api/version_api.html b/latest/admin_api/version_api.html index 0f3848599a..78df354026 100644 --- a/latest/admin_api/version_api.html +++ b/latest/admin_api/version_api.html @@ -115,7 +115,7 @@ <!-- Versions will be added dynamically in version-picker.js --> </ul> </div> - </div> + </div> </div> <h1 class="menu-title">Synapse</h1> @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/version_api.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/version_api.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> |