From 486019057a34015d994e861bc3e90c6b7c491e99 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 22 Nov 2022 12:22:40 +0000 Subject: deploy: ececb2d6cb272723f1f79a4710ee04b218307475 --- latest/admin_api/user_admin_api.html | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) (limited to 'latest/admin_api/user_admin_api.html') diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html index 650e3a00ed..5f4cc6c351 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html @@ -76,7 +76,7 @@ @@ -1166,6 +1166,30 @@ for more information.

}

Added in Synapse 1.68.0.

+

Find a user based on their Third Party ID (ThreePID or 3PID)

+

The API is:

+
GET /_synapse/admin/v1/threepid/$medium/users/$address
+
+

When a user matched the given address for the given medium, an HTTP code 200 with a response body like the following is returned:

+
{
+    "user_id": "@hello:example.org"
+}
+
+

Parameters

+

The following parameters should be set in the URL:

+ +

The address may have characters that are not URL-safe, so it is advised to URL-encode those parameters.

+

Errors

+

Returns a 404 HTTP status code if no user was found, with a response body like this:

+
{
+    "errcode":"M_NOT_FOUND",
+    "error":"User not found"
+}
+
+

Added in Synapse 1.72.0.

-- cgit 1.5.1