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

Commit

Permalink
Improve API doc readability (#7527)
Browse files Browse the repository at this point in the history
  • Loading branch information
ptman authored May 19, 2020
1 parent 250f3eb commit ab3e19d
Showing 1 changed file with 11 additions and 10 deletions.
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

0 comments on commit ab3e19d

Please sign in to comment.