Configure Membes AMS Single Sign-On (SSO) with webcastcloud

Configure Membes API

The following the steps and details are required when working with Membes API v1
https://membes.atlassian.net/wiki/spaces/DD/pages/1148977165/Membes+API+v1

The following the steps and details are required when working with Membes API v2
https://membes.atlassian.net/wiki/spaces/DD/pages/1416003585/Membes+API+v2

 

1. Retrieve the Authorisation - Access URLs and Keys needed
   • The API endpoints can be accessed via the following URLs
     • Authorisation URL: https://ms-auth.membes-ams.com/
     • API URL: https://[customer-membes-url]
        
2. The following keys will need to be obtained from Membes:

   • Organisational ID

   • Authentication Secret
     
      

Configure Webcastcloud Integration

Once you have the API details above, you can browse to webcastcloud admin:

1. Login to Webcastcloud Admin
2. Select >Settings >Integrations
3. Turn on the membes integration.
4. Edit Membes
   
   
    
5. Enter the following details from Membes API:
   • Client ID:
   • Client Secret:
   • OrgID:
   • Auth Base URL: https://ms-auth.membes-ams.com
   • Auth API Url:  https://[customer-membes-url]
   • Token Path: /token
   • User Profile Path: profile/PROFILEID
   • Use Active flag as Member: only enable this feature if you do not use Member Types, and only look at the 'Active' member flag. All users that login with an 'active' flag will then be added to the Member group in Webcastcloud.
   • CE Credit Write Back feature:
     • Write Back CE Credits: Please speak to Webcastcloud Support before enabling this feature to make sure that your environment has the correct content data setup that is needed to write back to Membes.  
     • Send Credits From Date: Will only send back credits that are achieved by a member after the set date. 
       
       
       

   • Save

      

User Fields stored in Webcastcloud

• First Name
• Last Name
• Email
• Member ID / Profile ID
• Member Type
• IsActive - if you’re not using Member Type, we can instead perform a simple IsActive check and place all active users into a single “Members” list in Webcastcloud
• Member Groups or Events - we can optionally retrieve a user’s groups or event registrations from Membes and store these as Member Lists in Webcastcloud

• Member Lists in Webcastcloud are used to control access and/or apply pricing tiers to content. 
• Users and Member lists are created and updated via just-in-time (JIT) provisioning during the SSO login flow.
• If you would like to support either member groups or events, please contact webcastcloud support to help test and configure.

CPD Write-Back

We also support CPD write-back to Membes. This can handle one or multiple credit types per activity. Data is written to the CPDActivityLog API with the following fields:

• Name: title of the video or course
• Category ID: as required by Membes
• Date: date CPD was achieved
• Profile: user/profile ID
• ActivityID: mapped to the relevant content type in Webcastcloud
• Points: primary credit value achieved
• Additional credit fields – Points1, Points2, Points3, etc., can be mapped where multiple credit types need to be recorded for a single video or course