Integrate Envoy

Envoy offers visitor management, employee sign-in, desk reservations, room booking, and delivery management software (see https://envoy.com/). You can protect access to Envoy by integrating Envoy with Identity as a Service. Once integrated, users can use single sign-on to log in to their Envoy account through Identity as a Service.

Note: This integration was tested using Identity as a Service version 5.15 and Envoy Premium Subscription Service. Other versions of Envoy may require integration and configuration steps that differ from those documented in this procedure. For other versions of Envoy, this integration guide may be used as an initial approach for integrating Envoy. In the event of other issues, contact support@entrust.com for assistance.

Prerequisites

1. Log in to your Envoy account. The Home page appears.

2. Click Employee directory.

3. Click Create New.

4. Add the new user to Envoy Premium and save the information.

● Create a corresponding user in Identity as a Service that has an email address that matches the email address of the user in Envoy Premium. (See Add users to Identity as a Service).

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

Step 1: Create a SAML signing certificate in Identity as a Service

Create a SAML signing certificate

Identity as a Service provides a default self-signed certificate. You can also create your own certificate. This might be necessary if your certificate is about to expire or you want to create a certificate and replace the self-signed certificate with a certificate signed by a Certificate Authority (CA).

1. Log in to your Identity as a Service administrator account.

2. Click > Security > Applications. The Applications List page appears.

3. Under SAML Cloud Integrations, click SAML Signing Certificates. The SAML Signing Certificates page appears.

4. Click . The Create Signing Certificate dialog box appears.

5. Enter a Name for the certificate.

6. Select the expiry date from the pop-up calendar and click OK.

7. Click Add. The certificate appears on the Signing Certificates page.

Step 2: Copy the metadata from Envoy

Copy the metadata from Envoy

1. Log in to your Envoy account. The Home page appears.

2. Click Integrations. The All Integrations page appears.

3. Scroll down to SAML and click Install. The Integrations page appears.

4. Open a text editor, such as Notepad.

5. Copy and paste the Assertion Consumer Service URL and the SAML Identifier into the text editor. You need to paste this information in Step 3: Add Envoy to Identity as a Service.

6. Save the file.

Step 3: Add Envoy to Identity as a Service

Add Envoy 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 Envoy. The Add Envoy 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. In the Default Assertion Consumer Service URL field, paste the Assertion Consumer Service URL you copied in Step 2: Copy the metadata from Envoy.

12. In the Service Provider Entity ID (Issuer) field, paste the SAML Identifier you copied in Step 2: Copy the metadata from Envoy.

13. In the Single Logout Service URL field, enter

https://dashboard.envoy.com/login

14. Enter the SAML Session Timeout to the time when the SAML Assertion times out. The maximum is 720 minutes.

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

16. From the SAML NameID Attribute drop-down list, select Email.

17. From the SAML NameID Encoding Format drop-down list, select Email.

18. From the SAML Signing Certificate drop-down list, select the signing certificate.

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 Envoy 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. Leave the other fields at the default settings.

24. Click Submit.

Step 4: Add a resource rule

Step 5: Download the metadata 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.

Attention: Be sure to select the certificate that you used when you added Envoy to Identity as a Service.

Step 6: Save the certificate fingerprint and single sign-on service URL from Identity as a Service

Save the certificate fingerprint

1. Open the metadata.xml file you downloaded in Step 5: Download the metadata from Identity as a Service.

2. Go to the ds:X509Certificate section.

3. Copy the contents of the ds:X509Certificate section and paste them into a text editor, such as Notepad.

4. Save the contents as SAMLCertificate.cer.

5. Locate the SAMLCertificate.cer file and double-click to open it. The Certificate Information dialog box appears.

6. Click the Details tab.

7. Scroll and click Thumbprint.

8. Copy the values that appear in the field and paste them in a text editor, such as Notepad.

9. In the metadata file, scroll to the SingleSignOnService Location section and copy the single sign-on URL and paste it into the text editor.

Example: https://<mytenantaccount>.com/api/saml/SAML2/SSO

10. Save the file as IDPConfiguration.txt.

11. Click OK to Close the Certificate Information dialog box.

Step 7: Configure Envoy for Identity as a Service authentication

Configure Envoy for Identity as a Service

1. Log in to your Envoy account. The Home page appears.

2. Click Integrations. The All Integrations page appears.

3. Scroll to SAML and click Install. The Integrations page appears.

4. Open the text file you created in Step 6: Save the certificate fingerprint and single sign-on URL from Identity as a Service.

5. Copy the fingerprint you saved in the text file and paste it in the Fingerprint field.

6. Copy the Single Sign-On Service URL you saved in the text file and paste it in the Identity Provider HTTP SAML URL field.

7. Click Required to enable it (the button turns green).

8. Click Save.

Testing Service Provider Login

1. Open a Web browser and enter the URL for your Envoy account. You are directed to Identity as a Service.

2. Enter your Envoy account User ID and click Next.

3. Respond to the second-factor authentication challenge. If you respond successfully, you are logged into Envoy .

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

4. Respond to the second-factor authentication challenge. If you respond successfully, you are logged into Envoy .