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.

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.
 #