Skip to content
Snippets Groups Projects
Commit 1fcfd35f authored by Thijs Kinkhorst's avatar Thijs Kinkhorst
Browse files

Unify Organization* documentation since the SAML spec (and SSP) requires...

Unify Organization* documentation since the SAML spec (and SSP) requires either all to be specified or none.
parent e01faeb8
No related branches found
No related tags found
No related merge requests found
...@@ -83,34 +83,27 @@ Common options ...@@ -83,34 +83,27 @@ Common options
`logouttype` `logouttype`
: The logout handler to use. Either `iframe` or `traditional`. `traditional` is the default. : The logout handler to use. Either `iframe` or `traditional`. `traditional` is the default.
`OrganizationName` `OrganizationName`, `OrganizationDisplayName`, `OrganizationURL`
: The name of the organization responsible for this IdP. : The name and URL of the organization responsible for this IdP.
This name does not need to be suitable for display to end users. 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: : This option can be translated into multiple languages by specifying the value as an array of language-code to translated name:
'OrganizationName' => [ 'OrganizationName' => [
'en' => 'Voorbeeld Organisatie Foundation b.a.',
'nl' => 'Stichting Voorbeeld Organisatie b.a.',
],
'OrganizationDisplayName' => [
'en' => 'Example organization', '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` `privacypolicy`
: This is an absolute URL for where an user can find a : This is an absolute URL for where an user can find a
......
...@@ -272,35 +272,27 @@ Options ...@@ -272,35 +272,27 @@ Options
: For compatibility purposes, `null` is equivalent to transient and a format : 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. 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 does not need to be suitable for display to end users, the DisplayName should be.
: The name of the organization responsible for this SP. The URL is a website the user can access for more information about the organization.
This name does not need to be suitable for display to end users.
: This option can be translated into multiple languages by specifying the value as an array of language-code to translated name: : This option can be translated into multiple languages by specifying the value as an array of language-code to translated name:
'OrganizationName' => [ 'OrganizationName' => [
'en' => 'Voorbeeld Organisatie Foundation b.a.',
'nl' => 'Stichting Voorbeeld Organisatie b.a.',
],
'OrganizationDisplayName' => [
'en' => 'Example organization', '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` `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. : 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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment