From 42e3f6b862cd3c5ad4f25fca7a1fe685a3a1d1e6 Mon Sep 17 00:00:00 2001
From: richvdh <richvdh@users.noreply.github.com>
Date: Tue, 17 Aug 2021 09:52:59 +0000
Subject: deploy: a933c2c7d8ef49c3c98ef443d959f955600bfb6b

---
 develop/admin_api/user_admin_api.html | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'develop/admin_api')

diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html
index 0a49fadba1..f5aac41774 100644
--- a/develop/admin_api/user_admin_api.html
+++ b/develop/admin_api/user_admin_api.html
@@ -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>
 
-- 
cgit 1.5.1