Integrating Audience with Single Sign-On

Product(s)
Video Cloud
Role(s)
Studio User
Topic(s)
Audience/Marketing Automation

This topic explains how to configure the Audience module for use with single sign-on.

The Audience module provides the ability to track viewing activity when the viewer has logged into a system using single sign-on (SSO). In this scenario, viewing data is not sent to a marketing automation platform. With an Audience SSO configuration, SAML attribute(s) are passed to Audience to identify the viewer. One common use case for this would be internal training videos. Employees might be required to login to watch videos and then their viewing activity can be tracked and then viewed inside the Audience module. To enable Audience for use with SSO, the following steps are required:

  1. Configure single sign-on software
  2. Configure your application to access SSO attributes
  3. Setup the Audience SSO connection
  4. Configure the integration
  5. Create an Audience-enabled player
  6. View video data

Configuring SSO software

The steps to install and configure SSO software is outside the scope of this topic. The SSO software should be configured so users have to authenticate themselves before they can view Video Cloud videos. The SSO software should be configured to expose some user attributes so they can be accessed from an external application. For example, this Okta SSO configuration exposes three attributes, FirstName, LastName and Email.

okta setup

In this topic, the Email attribute will be used to identify viewers to the Audience module.

Configuring an application to access SSO attributes

The application or website that will be used to view Video Cloud videos should be configured so that the SSO attributes are made available via JavaScript for Audience. This configuration will vary based upon the application or website being used. In the following example, an SSO access control profile was created in Gallery. As part of the configuration, the Email SSO attribute is being exposed and will be available inside the Gallery site. This is the value that will be used to identify viewers to the Audience module.

okta setup

Note: For information on configuring Access Control Profiles in Gallery, see Configuring Access Control Profiles.

Setting up the connection

Follow these steps to setup the connection between Video Cloud and your SSO provider.

Establishing the connection between Video Cloud and SSO

  1. Open the Audience module and click Setup in the left navigation.
  2. Click Add New Connection.
  3. Select SSO as the integration.

    Note: The integrations that are available are based upon your Video Cloud subscription.

  4. (Optional) Enter a Connection Name.
    audience setup
  5. Click Connect.

The SSO connection is now set up and ready to use.

Configuring the integration

Once the SSO connection has been made, you can configure the integration.

connected options
  1. Click the empty link in the SSO Property section. Enter the name of the JavaScript value to look for in the page. In this example, Gallery was configured to expose the Email SSO attribute so that is what is being used here.
    email attribute

    In this topic, the Audience SSO integration will be used to track viewing activity. Click Save.

    Note: It is also possible to leave the SSO Property empty and then use one of the additional options to identify viewers.

  2. By default, the Integration Status will be Enabled. The Integration Status determines if Video Cloud video engagement data is saved.
    • Enabled - Data is collected
    • Disabled - No data is collected (integration is disabled)
  3. Select a data retention policy. The data retention policy determines how long the viewing data and lead form data (if using an Audience lead form) will be retained in your Video Cloud account. You should adjust the retention settings according to your privacy policy.
    data retention options

To remove the integration, click Disconnect. The bottom of the page will list all Audience-enabled players, the connections they are associated with and the associated lead forms.

The Audience module supports multiple connections to marketing platforms. Click Add New Connection to configure additional integrations.

Additional options for identifying viewers

If you don't specify a value for the SSO Property when the integration is configured, you are responsible for identifying viewers. The Audience module needs the following information:

Description URL Parameter Embed Parameter Value
What’s the GUID (needed for view event tracking) bcssoguid data-bc-sso-guid string
 

This parameter can be passed in via a URL parameter or through the player embed code. For viewer tracking to occur, this parameter should be passed as a URL parameter on the page that is displaying the video.

Note: In order for the player/plugin to read the URL parameter, the Advanced (in-page) embed code should be used. The Standard (iframe) embed code will not work as the plugin will be running inside of an iframe and therefore is unable to access the parent page URL which has the parameter.

It’s also possible to pass the GUID to the Audience player using a JavaScript value that’s available in the page. Using the player config, it’s possible to tell Audience what the name of the JavaScript variable is and Audience will then attempt to read that variable using it as the custom GUID. To do this, edit the Audience player and configure the plugin options for the Audience plugin.

plugin params

In the above example, the player config is telling Audience that there’s a JavaScript object in the page called samlAttributes and it has a property called nameID. Audience will attempt to read that and use its value for the custom GUID.

Creating an Audience-enabled player

Video engagement data will only be tracked when you are using an Audience-enabled video player. For information on creating an Audience-enabled Brightcove Player, see Creating an Audience-enabled Player.

Viewing video data

There are several options available for viewing video data when using an SSO integration:

  • Viewer Activities (Events) - Provided as part of the Audience module, this option can be used to view video data inside the Audience module. For information, see Viewing Player Events in the Audience Module.
  • Viewer Profiles - Provided as part of the Audience module, this option can be used to view video data based upon a user profile value inside the Audience module. For information, see Viewing Viewer Profile Information.
  • Export Data - Provided as part of the Audience module, this option can be used to export video view and lead data. For information, see Exporting Data from the Audience Module.
  • Audience API - The Audience API can be used to programmatically retrieve video view and lead data. For information, see Overview: Audience API.