summary refs log tree commit diff
path: root/synapse/config/sso.py
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2020-04-24 15:03:49 -0400
committerGitHub <noreply@github.com>2020-04-24 15:03:49 -0400
commit7bfe0902ce2028bf4477f6a5b3bd02ff3877e829 (patch)
tree3897f7f9ed120aa022bea08055547e347c384850 /synapse/config/sso.py
parentConvert some of the federation handler methods to async/await. (#7338) (diff)
downloadsynapse-7bfe0902ce2028bf4477f6a5b3bd02ff3877e829.tar.xz
Add documentation to the sample config about the templates for SSO. (#7343)
Diffstat (limited to 'synapse/config/sso.py')
-rw-r--r--synapse/config/sso.py24
1 files changed, 24 insertions, 0 deletions
diff --git a/synapse/config/sso.py b/synapse/config/sso.py
index 6cd37d4324..cac6bc0139 100644
--- a/synapse/config/sso.py
+++ b/synapse/config/sso.py
@@ -113,6 +113,30 @@ class SSOConfig(Config):
             #
             #     * server_name: the homeserver's name.
             #
+            # * HTML page which notifies the user that they are authenticating to confirm
+            #   an operation on their account during the user interactive authentication
+            #   process: 'sso_auth_confirm.html'.
+            #
+            #   When rendering, this template is given the following variables:
+            #     * redirect_url: the URL the user is about to be redirected to. Needs
+            #                     manual escaping (see
+            #                     https://jinja.palletsprojects.com/en/2.11.x/templates/#html-escaping).
+            #
+            #     * description: the operation which the user is being asked to confirm
+            #
+            # * HTML page shown after a successful user interactive authentication session:
+            #   'sso_auth_success.html'.
+            #
+            #   Note that this page must include the JavaScript which notifies of a successful authentication
+            #   (see https://matrix.org/docs/spec/client_server/r0.6.0#fallback).
+            #
+            #   This template has no additional variables.
+            #
+            # * HTML page shown during single sign-on if a deactivated user (according to Synapse's database)
+            #   attempts to login: 'sso_account_deactivated.html'.
+            #
+            #   This template has no additional variables.
+            #
             # You can see the default templates at:
             # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
             #