summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2020-03-23 17:10:32 +0000
committerAndrew Morgan <andrew@amorgan.xyz>2020-03-23 17:10:32 +0000
commit3b0ce55bf7f43f41a33cefd657dd731f1de7d3c4 (patch)
treeef67907f5bde30eaba755c260353bb6c73d47312 /docs/admin_api
parentremove unused room_version_to_event_format (#6857) (diff)
parentAdmin api to add an email address (#6789) (diff)
downloadsynapse-3b0ce55bf7f43f41a33cefd657dd731f1de7d3c4.tar.xz
Admin api to add an email address (#6789)
* commit '56ca93ef5':
  Admin api to add an email address (#6789)
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/user_admin_api.rst11
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 ed6df61a26..6b02d963e6 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst
@@ -16,6 +16,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 @@ -24,6 +34,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'.