educationOneRosterApiDataProvider 资源

命名空间:microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

用于将 OneRoster API 用作输入源时设置学校数据同步配置文件。

派生自 educationSynchronizationDataProvider

属性

属性 类型 说明
connectionUrl 字符串 OneRoster 实例的连接 URL。
providerName String OneRoster 服务提供程序名称,由 OneRoster 规范定义
schoolsIds 字符串集合 要同步的学校/组织sourcedId列表。
termIds 字符串集合 要同步 的学院课程 列表。
connectionSettings educationSynchronizationConnectionSettings OneRoster 实例的 OAuth 1.0OAuth 2.0 设置。
自定义项 educationSynchronizationCustomizations 要应用于同步配置文件的可选自定义。

重要

OneRoster 使用学术课程而不是一个学校年份来划分数据。 此分段在 UI 中抽象学校数据同步,而不是此 API。 你将需要调用 OneRoster /terms 终结点,获取学院会话的 ID 集合,以便填充该 termIds 集合。

JSON 表示形式

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