For Developers

Implementation Details

This document provides an overview of how Edlink's OpenID Connect (OIDC) integration works, including key setup details, data requirements, and important considerations for successful implementation.

How the Integration Works

Edlink's OIDC integration enables schools and organizations to connect an external OIDC-compliant authentication provider to facilitate Single Sign-On (SSO) for people accessing connected platforms. This integration handles authentication only and does not sync roster data.

Integration Workflow

  1. OIDC Provider Setup: Schools or organizations configure an OIDC provider (e.g., Google, Okta, Microsoft Entra ID) to handle authentication.
  2. Edlink Connection: The OIDC provider is connected to Edlink as an authentication source.
  3. Enrichment: Connect the OIDC source to the primary rostering source (e.g., SIS, LMS, or CSV upload) to enable login for integrations with that source.

Requirements for Successful Integration

Successful integration relies on aligning user data between the OIDC provider and the primary rostering source. Below are the key requirements to ensure seamless authentication.

Matching Email/Usernames

  • Consistency Required: The email addresses from the OIDC provider must match those in the primary rostering source (e.g., SIS, LMS, or CSV upload). Mismatched identifiers will prevent successful authentication.

Primary Rostering Source

  • OIDC cannot function as the primary source of data for Edlink. Rostering data (such as people, classes, and enrollments) must come from an external SIS, LMS, or flat-file upload.
  • OIDC is used only as an authentication layer on top of the existing primary source.

Supported OIDC Providers

  • Any OIDC-compliant provider can be used, such as:
    • Google
    • Okta
    • Microsoft Entra ID
    • AWS Cognito
    • Other custom OIDC providers

Key Considerations

  • Secondary Source Requirement: OIDC is always a secondary source in Edlink integrations.
  • Testing & Validation: Ensure that email addresses match between the primary source and the OIDC provider before launching.
  • Security Best Practices: Select an OIDC provider that aligns with your organization's security policies and offers multi-factor authentication (MFA) if needed.

For assistance with OIDC setup, troubleshooting, or additional configuration, please contact Edlink support or your Customer Success Manager.