diff options
| author | Patrick Cloke <patrickc@matrix.org> | 2020-12-04 09:14:31 -0500 |
|---|---|---|
| committer | Patrick Cloke <patrickc@matrix.org> | 2020-12-04 09:14:31 -0500 |
| commit | 112f6bd49e54732e88523533f3b2d4b271be54e1 (patch) | |
| tree | 991e1ed53538e25486ed855c299d3599c380e895 /docs/sso_mapping_providers.md | |
| parent | Fix a buglet in the SAML username mapping provider doc (#8873) (diff) | |
| parent | Minor update to CHANGES. (diff) | |
| download | synapse-112f6bd49e54732e88523533f3b2d4b271be54e1.tar.xz | |
Merge tag 'v1.24.0rc2' into develop
Synapse 1.24.0rc2 (2020-12-04) ============================== Bugfixes -------- - Fix a regression in v1.24.0rc1 which failed to allow SAML mapping providers which were unable to redirect users to an additional page. ([\#8878](https://github.com/matrix-org/synapse/issues/8878)) Internal Changes ---------------- - Add support for the `prometheus_client` newer than 0.9.0. Contributed by Jordan Bancino. ([\#8875](https://github.com/matrix-org/synapse/issues/8875))
Diffstat (limited to 'docs/sso_mapping_providers.md')
| -rw-r--r-- | docs/sso_mapping_providers.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/sso_mapping_providers.md b/docs/sso_mapping_providers.md index c13b4f7155..7714b1d844 100644 --- a/docs/sso_mapping_providers.md +++ b/docs/sso_mapping_providers.md @@ -170,6 +170,13 @@ A custom mapping provider must specify the following methods: the value of `mxid_localpart`. * `emails` - A list of emails for the new user. If not provided, will default to an empty list. + + Alternatively it can raise a `synapse.api.errors.RedirectException` to + redirect the user to another page. This is useful to prompt the user for + additional information, e.g. if you want them to provide their own username. + It is the responsibility of the mapping provider to either redirect back + to `client_redirect_url` (including any additional information) or to + complete registration using methods from the `ModuleApi`. ### Default SAML Mapping Provider |