diff options
| author | Richard van der Hoff <richard@matrix.org> | 2021-01-28 22:08:11 +0000 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2021-01-28 22:08:11 +0000 |
| commit | 0d81a6fa3e1dc832f56ed09805229b9089758ba5 (patch) | |
| tree | 08a29e6210ef63c506f8a50944163cdabd400a8b /docs/sample_config.yaml | |
| parent | Ratelimit 3PID /requestToken API (#9238) (diff) | |
| parent | Add 'brand' field to MSC2858 response (#9242) (diff) | |
| download | synapse-0d81a6fa3e1dc832f56ed09805229b9089758ba5.tar.xz | |
Merge branch 'social_login' into develop
Diffstat (limited to 'docs/sample_config.yaml')
| -rw-r--r-- | docs/sample_config.yaml | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index e5b6268087..332befd948 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -1731,10 +1731,14 @@ saml2_config: # offer the user a choice of login mechanisms. # # idp_icon: An optional icon for this identity provider, which is presented -# by identity picker pages. If given, must be an MXC URI of the format -# mxc://<server-name>/<media-id>. (An easy way to obtain such an MXC URI -# is to upload an image to an (unencrypted) room and then copy the "url" -# from the source of the event.) +# by clients and Synapse's own IdP picker page. If given, must be an +# MXC URI of the format mxc://<server-name>/<media-id>. (An easy way to +# obtain such an MXC URI is to upload an image to an (unencrypted) room +# and then copy the "url" from the source of the event.) +# +# idp_brand: An optional brand for this identity provider, allowing clients +# to style the login flow according to the identity provider in question. +# See the spec for possible options here. # # discover: set to 'false' to disable the use of the OIDC discovery mechanism # to discover endpoints. Defaults to true. @@ -1795,9 +1799,9 @@ saml2_config: # # For the default provider, the following settings are available: # -# sub: name of the claim containing a unique identifier for the -# user. Defaults to 'sub', which OpenID Connect compliant -# providers should provide. +# subject_claim: name of the claim containing a unique identifier +# for the user. Defaults to 'sub', which OpenID Connect +# compliant providers should provide. # # localpart_template: Jinja2 template for the localpart of the MXID. # If this is not set, the user will be prompted to choose their @@ -1806,6 +1810,9 @@ saml2_config: # display_name_template: Jinja2 template for the display name to set # on first login. If unset, no displayname will be set. # +# email_template: Jinja2 template for the email address of the user. +# If unset, no email address will be added to the account. +# # extra_attributes: a map of Jinja2 templates for extra attributes # to send back to the client during login. # Note that these are non-standard and clients will ignore them @@ -1841,6 +1848,12 @@ oidc_providers: # userinfo_endpoint: "https://accounts.example.com/userinfo" # jwks_uri: "https://accounts.example.com/.well-known/jwks.json" # skip_verification: true + # user_mapping_provider: + # config: + # subject_claim: "id" + # localpart_template: "{ user.login }" + # display_name_template: "{ user.name }" + # email_template: "{ user.email }" # For use with Keycloak # @@ -1855,6 +1868,7 @@ oidc_providers: # #- idp_id: github # idp_name: Github + # idp_brand: org.matrix.github # discover: false # issuer: "https://github.com/" # client_id: "your-client-id" # TO BE FILLED |