educationOneRosterApiDataProvider リソース

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

OneRoster API を入力ソースとして使用する場合に、学校のデータ同期プロファイルを設定するために使用します。

educationSynchronizationDataProvider から派生します

プロパティ

プロパティ 種類 説明
connectionUrl 文字列 OneRoster インスタンスへの接続 URL。
providerName String OneRoster 仕様で定義されている OneRoster サービス プロバイダー名
schoolsIds String collection 同期する学校/組織のsourcedId一覧。
termIds String コレクション 同期する学術 セッションの 一覧。
connectionSettings educationSynchronizationConnectionSettings OneRoster インスタンスの OAuth 1.0 または OAuth 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"
  }
}