Identity as a Service includes a number of cloud applications for you to integrate with Identity as a Service for two-factor authentication. If the you want to protect a cloud service that is not preconfigured with Identity as a Service, you can integrate it as a generic SAML service provider application.
Note: This section describes how to add a generic SAML application. See SAML Integration Guides for a list of available pre-configured integrations.
Before you begin, identify the Assertion Consumer Service URL, Service Provider Entity ID, SAML NameID Attribute, and other required or optional SAML Attribute values needed to complete this procedure. If you have a metadata XML file that includes this information, you can upload the file to auto-populate these fields.
1. Click
> Security > Applications.
The Applications List page appears.
2. Click Add. The Select an Application Template page appears.
3. Scroll to SAML Cloud Integrations and click Generic SAML Application. The Add Generic SAML Application page appears.
4. Enter an Application Name.
5. Optional. Enter an Application Description.
6. Optional. Add a custom application logo.
a. Click next to Application Logo.
The Upload Logo dialog box appears.
b. Click to
select an image file to upload.
c. Browse to select your file and click Open. The Upload Logo dialog box displays your selected image.
d. If required, resize your image.
e. Click OK.
7. Select the Authentication Flow that appears to users during login. You must select at least one. For more information on Passkey login, see Manage Passkey/FIDO2 authenticators.
8. Click Next. The General page appears.
9. If available, use the Upload Metadata XML file option to auto-populate the following fields, if available in the file:
● Default Assertion Consumer Service URL
● Alternative Assertion Consumer URLs
● Service Provider Entity ID (Issuer)
● Single Logout Service URL
● SAML Signing Certificate
● SAML NameID Encoding Format
● SAML Signature Algorithm
10. To import the Metadata file:
a. Click and browse
to select the file. The Metadata
Configuration dialog box appears.
b. If required, click Merge with existing values to merge new values with existing values for Alternative Assertion Consumer Services URLs and SAML attribute names.
c. Click Save.
11. Select Enable Organizations and Domain-Based Identity Providers to allow organization information to be returned in SAML attribute values when users log in. When enabled, if users are associated with one or more organizations and one has not yet been requested, users can select their organizations after they authenticate to their application.
Note: When organizations are enabled, the corresponding SAML attributes must also be configured. See step 26.
12. If you do not have a metadata file, enter the following:
a. Enter the Default Assertion Consumer Service URL for the SAML application.
b. Enter the Service Provider Entity ID (Issuer) that is used by Identity as a Service to identify the SAML service provider.
c. If your SAML service provider supports SAML logout, set the Single Logout Service URL to the value supplied by your SAML service provider. Otherwise, leave it blank.
d. Optional. Enter the SAML Username Parameter Name used to identify the user ID being requested for authentication.
The user ID can then be passed as a parameter, for example, Username=jdoe. Alternately, if the SAML username is NameID, the SAML Request XML NameID element value is used to the identity the IDaaS userID.
13. Enter the SAML Session Timeout to the time when the SAML Assertion times out. The maximum is 720 minutes.
14. Enter the Max Authentication Age (seconds) to set the maximum amount of time that can elapse before a user is required to reauthenticate during a new login attempt. This applies for both SP-initiated and IDP-initiated login. Set this field to -1 to disable this feature.
15. From the SAML NameID Attribute drop-down list, select the user attribute that will be used to uniquely identity a user to both Identity as a Service and your SAML application. The attribute should be one that will never change.
16. Select the SAML NameID Encoding Format from the drop-down list.
Options include:
● KERBEROS
● WINDOWS_DOMAIN_QUALIFIED_NAME.
17. Select the SAML Signing Certificate from the drop-down list.
Attention: If you are updating a previous SAML Signing Certificate for the SAML application, you need to update both here and at the SAML service provider. The certificate update must be made at the same time. Once the change is made to either side, the other side will not be available until it is also updated. Any SAML authentications during this period will result in a failure.
18. From the SAML Signature Algorithm drop-down list, select the type of signing algorithm you want Identity as a Service to use to sign the SAML response/assertion. The type of algorithm you select depends on the requirements of the application being configured.
19. Optional: Select Sign complete SAML response to ensure the message integrity of the SAML response sent to the application during authentication.
20. Optional: Select Respond Immediately for Unsuccessful Responses to return to the application immediately after a login failure, rather than allow user to try again with a different userID.
21. Deselect Enable Go Back Button if you do not want users to be able to go back to the application login page to log in.
22. Select Show Default Assertion Consumer URL Service in the My Profile. When selected, the Default Assertion Consumer URL appears in a user's My Profile page in addition to relay states and Alternative Assertion Consumer URLs.
23. Optional: Select Encrypt SAML Assertion. When selected the SAML Assertion is also encrypted. If you select this option, do the following:
a. From the Encryption Method for Key drop-down list, select either RSA Version 1.5 or RSA-OAEP. RSA Version 1.5 is the default.
b. From the Encryption Method for Data drop-down list, select the encryption method used to encrypt data. The options are:
– AES-256 (default)
– AES-128
– AES-192
– Triple DES
c. In the Encryption Certificate field, upload the encryption certificate file.
Note: The Subject Domain Name and Certificate Expiry Date values are populated with values from the certificate once the Encryption Certificate is uploaded.
24. Optional. Select Override SAML Audience to override the SAML application issuer value. If you select this option, complete the following:
a. Select SAML Audience supplied in request to determine the purpose of the following audience value:
– If enabled, set the Audience value to the required prefix of the SAML authentication request audience parameter value. If it matches the supplied value, the supplied value is used.
– If deselected, set the Audience value to the override value to use.
Note: When selecting the Override SAML Audience option, consider the following:
– Set the Audience value to a different value only if it is required by the SAML Service Provider.
– Configure the SAML application to allow the client to override the audience only if the client is trusted. If the client specifies the audience value, it may allow one SAML application to specify the SAML audience of another SAML application and allow access to the other applications.
25. Optional: Add additional SAML Domains, as follows:
a. Click Add. The Add SAML Domain dialog box appears.
b. Enter the SAML Domain.
c. Click OK.
d. Repeat these steps to add additional domains.
Note: If you have multiple domains that will be federated, then add a domain entry for each one.
26. Optional. Add Alternative Assertion Consumer Service URLs, as follows:
a. Click Add.
b. Enter a Name.
c. Enter a URL Value.
d. Select Show in My Profile to display the Alternative Consumer Service URL in a user's My profile page.
e. Optional. Add an Application Logo.
f. Click Add.
g. Repeat these steps to add more Alternative Assertion Consumer Service URLs.
27. Optional. To add a Relay State, do the following:
a. Under Relay State click Add. The Add Relay State dialog box appears.
b. Enter a Name for the relay state.
c. Enter the Value for the relay state. This setting specifies the application or URL that a user is redirected to after successful authentication. For example, https://google.calendar.com.
d. Select Show in My Profile to display the relay state on the user's My Profile page.
Notes: After
you add relay states, you can also enable or disable them on the Add/Edit
application page. Click next to the relay state
to disable it or click
to re-enable it.
Relay states apply to the Default Assertion Consumer Service URLs and
not the Alternative Consumer Service URLs.
e. Optional.
Add a Relay State custom logo.
Click next
to Relay State Logo. The Upload
Logo dialog box appears.
Click
to select an image file to upload.
Browse to select your file and click Open. The Upload Logo dialog box reappears showing your selected image.
If required, resize your image.
Click OK.
f. Click Add.
g. Repeat these steps to add more Relay States.
28. Optional. Include user attributes, groups, authenticators, or organizations in the SAML assertion.
Note: If you have regex expertise and want to use attribute parsing, go to step 27.
a. Under SAML Attributes, click Add. The SAML Attributes dialog box appears.
b. Enter a Name that clearly indicates the purpose of the attribute. It should indicate whether the SAML attribute value contains user group, authenticator, or organization. For example, if the attribute value contains user groups the name could be User Groups.
c. Click Add next to Value(s).
d. In the Values field do the following, as required:
– Type < and select the user attribute to include every time the user authenticates to the application.
– Type [ and select [Groups] to include a user's groups every time the user authenticates to the application.
– Type [ and select [Unique Group IDs] to include a user's group ids every time the user authenticates to the application.
– Type [ and select [Authenticators] to include a user's authenticators every time the user authenticates to the application.
– Type [ and select [Organizations] to include a list of the user's organizations every time the user authenticates to the application.
– Type [ and select [Unique Organization IDs] to include a list of the user's organization ids every time the user authenticates to the application.
– Type [ and select [Selected Organization] to include the user's selected organization the next time the user authenticates to the application.
– Type [ and select [Unique Selected Organization ID] to include the user's selected organization id the next time the user authenticates to the application.
– To add static text, type the text in the Value text box.
e. Repeat these steps to add additional SAML attributes.
f. Click Add.
29. Under SAML Attributes, click Add. The SAML Attributes dialog box appears.
a. Enter a Name that clearly indicates the purpose of the attribute. It should indicate whether the SAML attribute value contains user group, authenticator, or organization attributes. For example, if the attribute value contains user groups, the name could be User Groups.
b. You can further filter and parse the attributes by appending the following actions to it:
.filter(regex filter expression).matcher(regex matcher expression).replace(regex replacement).end()
Note: This is an advanced setting and requires regex expertise.
Example:
Filter any IDaaS groups that start with AWS-, return the group names
after AWS- and before -xxx:
[Groups].filter(^AWS-(.*)$).matcher(^AWS-(.*)-(.*)$).replace($1).end()
Convert custom userid values of the form domain\userid into userid@domain.com:
<Custom Userid>.filter().matcher(^(.*)\(.*)$).replace($2@$1.com).end()
c. Click Add
next to Value(s). When you
define a value, click to
test it.
d. Optionally, use the Test Regular Expressions section to enter a list of values (one per line) and then click Test to run a test on the expression.
e. Repeat these steps to add additional SAML attributes.
f. Click Add.
30. Click Submit.
Create a resource rule to protect access to a SAML application
1. Log in to your Identity as a Service administrator account.
2. Click
> Security
> Resource Rule. The Resource Rules List
page appears.
3. Click + next to the application you want to protect with a resource rule. The Add Resource Rules page appears.
4. Enter a Rule Name and Rule Description for the resource rule.
5. In the Groups list, select the group or groups of users restricted by the resource rule.
These are the groups to which the resource rule applies. If you do not select any groups, by default the resource rule applies to all groups.
6. Click Next. The Authentication Conditions Settings page appears.
7. Optional: Select Disable Single Sign-On for Application to force a user to re-authenticate whenever they attempt a new login.
8. If you do not Enable Advanced Risk Factors, do the following:
a. Select the Authentication Flow from the drop-down list. The Authentication Flow flowchart updates based on the selection.
b. Click Submit to save the Resource Rule.
9. If you want to Enable Advanced Risk Factors complete the remaining steps in this procedure.
10. Select Enable Advanced Risk Factors to add additional risk factors to the resource rule.
11. Select Enable Strict Access for Application to set the resource rule to deny access regardless of the outcome from other resource rules. If this option is disabled for any resource rule that denies access, the user is allowed access if at least one resource rule allows access.
12. For each Advanced Risk Factor, click the Deny option to deny access to the application if the risk factor fails regardless of the results of the other risk factors.
13. Click Date/Time to set the conditions as follows:
a. Select one of the following:
– Allow Date/Time to set when a user can access the application.
– Deny Date/Time to set when the user cannot access the application.
The Date/Time Context Condition Settings appear.
b. Select the Condition Type:
– Specific Date Range Condition—Allows or denies access to the application during a select period of days.
– Time-of-day and/or Day of Week Recurring Conditions—Allows or denies access to the application on a specific time of day, day of the week, or both. Recurring times selected only apply to days not denied.
– Clear Selection—Clears existing Date and Time conditions.
c. Set the Condition Type settings, as follows:
i) Select Use local time zone to use the local time zone or deselect Use local time zone to use the local time zone and begin typing the time zone in the Begin Typing Timezone name field and select the time zone from the drop-down list.
ii) If you selected Specific Date Range Condition, click Start Date to select a start date from the pop-up calendar. Optionally, select the End Date.
iii) If you selected Time-of-Day and/or Day-of-Week, click Start Time and select the start time from the pop-up clock. Optionally set the End Time. You must also select the days of the week for the condition.
d. Click Save to return to the Authentication Conditions Settings page.
14. Click Geolocation to set the Location Condition Settings, as follows:
a. Select Allow or Deny to create an allowed or denied country list.
b. From the Selected Countries drop-down list, select the countries to add or deny access to the application. Repeat until you have added all the desired countries to the list.
c. Select Allow Anonymous IP Address to increase the risk of users authenticating from an anonymous IP.
d. Click Save to save to return to the Authentication Conditions Settings page.
15. Click Source IP Address. The IP Address Risk Setting dialog box appears. Do one of the following:
a. Select Custom and add the required IP Allowed Addresses and IP Denied Addresses.
b. Select IP List Address and select the IP List to allow or deny.
c. Select None to not restrict any IP addresses.
d. Click OK to return to the Authentication Conditions Settings.
16. Click Machine Authentication to set the Machine Authentication Condition Settings, as follows:
a. Set the Machine Authentication Risk is less than or equal to the value that the machine authenticator's total risk score must be less than during authentication to pass this condition.
The risk score is based on the attribute differences
between a user's Machine Authentication information and that recorded
on Identity as a Service before the condition fails. If an attribute does
not match, the attribute incurs the number of risk points shown in Non-Matching Risk Points for that attribute. The
Non-Matching Risk Points values of each non-matching
attribute are added together, resulting in a total risk score. This score
is normalized to be out of 100 as follows:
Total Risk Score = (Total Risk Points
of Failing Attributes / Maximum Risk Points of All Enabled Attributes)
* 100
The resource rule condition fails when the number of non-matching risk
points exceeds the Machine Authentication Risk value defined in this step.
A value of 0 means that a single attribute
difference causes the Device Fingerprint
condition to fail. The default value is 3.
The value between 0-50 can be entered.
The default value is defined by the Machine Risk Limit.
See Manage machine
authenticator settings.
b. Click Save.
17. Define the Location History / Known Locations and Travel Velocity conditions.
The Risk-Based Authentication (RBA) settings of your Identity as a Service account define the location history and travel velocity conditions. See Manage risk-based authentication settings for more information.
18. Set the Device Certificates risk factor to require the client to perform client-authenticated SSL with a certificate issued from a trusted CA to pass.
19. Set the risk score for application conditions to set the risk percentage a user receives if they fail to meet the condition, as follows:
● Click the dot next to the condition setting and slide the risk scale to the risk percentage
-or-
● Click the 0% and enter the risk points and then click OK.
The default setting is 0%. The Risk percentage determines the authentication requirements as set by the Authentication Decision. When a user attempts to authenticate to an application, the final risk percentage is the sum of all failed conditions.
20. Set the Authentication Decision risk level for Medium Risk and High Risk as follows:
a. Click the risk threshold percentage to the right of Medium Risk or High Risk. The Risk Threshold dialog box appears.
b. Enter the risk percentage.
c. Click OK.
21. Select the Authentication Flows for Low Risk, Medium Risk, and High Risk from the drop-down lists. The Authentication Flows flowchart updates based on your selections.
22. Click Submit to create the resource rule.
Export a SAML signing certificate
1. Log in to your Identity as a Service administrator account.
1. Click
> Security > Applications.
The Applications List page appears.
2. Under SAML Cloud Integrations, click SAML Signing Certificates. The SAML Signing Certificates page appears.
3. Click
next to the certificate to export the certificate
you want to import into your SAML service provider application. The Export Certificate dialog box appears.
a. If the certificate has been issued by a CA, do one of the following:
– Click Certificate to export the self-signed certificate.
– Click Root CA Certificate to export a certificate issued from a CA.
– Click Certificate Chain to export the SAML signing certificate and its CA certificates.
b. Click Export.
Set up Identity as a Service as an Identity Provider for your SAML service provider
1. Open your SAML Service Provider application.
2. Copy or import the signing certificate into your application.
Note: For Service Providers that support it, the metadata file can be uploaded instead of manually filling in all the fields.
3. Complete other required tasks to configure Identity as a Service as an Identity Provider in your custom application.