From c38c22f18ea92082416dd04dcac549cc5989959a Mon Sep 17 00:00:00 2001
From: Mads Freek Petersen <freek@wayf.dk>
Date: Tue, 22 Sep 2009 11:32:56 +0000
Subject: [PATCH] Added documentation for scoping.

git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@1773 44740490-163a-0410-bde0-09ae8108e29a
---
 docs/simplesamlphp-reference-sp-hosted.txt | 13 +++++++++++++
 docs/simplesamlphp-reference-sp-remote.txt | 13 +++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/docs/simplesamlphp-reference-sp-hosted.txt b/docs/simplesamlphp-reference-sp-hosted.txt
index 48f7d6df0..5ad22ef41 100644
--- a/docs/simplesamlphp-reference-sp-hosted.txt
+++ b/docs/simplesamlphp-reference-sp-hosted.txt
@@ -128,6 +128,19 @@ These options set the default for this SP, but options for each IdP can be set i
 
      'redirect.sign' => true,
 
+### Fields for scoping
+
+Only relevant if you are a sp connected to a proxy/bridge.
+
+`IDPList`
+: The list of scoped idps ie. the list of entityids for idps that
+are relevant for this sp. The final list is the concatenation of the
+list given as parameter to InitSSO, the list configured at the sp
+(here) and the list configured at the ipd for this sp. The
+intersection of the final list and the idps configured at the
+proxy/bridge will be presented to the user at the discovery service
+if neccessary. If only one idp is in the intersection the
+discoveryservice will go directly to the idp.
 
 Shibboleth 1.3 SP options
 ----------------------
diff --git a/docs/simplesamlphp-reference-sp-remote.txt b/docs/simplesamlphp-reference-sp-remote.txt
index c02b7a937..bda0a01c5 100644
--- a/docs/simplesamlphp-reference-sp-remote.txt
+++ b/docs/simplesamlphp-reference-sp-remote.txt
@@ -247,6 +247,19 @@ These options overrides the options set in `saml20-idp-hosted`.
     'redirect.validate' => TRUE,
     'certificate' => 'server.crt',
 
+### Fields for scoping
+
+Only relevant if you are a proxy/bridge and wants to limit the idps this
+sp can use.
+
+`IDPList`
+: The list of scoped idps ie. the list of entityids for idps that are
+relevant for this sp. The final list is the concatenation of the list
+given as parameter to InitSSO (at the sp), the list configured at the
+sp and the list configured at the ipd (here) for this sp. The intersection
+of the final list and the idps configured at the at this idp will be
+presented to the user at the discovery service if neccessary. If only one 
+idp is in the intersection the discoveryservice will go directly to the idp.
 
 Shibboleth 1.3 options
 ----------------------
-- 
GitLab