次の方法で共有

educationOneRosterApiDataProvider リソースの種類 (非推奨)

  • [アーティクル]

名前空間: microsoft.graph

重要

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

注意

Education Synchronization Profile API は非推奨となり、2024 年 12 月 31 日にデータの返しを停止します。 新しい Industry Data API に移行する方法の詳細については、「 School Data Sync (クラシック)からの移行」を参照してください。

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

educationSynchronizationDataProvider から派生します。

プロパティ

プロパティ 型 説明
connectionUrl String OneRoster インスタンスへの接続 URL。
providerName String OneRoster 仕様で定義されている OneRoster サービス プロバイダー名。
schoolsIds String collection 同期する 学校/組織sourcedId の一覧。
termIds String collection 同期する アカデミック セッション の一覧。
connectionSettings educationSynchronizationConnectionSettings OneRoster インスタンスの OAuth 1.0 または OAuth 2.0 設定。
カスタマイズ educationSynchronizationCustomizations 同期プロファイルに適用するオプションのカスタマイズ。

重要

OneRoster では、1 学年ではなくアカデミック セッションを使用してデータをセグメント化します。 このセグメント化は、学校データ同期 UI 内で抽象化されますが、この API では抽象化されません。 termIds コレクションを設定するには、OneRoster /terms エンドポイントを呼び出してアカデミック セッション ID のコレクションを取得する必要があります。

リレーションシップ

なし。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

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