Integrate DocuSign

DocuSign 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.

Prerequisites

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.

Integrate DocuSign

To integrate DocuSign with Identity as a Service, you must do the following:

Step 1: Add your Identity Provider Name to DocuSign and download the Identity Provider metadata file

1. 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 Service

Add 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. Do one of the following:

● Select SAML Cloud Integrations from the search drop-down list and scroll to find the application you want to add to IDaaS.

- or -

● In the Search bar, enter a search option to filter for the application you want to add to IDaaS.

5. Click DocuSign. The Add DocuSign page appears.

6. Enter an Application Name.

7. Enter an Application Description.

8. 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.

9. Select the Authentication Flow that appears to users during login.

10. Click Next. The General page appears.

11. 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.

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.

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, 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.

16. From the SAML NameID Encoding Format drop-down list, select Persistent.

17. From the SAML Signature Algorithm drop-down list, select SHA512.

18. Select the SAML Signing Certificate from the drop-down list.

19. 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.

20. 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.

21. 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.

22. 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.

23. 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. Click Add next to Value(s).

d. In the Values field, type < and select First Name.

e. 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. Click Add next to Value(s).

d. In the Values field, type < and select Last Name.

e. 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. Click Add next to Value(s).

d. In the Values field, type < and select Email.

e. Click Add.

24. 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.

25. Click Submit.

Step 3: Add a resource rule

Step 4: Download the metadata file from Identity as a Service

Download 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 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 6: Configure DocuSign for Identity as a Service authentication

1. 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.