Configuring Access Control Profiles

Product(s)
Gallery
Role(s)
Studio User
Task(s)
Configure Gallery Settings
Topic(s)
Access Control

In this topic you will learn how to configure access control profiles for a Gallery Portal experience.

By default, when a Gallery portal experience is published, anyone with the site URL will be able to access the site. Access control profiles can be created to restrict access to a Gallery portal experience. Access control profiles are created as part of the Gallery settings and then the profiles are assigned to sites. Access control profiles can be created to restrict access based upon:

To create an access control profile, follow these steps:

  1. Open the Gallery module.
  2. Click the Settings link on the Gallery home page.
  3. In the left navigation, click Access Control Profiles. A list of created Access Control Profiles will be displayed.
    profiles list

    Note: You may see access control profiles in your account that you did not create. If you had configured IP restrictions, SSO or an access code for site(s) before Gallery implemented access control profiles, those settings have been saved as access control profiles when the feature was released.

  4. Click Create Profile.
  5. Give the profile a Name.
  6. (Optional) Configure a Session Timeout to specify the amount of time a user's session will last. A few notes:
    • This setting applies when using SSO and Access code
    • This is an "idle timeout". Whenever the Gallery server is hit (either through loading a page on the site or via an API call to the site) the timer is reset. This allows viewers to continually browse for longer than the specified timeout, but as soon as they go idle for longer than the timeout, they will be logged out. While a video is being watched, the Gallery server is not being accessed though, so the timeout value should be longer than your longest video.
    • Your SSO provider must be set to either force re-authentication or to have a session timeout of less than our timeout. If it's not, we'll redirect to your SSO provider after our timeout and they will immediately issue a response that the user is logged in.
  7. Select the option(s) to secure the site:
  8. Click Save.
  9. Create additional Access Control Profiles as needed.

To edit or delete an access control profile, click the edit (edit icon) or delete (delete icon) buttons associated with the access control profile. Once access control profiles have been created, they can be assigned to a site as part of the site properties. For information, see Controlling Access to a Portal Experience.

Configuring IP restriction

When creating an access control profile that uses IP restriction, viewers with an IP address outside of the predefined range will receive an error when they try to access the site.

To configure an access control profile to use IP restriction, follow these steps:

  1. Select the Limited by IP address option.
  2. Enter a range of IP addresses that can access the site. CIDR block notation is also supported.
    configure ip address
  3. Click Save.

Configuring Single Sign-on

When creating an access control profile that uses SSO, site visitors will be prompted to login with valid credentials before they can access the site. Gallery supports the Security Assertion Markup Language 2.0 (SAML 2.0) standard for exchanging authentication and authorization data between security domains.

Gallery supports most major Identity Providers, including:

  • Ping
  • OneLogin
  • ADFS 2.0 / 3.0
  • Google G Suite
  • Shibboleth
  • Okta
  • Salesforce.com

Other providers using the SAML 2.0 standard will also work. Gallery uses the passport-saml library. Gallery does not support Identity Providers that do not work with this library.

Note: Gallery requires SAML 2.0 for single sign-on authentication. SAML 1.1 is not supported.

Note: We only support single-byte characters.

Your SSO provider will require an Assertion Consumer Service URL (ACS URL). The ACS URL is listed in the SSO section of the Access Control Profiles table.

acs url

The ACS URL defaults to https://auth.bcvp0rtal.com/login/callback. You can also override the ACS URL by providing your own URL. Both of these options can be used for configuring stricter SSO providers. For existing sites, http(s)://<site-root-url>/login/callback will still work but Brightcove recommends that publishers use https://auth.bcvp0rtal.com/login/callback. This endpoint takes care of forwarding SAML data to the correct site for any sites that use a path on a domain.

Note: When using an IDP-initiated SSO workflow, the ACS URL specified in your SSO software should point to a Gallery site which is configured with that access control profile. In this case, the https://auth.bcvp0rtal.com/login/callback URL should not be used.

To configure an access control profile to use SSO, follow these steps:

configure sso
  1. Select the SSO option.
  2. If you have an export file of your SAML 2.0 metadata, click Select File to browse and select the metadata file. This will prefill the SAML 2.0 Endpoint and the X.509 Certificate fields.
  3. Enter a value for the SAML 2.0 Endpoint (HTTP). This value should be available from your SAML provider.
  4. Enter a value for the X.509 Certificate. This value should be available from your SAML provider.
  5. (Optional) Enter the SAML Issuer / Entity ID Override. Enter a value here to optionally override the SAML issuer.
  6. (Optional) Enter the ACS URL Override. Enter a value here to optionally override the ACS URL.
  7. (Optional) Enter the SAML AuthnContext Override. Enter a value here to optionally override the SAML AuthnContext.
  8. (Optional) Enter any SAML attributes for that you want passed to your external JavaScript.
  9. (Optional) Check Expose all attributes to expose all of the SAML attributes for use in external JavaScript.
  10. Click Save.

Configuring an access code

When a site has an access code applied, viewers will be prompted to provide the correct access code when the access the site URL.

access code prompt

If an incorrect access code is entered, the viewer will receive an error. Access codes are a good way to restrict access to a site while it is under construction. Access codes do not offer any site security or authentication.

To configure an access control profile to use an access code, follow these steps:

  1. Select the Require Access Code option.
  2. Enter the Access Code for the site.
  3. Enter the Access Code Label. The Access Code Label will appear above where the user will enter their access code.
    configure access code
  4. (Optional) Style the access control page.
  5. Click Save.

 

Styling the access control page

The access control page can be styled to more closely match the look of your overall site. Gallery provides three styling options:

Default styling

With the default styling option, a Gallery logo, the Access Code Label and an access code field will always be displayed.

access code prompt

Image & Border styling

The Image & Border option allows for some basic customizations to the access control page. An example can be seen below.

image border example

To customize the image and border styling, follow these steps:

  1. Select Image & Border.
  2. Drag & drop, browse, or add a link to the image to display on the access control page.
  3. Enter a Clickthrough URL. The Clickthrough URL will make the image a clickable link.
  4. Click on the color picker to select a Header Border Color.
    image border properties
  5. Click Save.

Custom styling

The Custom styling option allows for more advanced customizations to the access control page. An example can be seen below.

custom example

To use the Custom option, follow these steps:

  1. Select Custom.
  2. Enter custom HTML for the header and footer.
    custom properties
  3. Click Save