Saml2 (Section)#

Path: /profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/saml2

Parameters#

NameTypeRequiredDefaultDescription
issuer-entity-idstringrequiredThe SAML Entity Id that the authenticator uses when communicating with the remote SAML IDP.
clock-skewuint32optional60The allowed clock-skew in seconds when validating the inbound response message
include-subject-with-requested-authn-contextbooleanoptionalfalseIf there is a previously authenticated subject, pass the subject in the AuthnRequest to the SAML Identity Provider.
force-authnenumerationoptionalSetting controlling sending of ForceAuthn=true parameter. By default, it is not sent; this overrules the forceAuthN parameter of the request or the configuration of forced re-authentication on a client.
idp-entity-idstringrequiredThe SAML Entity Id of the remote SAML IDP
idp-urlstringrequiredThe target IDP URL where SAML Authentication Requests are delivered to.
acs-url-overridestringoptionalThe Assertion Consumer Service URL as configured on the IdP - the IdP will send the SAML authentication response to this URL. This setting doesn’t change the real ACS URL of this authenticator. Authorization responses have to be relayed to the real ACS URL of this authenticator.
signature-verification-keyleafrefoptionalThe key to verify the signature of received SAML Response messages. When no key is configured and signed SAML messages are received, then the messages will be rejected.
secondary-signature-verification-keyleafrefoptionalThe secondary key to verify the signature of received SAML Response messages. This key is only used when verification using the signature-verification-key fails.
wants-response-signedbooleanoptionalfalseIndicate whether the received SAML Response message must be signed.
wants-assertion-signedbooleanoptionaltrueIndicate whether the received Assertion must be signed.
request-signing-keyleafrefoptionalOptional reference to the signing key that is used to sign outbound SAML AuthnRequest messages. If not configured, signing AuthnRequests is disabled.
request-bindingenumerationoptionalredirectThe binding to use to send the SAML AuthnRequest message to the IDP
assertion-decryption-keyleafrefoptionalThe key to decrypt encrypted assertions from the SAML Response. When this is set, an encrypted assertion is required.

Subsections#

NameTypeDescription
authentication-context-class-reference SectionThe Authentication Context Class Reference (ACR) values to be included in the SAML Authentication Request.
request-options SectionOptional settings to finetune how a SAML Authentication Request message is constructed.
use-artifact-binding SectionWhen enabled Assertion Consumer Service expects to receive the authentication response through the artifact binding

Was this helpful?