Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve API doc readability (#7527)

This commit is contained in:
Paul Tötterman 2020-05-19 13:20:23 +03:00 committed by GitHub
parent 250f3eb991
commit ab3e19d814
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/admin_api/user_admin_api.rst
View File

@ -33,21 +33,22 @@ with a body of:
including an ``access_token`` of a server admin.
The parameter ``displayname`` is optional and defaults to the value of
``user_id``.
Parameters:
The parameter ``threepids`` is optional and allows setting the third-party IDs
(email, msisdn) belonging to a user.
- ``password``, optional. If provided, the user's password is updated and all
devices are logged out.
The parameter ``avatar_url`` is optional. Must be a [MXC
URI](https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris).
- ``displayname``, optional, defaults to the value of ``user_id``.
The parameter ``admin`` is optional and defaults to ``false``.
- ``threepids``, optional, allows setting the third-party IDs (email, msisdn)
belonging to a user.
The parameter ``deactivated`` is optional and defaults to ``false``.
- ``avatar_url``, optional, must be a
`MXC URI <https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris>`_.
The parameter ``password`` is optional. If provided, the user's password is
updated and all devices are logged out.
- ``admin``, optional, defaults to ``false``.
- ``deactivated``, optional, defaults to ``false``.
If the user already exists then optional parameters default to the current value.