| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| 712:integration:saml [2026/02/20 13:51] – [Generate the SAML SP metadata] Suess, Bernhard | 712:integration:saml [2026/02/20 14:02] (current) – [Configure the SAML Identity Provider (IdP)] Suess, Bernhard |
|---|
| * EntityIdfromMetadata | * EntityIdfromMetadata |
| |
| * SingleSignOnServiceLocationFromMetadata (should be HTTPS, please see [[:general:saml-note-samesite|]]) | * SingleSignOnServiceLocationFromMetadata (should be HTTPS, please see [[:general:saml-note-samesite]]) |
| |
| * DisplayName (alternative: FirstName, LastName) | * DisplayName (alternative: FirstName, LastName) |
| |
| for the following configuration: | for the following configuration: |
| <code> | |
| |
| | <code -> |
| <authentication | <authentication |
| enabled="true" | enabled="true" |
| <identity-provider providerId="STAGES"/> | <identity-provider providerId="STAGES"/> |
| </authentication> | </authentication> |
| |
| </code> | </code> |
| |
| After you configured the service provider and identity provider in ''config.xml'', update the configuration via "stages update'' and restart the Stages service. | After you configured the service provider and identity provider in ''config.xml'', update the configuration via "stages update'' and restart the Stages service.'' |
| |
| ===== Changing the license pool and license type for existing users ===== | ===== Changing the license pool and license type for existing users ===== |
| |
| By default, existing users are not modified by the SAML authentication process when the SAML configuration was changed after the user had been created. However, you can set the ''forceLicensePoolReassignment'' attribute on an ''identity-provider-attribute-match'' to ''true'' if you want changes of the ''licensePoolIdent'' or ''defaultLicenseType'' attributes to be applied to existing users. | ''By default, existing users are not modified by the SAML authentication process when the SAML configuration was changed after the user had been created. However, you can set the ''forceLicensePoolReassignment'' attribute on an ''identity-provider-attribute-match'' to ''true'' if you want changes of the ''licensePoolIdent'' or ''defaultLicenseType'' attributes to be applied to existing users. '' |
| |
| ===== Configuring Stages attributes in default-matcher section with JavaScript ===== | ===== Configuring Stages attributes in default-matcher section with JavaScript ===== |
| |
| JavaScript control flow statements (e.g. "if","switch") can be used to configure values for Stages attributes. All assertion attributes of the SAML response are accessible as variables and can be used in the JavaScript expression | ''JavaScript control flow statements (e.g. "if","switch") can be used to configure values for Stages attributes. All assertion attributes of the SAML response are accessible as variables and can be used in the JavaScript expression JavaScript expressions can be used with the following Stages attributes: * defaultRolesUsername * defaultLicenseType * licensePoolIdent **General JavaScript expression notation:** <code> <Stages_attribute>="=<JavaScript_expression>" </code> **JavaScript notation of if-clauses:** <code> if (condition1) 'returnValue1'; else if (condition2) 'returnValue2'; else if (condition3) 'returnValue3'; else 'returnValue4'; </code> **JavaScript notation of value conditions:** SAML Attributes that are defined via identity_provider_attribute elements can be used in these scripts. E.g. <code> <identity-provider-attribute name="email" id="<EMailAddress>" /> </code> <code> Attribute contains value: </code> <code> <saml_attribute_id>.match(/.*value/) // <= 7.9.10.0, <= 7.10.1.0 <saml_attribute_name>.match(/.*value/) //> 7.9.10.0,> 7.10.1.0 </code> Attribute equals value: <code> <saml_attribute_id>=="value // <= 7.9.10.0, <= 7.10.1.0 <saml_attribute_name>=="value //> 7.9.10.0,> 7.10.1.0 </code> **Names of license types for license assignment** ^License name^License type^ |Modeler|QM| |Contributor|FloatingADev| |Participant|FloatingDev| |Project Manager|FloatingPM| |Viewer|AuthPsReader| **Example configuration:** ''\\ '' ''\\ ''This example creates Stages users with the following conditions: * The pattern matches the entry of the SAML attribute "id". * Depending on the users' email address (domain-part), SAML attribute name "email" is used to assign different values for defaultRolesUsername, defaultLicenseType and licensePoolIdent <code> <identity-provider-attribute-match id="<saml_attribute_id>" pattern="<matching_value>" defaultRolesUsername="= if (email.match(/.*@company1.com/)) 'User1'; else if (email.match(/.*@company2.com/)) 'User2'; else 'default'; " defaultLicenseType="= if (email.match(/.*@company1.com/)) 'QM'; else if (email.match(/.*@company2.com/)) 'PM'; else 'none'; " licensePoolIdent="= if (email.match(/.*@company2.com/)) 'company2'; else ''; |
| |
| JavaScript expressions can be used with the following Stages attributes: | |
| |
| * defaultRolesUsername | |
| * defaultLicenseType | |
| * licensePoolIdent | |
| |
| **General JavaScript expression notation:** | |
| |
| <code> | |
| <Stages_attribute>="=<JavaScript_expression>" | |
| |
| </code> | |
| |
| **JavaScript notation of if-clauses:** | |
| |
| <code> | |
| if (condition1) 'returnValue1'; | |
| else if (condition2) 'returnValue2'; | |
| else if (condition3) 'returnValue3'; | |
| else 'returnValue4'; | |
| |
| </code> | |
| |
| **JavaScript notation of value conditions:** | |
| |
| SAML Attributes that are defined via identity_provider_attribute elements can be used in these scripts. E.g. | |
| |
| <code> | |
| <identity-provider-attribute name="email" id="<EMailAddress>" /> | |
| |
| </code> | |
| |
| <code> | |
| Attribute contains value: | |
| |
| </code> | |
| |
| <code> | |
| <saml_attribute_id>.match(/.*value/) // <= 7.9.10.0, <= 7.10.1.0 | |
| <saml_attribute_name>.match(/.*value/) //> 7.9.10.0,> 7.10.1.0 | |
| |
| </code> | |
| |
| Attribute equals value: | |
| |
| <code> | |
| <saml_attribute_id>=="value // <= 7.9.10.0, <= 7.10.1.0 | |
| <saml_attribute_name>=="value //> 7.9.10.0,> 7.10.1.0 | |
| |
| </code> | |
| |
| **Names of license types for license assignment** | |
| |
| ^License name^License type^ | |
| |Modeler|QM| | |
| |Contributor|FloatingADev| | |
| |Participant|FloatingDev| | |
| |Project Manager|FloatingPM| | |
| |Viewer|AuthPsReader| | |
| |
| **Example configuration:** \\ \\ This example creates Stages users with the following conditions: | |
| |
| * The pattern matches the entry of the SAML attribute "id". | |
| * Depending on the users' email address (domain-part), SAML attribute name "email" is used to assign different values for defaultRolesUsername, defaultLicenseType and licensePoolIdent | |
| |
| <code> | |
| <identity-provider-attribute-match | |
| id="<saml_attribute_id>" | |
| pattern="<matching_value>" | |
| defaultRolesUsername="= | |
| if (email.match(/.*@company1.com/)) 'User1'; | |
| else if (email.match(/.*@company2.com/)) 'User2'; | |
| else 'default'; | |
| " | |
| defaultLicenseType="= | |
| if (email.match(/.*@company1.com/)) 'QM'; | |
| else if (email.match(/.*@company2.com/)) 'PM'; | |
| else 'none'; | |
| " | |
| licensePoolIdent="= | |
| if (email.match(/.*@company2.com/)) 'company2'; | |
| else ''; | |
| " | " |
| autocreateUser="true" | autocreateUser="true" |
| | |
| /> | /> |
| |
| |
| Please note that the values of multi value attributes are provided to the scripts as one value as a comma separated string. | Please note that the values of multi value attributes are provided to the scripts as one value as a comma separated string. |
| |
| ===== ===== | |
| |
| |