Smile CDR v2024.05.PRE
On this page:
   45.118    Search Parameter Seeding 45.120    Security Inbound Script   

45.119.1SAML Provider

 

The SAML Provider configuration category includes the following configurable options:

  • Relying Party Entity ID Template

  • Issuer ID

  • Keystore File

  • Keystore Password

  • Registration ID

  • Sign Auth Request

  • Signing Key Alias

  • Signing Key Password

  • Verification Certificate Alias

  • Web SSO URL

45.119.2Property: Relying Party Entity ID Template

 
Property Name Relying Party Entity ID Template
Property Key
Property Type STRING
Description This setting controls the Entity ID that will be assigned to the SAML Relying Party (i.e. the Smile CDR web application being authenticated). See Entity ID Template for more information.
Applies to Modules
  • SAML Inbound Security
Default Value {baseUrl}/saml2/service-provider-metadata/{registrationId}
Example Property
module.[MODULE_ID].config.relying_party.default.entity_id_template = {baseUrl}/saml2/service-provider-metadata/{registrationId}

45.119.3Property: Issuer ID

 
Property Name Issuer ID
Property Key
Property Type STRING
Description Contains the ID for the IDP (Identity Provider) that will be used to authenticate, and must match the value configured in that system. This is also sometimes called an Entity ID.
Applies to Modules
  • SAML Inbound Security
Default Value (no default)
Example Property
module.[MODULE_ID].config.relying_party.default.issuer_id = 

45.119.4Property: Keystore File

 
Property Name Keystore File
Property Key
Property Type Resource Path
Description Specifies a Keystore to obtain keys and certificates for use in signing and verifying signatures in SAML assertions.
Applies to Modules
  • SAML Inbound Security
Default Value (no default)
Example Property
module.[MODULE_ID].config.relying_party.default.keystore.file = 

45.119.5Property: Keystore Password

 
Property Name Keystore Password
Property Key
Property Type PASSWORD
Description The keystore password
Applies to Modules
  • SAML Inbound Security
Default Value (no default)
Example Property
module.[MODULE_ID].config.relying_party.default.keystore.password = 

45.119.6Property: Registration ID

 
Property Name Registration ID
Property Key
Property Type STRING
Description An identifier intended to uniquely identify the registration between the Identity Provider and Smile CDR (the Service Provider). The default value of SMILECDR is typically fine, unless you are authenticating multiple instances of Smile CDR using SAML, and the different instances have different purposes/users/etc.
Applies to Modules
  • SAML Inbound Security
Default Value SMILECDR
Example Property
module.[MODULE_ID].config.relying_party.default.registration_id = SMILECDR

45.119.7Property: Sign Auth Request

 
Property Name Sign Auth Request
Property Key
Property Type BOOLEAN
Description Should the SAML Authentication Request be signed?
Applies to Modules
  • SAML Inbound Security
Default Value true
Example Property
module.[MODULE_ID].config.relying_party.default.sign_auth_request = true

45.119.8Property: Signing Key Alias

 
Property Name Signing Key Alias
Property Key
Property Type STRING
Description Specifies the alias within the keystore for the key that will be used to sign the Authentication Request.
Applies to Modules
  • SAML Inbound Security
Default Value (no default)
Example Property
module.[MODULE_ID].config.relying_party.default.signing_key_alias = 

45.119.9Property: Signing Key Password

 
Property Name Signing Key Password
Property Key
Property Type PASSWORD
Description The password for the key used for signing.
Applies to Modules
  • SAML Inbound Security
Default Value (no default)
Example Property
module.[MODULE_ID].config.relying_party.default.signing_key_password = 

45.119.10Property: Verification Certificate Alias

 
Property Name Verification Certificate Alias
Property Key
Property Type STRING
Description Specifies the alias in the keystore for the certificate to use to verify the SAML response signature.
Applies to Modules
  • SAML Inbound Security
Default Value (no default)
Example Property
module.[MODULE_ID].config.relying_party.default.verification_cert_alias = 

45.119.11Property: Web SSO URL

 
Property Name Web SSO URL
Property Key
Property Type STRING
Description Specifies the URL that should be used as the destination for the initial redirect from the Service Provider to the Identity Provider.
Applies to Modules
  • SAML Inbound Security
Default Value (no default)
Example Property
module.[MODULE_ID].config.relying_party.default.web_sso_url = 
   45.118    Search Parameter Seeding 45.120    Security Inbound Script