Smile CDR v2022.08.PRE
On this page:
   37.89    Search Parameter Seeding
  • Configuration Categories
  • 37.0 Web Admin Console Settings
  • 37.1 appSphere
  • 37.2 Payer Config
  • 37.3 Initial appSphere Seeding
  • 37.4 Authentication Callback Scripts
  • 37.5 Auth: General for APIs
  • 37.6 User Authentication
  • 37.7 Auth: HTTP Basic
  • 37.8 Auth: OpenID Connect
  • 37.9 Browser Syntax Highlighting
  • 37.10 Capability Statement (metadata)
  • 37.11 CDA Generation
  • 37.12 CDA Import
  • 37.13 CDS Hooks Definitions
  • 37.14 Channel Import
  • 37.15 Channel Retry
  • 37.16 Kafka
  • 37.17 Smile CDR License
  • 37.18 Cluster Manager Maintenance
  • 37.19 Message Broker
  • 37.20 Cluster Level Security
  • 37.21 Credentials
  • 37.22 Cross-Origin Resource Sharing (CORS)
  • 37.23 Database
  • 37.24 Email Configuration
  • 37.25 ETL Import: CSV Properties
  • 37.26 ETL Import: Source
  • 37.27 FHIR Binary Storage
  • 37.28 FHIR Bulk Operations
  • 37.29 Capability Statement
  • 37.30 FHIR Configuration
  • 37.31 Consent Service
  • 37.32 FHIR Endpoint Conversion
  • 37.33 Interceptors
  • 37.34 FHIR Endpoint Partitioning
  • 37.35 Custom Resource Providers
  • 37.36 FHIR Endpoint Security
  • 37.37 Endpoint Terminology
  • 37.38 FHIR Gateway Configuration
  • 37.39 FHIR Interceptors
  • 37.40 LiveBundle Service
  • 37.41 FHIR MDM Server
  • 37.42 FHIR Performance
  • 37.43 FHIR Performance Tracing
  • 37.44 FHIR Realtime Export
  • 37.45 Repository Validation
  • 37.46 FHIR Resource Types
  • 37.47 FHIR REST Endpoint
  • 37.48 FHIR Search
  • 37.49 FHIR Storage Module Scheduled Tasks
  • 37.50 FHIR Validation Services
  • 37.51 FHIR Storage Package Registry
  • 37.52 FHIR Storage Partitioning
  • 37.53 Versioned References
  • 37.54 FHIR Subscription Delivery
  • 37.55 FHIR Subscription Persistence
  • 37.56 Amazon HealthLake REST Endpoint
  • 37.57 HL7 v2.x Mapper - Contained Resource
  • 37.58 HL7 v2.x Mapper - DG1
  • 37.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 37.60 HL7 v2.x Mapper - General
  • 37.61 HL7 v2.x Mapper - Medications
  • 37.62 HL7 v2.x Mapper - OBR
  • 37.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 37.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 37.65 HL7 v2.x Mapper - PID
  • 37.66 HL7 v2.x Mapper - PV1
  • 37.67 HL7 v2.x Listener Script
  • 37.68 HL7 v2.x MLLP Listener
  • 37.69 HL7 v2.x MLLP Sender
  • 37.70 FHIR to HL7 v2.x Mapper Script
  • 37.71 HL7 v2.x Outbound Mapping
  • 37.72 HTTP Access Log
  • 37.73 HTTP Listener
  • 37.74 HTTP Request Pool
  • 37.75 HTTP Security
  • 37.76 Hybrid Providers Definitions
  • 37.77 Initial User Seeding
  • 37.78 JavaScript Execution Environment
  • 37.79 JSON Web KeySet (JWKS)
  • 37.80 LDAP Authentication
  • 37.81 Lucene FullText Indexing
  • 37.82 MDM
  • 37.83 Narrative Generator
  • 37.84 OpenID Connect Token Validation
  • 37.85 OpenID Connect (OIDC)
  • 37.86 Provenance Injection
  • 37.87 Realtime Export
  • 37.88 Endpoint Validation: Request Validating
  • 37.89 Search Parameter Seeding
  • 37.90 SAML Provider
  • 37.91 Security Inbound Script
  • 37.92 Inbound SMART on FHIR Authentication
  • 37.93 Inbound SMART on FHIR Endpoints
  • 37.94 OAuth2/OIDC Federation
  • 37.95 SMART Callback Script
  • 37.96 Cross-Organizational Data Access Profile
  • 37.97 SMART Login Skin
  • 37.98 SMART Login Terms of Service
  • 37.99 SMART Authorization
  • 37.100 SMART Definitions Seeding
  • 37.101 Sessions
  • 37.102 Two Factor Authentication
  • 37.103 TLS / SSL (Encryption)
  • 37.104 Transaction Log
  • 37.105 Trusted Client
  • 37.106 User Self Registration
    • 37.91    Security Inbound Script   
       Table of Contents

    SAML Provider

    37.90SAML 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

    37.90.1Property: 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}

    37.90.2Property: 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 =

    37.90.3Property: 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 =

    37.90.4Property: 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 =

    37.90.5Property: 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

    37.90.6Property: 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

    37.90.7Property: 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 =

    37.90.8Property: 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 =

    37.90.9Property: 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 =

    37.90.10Property: 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 =
       37.89    Search Parameter Seeding
  • Configuration Categories
  • 37.0 Web Admin Console Settings
  • 37.1 appSphere
  • 37.2 Payer Config
  • 37.3 Initial appSphere Seeding
  • 37.4 Authentication Callback Scripts
  • 37.5 Auth: General for APIs
  • 37.6 User Authentication
  • 37.7 Auth: HTTP Basic
  • 37.8 Auth: OpenID Connect
  • 37.9 Browser Syntax Highlighting
  • 37.10 Capability Statement (metadata)
  • 37.11 CDA Generation
  • 37.12 CDA Import
  • 37.13 CDS Hooks Definitions
  • 37.14 Channel Import
  • 37.15 Channel Retry
  • 37.16 Kafka
  • 37.17 Smile CDR License
  • 37.18 Cluster Manager Maintenance
  • 37.19 Message Broker
  • 37.20 Cluster Level Security
  • 37.21 Credentials
  • 37.22 Cross-Origin Resource Sharing (CORS)
  • 37.23 Database
  • 37.24 Email Configuration
  • 37.25 ETL Import: CSV Properties
  • 37.26 ETL Import: Source
  • 37.27 FHIR Binary Storage
  • 37.28 FHIR Bulk Operations
  • 37.29 Capability Statement
  • 37.30 FHIR Configuration
  • 37.31 Consent Service
  • 37.32 FHIR Endpoint Conversion
  • 37.33 Interceptors
  • 37.34 FHIR Endpoint Partitioning
  • 37.35 Custom Resource Providers
  • 37.36 FHIR Endpoint Security
  • 37.37 Endpoint Terminology
  • 37.38 FHIR Gateway Configuration
  • 37.39 FHIR Interceptors
  • 37.40 LiveBundle Service
  • 37.41 FHIR MDM Server
  • 37.42 FHIR Performance
  • 37.43 FHIR Performance Tracing
  • 37.44 FHIR Realtime Export
  • 37.45 Repository Validation
  • 37.46 FHIR Resource Types
  • 37.47 FHIR REST Endpoint
  • 37.48 FHIR Search
  • 37.49 FHIR Storage Module Scheduled Tasks
  • 37.50 FHIR Validation Services
  • 37.51 FHIR Storage Package Registry
  • 37.52 FHIR Storage Partitioning
  • 37.53 Versioned References
  • 37.54 FHIR Subscription Delivery
  • 37.55 FHIR Subscription Persistence
  • 37.56 Amazon HealthLake REST Endpoint
  • 37.57 HL7 v2.x Mapper - Contained Resource
  • 37.58 HL7 v2.x Mapper - DG1
  • 37.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 37.60 HL7 v2.x Mapper - General
  • 37.61 HL7 v2.x Mapper - Medications
  • 37.62 HL7 v2.x Mapper - OBR
  • 37.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 37.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 37.65 HL7 v2.x Mapper - PID
  • 37.66 HL7 v2.x Mapper - PV1
  • 37.67 HL7 v2.x Listener Script
  • 37.68 HL7 v2.x MLLP Listener
  • 37.69 HL7 v2.x MLLP Sender
  • 37.70 FHIR to HL7 v2.x Mapper Script
  • 37.71 HL7 v2.x Outbound Mapping
  • 37.72 HTTP Access Log
  • 37.73 HTTP Listener
  • 37.74 HTTP Request Pool
  • 37.75 HTTP Security
  • 37.76 Hybrid Providers Definitions
  • 37.77 Initial User Seeding
  • 37.78 JavaScript Execution Environment
  • 37.79 JSON Web KeySet (JWKS)
  • 37.80 LDAP Authentication
  • 37.81 Lucene FullText Indexing
  • 37.82 MDM
  • 37.83 Narrative Generator
  • 37.84 OpenID Connect Token Validation
  • 37.85 OpenID Connect (OIDC)
  • 37.86 Provenance Injection
  • 37.87 Realtime Export
  • 37.88 Endpoint Validation: Request Validating
  • 37.89 Search Parameter Seeding
  • 37.90 SAML Provider
  • 37.91 Security Inbound Script
  • 37.92 Inbound SMART on FHIR Authentication
  • 37.93 Inbound SMART on FHIR Endpoints
  • 37.94 OAuth2/OIDC Federation
  • 37.95 SMART Callback Script
  • 37.96 Cross-Organizational Data Access Profile
  • 37.97 SMART Login Skin
  • 37.98 SMART Login Terms of Service
  • 37.99 SMART Authorization
  • 37.100 SMART Definitions Seeding
  • 37.101 Sessions
  • 37.102 Two Factor Authentication
  • 37.103 TLS / SSL (Encryption)
  • 37.104 Transaction Log
  • 37.105 Trusted Client
  • 37.106 User Self Registration
    • 37.91    Security Inbound Script