mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 03:20:52 +00:00
deploy: a933c2c7d8
This commit is contained in:
parent
1e4f6a5c57
commit
42e3f6b862
4 changed files with 26 additions and 2 deletions
|
@ -1065,6 +1065,18 @@ server admin: <a href="../usage/administration/admin_api">Admin API</a></p>
|
||||||
<li><code>user_id</code> - The fully qualified MXID: for example, <code>@user:server.com</code>. The user must
|
<li><code>user_id</code> - The fully qualified MXID: for example, <code>@user:server.com</code>. The user must
|
||||||
be local.</li>
|
be local.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h3 id="check-username-availability"><a class="header" href="#check-username-availability">Check username availability</a></h3>
|
||||||
|
<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
|
||||||
|
<code>/_matrix/client/r0/register/available</code>.</p>
|
||||||
|
<p>The API is:</p>
|
||||||
|
<pre><code>POST /_synapse/admin/v1/username_availabile?username=$localpart
|
||||||
|
</code></pre>
|
||||||
|
<p>The request and response format is the same as the <a href="https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available">/_matrix/client/r0/register/available</a> API.</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>
|
||||||
|
|
||||||
</main>
|
</main>
|
||||||
|
|
||||||
|
|
|
@ -10786,6 +10786,18 @@ server admin: <a href="admin_api/../usage/administration/admin_api">Admin API</a
|
||||||
<li><code>user_id</code> - The fully qualified MXID: for example, <code>@user:server.com</code>. The user must
|
<li><code>user_id</code> - The fully qualified MXID: for example, <code>@user:server.com</code>. The user must
|
||||||
be local.</li>
|
be local.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h3 id="check-username-availability"><a class="header" href="#check-username-availability">Check username availability</a></h3>
|
||||||
|
<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
|
||||||
|
<code>/_matrix/client/r0/register/available</code>.</p>
|
||||||
|
<p>The API is:</p>
|
||||||
|
<pre><code>POST /_synapse/admin/v1/username_availabile?username=$localpart
|
||||||
|
</code></pre>
|
||||||
|
<p>The request and response format is the same as the <a href="https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available">/_matrix/client/r0/register/available</a> API.</p>
|
||||||
|
<p>To use it, you will need to authenticate by providing an <code>access_token</code> for a
|
||||||
|
server admin: <a href="admin_api/../usage/administration/admin_api">Admin API</a></p>
|
||||||
<div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><h1 id="version-api"><a class="header" href="#version-api">Version API</a></h1>
|
<div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><h1 id="version-api"><a class="header" href="#version-api">Version API</a></h1>
|
||||||
<p>This API returns the running Synapse version and the Python version
|
<p>This API returns the running Synapse version and the Python version
|
||||||
on which Synapse is being run. This is useful when a Synapse instance
|
on which Synapse is being run. This is useful when a Synapse instance
|
||||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue