Step 1: Download
the Zuora metadata fileZuora offers cloud-based software enabling companies to launch, manage and transform into a subscription business. (see https://zuora.com/). You can protect access to Zuora by integrating Zuora with Identity as a Service. Once integrated, users can use single sign-on to log in to their Zuora account through Identity as a Service.
Note: This integration was tested using Identity as a Service version 5.2x and Zuora Release June 2022. For other versions of Zuora, this integration guide may be used as an initial approach for integrating Zuora. In the event of other issues, contact support@entrust.com for assistance.
To integrate Zuora, do the following:
Step 1: Download
the Zuora metadata fileDownload the Zuora metadata file. You use this file when you Add Zuora to Identity as a Service.
1. Go to any of these locations, as appropriate, to download the metadata file:
● US Cloud 1 Production: https://na.zuora.com/apps/saml/metadata
● US Cloud 1 API Sandbox: https://sandbox.na.zuora.com/apps/saml/metadata
● US Cloud 2 Production: https://www.zuora.com/apps/saml/metadata
● US Cloud 2 API Sandbox: https://apisandbox.zuora.com/apps/saml/metadata
● Performance Test: https://pt1.zuora.com/apps/saml/metadata
● EU Production: https://eu.zuora.com/apps/saml/metadata
● EU Sandbox: https://sandbox.eu.zuora.com/apps/saml/metadata
● Central Sandbox US: https://test.zuora.com/apps/saml/metadata
● Central Sandbox EU: https://test.eu.zuora.com/apps/saml/metadata
2. Open a Web browser and paste the Zuora Metadata URL in the browser.
3. Copy the contents of the MetaData to a text editor, such as Notepad.
4. Save the metadata file as zuora_saml_metadata.xml. You need to upload this in Step 2: Add Zuora to Identity as a Service.
5. The metadata file downloads by default as an xml file named sp.xml. You need to upload the metadata file in Step 2: Add Zoom to Identity as a Service.
Step
2: Copy the SAML Configuration from Identity as a Service
Copy the SAML Configuration from Identity as a Service
1. Log into your Identity as a Service administrator account.
2. Click
> Security
> Applications. The Applications Lists page appears.
3. Under SAML Cloud Integrations, click SAML Configuration. The SAML Configuration dialog box appears.
This dialog box contains information you need to configure your SAML application for Identity as a Service authentication.
4. Do one of the following:
● Leave this dialog box open to reference later in this procedure.
● Copy the Entity ID, Single Sign-on URL, and Single Logout URL to a text file and save it to reference later in this procedure.
Note: Depending on the integration you are performing, you may not need all three of these SAML configuration values.
Step 3: Add
Zuora to Identity as a ServiceAdd Zoom as an application to Identity as a Service
1. Log into your Identity as a Service administrator account.
2. Click
> Security > Applications. The Applications
Lists page appears.
3. Click Add. The Select an Application Template page appears.
4. Under SAML Cloud Integrations, click Zuora. The Add Zuora page appears.
5. Enter an Application Name.
6. Enter an Application Description.
7. 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 reappears showing your selected image.
d. If required, resize your image.
e. Click OK.
8. Select the Authentication Flow that appears to users during login.
9. Click Next. The General page appears.
10. Click
to the Upload Metadata XML
and browse to the location of the metadata file you downloaded
in Step 1: Download the Zuora metadata file.
The Metadata Configuration dialog box appears.
a. If required, click Merge with existing values to merge new values with existing values for Alternative Assertion Consumer Services URLs and SAML attribute names.
b. Click Save.
11. Click OK on the Metadata Configuration dialog box to complete the upload of the metadata.
12. Optional. Enter the SAML Username Parameter Name used to identity 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 identify 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 UserID.
16. From the SAML NameID Encoding Format drop-down list, select EMAIL
13. Select the SAML Signing Certificate from the drop-down list.
17. Deselect Enable Go Back Button if you do not want users to be able to go back to the Zuora login page to log in.
18. 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.
19. 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.
20. Click Submit.
Step 4: Create
a resource rule to protect access to ZuoraCreate 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 Rules. 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 Modify 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.
Step 5: Download
the metadata from Identity as a ServiceDownload the Metadata file from Identity as a Service
1. In Identity as a Service, click
> Security > Applications.
The Applications List page appears.
2. Do one of the following:
● Click
next to the application you are integrating
with Identity as a Service.
–or–
● Click
next to the application you are integrating
with Identity as a Service and select SAML IDP Metadata.
The SAML Application Metadata dialog box appears.
3. Select the certificate to include in the SAML IDP Metadata file from the drop-down list.
4. If applicable, Select the domain to include in the SAML IDP Metadata file from the drop-down list.
5. Enter the Lifetime, in days, for the SAML IDP Metadata file. The value must be between 2 and 730.
6. Do one of the following, as required:
a. Copy the Public Endpoint to paste into your SAML application being used Identity Provider authentication.
b. Click Download.
Note: If you are using multiple domains, you must download each domain's metadata file separately because the values in the metadata file vary for each domain.
Step 6: Copy
the SAML Configuration from Identity as a ServiceCopy the SAML Configuration from Identity as a Service
1. Log into your Identity as a Service administrator account.
2. Click
> Security
> Applications. The Applications Lists page appears.
3. Under SAML Cloud Integrations, click SAML Configuration. The SAML Configuration dialog box appears.
This dialog box contains information you need to configure your SAML application for Identity as a Service authentication.
4. Do one of the following:
● Leave this dialog box open to reference later in this procedure.
● Copy the Entity ID, Single Sign-on URL, and Single Logout URL to a text file and save it to reference later in this procedure.
Note: Depending on the integration you are performing, you may not need all three of these SAML configuration values.
Step
5: Export the Signing Certificate from Identity as a ServiceExport 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.
Step 6: Configure
Zuora for Identity as a Service authentication1. Log in to Zuora support.
2. Submit a request at Zuora Global Support to provide your Zuora contact with the provider metadata, you downloaded in Step 5: Download the metadata from Identity as a Service and the logout URL from Step 5: Copy the SAML Configuration from Identity as a Service.
3. Enable SSO for a Zuora User.
Note: Before you enable SSO for a user, that user must have a user account in Zuora. If this is a new user, first, create this user in Zuora as described in Manage Users.
To enable SSO for a Zuora user, complete the following steps:
a. Log into the Zuora application as a tenant administrator and navigate to Settings > Administration Settings > Manage Users.
b. In the user List, click the user for whom you want to enable SSO. The User Details page appears.
c. In the Basic Information section, select SSO SAML Enabled.
d. In the Federated ID field, enter the unique SSO federated ID of this user. The federated ID must be in an email format, for example, username@domain.com.
e. Click Save.
Notes:
Activation email: New Zuora users with SSO is enabled do
not receive the activation email from Zuora. The user is automatically
activated upon the first successful login to Zuora. If SSO needs to
be disabled for this user, the tenant administrator needs to use the
Resend Activation Email feature
to convert this user to a local Zuora user.
Zuora
session time out: When a user session times out in Zuora, the
user is redirected to the Zuora login page. If SSO is enabled, the
user needs to browse to the Zuora link on their Identity Provider
login page to re-establish a Zuora session.
Disable SSO for Zuora User
To disable a user from signing on to Zuora by SSO, complete the following steps:
1. Log in to the Zuora application as a tenant administrator and navigate to Settings > Administration Settings > Manage Users.
2. In the user list, click the user for whom you want to disable SSO. The user details page opens.
3. In the Basic Information section, clear the SSO SAML Enabled field.
4. Click Save.
Testing Identity as a Service redirect log in
1. Log in to your Identity as a Service account.
2. Go to your My Profile page if you are not already there.
3. Under Applications, click Zuora.
4. Respond to the second-factor authentication challenge. If you respond successfully, you are logged in to Zuora.
Note: See the following documentation for more information on Zuora SAML configuration: Configure Single Sign-on for Zuora.