diff options
author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2021-02-01 18:36:04 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-01 18:36:04 +0000 |
commit | e5d70c8a82f5d615dbdc7f7aa69288681ba2e9f5 (patch) | |
tree | 4b95eb05a269630448ee2904867234aba4faa8b6 /docs/sample_config.yaml | |
parent | Improve styling and wording of SSO error templates (#9287) (diff) | |
download | synapse-e5d70c8a82f5d615dbdc7f7aa69288681ba2e9f5.tar.xz |
Improve styling and wording of SSO UIA templates (#9286)
fixes #9171
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r-- | docs/sample_config.yaml | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index a6fbcc6080..eec082ca8c 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1958,8 +1958,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: @@ -2037,6 +2042,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'. # |