The following may be specified for all types of Session Initiator
Name | Type | Default | Description |
---|---|---|---|
type | string | required | Plugin type name. |
Location
Location | relative path | The location of |
SessionInitiator
the SessionInitiator (when combined with the |
handlerURL
base handlerURL). This is the location to redirect to when manually initiating a session using the Initiator protocol (query string) |
id
id | string | optional | Identifies |
SessionInitiator
so a SessionInitiator so that it can be referenced by |
requireSessionWith
the requireSessionWith content setting. |
isDefault
isDefault | boolean | If true, establishes the |
SessionInitiator
used default SessionInitiator used implicitly for content protected with |
requireSession
the requireSession content setting. If none are labeled, the first is implicitly the default. |
entityID
entityID | URI | If set, establishes an assumed IdP to use for authentication, if none is passed explicitly with a query string parameter or overridden via content settings. |
relayState
relayState | string | Controls how information associated with the session request, primarily the original resource accessed, is preserved for the completion of the authentication process. Overrides the like-named attribute in the <Sessions> element. |
acsIndex
acsIndex | string | This matches |
index
of the index of the <md:AssertionConsumerService> element to use for the return message from the IdP. |
entityIDParam
entityIDParam | string | Optional, advanced setting for overriding the name of the query string parameter used to override the IdP to use. Normally "entityID" and "providerId" are the parameter names supported. This is provided for supporting unusual application requirements. |
target
target | URL | Allows the resources to return to after SSO to be "locked" to a specific value, even when running as a result of active protection of other resources. In other words, this value overrides the actual resource location when SSO redirection is automatic, including initial access and after a timeout. |
signing
signing | one of | See Signing&Encryption. Controls outbound signing of XML messages and content subject to applicability to the protocol involved. |
encryption
encryption | See Signing&Encryption. Controls outbound encryption of XML messages and content subject to applicability to the protocol involved. |
externalInput
externalInput | boolean | true | Allows handlers to disallow the use of externally supplied parameters / input to drive them. The specific settings this influences will vary by handler, and by default the full range of settings supported can be supplied from outside the SP, typically using query string parameters or form submission. For particularly sensitive or important options, this setting can be used to block that support. This primarily applies to the "SAML2" handler but may be honored by any handler as it deems appropriate. |