diff options
Diffstat (limited to 'develop/print.html')
| -rw-r--r-- | develop/print.html | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/develop/print.html b/develop/print.html index 2e413a2031..eed6144f34 100644 --- a/develop/print.html +++ b/develop/print.html @@ -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 be local.</li> </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> <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 |