Integrate with Auth0

Integrate Beyond Identity as a passwordless Identity provider in Auth0

Introduction

This guide provides information on how to set up Beyond Identity as a passwordless authentication provider in an Auth0 environment.

This guide will cover:

  • How to configure SSO for Beyond Identity's Admin Portal
  • How to configure Beyond Identity as an Identity provider
  • How to Provision and Deprovision users when Auth0 is the master directory

📘

You can find us in the Auth0 Marketplace.

Prerequisites

Before continuing, make sure the following prerequisites have been met:

  • Ensure that you have an Auth0 account with admin privileges
  • Access to a Beyond Identity tenant

Configure SSO for Beyond Identity Admin portal

The Beyond Identity Admin portal can either be accessed using Auth0 or using Beyond Identity as the Identity provider (default). The following steps should be implemented if Auth0 will be the SSO provider for access into Beyond Identity's Admin Portal.

Step 1. Set Up the Beyond Identity Admin Portal application

  1. From the left side menu, select Applications and click + Create Applications.
  1. Name the application Beyond Identity Admin Portal, and set the Application Type as Regular Web Application.
  2. Select Create.
  1. On the Settings tab, scroll down and make note of the Domain, SSO Client ID, and SSO Client Secret. You will need these in the next step.
  1. Optional: To add a Beyond Identity logo, scroll down to Application Properties and in the Application Logo field, copy in the following link:

  2. Scroll down to Application URIs and fill in the following values:

  1. Scroll down to the end of the page and click Save Changes.

Note: All other settings should be left with default values.

Set Up Admin Portal Access

Make a note of the Domain, Auth0 Client ID, and Auth0 Client Secret from the previous step. These values will be used to configure access to the Beyond Identity Admin Portal.

  1. Log in to the Beyond Identity Admin portal and select Account Settings.
  1. Select the Admin Console tab, and click Edit SSO.
  1. Update the SSO Issuer, SSO Client ID, and SSO Client Secret from Step 3.4 and click Save Changes.

Note: SSO Issuer is the domain URL in Auth0.

Add Beyond Identity as an Identity Provider

Depending on your Auth0 subscription (license) you can add Beyond Identity as an identity provider using the Enterprise OIDC connection or as a custom social (OAuth2.0) connection.

Create an Inbound OIDC client in Beyond Identity

  1. Log into the Beyond Identity Admin portal, select the Integrations tab, and select OIDC Clients.

  2. Select Add OIDC Client and fill in the following fields:

    • Name = Auth0 SSO

    • Redirect URL = https://.auth0.com/login/callback

    • Replace with your Auth0 domain URL

example: https://byndid-auth0-demo.us.auth0.com/login/callback

Leave Token Signing Algorithm and Auth Method with their default values.

  1. Click Save Changes.
  1. Select the newly created OIDC client configuration and make a note of the Client ID and Client Secret as these will be used in the next steps.

Enterprise OIDC Connection

  1. On the left side menu, click Authentication, and click Enterprise from the expanded menu.
  2. On the Enterprise Connections page, click Open ID Connect.
  1. Then within the Open ID Connect menu click ‘Create Connection’
  2. Enter the following values:
    • Connection Name: “Beyond-Identity”
    • Issuer URL: “https://auth.byndid.com/v2”
    • Client ID: From OIDC client created in Beyond Identity
    • Client Secret: From OIDC client created in Beyond Identity
  1. Click Create.

  2. On the Settings tab under Issuer URL, click Show Issuer Details and add the following values to the appropriate fields:

  1. Scroll down to Scopes and enter openid.
  1. Click Save Changes.
  2. Scroll up and click the Login Experience tab.
  1. Under this tab, find the section called Connection button and check (enable) the checkbox field labelled Display connection as a button.
  2. Enter the ‘Button display name’ as “Beyond Identity”.
  3. Add the following URL for the :point-down:

Button Logo URL - https://byndid-public-assets.s3-us-west-2.amazonaws.com/logos/beyondidentity.png

  1. Scroll down and click Save.

Custom Social (OAuth2.0) Connection

  1. On the left side menu, click Authentication, and from the expanded menu, click Social.
  2. On the Social Connections page, click the + Create Connection button in the top right corner:
  1. On the New Social Connection page, scroll down to the last option called Create Custom.
  1. On the new connection form, enter the following values:
function(accessToken, ctx, cb) {

  request.get('https://auth.byndid.com/v2/userinfo',        {
      headers: {
        'Authorization': 'Bearer ' + accessToken
      }
   },
    function(err, r, body) {
      if (err) {
        return cb(err);
      }
      try {
        var profile = JSON.parse(body);
        profile.provider = 'beyond';
        profile.id = profile.id;
        profile.displayName = profile.display_name;
        profile.email = profile.email;
        cb(null, profile);
      } catch (e) {
        cb(e);
      }
    });
}
  1. Leave the other values as default and click Create.

  2. The connection is then saved and the ‘Applications’ tab will be displayed. You can now configure which applications should use this connection. Use the toggle switches to enable the connection for the applications you wish to use Beyond identity with.

  3. If you are using Auth0 hosted pages, the button text and button logo must be be updated. Auth0 only supports this via the API at the point rather than through the UI. You can follow the Auth0 docs here to configure this last part:

Note: We recommend labelling the button ‘Beyond Identity’ or ‘Passwordless’.

  1. If you are using your own login form, you can add the button manually and call the authorize endpoint specifying the connection parameter where the connection is the name of the connection you just created as documented here:

Enable the Beyond Identity connection in Auth0

  1. From the left side menu, select Connections → Enterprise → Beyond-Identity → Applications.

  2. Enable the OIDC connection or Custom OAuth2.0 connection for the Beyond Identity Admin portal and any applications you wish to user Beyond Identity for.

Confirm Callback URL

Important Check the Auth0 callback URL is correct the in Beyond Identity OIDC integration

  1. In Auth0, under the Settings tab of the Beyond Identity OIDC connection created in Step 8, make a note of the Callback URL as shown below:
  1. Navigate to the Beyond Identity Admin portal, select the Integrations tab, and click OIDC Clients. Select the OIDC client that was created in Step 4 and click Edit.

  2. Ensure that the Redirect URI value matches the value in the Auth0 connection. If the values do not match, update the value with the Callback URL from Auth0.

User Provisioning

Setting up test users

Before users can start authenticating with Beyond Identity, they must be provisioned in the Beyond Identity Directory. As Auth0 does not support SCIM, users must be manually provisioned using the Beyond Identity Admin Portal or using the Create User API. See the Admin Portal video tutorial that shows how to navigate to the directory area of the admin portal.

https://www.beyondidentity.com/resources/beyond-identity-admin-console-overview

  1. In the Admin Portal under the Directory tab, select Add User.

  2. Enter the following values:

    • External ID: user_id in Auth0, for example: oidc | Beyond-Identity | <email_address>

    • Email: <email_address>

    • Username: <email_address>

    • Display Name: <Full_Name>

Note: The External ID format above must be adhered to as this will be the user ID of the user in Auth0.

User Deprovisioning

To deprovision users from the Beyond Identity experience, access the Beyond Identity Admin Portal and manually delete the appropriate user(s).


Did this page help you?