summary refs log tree commit diff
path: root/develop/admin_api
diff options
context:
space:
mode:
authorbabolivier <babolivier@users.noreply.github.com>2021-10-26 09:01:49 +0000
committerbabolivier <babolivier@users.noreply.github.com>2021-10-26 09:01:49 +0000
commit78a3153e70bf8bd8a094900f6ecf9221a36258ae (patch)
tree3aa47f6cd6356dff58f9f4156d3dbb2b43b8b368 /develop/admin_api
parentdeploy: b0f03aeb6a02a5c152f769cea4992079609481d1 (diff)
downloadsynapse-78a3153e70bf8bd8a094900f6ecf9221a36258ae.tar.xz
deploy: 63cbdd8af081839f245915a18ed57f1a44f1a5f4
Diffstat (limited to 'develop/admin_api')
-rw-r--r--develop/admin_api/user_admin_api.html9
1 files changed, 7 insertions, 2 deletions
diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html
index 4ee41e96cf..02c27d25d2 100644
--- a/develop/admin_api/user_admin_api.html
+++ b/develop/admin_api/user_admin_api.html
@@ -225,7 +225,8 @@ server admin: <a href="../usage/administration/admin_api">Admin API</a></p>
             &quot;auth_provider&quot;: &quot;&lt;provider2&gt;&quot;,
             &quot;external_id&quot;: &quot;&lt;user_id_provider_2&gt;&quot;
         }
-    ]
+    ],
+    &quot;user_type&quot;: null
 }
 </code></pre>
 <p>URL parameters:</p>
@@ -264,7 +265,8 @@ specific <code>user_id</code>.</p>
     ],
     &quot;avatar_url&quot;: &quot;&lt;avatar_url&gt;&quot;,
     &quot;admin&quot;: false,
-    &quot;deactivated&quot;: false
+    &quot;deactivated&quot;: false,
+    &quot;user_type&quot;: null
 }
 </code></pre>
 <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a
@@ -307,6 +309,9 @@ in homeserver configuration.</li>
 unchanged on existing accounts and set to <code>false</code> for new accounts.
 A user cannot be erased by deactivating with this API. For details on
 deactivating users see <a href="#deactivate-account">Deactivate Account</a>.</li>
+<li><code>user_type</code> - string or null, optional. If provided, the user type will be
+adjusted. If <code>null</code> given, the user type will be cleared. Other 
+allowed options are: <code>bot</code> and <code>support</code>.</li>
 </ul>
 <p>If the user already exists then optional parameters default to the current value.</p>
 <p>In order to re-activate an account <code>deactivated</code> must be set to <code>false</code>. If