diff options
| author | reivilibre <reivilibre@users.noreply.github.com> | 2023-07-18 15:46:53 +0000 |
|---|---|---|
| committer | reivilibre <reivilibre@users.noreply.github.com> | 2023-07-18 15:46:53 +0000 |
| commit | dd6056eb58d896293c4ed23451f3942f08691b88 (patch) | |
| tree | 4073779d73c06e323d45f21ed04073dcdbfc76c0 /latest/admin_api | |
| parent | deploy: 1c802de626de3293049206cb788af15cbc8ea17f (diff) | |
| download | synapse-dd6056eb58d896293c4ed23451f3942f08691b88.tar.xz | |
deploy: 69699a9bd11822635fcf2166f5dec2ce2365219c
Diffstat (limited to 'latest/admin_api')
| -rw-r--r-- | latest/admin_api/user_admin_api.html | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index c7322cb65f..61269be951 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -401,6 +401,11 @@ which guarantees a stable ordering. Valid values are:</p> <p><code>dir</code> - Direction of media order. Either <code>f</code> for forwards or <code>b</code> for backwards. Setting this value to <code>b</code> will reverse the above sort order. Defaults to <code>f</code>.</p> </li> +<li> +<p><code>not_user_type</code> - Exclude certain user types, such as bot users, from the request. +Can be provided multiple times. Possible values are <code>bot</code>, <code>support</code> or "empty string". +"empty string" here means to exclude users without a type.</p> +</li> </ul> <p>Caution. The database only has indexes on the columns <code>name</code> and <code>creation_ts</code>. This means that if a different sort order is used (<code>is_guest</code>, <code>admin</code>, @@ -1180,7 +1185,7 @@ being limited.</li> <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> +<h2 id="check-username-availability"><a class="header" href="#check-username-availability">Check username availability</a></h2> <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> @@ -1191,7 +1196,7 @@ 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> +<h2 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></h2> <p>The API is:</p> <pre><code>GET /_synapse/admin/v1/auth_providers/$provider/users/$external_id </code></pre> @@ -1215,7 +1220,7 @@ 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> +<h2 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></h2> <p>The API is:</p> <pre><code>GET /_synapse/admin/v1/threepid/$medium/users/$address </code></pre> |