summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorBen Banfield-Zanin <benbz@matrix.org>2020-11-19 14:57:13 +0000
committerGitHub <noreply@github.com>2020-11-19 09:57:13 -0500
commit53a6f5ddf0c6bf2a8c8c3b757fb54a0c7755daf7 (patch)
tree9dc5edaf1408de85cc569a0dd12fbe7643ca31cd /docs
parentConsistently use room_id from federation request body (#8776) (diff)
downloadsynapse-53a6f5ddf0c6bf2a8c8c3b757fb54a0c7755daf7.tar.xz
SAML: Allow specifying the IdP entityid to use. (#8630)
If the SAML metadata includes multiple IdPs it is necessary to
specify which IdP to redirect users to for authentication.
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_config.yaml8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index bedc147770..52a1d8b853 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1674,6 +1674,14 @@ saml2_config:
   #  - attribute: department
   #    value: "sales"
 
+  # If the metadata XML contains multiple IdP entities then the `idp_entityid`
+  # option must be set to the entity to redirect users to.
+  #
+  # Most deployments only have a single IdP entity and so should omit this
+  # option.
+  #
+  #idp_entityid: 'https://our_idp/entityid'
+
 
 # Enable OpenID Connect (OIDC) / OAuth 2.0 for registration and login.
 #