summary refs log tree commit diff
path: root/docs/sso_mapping_providers.md
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2020-12-04 08:25:15 -0500
committerGitHub <noreply@github.com>2020-12-04 08:25:15 -0500
commit22c6c19f91d7325c82eddfada696826adad69e5b (patch)
tree7948c3f80aff6ad6f2ff11e2a56676a70c3346b5 /docs/sso_mapping_providers.md
parentRemove version pin prometheus_client dependency (#8875) (diff)
downloadsynapse-22c6c19f91d7325c82eddfada696826adad69e5b.tar.xz
Fix a regression that mapping providers should be able to redirect users. (#8878)
This was broken in #8801.
Diffstat (limited to 'docs/sso_mapping_providers.md')
-rw-r--r--docs/sso_mapping_providers.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/sso_mapping_providers.md b/docs/sso_mapping_providers.md
index dee53b5d40..ab2a648910 100644
--- a/docs/sso_mapping_providers.md
+++ b/docs/sso_mapping_providers.md
@@ -168,6 +168,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