summary refs log tree commit diff
path: root/latest/admin_api/user_admin_api.html
diff options
context:
space:
mode:
authorerikjohnston <erikjohnston@users.noreply.github.com>2023-06-06 09:50:03 +0000
committererikjohnston <erikjohnston@users.noreply.github.com>2023-06-06 09:50:03 +0000
commitbf6393f5a8057d57dee034d3dd546955cd12b434 (patch)
tree09140d6c755e7c35763483f6a7eb8dc7301e71e4 /latest/admin_api/user_admin_api.html
parentdeploy: 8af29155ececd8fb18e54241012d73d60c33a79f (diff)
downloadsynapse-bf6393f5a8057d57dee034d3dd546955cd12b434.tar.xz
deploy: ec71214243eac58a4a6d272c15441a6405f6ae9c
Diffstat (limited to 'latest/admin_api/user_admin_api.html')
-rw-r--r--latest/admin_api/user_admin_api.html20
1 files changed, 20 insertions, 0 deletions
diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html

index 55af2cadb6..c7322cb65f 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html
@@ -878,6 +878,26 @@ devices was last seen. (May be a few minutes out of date, for efficiency reasons <p><code>total</code> - Total number of user's devices.</p> </li> </ul> +<h3 id="create-a-device"><a class="header" href="#create-a-device">Create a device</a></h3> +<p>Creates a new device for a specific <code>user_id</code> and <code>device_id</code>. Does nothing if the <code>device_id</code> +exists already.</p> +<p>The API is:</p> +<pre><code>POST /_synapse/admin/v2/users/&lt;user_id&gt;/devices + +{ + &quot;device_id&quot;: &quot;QBUAZIFURK&quot; +} +</code></pre> +<p>An empty JSON dict is returned.</p> +<p><strong>Parameters</strong></p> +<p>The following parameters should be set in the URL:</p> +<ul> +<li><code>user_id</code> - fully qualified: for example, <code>@user:server.com</code>.</li> +</ul> +<p>The following fields are required in the JSON request body:</p> +<ul> +<li><code>device_id</code> - The device ID to create.</li> +</ul> <h3 id="delete-multiple-devices"><a class="header" href="#delete-multiple-devices">Delete multiple devices</a></h3> <p>Deletes the given devices for a specific <code>user_id</code>, and invalidates any access token associated with them.</p>