summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2022-02-18 12:24:25 -0500
committerGitHub <noreply@github.com>2022-02-18 17:24:25 +0000
commit444b04058b497da15812d7f14858e6270d54abb5 (patch)
treeac8282fb3d09775a8276154636046deb23913879 /docs/admin_api
parentTrack and deduplicate in-flight requests to `_get_state_for_groups`. (#10870) (diff)
downloadsynapse-444b04058b497da15812d7f14858e6270d54abb5.tar.xz
Document why auth providers aren't validated in the admin API. (#12004)
Since it is reasonable to give a future or past auth provider,
which might not be in the current configuration.
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/user_admin_api.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index 1bbe237080..4076fcab65 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/docs/admin_api/user_admin_api.md
@@ -126,7 +126,8 @@ Body parameters:
   [Sample Configuration File](../usage/configuration/homeserver_sample_config.html)
   section `sso` and `oidc_providers`.
   - `auth_provider` - string. ID of the external identity provider. Value of `idp_id`
-    in homeserver configuration.
+    in the homeserver configuration. Note that no error is raised if the provided
+    value is not in the homeserver configuration.
   - `external_id` - string, user ID in the external identity provider.
 - `avatar_url` - string, optional, must be a
   [MXC URI](https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris).