Single Sign On Integration

Single Sign On Integration

Purpose

A single sign on API, also termed as ‘SSO’, allows two software systems to communicate with each other by allowing an end user to login to only one system and then be able to seamlessly access another system without having to login again.

For example, you may have a third-party membership system and you are using the X-CD system to collect Abstract Submissions and/or Registration. You want your end-users to login through your Membership system BEFORE accessing the X-CD system. By logging into your Membership system, it validates the membership status of the end-user and passes that information along with basic contact information to the X-CD system.

API Types

  1. Login and Read User Information

This is the most basic SSO API functionality which allows access to the X-CD system through logging in from the membership system. X-CD will capture the active user’s information (name, email, etc.) as they are being transferred into X-CD. X-CD will either create an account for that user or assign a previously existing user account for that user.

  1. Membership Type Information

Additional API methods may be needed to read a user’s membership status. Information about an end user’s membership/non-membership status to X-CD may allow X-CD to perform one or more of the following actions:

  1. Only display a single registration type on the X-CD defined registration form (this presets the registration type for the end user which cannot be edited by the end user)

  2. Put the end user in one of the defined groups in X-CD

    1. The groups then control registration type visibility (eg. member rates)

3.  Event Registration Information

Additional API methods may be needed to read a user’s event registration details. Registration categories/selections of a user may define what sessions they have access to for the following purposes:

  1. Session details access with virtual platform or mobile app

  2. Session access for continuing education purposes

4.  Co-Author Lookup

When users are submitting conference speaker proposals - some authors may want to find other members who are already in your membership database. Additional API methods may be needed to search all users in your membership system.

5.  New User Creation (Co-Author Creation)

When users are submitting a conference speaker proposal - some authors may add a new contact as a co-author. This new contact can be written back to your membership system with an additional API method.

6.  Nightly Synchronization of Contact Data

After users are created inside X-CD it is possible they will sometime thereafter update their information directly inside your membership system. When this happens X-CD must read changes and update the X-CD contact record. This is most easily done by a nightly synchronization of “users who have changed profile data recently”. To accomplish this another API method is needed where we can search for contacts who have changed “since yesterday” and update the related user contact information within X-CD.

Technical Requirements

  • Your membership system must have an API that is available to 3rd party developers (X-CD)

  • The API must include single sign on ability

Implementation Requirements

  1. Ensure your membership system offers a Single Sign On API

  2. Ask your membership system for:
    - API access / keys to provide to a 3rd party platform (X-CD) who wants to create a Single Sign On application
    - API documentation related to:
    -- single sign on
    -- reading user account information
    -- creating a user
    -- finding users who have changed their profile data from a certain date

  3. Provide X-CD with the API credentials & the documentation

X-CD will perform a review of the documentation and provide a development cost and timeline plan.


    • Related Articles

    • Reviewer Sign-Up

      Overview The Reviewer Sign-up form allows you to define a form to solicit potential reviewers for your review process and then use the Assignment Wizard to assign reviewers to submissions. There are multiple ways to distribute the sing-up form. If ...
    • MailChimp Integration

      View the Mailchimp Integration Document Click HERE to download the mailchimp integration documentation #2 Where to obtain Mailchimp APIKEY? Login to your Mailchimp account Click Extras menu #3 Where to obtain Mailchimp listID? Login to your Mailchimp ...
    • X-CD MailChimp Integration

      The MailChimp integration will synchronize the X-CD contacts with your Mailchimp mailing list. Any changes made to an X-CD contact will be updated in Mailchimp. View the Mailchimp Integration Document Click HERE to download the mailchimp integration ...
    • How to Turn a Single Abstract into a Session?

      If a session contains only 1 abstract and you want to convert that abstract into a Session, use the Session Wizard. If there are several abstracts, each may be turned in to a single session, this may be done in bulk. Note: The Session Wizard cannot ...
    • Payment Integration Configuration

      Moneris Setup (Not Using Auto-Renew) Login at: https://www3.moneris.com/mpg/index.php Go to the Admin menu option Setting up a Direct Post Configuration Select Directpost Config from the Admin menu. Then select 'Generate a New Configuration'. When ...