mirror of
https://github.com/element-hq/synapse
synced 2024-08-18 23:50:52 +00:00
deploy: 74f60cec92
This commit is contained in:
parent
1f26e986bc
commit
e88afd2243
4 changed files with 50 additions and 2 deletions
|
@ -1138,6 +1138,30 @@ for more information.</p>
|
|||
</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>
|
||||
<h3 id="find-a-user-based-on-their-id-in-an-auth-provider"><a class="header" href="#find-a-user-based-on-their-id-in-an-auth-provider">Find a user based on their ID in an auth provider</a></h3>
|
||||
<p>The API is:</p>
|
||||
<pre><code>GET /_synapse/admin/v1/auth_providers/$provider/users/$external_id
|
||||
</code></pre>
|
||||
<p>When a user matched the given ID for the given provider, 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>provider</code> - The ID of the authentication provider, as advertised by the <a href="https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3login"><code>GET /_matrix/client/v3/login</code></a> API in the <code>m.login.sso</code> authentication method.</li>
|
||||
<li><code>external_id</code> - The user ID from the authentication provider. Usually corresponds to the <code>sub</code> claim for OIDC providers, or to the <code>uid</code> attestation for SAML2 providers.</li>
|
||||
</ul>
|
||||
<p>The <code>external_id</code> may have characters that are not URL-safe (typically <code>/</code>, <code>:</code> or <code>@</code>), 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.68.0.</em></p>
|
||||
|
||||
</main>
|
||||
|
||||
|
|
|
@ -13295,6 +13295,30 @@ for more information.</p>
|
|||
</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>
|
||||
<h3 id="find-a-user-based-on-their-id-in-an-auth-provider"><a class="header" href="#find-a-user-based-on-their-id-in-an-auth-provider">Find a user based on their ID in an auth provider</a></h3>
|
||||
<p>The API is:</p>
|
||||
<pre><code>GET /_synapse/admin/v1/auth_providers/$provider/users/$external_id
|
||||
</code></pre>
|
||||
<p>When a user matched the given ID for the given provider, 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>provider</code> - The ID of the authentication provider, as advertised by the <a href="https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3login"><code>GET /_matrix/client/v3/login</code></a> API in the <code>m.login.sso</code> authentication method.</li>
|
||||
<li><code>external_id</code> - The user ID from the authentication provider. Usually corresponds to the <code>sub</code> claim for OIDC providers, or to the <code>uid</code> attestation for SAML2 providers.</li>
|
||||
</ul>
|
||||
<p>The <code>external_id</code> may have characters that are not URL-safe (typically <code>/</code>, <code>:</code> or <code>@</code>), 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.68.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
|
||||
|
|
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