summary refs log tree commit diff
path: root/docs/admin_api/register_api.rst
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2020-11-05 14:55:45 +0100
committerGitHub <noreply@github.com>2020-11-05 13:55:45 +0000
commite4676bd8772275833857c803f8fe4025744cec01 (patch)
treefc51c24cf327979a294a74922ff2205e39ac9df6 /docs/admin_api/register_api.rst
parentConsolidate purge table lists to prevent desyncronisation (#8713) (diff)
downloadsynapse-e4676bd8772275833857c803f8fe4025744cec01.tar.xz
Add `displayname` to Shared-Secret Registration for admins (#8722)
Add `displayname` to Shared-Secret Registration for admins to `POST /_synapse/admin/v1/register`
Diffstat (limited to 'docs/admin_api/register_api.rst')
-rw-r--r--docs/admin_api/register_api.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/admin_api/register_api.rst b/docs/admin_api/register_api.rst
index 3a63109aa0..c3057b204b 100644
--- a/docs/admin_api/register_api.rst
+++ b/docs/admin_api/register_api.rst
@@ -18,7 +18,8 @@ To fetch the nonce, you need to request one from the API::
 
 Once you have the nonce, you can make a ``POST`` to the same URL with a JSON
 body containing the nonce, username, password, whether they are an admin
-(optional, False by default), and a HMAC digest of the content.
+(optional, False by default), and a HMAC digest of the content. Also you can
+set the displayname (optional, ``username`` by default).
 
 As an example::
 
@@ -26,6 +27,7 @@ As an example::
   > {
      "nonce": "thisisanonce",
      "username": "pepper_roni",
+     "displayname": "Pepper Roni",
      "password": "pizza",
      "admin": true,
      "mac": "mac_digest_here"