diff options
| author | Richard van der Hoff <richard@matrix.org> | 2021-02-01 18:46:12 +0000 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2021-02-01 18:46:12 +0000 |
| commit | 5963426b957d9f312817e0f3e4f44b753f8e2398 (patch) | |
| tree | 217afd1d90cc7c0cb217158e5849dc011fbea5c4 /docs | |
| parent | Refactor email summary generation. (#9260) (diff) | |
| parent | make primary button not wider than viewport (diff) | |
| download | synapse-5963426b957d9f312817e0f3e4f44b753f8e2398.tar.xz | |
Merge branch 'social_login' into develop
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 37 | ||||
| -rw-r--r-- | docs/workers.md | 1 |
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index a669a241da..dd2981717d 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1968,8 +1968,13 @@ sso: # # * providers: a list of available Identity Providers. Each element is # an object with the following attributes: + # # * idp_id: unique identifier for the IdP # * idp_name: user-facing name for the IdP + # * idp_icon: if specified in the IdP config, an MXC URI for an icon + # for the IdP + # * idp_brand: if specified in the IdP config, a textual identifier + # for the brand of the IdP # # The rendered HTML page should contain a form which submits its results # back as a GET request, with the following query parameters: @@ -2008,6 +2013,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'. # @@ -2047,6 +2074,16 @@ sso: # # * description: the operation which the user is being asked to confirm # + # * idp: details of the Identity Provider that we will use to confirm + # the user's identity: an object with the following attributes: + # + # * idp_id: unique identifier for the IdP + # * idp_name: user-facing name for the IdP + # * idp_icon: if specified in the IdP config, an MXC URI for an icon + # for the IdP + # * idp_brand: if specified in the IdP config, a textual identifier + # for the brand of the IdP + # # * HTML page shown after a successful user interactive authentication session: # 'sso_auth_success.html'. # diff --git a/docs/workers.md b/docs/workers.md index bd8c9f95cb..c36549c621 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -262,6 +262,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. |