Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Improve API doc readability #7527

Merged
merged 4 commits into from
May 19, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/admin_api/user_admin_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- ``displayname``, optional, defaults to the value of ``user_id``.

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).
- ``threepids``, optional, allows setting the third-party IDs (email, msisdn)
belonging to a user.

The parameter ``admin`` 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 ``deactivated`` is optional and defaults to ``false``.
- ``admin``, optional, defaults to ``false``.

The parameter ``password`` is optional. If provided, the user's password is
updated and all devices are logged out.
- ``deactivated``, optional, defaults to ``false``.

If the user already exists then optional parameters default to the current value.

Expand Down