educationOneRosterApiDataProvider 资源educationOneRosterApiDataProvider resource

命名空间:microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph 中的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported. 若要确定 API 在 v1.0 中是否可用,请使用 版本 选择器。To determine whether an API is available in v1.0, use the Version selector.

用于在将 ONEROSTER API 用作输入源时设置学校数据同步配置文件。Used to set up the school data synchronization profile when the OneRoster API is used as the input source.

派生自 educationSynchronizationDataProviderDerived from educationSynchronizationDataProvider.

属性Properties

属性Property 类型Type 说明Description
connectionUrlconnectionUrl StringString 指向 OneRoster 实例的连接 URL。The connection URL to the OneRoster instance.
providerNameproviderName StringString OneRoster 规范定义的 OneRoster 服务提供程序名称。The OneRoster Service Provider name as defined by the OneRoster specification.
schoolsIdsschoolsIds String collectionString collection 要同步的 学校/组织的列表 sourcedIdThe list of School/Org sourcedId to sync.
termIdstermIds String collectionString collection 要同步的 学术会话 的列表。The list of academic sessions to sync.
connectionSettingsconnectionSettings educationSynchronizationConnectionSettingseducationSynchronizationConnectionSettings OneRoster 实例的 oauth 1.0oauth 2.0 设置。The OAuth 1.0 or OAuth 2.0 settings for the OneRoster instance.
操作customizations educationSynchronizationCustomizations) educationSynchronizationCustomizations) 要应用于同步配置文件的可选自定义项。Optional customization to be applied to the synchronization profile.

重要

OneRoster 使用学术会议,而不是一年的时间来细分其数据。OneRoster uses academic sessions rather than a single school year to segment their data. 此细分在学校数据同步 UI 中被抽象掉,而不是在此 API 中。This segmentation is abstracted away within School Data Sync UI but not this API. 您需要调用 OneRoster /terms 终结点以获取学术会话 id 的集合,以便填充该 termIds 集合。You will need to call the OneRoster /terms endpoint to get the collection of academic session IDs in order to populate the termIds collection.

JSON 表示形式JSON representation

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