SSO and API

Extending the Unified User Experience with Single Sign-On (SSO) and API Data Exchange


If you have a membership database or an Association Management System (AMS) that requires your members to login to a “Members Only” portion of your website, then our Application Program Interface (API) takes the meaning of “Unified Learning Experience” to a whole new level, both for you and for your users. Through secure data exchange between your servers and ours, user profile data, and registration and course completion data are synchronized, and a wide range of administrative tasks are handled behind the scenes without your having to think about them. To benefit from these features, your organization must have a “Members Only” area or an Association Management System (AMS) that requires your members to login to your website.

Below are the features and options currently available. Our custom development team can develop additional API calls to meet any special needs you may have for the efficient functioning and integration of your iCohere sites with your existing member database.

Single Sign-On (SSO)

Once members log into your website, single sign-on enables them to simply click a link to join a course, virtual conference, or your peer community. No second set of login credentials, no retyping profile data they have already entered into your membership database. It’s a seamless experience. Your SSO call can include parameters that activate the following options:

Options Benefits
Enables your users to access your iCohere site from a link in your Members Only” area, without logging in to iCohere. Keeps your website/brand as the gateway to your community, courses, and virtual conferences.

Ease of Use: Your users only have to remember the credentials for website, not a second set of credentials for iCohere.

Enables you to add users to your iCohere site dynamically, at the time a user first wants to access your site. Eliminates the need to add members to iCohere manually.
Add users to iCohere groups. Eliminates the need to add members to groups manually.

Automatically synchronizes the committee and team memberships tracked in your Membership Database or AMS with access rights to content in iCohere

Populate iCohere profile fields with data from your Membership Database or AMS. Ease of Use: Your members do not have to add the same information into iCohere that they have already entered into your membership system.
Update iCohere profile fields Synchronizes users profile fields in iCohere with any changes they have made in your AMS, since the last time they logged in.

icMemberAdd

The icMemberAdd API call enables members to be added to an iCohere site prior to their using SSO to login.

Options Benefits
Adds a user to an iCohere site. New members added to your AMS can be added to iCohere prior to their accessing your iCohere site. As a result, they begin receiving announcements, discussion digests, etc. as soon as they are added to your AMS.
Add the user to iCohere groups. Eliminates the need to add new members to groups manually.
Populate the new user’s profile fields with data from your Membership Database or AMS. Ease of Use: Your member does not have to add the same information into iCohere that they have already entered into your membership system.

The user shows up in the iCohere site Directory, enriching networking opportunities.

icRegistrationAdd

The icRegistrationAdd API is used to transfer data to iCohere from your AMS or other third-party event or course registration system.

Options Benefits
Adds a registrant to an iCohere site, webinar, course, or conference. The user is added to the iCohere group with rights to specified content.

All settings that govern that event in iCohere – start date/time, access rights, expiration date, etc. – are activated for the user’s participation in the event and the site.

icRegistrationReport

The icRegistrationReport web service can be called by your AMS to retrieve registration data for activities where registration is handled through iCohere’s registration module.

Options Benefits
Returns the program code, registrant’s contact information, date of registration, fee paid (if any), and related data. User records in your AMS or Membership Database can be updated daily with user registration data.

icProgramCompletionReport

The icProgramCompletionReport web service can be called by your AMS to retrieve course progress and status data for courses in iCohere.

Options Benefits
Returns the program code, student’s contact information, course status, final grade, completion date, and related data. User records in your AMS or Membership Database can be updated daily with user course completion data.

icMemberStatusChange

The icMemberStatusChange API can be called by your AMS to change a member’s status in iCohere.

Options Benefits
Members can be made inactive; they can be reactivated; or they can be deleted from the iCohere site. A member’s status in your iCohere site can be synchronized with their status in your organization. If they are late paying dues, they can be deactivated in iCohere, reactivated when payment is made, or deleted if they cancel their membership.

icMemberGroupStatusChange

The icMemberGroupStatusChange API can be called by your AMS to change a member’s participation in iCohere groups, thereby expanding or limiting their access to content in your site.

Options Benefits
Members can be added to groups. As members join committees or teams that are tracked in your Membership Database, they can be added to iCohere groups that provide those committees or teams with access to secured content.
Members can be removed from groups. As members participation in committees and teams ceases, they can be removed from the corresponding groups in iCohere, thereby limiting their access to content designated for those groups.

icEmailAddressChange

The icEmailAddressChange API can be called by your AMS to change a member’s email address.

Options Benefits
Update a member’s email address When a member’s email address is updated in your AMS, that change can immediately be reflected in iCohere, so members continue to receive communications from your course, community, or conference site.

icProfileChangeReport

The icProfileChangeReport web service can be called by your AMS to synchronize changes made to profile information in iCohere with corresponding fields in your Membership Database.

Options Benefits
Retrieve all changes to profile fields since a specified date Automates synchronization between iCohere and profile information in your AMS.

icProctorAdd

For sites where tests require in-person proctoring, this API call adds a member with proctor rights to the course site.

Options Benefits
Adds a member with rights to proctor exams. Eliminates duplicate data entry.

icProctorRemove

For sites where tests require in-person proctoring, this API call removes proctor rights from a member in the course site.

Options Benefits
Removes proctor rights from a member in a course site. (Note: call icMemberStatusChange to remove the member entirely from the site.) Eliminates duplicate data entry.




Unlike other crustaceans, the growing Nautilus doesn’t search hither and yon for a new and different house. What it needs, it finds within itself.

Just like our clients do when using iCohere’s Unified Learning System.


Resources