kaslo/synapse
1
0
Fork 0
Code Wiki Activity

deploy: a933c2c7d8

Browse Source
This commit is contained in:
richvdh
2021-08-17 09:52:59 +00:00
parent 1e4f6a5c57
commit 42e3f6b862
4 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
develop/admin_api/user_admin_api.html
View File

@@ -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
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="../usage/administration/admin_api">Admin API</a></p>
</main>