diff options
| author | DMRobertson <DMRobertson@users.noreply.github.com> | 2022-11-11 15:39:05 +0000 |
|---|---|---|
| committer | DMRobertson <DMRobertson@users.noreply.github.com> | 2022-11-11 15:39:05 +0000 |
| commit | 9d117b7ec9e8ce52a79c884d6722038baec13484 (patch) | |
| tree | 624be34250560814a304cd08e656c6561efaf4cd /develop/print.html | |
| parent | deploy: a5fcdea090c2396c30dd07c357ce4d9c90004c34 (diff) | |
| download | synapse-9d117b7ec9e8ce52a79c884d6722038baec13484.tar.xz | |
deploy: a3623af74e0af0d2f6cbd37b47dc54a1acd314d5
Diffstat (limited to 'develop/print.html')
| -rw-r--r-- | develop/print.html | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/develop/print.html b/develop/print.html index f28dd803b7..3ed3d9a0b9 100644 --- a/develop/print.html +++ b/develop/print.html @@ -13689,6 +13689,30 @@ for more information.</p> } </code></pre> <p><em>Added in Synapse 1.68.0.</em></p> +<h3 id="find-a-user-based-on-their-third-party-id-threepid-or-3pid"><a class="header" href="#find-a-user-based-on-their-third-party-id-threepid-or-3pid">Find a user based on their Third Party ID (ThreePID or 3PID)</a></h3> +<p>The API is:</p> +<pre><code>GET /_synapse/admin/v1/threepid/$medium/users/$address +</code></pre> +<p>When a user matched the given address for the given medium, an HTTP code <code>200</code> with a response body like the following is returned:</p> +<pre><code class="language-json">{ + "user_id": "@hello:example.org" +} +</code></pre> +<p><strong>Parameters</strong></p> +<p>The following parameters should be set in the URL:</p> +<ul> +<li><code>medium</code> - Kind of third-party ID, either <code>email</code> or <code>msisdn</code>.</li> +<li><code>address</code> - Value of the third-party ID.</li> +</ul> +<p>The <code>address</code> may have characters that are not URL-safe, so it is advised to URL-encode those parameters.</p> +<p><strong>Errors</strong></p> +<p>Returns a <code>404</code> HTTP status code if no user was found, with a response body like this:</p> +<pre><code class="language-json">{ + "errcode":"M_NOT_FOUND", + "error":"User not found" +} +</code></pre> +<p><em>Added in Synapse 1.72.0.</em></p> <div 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 |