Step 1: Add
your Identity Provider Name to DocuSign and download the Identity Provider
metadata fileDocuSign is a cloud-based transaction platform that lets users send, sign and manage legally binding documents securely (see https://www.docusign.com/). You can protect access to DocuSign by integrating DocuSign with Identity as a Service. Once integrated, users can use single sign-on to log in to their DocuSign account through Identity as a Service.
Note: This integration was tested using Identity as a Service version 5.12 and DocuSign Release November 10, 2020. Other versions of DocuSign may require integration and configuration steps that differ from those documented in this procedure. For other versions of DocuSign, this integration guide may be used as an initial approach for integrating DocuSign. In the event of other issues, contact support@entrust.com for assistance.
Before you begin, you must provide proof of domain ownership to allow for SSO with Identity as a Service. You do this by Claiming a Name and then validating your domain. For more information, see the DocuSign Domains documentation.
Step 1: Add
your Identity Provider Name to DocuSign and download the Identity Provider
metadata file1. Log in to DocuSign using one of the following options:
● Log in using the DocuSign Admin app.
● Log in to DocuSign eSignature and click Settings. The Settings page appears.
2. Click Switch To and select DocuSign Admin. The DocuSign Admin page appears.
3. From the menu pane, select Access Management > Identity Providers. The Identity Providers page appears.
4. Click Add Identity Provider. The Identity Providers Setting page appears.
5. Enter a Name for your Identity Provider, for example, docusign-mycompany.com.
6. Click Save to return to the Identity Provider page.
7. Under the Name pane, locate your Identity Provider name (the one you just created in step 5) and from the Actions drop-down list select Endpoints. The SAML 2.0 Endpoints dialog box appears.
8. Copy the Service Provider Metadata URL and open it in a Web browser. The XML file appears.
9. Right-click in the file and select Save as.
10. Save the XML file as docusign_metadata.xml.
Step 2: Add
DocuSign to Identity as a ServiceAdd DocuSign 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 DocuSign. The Add DocuSign 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 DocuSign 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. 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.
12. Enter the SAML Session Timeout to the time when the SAML Assertion times out. The maximum is 720 minutes.
13. 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.
14. From the SAML NameID Attribute drop-down list, elect the user attribute that will be used to uniquely identity a user to both Identity as a Service and DocuSign. The attribute should be one that will never change. Valid options include Unique User ID, User ID, or Email.
15. From the SAML NameID Encoding Format drop-down list, select Persistent.
16. From the SAML Signature Algorithm drop-down list, select SHA512.
17. Select the SAML Signing Certificate from the drop-down list.
18. 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.
19. 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.
20. 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.
21. 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.
22. Add SAML Attributes as follows (you need to add three attributes):
Add the First Name attribute, as follows:
a. Under SAML Attributes, click Add. The SAML Attributes dialog box appears.
b. In the Name field enter http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname.
c. From the drop-down list, select the Name Format for the attribute.
d. Click Add next to Value(s).
e. In the Values field, type < and select First Name.
f. Click Add.
Add the Last Name attribute, as follows:
a. Under SAML Attributes, click Add. The SAML Attributes dialog box appears.
b. In the Name field enter http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname.
c. From the drop-down list, select the Name Format for the attribute.
d. Click Add next to Value(s).
e. In the Values field, type < and select Last Name.
f. Click Add.
Add the Email attribute, as follows:
a. Under SAML Attributes, click Add. The SAML Attributes dialog box appears.
b. In the Name field enter http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.
c. From the drop-down list, select the Name Format for the attribute.
d. Click Add next to Value(s).
e. In the Values field, type < and select Email.
f. Click Add.
23. Deselect Enable Go Back Button if you do not want users to be able to go back to the DocuSign login page to log in.
24. Click Submit.
Step 3: Create
a resource rule to protect access to DocuSignCreate 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 4: Download
the metadata file 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 5: 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 6: Configure
DocuSign for Identity as a Service authentication1. Log in to DocuSign Admin.
2. Click Settings. The Settings page appears.
3. Click Switch To. The Switch To dialog box appears.
4. Click DocuSign Admin. The DocuSign Admin page appears.
5. In the menu pane under Access Management click Identity Providers. The Identity Providers page appears.
6. In the Name pane click your Identity Provider name you created in Step 1: Add your Identity Provider name to DocuSign and download the Identity Provider metadata file. The Identity Providers Settings page appears.
7. In the Identity Provider Issuer field, paste the Entity ID from the SAML Configuration from Step 5: Copy the SAML Configuration from Identity as a Service.
8. In the Identity Provider Login URL field, paste the Single Sign-On URL from the SAML Configuration from Step 5: Copy the SAML Configuration from Identity as a Service.
9. In the Identity Provider Logout URL field, paste the Single Logout URL from the SAML Configuration from Step 5: Copy the SAML Configuration from Identity as a Service.
10. Select SignAuthNRequest.
11. Select Send AuthN Request by POST.
12. Select Send Logout Request by GET.
13. Under Identity Provider Certificates, upload the metadata file that you downloaded in Step 4: Download the metadata file from Identity as a Service.
14. Click Save.
Testing Service Provider Login
1. Open a Web browser and enter the URL for your DocuSign account. You are directed to Identity as a Service.
2. Enter your DocuSign account User ID and click Next.
3. Respond to the second-factor authentication challenge. If you respond successfully, you are logged into DocuSign.
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 DocuSign.
4. Respond to the second-factor authentication challenge. If you respond successfully, you are logged into DocuSign.