educationOneRosterApiDataProvider resource type (deprecated)

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Caution

The Education Synchronization Profile API is deprecated and will stop returning data on December 31, 2024. For information about how to migrate to the new Industry Data API, see Transition from School Data Sync (Classic).

Used to set up the school data synchronization profile when the OneRoster API is used as the input source.

Derived from educationSynchronizationDataProvider.

Properties

Property Type Description
connectionUrl String The connection URL to the OneRoster instance.
providerName String The OneRoster Service Provider name as defined by the OneRoster specification.
schoolsIds String collection The list of School/Org sourcedId to sync.
termIds String collection The list of academic sessions to sync.
connectionSettings educationSynchronizationConnectionSettings The OAuth 1.0 or OAuth 2.0 settings for the OneRoster instance.
customizations educationSynchronizationCustomizations Optional customization to be applied to the synchronization profile.

Important

OneRoster uses academic sessions rather than a single school year to segment their data. This segmentation is abstracted away within School Data Sync UI but not this API. You will need to call the OneRoster /terms endpoint to get the collection of academic session IDs in order to populate the termIds collection.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "microsoft.graph.educationoneRosterApiDataProvider",
  "connectionUrl": "String",
  "providerName": "String",
  "schoolsIds": ["String"],
  "termIds": ["String"],
  "connectionSettings": {
    "clientId": "String",
    "clientSecret": "String"
  }
}