Share via


educationOneRosterApiDataProvider-Ressourcentyp

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Wird zum Einrichten des Schuldatensynchronisierungsprofils verwendet, wenn die OneRoster-API als Eingabequelle verwendet wird.

Abgeleitet von educationSynchronizationDataProvider.

Eigenschaften

Eigenschaft Typ Beschreibung
connectionUrl String Die Verbindungs-URL zum OneRoster-instance.
Providername String Der Name des OneRoster-Dienstanbieters gemäß der OneRoster-Spezifikation.
schoolsIds String collection Die Liste der zu synchronisierenden Schulen/OrganisationensourcedId .
termIds String collection Die Liste der zu synchronisierenden akademischen Sitzungen .
connectionSettings educationSynchronizationConnectionSettings Die OAuth 1.0- oder OAuth 2.0-Einstellungen für die OneRoster-instance.
Anpassungen educationSynchronizationCustomizations Optionale Anpassung, die auf das Synchronisierungsprofil angewendet werden soll.

Wichtig

OneRoster verwendet akademische Sitzungen anstelle eines einzelnen Schuljahres, um seine Daten zu segmentieren. Diese Segmentierung wird in der School Data Sync-Benutzeroberfläche abstrahiert, aber nicht in dieser API. Sie müssen den OneRoster-Endpunkt /terms aufrufen, um die Sammlung akademischer Sitzungs-IDs abzurufen, um die termIds Sammlung aufzufüllen.

JSON-Darstellung

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