From 9c779e80d52fe68277e91adc810e4c4611dcfb54 Mon Sep 17 00:00:00 2001 From: Guy Halse <guy@tenet.ac.za> Date: Thu, 19 Jul 2018 22:50:40 +0200 Subject: [PATCH] Improve documentation for cardinality authproc filter --- docs/simplesamlphp-authproc.md | 2 ++ modules/core/docs/authproc_cardinality.md | 2 ++ modules/core/docs/authproc_cardinalitysingle.md | 2 +- 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/simplesamlphp-authproc.md b/docs/simplesamlphp-authproc.md index be91c4207..d082a8255 100644 --- a/docs/simplesamlphp-authproc.md +++ b/docs/simplesamlphp-authproc.md @@ -132,6 +132,8 @@ The following filters are included in the SimpleSAMLphp distribution: - [`core:AttributeLimit`](./core:authproc_attributelimit): Limit the attributes in the response. - [`core:AttributeMap`](./core:authproc_attributemap): Change the name of the attributes. - [`core:AttributeRealm`](./core:authproc_attributerealm): (deprecated) Create an attribute with the realm of the user. +- [`core:Cardinality`](./core:authproc_cardinality): Ensure the number of attribute values is within the specified multiplicity. +- [`core:CardinalitySingle`](./core:authproc_cardinalitysingle): Ensure the correct cardinality of single-valued attributes. - [`core:GenerateGroups`](./core:authproc_generategroups): Generate a `group` attribute for the user. - [`core:LanguageAdaptor`](./core:authproc_languageadaptor): Transfering language setting from IdP to SP. - [`core:PHP`](./core:authproc_php): Modify attributes with custom PHP code. diff --git a/modules/core/docs/authproc_cardinality.md b/modules/core/docs/authproc_cardinality.md index 0902bf278..97b73f866 100644 --- a/modules/core/docs/authproc_cardinality.md +++ b/modules/core/docs/authproc_cardinality.md @@ -7,6 +7,8 @@ This filter should contain a set of attribute name => rule pairs describing the The special parameter `%ignoreEntities` can be used to give an array of entity IDs that should be ignored for testing, etc purposes. +A separate [`core:CardinalitySingle`](./core:authproc_cardinalitysingle) authproc filter provides additional functionality for the special case where attributes are single valued. + Specifying Rules ---------------- diff --git a/modules/core/docs/authproc_cardinalitysingle.md b/modules/core/docs/authproc_cardinalitysingle.md index 4a61bdbc5..62d2fa799 100644 --- a/modules/core/docs/authproc_cardinalitysingle.md +++ b/modules/core/docs/authproc_cardinalitysingle.md @@ -2,7 +2,7 @@ ======================== Ensure the correct cardinality of single-valued attributes. This filter is a special case -of the more generic [core:Cardinality] filter that allows for optional corrective measures +of the more generic [`core:Cardinality`](./core:authproc_cardinality) filter that allows for optional corrective measures when multi-valued attributes are received where single-valued ones are expected. Parameters -- GitLab