mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-21 17:15:38 +03:00
deploy: 3bcd525b46
This commit is contained in:
richvdh
parent
42e3f6b862
commit
b6e62fe9db
4 changed files with 78 additions and 42 deletions
|
|
@ -248,6 +248,16 @@ specific <code>user_id</code>.</p>
|
|||
"address": "<user_mail_2>"
|
||||
}
|
||||
],
|
||||
"external_ids": [
|
||||
{
|
||||
"auth_provider": "<provider1>",
|
||||
"external_id": "<user_id_provider_1>"
|
||||
},
|
||||
{
|
||||
"auth_provider": "<provider2>",
|
||||
"external_id": "<user_id_provider_2>"
|
||||
}
|
||||
],
|
||||
"avatar_url": "<avatar_url>",
|
||||
"admin": false,
|
||||
"deactivated": false
|
||||
|
|
@ -255,36 +265,44 @@ specific <code>user_id</code>.</p>
|
|||
</code></pre>
|
||||
<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>
|
||||
<p>Returns HTTP status code:</p>
|
||||
<ul>
|
||||
<li><code>201</code> - When a new user object was created.</li>
|
||||
<li><code>200</code> - When a user was modified.</li>
|
||||
</ul>
|
||||
<p>URL parameters:</p>
|
||||
<ul>
|
||||
<li><code>user_id</code>: fully-qualified user id: for example, <code>@user:server.com</code>.</li>
|
||||
</ul>
|
||||
<p>Body parameters:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>password</code>, optional. If provided, the user's password is updated and all
|
||||
devices are logged out.</p>
|
||||
<li><code>password</code> - string, optional. If provided, the user's password is updated and all
|
||||
devices are logged out.</li>
|
||||
<li><code>displayname</code> - string, optional, defaults to the value of <code>user_id</code>.</li>
|
||||
<li><code>threepids</code> - array, optional, allows setting the third-party IDs (email, msisdn)
|
||||
<ul>
|
||||
<li><code>medium</code> - string. Kind of third-party ID, either <code>email</code> or <code>msisdn</code>.</li>
|
||||
<li><code>address</code> - string. Value of third-party ID.
|
||||
belonging to a user.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>displayname</code>, optional, defaults to the value of <code>user_id</code>.</p>
|
||||
<li><code>external_ids</code> - array, optional. Allow setting the identifier of the external identity
|
||||
provider for SSO (Single sign-on). Details in
|
||||
<a href="../usage/configuration/homeserver_sample_config.html">Sample Configuration File</a>
|
||||
section <code>sso</code> and <code>oidc_providers</code>.
|
||||
<ul>
|
||||
<li><code>auth_provider</code> - string. ID of the external identity provider. Value of <code>idp_id</code>
|
||||
in homeserver configuration.</li>
|
||||
<li><code>external_id</code> - string, user ID in the external identity provider.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>threepids</code>, optional, allows setting the third-party IDs (email, msisdn)
|
||||
belonging to a user.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>avatar_url</code>, optional, must be a
|
||||
<a href="https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris">MXC URI</a>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>admin</code>, optional, defaults to <code>false</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>deactivated</code>, optional. If unspecified, deactivation state will be left
|
||||
<li><code>avatar_url</code> - string, optional, must be a
|
||||
<a href="https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris">MXC URI</a>.</li>
|
||||
<li><code>admin</code> - bool, optional, defaults to <code>false</code>.</li>
|
||||
<li><code>deactivated</code> - bool, optional. If unspecified, deactivation state will be left
|
||||
unchanged on existing accounts and set to <code>false</code> for new accounts.
|
||||
A user cannot be erased by deactivating with this API. For details on
|
||||
deactivating users see <a href="#deactivate-account">Deactivate Account</a>.</p>
|
||||
</li>
|
||||
deactivating users see <a href="#deactivate-account">Deactivate Account</a>.</li>
|
||||
</ul>
|
||||
<p>If the user already exists then optional parameters default to the current value.</p>
|
||||
<p>In order to re-activate an account <code>deactivated</code> must be set to <code>false</code>. If
|
||||
|
|
|
|||
|
|
@ -9969,6 +9969,16 @@ specific <code>user_id</code>.</p>
|
|||
"address": "<user_mail_2>"
|
||||
}
|
||||
],
|
||||
"external_ids": [
|
||||
{
|
||||
"auth_provider": "<provider1>",
|
||||
"external_id": "<user_id_provider_1>"
|
||||
},
|
||||
{
|
||||
"auth_provider": "<provider2>",
|
||||
"external_id": "<user_id_provider_2>"
|
||||
}
|
||||
],
|
||||
"avatar_url": "<avatar_url>",
|
||||
"admin": false,
|
||||
"deactivated": false
|
||||
|
|
@ -9976,36 +9986,44 @@ specific <code>user_id</code>.</p>
|
|||
</code></pre>
|
||||
<p>To use it, you will need to authenticate by providing an <code>access_token</code> for a
|
||||
server admin: <a href="admin_api/../usage/administration/admin_api">Admin API</a></p>
|
||||
<p>Returns HTTP status code:</p>
|
||||
<ul>
|
||||
<li><code>201</code> - When a new user object was created.</li>
|
||||
<li><code>200</code> - When a user was modified.</li>
|
||||
</ul>
|
||||
<p>URL parameters:</p>
|
||||
<ul>
|
||||
<li><code>user_id</code>: fully-qualified user id: for example, <code>@user:server.com</code>.</li>
|
||||
</ul>
|
||||
<p>Body parameters:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><code>password</code>, optional. If provided, the user's password is updated and all
|
||||
devices are logged out.</p>
|
||||
<li><code>password</code> - string, optional. If provided, the user's password is updated and all
|
||||
devices are logged out.</li>
|
||||
<li><code>displayname</code> - string, optional, defaults to the value of <code>user_id</code>.</li>
|
||||
<li><code>threepids</code> - array, optional, allows setting the third-party IDs (email, msisdn)
|
||||
<ul>
|
||||
<li><code>medium</code> - string. Kind of third-party ID, either <code>email</code> or <code>msisdn</code>.</li>
|
||||
<li><code>address</code> - string. Value of third-party ID.
|
||||
belonging to a user.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>displayname</code>, optional, defaults to the value of <code>user_id</code>.</p>
|
||||
<li><code>external_ids</code> - array, optional. Allow setting the identifier of the external identity
|
||||
provider for SSO (Single sign-on). Details in
|
||||
<a href="admin_api/../usage/configuration/homeserver_sample_config.html">Sample Configuration File</a>
|
||||
section <code>sso</code> and <code>oidc_providers</code>.
|
||||
<ul>
|
||||
<li><code>auth_provider</code> - string. ID of the external identity provider. Value of <code>idp_id</code>
|
||||
in homeserver configuration.</li>
|
||||
<li><code>external_id</code> - string, user ID in the external identity provider.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>threepids</code>, optional, allows setting the third-party IDs (email, msisdn)
|
||||
belonging to a user.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>avatar_url</code>, optional, must be a
|
||||
<a href="https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris">MXC URI</a>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>admin</code>, optional, defaults to <code>false</code>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>deactivated</code>, optional. If unspecified, deactivation state will be left
|
||||
<li><code>avatar_url</code> - string, optional, must be a
|
||||
<a href="https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris">MXC URI</a>.</li>
|
||||
<li><code>admin</code> - bool, optional, defaults to <code>false</code>.</li>
|
||||
<li><code>deactivated</code> - bool, optional. If unspecified, deactivation state will be left
|
||||
unchanged on existing accounts and set to <code>false</code> for new accounts.
|
||||
A user cannot be erased by deactivating with this API. For details on
|
||||
deactivating users see <a href="admin_api/user_admin_api.html#deactivate-account">Deactivate Account</a>.</p>
|
||||
</li>
|
||||
deactivating users see <a href="admin_api/user_admin_api.html#deactivate-account">Deactivate Account</a>.</li>
|
||||
</ul>
|
||||
<p>If the user already exists then optional parameters default to the current value.</p>
|
||||
<p>In order to re-activate an account <code>deactivated</code> must be set to <code>false</code>. If
|
||||
|
|
|
|||
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