diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2021-02-01 18:37:41 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-01 18:37:41 +0000 |
| commit | c543bf87ecf295fa68311beabd1dc013288a2e98 (patch) | |
| tree | 2f779d4c658395bb4ba337e7cb90a3ca998c7be7 /docs | |
| parent | Improve styling and wording of SSO UIA templates (#9286) (diff) | |
| download | synapse-c543bf87ecf295fa68311beabd1dc013288a2e98.tar.xz | |
Collect terms consent from the user during SSO registration (#9276)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 22 | ||||
| -rw-r--r-- | docs/workers.md | 1 |
2 files changed, 23 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index eec082ca8c..15e9746696 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -2003,6 +2003,28 @@ sso: # # * username: the localpart of the user's chosen user id # + # * HTML page allowing the user to consent to the server's terms and + # conditions. This is only shown for new users, and only if + # `user_consent.require_at_registration` is set. + # + # When rendering, this template is given the following variables: + # + # * server_name: the homeserver's name. + # + # * user_id: the user's matrix proposed ID. + # + # * user_profile.display_name: the user's proposed display name, if any. + # + # * consent_version: the version of the terms that the user will be + # shown + # + # * terms_url: a link to the page showing the terms. + # + # The template should render a form which submits the following fields: + # + # * accepted_version: the version of the terms accepted by the user + # (ie, 'consent_version' from the input variables). + # # * HTML page for a confirmation step before redirecting back to the client # with the login token: 'sso_redirect_confirm.html'. # diff --git a/docs/workers.md b/docs/workers.md index 6b8887de36..0da805c333 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -259,6 +259,7 @@ using): ^/_matrix/client/(api/v1|r0|unstable)/login/sso/redirect ^/_synapse/client/pick_idp$ ^/_synapse/client/pick_username + ^/_synapse/client/new_user_consent$ ^/_synapse/client/sso_register$ # OpenID Connect requests. |