For Developers

Provider

Edlink stores basic information on each of the data providers to which it connects connects. These data providers may be learning management systems (LMSs), student information systems (SISs), or even other data connectors such as Classlink and Clever. The provider object contains basic metadata about each system, and likely does not need to be used by your application. A reason that you may wish to access this endpoint is to automatically construct a list of the systems to which your product connects.

Properties

PropertyTypeDescription
idUUIDA stable UUID representing this provider.
applicationStringThe internal name of this provider.
nameStringThe formatted name of this provider.
icon_urlStringA URL to the icon for this provider.
configurationJSONThe required configuration parameters to set up a new connection to this provider.
requires_administrator_loginBooleanWhether this provider requires an administrator account to activate.
requires_administrator_consentBooleanWhether this provider requires an administrator consent step to activate.
allows_data_syncBooleanWhether this provider allows full roster data syncing.
requires_remote_configurationBooleanWhether this provider can be set up through Edlink or must be configured through an outside platform.