From 1fcfd35f261e7076d422d9a635c82f42ba70cced Mon Sep 17 00:00:00 2001
From: Thijs Kinkhorst <thijs@kinkhorst.com>
Date: Wed, 18 Aug 2021 08:26:22 +0000
Subject: [PATCH] Unify Organization* documentation since the SAML spec (and
SSP) requires either all to be specified or none.
---
docs/simplesamlphp-reference-idp-hosted.md | 37 +++++++++-------------
modules/saml/docs/sp.md | 36 ++++++++-------------
2 files changed, 29 insertions(+), 44 deletions(-)
diff --git a/docs/simplesamlphp-reference-idp-hosted.md b/docs/simplesamlphp-reference-idp-hosted.md
index a2ab44be0..17f3a195b 100644
--- a/docs/simplesamlphp-reference-idp-hosted.md
+++ b/docs/simplesamlphp-reference-idp-hosted.md
@@ -83,34 +83,27 @@ Common options
`logouttype`
: The logout handler to use. Either `iframe` or `traditional`. `traditional` is the default.
-`OrganizationName`
-: The name of the organization responsible for this IdP.
- This name does not need to be suitable for display to end users.
+`OrganizationName`, `OrganizationDisplayName`, `OrganizationURL`
+: The name and URL of the organization responsible for this IdP.
+ You need to either specify _all three_ or none of these options.
+
+: The Name does not need to be suitable for display to end users, the DisplayName should be.
+ The URL is a website the user can access for more information about the organization.
: This option can be translated into multiple languages by specifying the value as an array of language-code to translated name:
'OrganizationName' => [
+ 'en' => 'Voorbeeld Organisatie Foundation b.a.',
+ 'nl' => 'Stichting Voorbeeld Organisatie b.a.',
+ ],
+ 'OrganizationDisplayName' => [
'en' => 'Example organization',
- 'no' => 'Eksempel organisation',
+ 'nl' => 'Voorbeeldorganisatie',
+ ],
+ 'OrganizationURL' => [
+ 'en' => 'https://example.com',
+ 'nl' => 'https://example.com/nl',
],
-
-: *Note*: If you specify this option, you must also specify the `OrganizationURL` option.
-
-`OrganizationDisplayName`
-: The name of the organization responsible for this IdP.
- This name must be suitable for display to end users.
- If this option isn't specified, `OrganizationName` will be used instead.
-
-: This option can be translated into multiple languages by specifying the value as an array of language-code to translated name.
-
-: *Note*: If you specify this option, you must also specify the `OrganizationName` option.
-
-`OrganizationURL`
-: A URL the end user can access for more information about the organization.
-
-: This option can be translated into multiple languages by specifying the value as an array of language-code to translated URL.
-
-: *Note*: If you specify this option, you must also specify the `OrganizationName` option.
`privacypolicy`
: This is an absolute URL for where an user can find a
diff --git a/modules/saml/docs/sp.md b/modules/saml/docs/sp.md
index 2de1daf3c..2d6271d77 100644
--- a/modules/saml/docs/sp.md
+++ b/modules/saml/docs/sp.md
@@ -272,35 +272,27 @@ Options
: For compatibility purposes, `null` is equivalent to transient and a format
can be defined as a string instead of an array. These variants are deprecated.
+`OrganizationName`, `OrganizationDisplayName`, `OrganizationURL`
+: The name and URL of the organization responsible for this IdP.
+ You need to either specify _all three_ or none of these options.
-`OrganizationName`
-: The name of the organization responsible for this SP.
- This name does not need to be suitable for display to end users.
+: The Name does not need to be suitable for display to end users, the DisplayName should be.
+ The URL is a website the user can access for more information about the organization.
: This option can be translated into multiple languages by specifying the value as an array of language-code to translated name:
'OrganizationName' => [
+ 'en' => 'Voorbeeld Organisatie Foundation b.a.',
+ 'nl' => 'Stichting Voorbeeld Organisatie b.a.',
+ ],
+ 'OrganizationDisplayName' => [
'en' => 'Example organization',
- 'no' => 'Eksempel organisation',
+ 'nl' => 'Voorbeeldorganisatie',
+ ],
+ 'OrganizationURL' => [
+ 'en' => 'https://example.com',
+ 'nl' => 'https://example.com/nl',
],
-
-: *Note*: If you specify this option, you must also specify the `OrganizationURL` option.
-
-`OrganizationDisplayName`
-: The name of the organization responsible for this SP.
- This name must be suitable for display to end users.
- If this option isn't specified, `OrganizationName` will be used instead.
-
-: This option can be translated into multiple languages by specifying the value as an array of language-code to translated name.
-
-: *Note*: If you specify this option, you must also specify the `OrganizationName` option.
-
-`OrganizationURL`
-: A URL the end user can access for more information about the organization.
-
-: This option can be translated into multiple languages by specifying the value as an array of language-code to translated URL.
-
-: *Note*: If you specify this option, you must also specify the `OrganizationName` option.
`privatekey`
: File name of private key to be used for signing messages and decrypting messages from the IdP. This option is only required if you use encrypted assertions or if you enable signing of messages.
--
GitLab