From 9d32fdf0960ac41df2c011ce27cd83f09cbc9428 Mon Sep 17 00:00:00 2001
From: Olav Morken <olav.morken@uninett.no>
Date: Tue, 6 Mar 2012 06:48:55 +0000
Subject: [PATCH] docs: Add better description for simplesaml.nameidattribute.
(Also fixes a couple of formatting errors.)
Thanks to Thijs Kinkhorst for providing this patch.
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@3036 44740490-163a-0410-bde0-09ae8108e29a
---
docs/simplesamlphp-reference-sp-remote.txt | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/docs/simplesamlphp-reference-sp-remote.txt b/docs/simplesamlphp-reference-sp-remote.txt
index 20a6fda34..a3d9c68c4 100644
--- a/docs/simplesamlphp-reference-sp-remote.txt
+++ b/docs/simplesamlphp-reference-sp-remote.txt
@@ -206,14 +206,14 @@ The following SAML 2.0 options are available:
unset.)
`saml20.sign.response`
-: Whether `<samlp:Response> messages should be signed.
+: Whether `<samlp:Response>` messages should be signed.
Defaults to `TRUE`.
: Note that this option also exists in the IdP-hosted metadata.
The value in the SP-remote metadata overrides the value in the IdP-hosted metadata.
`saml20.sign.assertion`
-: Whether `<saml:Assertion> elements should be signed.
+: Whether `<saml:Assertion>` elements should be signed.
Defaults to `TRUE`.
: Note that this option also exists in the IdP-hosted metadata.
@@ -222,7 +222,11 @@ The following SAML 2.0 options are available:
`simplesaml.nameidattribute`
: When the value of the `NameIDFormat`-option is set to either
`email` or `persistent`, this is the name of the attribute which
- should be used as the value of the `NameID`.
+ should be used as the value of the `NameID`. The attribute must
+ be in the set of attributes exported to the SP (that is, be in
+ the `attributes` array). For more advanced control over `NameID`,
+ including the ability to specify any attribute regardless of
+ the set sent to the SP, see the [NameID processing filters](./saml:nameid).
: Typical values can be `mail` for when using the `email` format,
and `eduPersonTargetedID` when using the `persistent` format.
--
GitLab