Add a comment about SAML 1 vs 2 names

diff --git a/configs/attribute-map.xml b/configs/attribute-map.xml
index dc61901..8dd4073 100644 (file)
--- a/configs/attribute-map.xml
+++ b/configs/attribute-map.xml
@@ -1,5 +1,12 @@
 <Attributes xmlns="urn:mace:shibboleth:2.0:attribute-map" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
+    <!--
+    The mappings are a mix of SAML 1.1 and SAML 2.0 attribute names agreed to within the Shibboleth
+    community. The non-OID URNs are SAML 1.1 names and most of the OIDs are SAML 2.0 names, with a
+    few exceptions for newer attributes where the name is the same for both versions. You will
+    usually want to uncomment or map the names for both SAML versions as a unit.
+    -->
+    
     <!-- First some useful eduPerson attributes that many sites might use. -->
     
     <Attribute name="urn:mace:dir:attribute-def:eduPersonPrincipalName" id="eppn">
@@ -77,11 +84,12 @@
     <Attribute name="urn:oid:1.3.6.1.4.1.5923.1.6.1.2" id="eduCourseMember"/>
     -->
 
-    <!--Examples of LDAP-based attributes, uncomment to use these... -->
+    <!-- Examples of LDAP-based attributes, uncomment to use these... -->
     <!--
     <Attribute name="urn:mace:dir:attribute-def:cn" id="cn"/>
     <Attribute name="urn:mace:dir:attribute-def:sn" id="sn"/>
     <Attribute name="urn:mace:dir:attribute-def:givenName" id="givenName"/>
+    <Attribute name="urn:mace:dir:attribute-def:displayName" id="displayName"/>
     <Attribute name="urn:mace:dir:attribute-def:mail" id="mail"/>
     <Attribute name="urn:mace:dir:attribute-def:telephoneNumber" id="telephoneNumber"/>
     <Attribute name="urn:mace:dir:attribute-def:title" id="title"/>
@@ -89,7 +97,6 @@
     <Attribute name="urn:mace:dir:attribute-def:description" id="description"/>
     <Attribute name="urn:mace:dir:attribute-def:carLicense" id="carLicense"/>
     <Attribute name="urn:mace:dir:attribute-def:departmentNumber" id="departmentNumber"/>
-    <Attribute name="urn:mace:dir:attribute-def:displayName" id="displayName"/>
     <Attribute name="urn:mace:dir:attribute-def:employeeNumber" id="employeeNumber"/>
     <Attribute name="urn:mace:dir:attribute-def:employeeType" id="employeeType"/>
     <Attribute name="urn:mace:dir:attribute-def:preferredLanguage" id="preferredLanguage"/>
@@ -109,6 +116,7 @@
     <Attribute name="urn:oid:2.5.4.3" id="cn"/>
     <Attribute name="urn:oid:2.5.4.4" id="sn"/>
     <Attribute name="urn:oid:2.5.4.42" id="givenName"/>
+    <Attribute name="urn:oid:2.16.840.1.113730.3.1.241" id="displayName"/>
     <Attribute name="urn:oid:0.9.2342.19200300.100.1.3" id="mail"/>
     <Attribute name="urn:oid:2.5.4.20" id="telephoneNumber"/>
     <Attribute name="urn:oid:2.5.4.12" id="title"/>
@@ -119,7 +127,6 @@
     <Attribute name="urn:oid:2.16.840.1.113730.3.1.3" id="employeeNumber"/>
     <Attribute name="urn:oid:2.16.840.1.113730.3.1.4" id="employeeType"/>
     <Attribute name="urn:oid:2.16.840.1.113730.3.1.39" id="preferredLanguage"/>
-    <Attribute name="urn:oid:2.16.840.1.113730.3.1.241" id="displayName"/>
     <Attribute name="urn:oid:0.9.2342.19200300.100.1.10" id="manager"/>
     <Attribute name="urn:oid:2.5.4.34" id="seeAlso"/>
     <Attribute name="urn:oid:2.5.4.23" id="facsimileTelephoneNumber"/>