For Developers

Supported Functionality

Edlink supports integration with any authentication provider that uses OAuth 2.0. This document outlines the supported functionality, key features, and limitations of using OAuth 2.0 as part of your Edlink integration.

Edlink integrates with any OAuth 2.0-compliant authentication provider to support Single Sign-On (SSO). OAuth 2.0 is used only for authentication and must be paired with a primary source for rostering. The email addresses or usernames provided by the OAuth 2.0 source must match those in the primary source for successful authentication.

Single Sign-On (SSO)

Edlink supports Single Sign-On (SSO) through an external OAuth 2.0-enabled authentication provider, allowing people to authenticate seamlessly into platforms connected to Edlink.

Compatibility

Edlink supports any authentication provider that complies with the OAuth 2.0 standard, offering flexibility for schools and organizations with existing OAuth 2.0 infrastructure.

Limitations

Some important things to keep in mind when using OAuth 2.0 with Edlink:

No Rostering Capabilities

OAuth 2.0 integration does not include rostering capabilities. Person, class, and enrollment data must come from a primary source, such as an LMS, SIS, or other (CSV/SFTP) integration.

Email/Person Matching Required

For the OAuth 2.0 provider to function correctly, the email addresses or usernames provided by the OAuth 2.0 source must match those in the primary source. If these identifiers do not align, people will not be able to authenticate successfully.

Secondary Source Only

OAuth 2.0 is designed to be used exclusively as a secondary source within Edlink. This ensures that authentication is seamlessly layered on top of existing roster data from a primary source.

Recommendations for Successful Implementation

  • Ensure Matching Identifiers: Verify that email addresses or usernames in the OAuth 2.0 provider match those in the primary data source to avoid authentication issues.
  • Choose a Reliable Provider: Select an OAuth 2.0 provider that adheres to the OAuth 2.0 standard and meets the security requirements of your organization.
  • Coordinate Sources: Confirm that your primary source is providing accurate and up-to-date roster data since OAuth 2.0 will only handle authentication.

For further questions or assistance with setting up your OAuth 2.0 integration, please contact Edlink support or your Customer Success Manager.