Skip to main content
Sign in

Cloud Streaming - SSO - Azure OIDC Setup Guide

Andrew Ricke
  • Updated
Not yet followed by anyone

This document is intended to be paired with Cloud Streaming - SSO - OIDC Configuration for users with Azure Entra ID 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.

 

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 Configuration in the left menu
  3. Review the list of SSO Configurations for your portal
    •  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).
    • 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 - Azure App Registration

  1. In a separate tab navigate to your Azure Portal, go to App registrations and click New registration
  2. Complete the Register an application form
    1. Name: Swank Cloud Streaming or Swank Digital Campus is recommended.
    2. Support Account Types: Accounts in this organizational directory only (Default Directory only - Single tenant)
    3. Redirect URL: leave blank for now
    4. Click Register
  3. On the Overview page for this new App, copy the Application (client) ID
     
    • Paste this value into the Client ID of your Swank Streaming Portal's OIDC SSO Configuration
  4. On the Overview page for this new App, click Endpoints
    • Copy the first Authority URL (Accounts in this organizational directory only)
    • Copy this into the Authority URL of your Swank Streaming Portal's OIDC SSO Configuration
  5. On the Overview page for this new App, click the Add a certificate or secret
  6. Click New client secret
    • Select the desired Expires duration - 24 months is recommended
    • Click Add
  7. Copy this newly created client secret.
      • Do not leave this session before copying this Client Secret value or it will no longer be available to use.  Please also note the date of expiration when a new key must be generated.
  8. Paste the Client Secret into the Client Secret of your Swank Streaming Portal's OIDC SSO Configuration
  9. Click Save and a Callback Path (ACS Endpoint) will be generated
  10. Complete the handshake with the OIDC provider by copying the Callback Path (ACS Endpoint)
  11. On your Azure Portal, in the Authentication page, under Platform configuration, click Add a platform
    • Choose Web
    • Paste the Callback Path (ACS Endpoint) into the Redirect URIs
    • Click Configure
    • Also on the Authentication page make sure Supported account types is set to Accounts in this organizational directory only

Step 3 – Update Branding

  1. Navigate to the Branding & properties page
  2. Add an App Logo - You may use one of the below
  3. Complete the URLs section
  4. Ensure that the Publisher domain is one under your Azure account

 

Step 4 – Add Claims

  1. Navigate to the Token configuration page
  2. Select Add optional claim, select Token type ID
  3. Select the following Claims
    1. email
    2. family_name
    3. given_name
  4. Optional: You can select Add groups claim to use for Role mapping

 

Step 5

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 market. 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.  Claim/Attribute of "role" directly provided by your Identity Provider
  2.  Role Mapping on the Portal's SSO Configuration
  3.  The Portal Default "User" or "Basic" role (Set by your Swank support)

Option 1: Identity Provider Role Assignment (Recommended)

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, below are some examples for Google and Azure for reference.

For Google:

  1. Go to Users and under More options, choose Manage custom attributes
  2. Add a Custom Attribute: Choose any name you'd like for tracking.
  3. Assign that Custom Attribute to an App Attribute of "role" in the SAML Attribute mappings.
  4. Make sure the User Information in Google Directory populates that Custom Value correctly for each user:

For Azure:

  1. Add a User Attribute such as 'SwankRole' that has a Data Type of String
  2. Define this string for your users as required
  3. In your Azure SAML Configuration, go to the Attributes & Claims and click Add new claim 
  4. Edit the Name values to role, and map the  Source attribute to the User Attribute created in step 1

 

You can verify you have "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:  (e.g.: https://digitalcampus.swankmp.net/[your site ID]/diagnostics or https://streaming.swankmp.net/[your site ID]/diagnostics)

 

Option 2: Role Mapping via Attributes

To use this, you will need to identify or create an attribute that defines the user group(s) (such as a department) and differentiates them from the general population (students). Those attributes must be provided to your SSO configuration via your Identity Provider.  You can see what attributes are currently being delivered in your SAML statement via checking your diagnostics.
 

Log into your Portal's catalog, appending /diagnostics to the URL:  (e.g.: https://digitalcampus.swankmp.net/[your site ID]/diagnostics or https://streaming.swankmp.net/[your site ID]/diagnostics)

 

Under Access Token you will find the available attributes available to role map. 

In this example, you can see the attribute "department" has a value of "adminDepartment". We will use this as an example as to how to grant "Admin" permissions to all users with this attribute value: 

  1. While editing the SSO Provider, go to the Claims Role Mappings table, click Add Role Mapping
  2. In the Add Role Mapping pop-up window, for this example you would enter:
    Claim Name: "department"
    Claim Value: "adminDepartment"
    Role: "Admin"
     
  3. Click Save, You will now see your Role Mappings in the listing

You may add as many of these as needed for Instructor and Administrator permissions.   You can see from the example above, you can use direct email addresses, or even these can be based on Groups, such as email groups provided by Google:

 

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