Skip to main content
Sign in

Cloud Streaming - SSO - Google OIDC Setup Guide

Andrew Ricke
  • Updated

This document is intended to be paired with Cloud Streaming - SSO - OIDC Configuration for users with Google Admin Console to manage their users.

 

You must start an SSO Configuration on your Cloud Portal Admin to continue below. It is best to configure both ends of this OIDC handshake together with 2 open windows or tabs on your browser.

 

For most of our customers using Google Workspace for user and directory management, we recommend using the SAML configuration option as an easier to configure and manage option.  This is provided for users familiar with OIDC via Google Cloud who know what advanced features within OIDC they are looking for.

 

Step 1 – Start Swank SSO OIDC Configuration

  1. Log Into your Swank Streaming Portal to the Admin section (e.g.: https://digitalcampus.swankmp.net/[your site ID]/admin or https://streaming.swankmp.net/[your site ID]/admin)
  2. Select SSO Configurations in the left menu
  3. Review the list of SSO Configurations for your portal
    1.  
    2. Legacy Providers:  If you've previously configured SSO via SAML or Google OAuth, you'll find their configuration listed at the bottom here.
      • Note: You cannot "upgrade" your existing OAuth configuration to our new Identity Service host - you must create a new OIDC configuration. 
      • The legacy configurations are deactivated automatically when a new SSO Provider is activated.  You can "fallback" to the legacy provider by deactivating the new provider(s).
    3. SSO Configurations  At the top of the page, see the list of available providers.  You can:
      • Activate or Deactivate existing configurations via the Active toggle.
      • Edit or Delete existing configurations via button actions
      • Add new SSO Configurations via the button at the Top.  (We'll continue this guide from this route)
  4. Click the Add Configuration button. 
  5. Choose the Provider Type of OIDC
  6. Display Name: This displays on the list of SSO Configurations as well as the button added to the Login page.

Step 2 – Create Google Cloud Project

  1. On a separate tab/window log into your https://console.cloud.google.com/ account.
  2. Open the Google project selector from the top navigation bar
  3. On the Resource selection, create a new project
    • Make sure it is assigned to the Organization with the users you wish to grant access for.
    • Project name can be anything you prefer to stay organized.  Swank Cloud Streaming or Swank Digital Campus is recommended.
    • Click Create to generate the project

Step 3 – Setup Google Auth Platform

  1. Open the Google project selector from the top navigation bar and select the newly created project.
  2. From the main Navigati menu, select Google Auth Platform > Overview
    • Click Get Started
  3. Complete App Information
    • App Name: Swank Cloud Streaming or Swank Digital Campus is recommended
    • User Support Email:  Your IT help contact address
    • Click Next
  4. Select Internal for Audience
    • Click Next
  5. Provide your IT support email for the Contact Information
    • Click Next
  6. Finish: Agree to the Google API Services User Data Policy
    • Click Continue
    • Click Create

Step 4 – Create OAuth Client

  1. On Overview you will find CREATE OAUTH CLIENT or navigate to the Clients page and client + CREATE CLIENT
  2. Complete the form
    • Application type: Web application
    • Name:Swank Cloud Streaming or Swank Digital Campus is recommended
  3. Add Authorized JavaScript origins - Adding both subdomains below are recommended
     
    • https://streaming.swankmp.net
    • https://digitalcampus.swankmp.net
  4. Click Create to generate the client and then go back into the edit form:
  5. On your Swank Streaming Portal
    1. Add https://accounts.google.com as the Authority URL.
    2. From your Google Admin Console copy the Client ID and Client secret and paste them into the respective OIDC fields on your Swank Cloud Portal:
      • Click Save to generate a Callback Path
  6. Add your generated Callback Path to the Authorized redirect URIs within the Client ID form and click Save:

Step 5 – Update Branding

  1. From the Google Auth Platform menu select Branding
  2. Add an App Logo - You may use one of the below
  3. Complete the App domain section
  4. Add Authorized domains
    • Add Authorized Domains for each email domain your users will be utilizing under your directory
      • Note: These must not be public email domains such as gmail.com - they must be private domains used in your directory.
        • Example:
        •  
  5. Verify that Developer Contact information is correct
    • This must be the contact for who will be supporting this OIDC connection
  6. Click the Save button

Step 6 – Provide Necessary Data Access Scopes

  1. From the Google Auth Platform menu select Data Access
  2. Click ADD OR REMOVE SCOPES
  3. Check the first 3 options for providing non-sensitive scopes: 
    • /auth/userinfo.email
    • /auth/userinfo.profile
    • openid
  4. Click Update to save changes

 

Step 7

Role Mapping, User Authorization, and Permission Elevation

All successful authentications will be authorized at the "Basic" or "User" account levels (role) by default depending on the portal settings. To elevate permissions to a higher permission level for Instructors or Administrators you will need to add Role Mappings to grant this elevation either by Attribute Value or Individual UserID. For more information on Account Level Permissions, please see the following article: 
https://swankmp.zendesk.com/hc/en-us/articles/5723258435092-Cloud-Streaming-User-Account-Roles

 

There are 3 methods of providing roles and are respected in the following order - with the former values overriding any latter options.

  1. Mapping Roles on the Streaming Portal 
  2. Claim/Attribute of "role" directly provided by your Identity Provider
  3. The Portal Default "User" or "Basic" role (Set by your Swank support)

Option 1: Mapping Roles on the Streaming Portal (Recommended)

Initial Account Creation

A registered account with the preferred role using the email of a user can be established prior to their initial login by using one of the methods described in the link below.

 

Post Account Creation

Individual Role Mappings can be modified after an account has been established by using the following steps:

  • Log in to your streaming portal with an Admin account.
  • Select Users from the menu
  • Select the expand menu for the intended user and select Edit Profile
  • Select the appropriate Role and click Save

 

Option 2: Identity Provider Role Assignment

In some cases, your Identity Provider can provide a Claim or Attribute for each User with the Name of "role" and the Value of one of our available user roles:  "Admin", "Instructor", "User", or "Basic".  This allows your Identity Provider Admin to set the roles based on policies and rules aligned with your organizations larger technology access strategy and to manage that access centrally at your User Directory.

Each Identity Provider has a different method for handling this action, please consult your identity provider to confirm the availability and documentation.

Notes: 

  • The attribute name is case-sensitive and must be "role".
  • The attribute values are not case-sensitive.
  • You can verify you have the "Role" attribute provided by checking your diagnostics while logged in under the desired SSO setup.  
    • Log into your Portal's catalog, appending /diagnostics to the URL.
      • For Example:
        • https://digitalcampus.swankmp.net/[your site ID]/diagnostics
        • https://streaming.swankmp.net/[your site ID]/diagnostics)
    • Look for the field Swank.ExternalRole for the role sent by your identity provider (IDP).
  • Once an account is established on your Swank Streaming portal it cannot be overwritten by your IDP role. You can do one of the following:
    • Update the account role manually in the streaming portal.
    • You can attempt to remove the established account, but if it has been used with the title request process this is not always possible.

 

Option 3: Portal Default Role

All successful authentications will be authorized at the "Basic" or "User" account levels (role) by default depending on the portal settings. 

 

 

 

Final Step

Make Configuration Active

Once you configured your OIDC Identity Provider, and determined your User's roles, remember to click the Activate toggle on the SSO Configuration page for your chosen Provider(s). If you are currently viewing the SSO Configuration detail page, you can click the "Go Back" link at the top of the page or click SSO Configuration from the side menu.

  • Toggle Active to the On position for your new SSO Configuration.

Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk