diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2020-02-07 11:29:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-07 10:29:36 +0000 |
| commit | 56ca93ef5941b5dfcda368f373a6bcd80d177acd (patch) | |
| tree | 4c153a2fce717773aefcb9010cd3ec3d8fb1b99f /docs/admin_api | |
| parent | remove unused room_version_to_event_format (#6857) (diff) | |
| download | synapse-56ca93ef5941b5dfcda368f373a6bcd80d177acd.tar.xz | |
Admin api to add an email address (#6789)
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst index 0b3d09d694..eb146095de 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst @@ -15,6 +15,16 @@ with a body of: { "password": "user_password", "displayname": "User", + "threepids": [ + { + "medium": "email", + "address": "<user_mail_1>" + }, + { + "medium": "email", + "address": "<user_mail_2>" + } + ], "avatar_url": "<avatar_url>", "admin": false, "deactivated": false @@ -23,6 +33,7 @@ with a body of: including an ``access_token`` of a server admin. The parameter ``displayname`` is optional and defaults to ``user_id``. +The parameter ``threepids`` is optional. The parameter ``avatar_url`` is optional. The parameter ``admin`` is optional and defaults to 'false'. The parameter ``deactivated`` is optional and defaults to 'false'. |