summary refs log tree commit diff
path: root/develop/admin_api
diff options
context:
space:
mode:
authoranoadragon453 <anoadragon453@users.noreply.github.com>2022-01-14 14:54:00 +0000
committeranoadragon453 <anoadragon453@users.noreply.github.com>2022-01-14 14:54:00 +0000
commite58a7087c62dfe1c95285298b25ff6cb9cd43961 (patch)
tree35b9e713dcb76ed88aa5342d6918b16f4680c169 /develop/admin_api
parentdeploy: 904bb044097a34ff37d06a92da4a1a39f2a9282b (diff)
downloadsynapse-e58a7087c62dfe1c95285298b25ff6cb9cd43961.tar.xz
deploy: 18862f20b5495bdc556c54e92fd4b1efdc718ba7
Diffstat (limited to 'develop/admin_api')
-rw-r--r--develop/admin_api/user_admin_api.html9
1 files changed, 5 insertions, 4 deletions
diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html
index ee311329a5..5e10a62d64 100644
--- a/develop/admin_api/user_admin_api.html
+++ b/develop/admin_api/user_admin_api.html
@@ -191,8 +191,9 @@
 <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a
 server admin: <a href="../usage/administration/admin_api">Admin API</a></p>
 <p>It returns a JSON body like the following:</p>
-<pre><code class="language-json">{
-    &quot;displayname&quot;: &quot;User&quot;,
+<pre><code class="language-jsonc">{
+    &quot;name&quot;: &quot;@user:example.com&quot;,
+    &quot;displayname&quot;: &quot;User&quot;, // can be null if not set
     &quot;threepids&quot;: [
         {
             &quot;medium&quot;: &quot;email&quot;,
@@ -207,11 +208,11 @@ server admin: <a href="../usage/administration/admin_api">Admin API</a></p>
             &quot;validated_at&quot;: 1586458409743
         }
     ],
-    &quot;avatar_url&quot;: &quot;&lt;avatar_url&gt;&quot;,
+    &quot;avatar_url&quot;: &quot;&lt;avatar_url&gt;&quot;,  // can be null if not set
+    &quot;is_guest&quot;: 0,
     &quot;admin&quot;: 0,
     &quot;deactivated&quot;: 0,
     &quot;shadow_banned&quot;: 0,
-    &quot;password_hash&quot;: &quot;$2b$12$p9B4GkqYdRTPGD&quot;,
     &quot;creation_ts&quot;: 1560432506,
     &quot;appservice_id&quot;: null,
     &quot;consent_server_notice_sent&quot;: null,