mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 04:30:53 +00:00
deploy: a3623af74e
This commit is contained in:
parent
2d31a8e7e8
commit
9d117b7ec9
4 changed files with 50 additions and 2 deletions
|
@ -1166,6 +1166,30 @@ for more information.</p>
|
||||||
}
|
}
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p><em>Added in Synapse 1.68.0.</em></p>
|
<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>
|
||||||
|
|
||||||
</main>
|
</main>
|
||||||
|
|
||||||
|
|
|
@ -13689,6 +13689,30 @@ for more information.</p>
|
||||||
}
|
}
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p><em>Added in Synapse 1.68.0.</em></p>
|
<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>
|
<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
|
<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