diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2022-02-18 12:24:25 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-18 17:24:25 +0000 |
| commit | 444b04058b497da15812d7f14858e6270d54abb5 (patch) | |
| tree | ac8282fb3d09775a8276154636046deb23913879 /synapse/module_api | |
| parent | Track and deduplicate in-flight requests to `_get_state_for_groups`. (#10870) (diff) | |
| download | synapse-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 'synapse/module_api')
| -rw-r--r-- | synapse/module_api/__init__.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/synapse/module_api/__init__.py b/synapse/module_api/__init__.py index 8a17b912d3..07020bfb8d 100644 --- a/synapse/module_api/__init__.py +++ b/synapse/module_api/__init__.py @@ -653,7 +653,11 @@ class ModuleApi: Added in Synapse v1.9.0. Args: - auth_provider: identifier for the remote auth provider + auth_provider: identifier for the remote auth provider, see `sso` and + `oidc_providers` in the homeserver configuration. + + Note that no error is raised if the provided value is not in the + homeserver configuration. external_id: id on that system user_id: complete mxid that it is mapped to """ |