Envoy

Before You Begin

Introduction

This document describes how to configure Oracle Identity Cloud Service to provide Single Sign-On (SSO) for Envoy using SAML.

About Envoy

Envoy is a visitor registration system (sometimes called an iPad app for front desk sign-in) that is changing the approach of greeting visitors upon their arrival at a workplace. Envoy facilitates modern business organizations with a seamless, digital visitor sign-in experience.

After integrating Envoy with Oracle Identity Cloud Service:

  • Users can access Envoy using their Oracle Identity Cloud Service login credentials.
  • Users can start Envoy using the Oracle Identity Cloud Service My Apps console.
  • Admins can assign and revoke user access to the Envoy app using the Oracle Identity Cloud Service administration console.

What Do You Need?

  • An Oracle Identity Cloud Service account with authorization rights to manage apps and users (Identity Domain Administrator or Application Administrator).
  • An Envoy account with authorization rights to configure federated authentication.
  • Make sure that the email ID of each user in Envoy matches the primary email ID of the Oracle Identity Cloud Service account.

Configuring the Envoy App in Oracle Identity Cloud Service

Use this section to register and activate the Envoy app, and then assign users to the app.

Registering and Activating the Envoy App

  1. Access the Oracle Identity Cloud Service administration console, select Applications, and then click Add.

  2. Click App Catalog.

  3. Search for Envoy, click Add, and then click Next.

  4. Click Download Signing Certificate.

    Tip: Use this file later during the Envoy configuration in the "Configuring SSO for Envoy" section.

  5. Click Finish. Oracle Identity Cloud Service displays a confirmation message.

  6. Click Activate, and then click Activate Application. Oracle Identity Cloud Service displays a confirmation message.

Assigning Users to the Envoy App

  1. On the Envoy app page in Oracle Identity Cloud Service, select Users, and then click Assign. The Assign Users window appears.

  2. Select users that you want to assign to Envoy, and then click OK. Oracle Identity Cloud Service displays a confirmation message stating that the Envoy app is assigned to the users that you selected.

Configuring SSO for Envoy

  1. Access Envoy as an administrator using the URL: https://dashboard.envoy.com/login. The Envoy home page appears.

  2. From the header navigation menu, select Settings.

  3. On the Settings page, select INTEGRATIONS. The All integrations window appears.

  4. Locate the Single sign-on section, and then click Install under SAML to configure SSO.

  5. On the SAML page, use the table to update the federated authentication attributes, and then click Save.

    This table lists the mandatory federated authentication attributes that you must set to complete the SSO configuration.
    Attribute Value
    Fingerprint Convert your Identity Cloud Service certificate that you downloaded during the Envoy registration into a Fingerprint. To convert, go to https://www.samltool.com/fingerprint.php and paste the certificate. Select SHA1 as the algorithm. Paste the converted certificate into the Fingerprint box.
    Identity Provider HTTP SAML URL Enter the Sign-in URL/SSO Endpoint: https://<IDCS-Service-Instance>.identity.oraclecloud.com/fed/v1/idp/sso.

Verifying the Integration

Use this section to verify that SSO works when initiated from Oracle Identity Cloud Service (IdP Initiated SSO) and Envoy (SP Initiated SSO).

Verifying Identity Provider Initiated SSO from Oracle Identity Cloud Service

  1. Access the Oracle Identity Cloud Service My Profile console using the URL: https://<IDCS-Service-Instance>.identity.oraclecloud.com/ui/v1/myconsole.

  2. Log in using credentials for a user that is assigned to the Envoy app. Oracle Identity Cloud Service displays a shortcut to Envoy under My Apps.

  3. Click Envoy. The Envoy home page appears.

  4. In the upper-right corner, confirm that the user logged in is the same for both Envoy and Oracle Identity Cloud Service.

    This confirms that SSO that is initiated from Oracle Identity Cloud Service works.

Verifying Service Provider Initiated SSO from Envoy

  1. Access Envoy using the URL: https://dashboard.envoy.com/login. The Envoy sign in page appears.

  2. Enter your Email address, click Next, and then click You can also login using Single Sign On. You are redirected to the Oracle Identity Cloud Service login page.

  3. Log in using credentials for a user that is assigned to the Envoy app. The Envoy home page appears.

  4. In the upper-right corner, confirm that the user that is logged in is the same for both Envoy and Oracle Identity Cloud Service.

    This confirms that SSO that is initiated from Envoy works.

Troubleshooting

Use this section to locate solutions to common integration issues.

Known Issues

Envoy displays the message, "SAML employee not found"

Cause: The email attribute sent by Oracle Identity Cloud Service during SSO doesn't match any existing user in Envoy.

Solution: Ensure that the user that you assign to the Envoy app has an account in both Oracle Identity Cloud Service and Envoy with the same email address.

Oracle Identity Cloud Service displays the message, "You are not authorized to access the app. Contact your system administrator."

Cause 1: The SAML 2.0 integration between the Oracle Identity Cloud Service Envoy app and Envoy is deactivated.

Solution 1:

  • Access the Oracle Identity Cloud Service administration console, select Applications, and then select Envoy.
  • In the App Details section, click Activate, and then click Activate Application. Oracle Identity Cloud Service displays a confirmation message.

Cause 2: The administrator revokes access for the user at the same time that the user tries to access the Envoy app using Oracle Identity Cloud Service.

Solution 2:

  • Access the Oracle Identity Cloud Service administration console, select Applications, and then select Envoy.
  • In the App Details section, select Users, and then click Assign to re-assign the user.

Unknown Issues

For unknown issues, contact Oracle Support:

  1. Go to https://support.oracle.com.

  2. Select Cloud Support, and then sign in with your support credentials.

  3. In the Cloud Dashboard, confirm that there are no planned outages in Oracle Identity Cloud Service, and then click Create Service Request.

  4. Select Oracle Identity Cloud Service as the service type.

  5. Complete your service request.