summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2021-07-01 11:26:24 +0200
committerGitHub <noreply@github.com>2021-07-01 11:26:24 +0200
commit6c02cca95f8136010062b6af0fa36a2906a96a6b (patch)
tree6c95725fd9a35804dd7901b3d3e61e8f529c23fb /docs/admin_api
parentAdd some metrics to staging area (#10284) (diff)
downloadsynapse-6c02cca95f8136010062b6af0fa36a2906a96a6b.tar.xz
Add SSO `external_ids` to Query User Account admin API (#10261)
Related to #10251
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/user_admin_api.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index ef1e735e33..4a65d0c3bc 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/docs/admin_api/user_admin_api.md
@@ -36,7 +36,17 @@ It returns a JSON body like the following:
     "creation_ts": 1560432506,
     "appservice_id": null,
     "consent_server_notice_sent": null,
-    "consent_version": null
+    "consent_version": null,
+    "external_ids": [
+        {
+            "auth_provider": "<provider1>",
+            "external_id": "<user_id_provider_1>"
+        },
+        {
+            "auth_provider": "<provider2>",
+            "external_id": "<user_id_provider_2>"
+        }
+    ]
 }
 ```