OneRoster API を使用したデータ インジェスト
OneRoster API (アプリケーション プログラミング インターフェイス) は、学生情報システム (SIS) /学生管理システム (SMS) データの交換のために、1EdTech (旧称 IMS Global) からの業界標準の形式です。 この同期方法を使用すると、SIS/SMS プロバイダーによって開発された REST ベースの OneRoster 1.1 API を使用して、SIS/SMS に直接接続できます。 API サポートを使用すると、CSV (コンマ区切り値) ファイルを使用する代わりに、データを直接同期できます。
学校データ同期によってアクセスされるデータ
重要
School Data Sync で教育機関のデータを接続して利用できるようにすることで、このデータを Microsoft と共有し、organizationのデータ ガバナンス標準に準拠することをコミットする権限があることを確認します。
| アクション | URL | 必須のフィルター プロパティ | 省略可能/推奨フィルター | 例 |
|---|---|---|---|---|
| GetAllAcademicSessions | /academicSessions | status | dateLastModified | /academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}' |
Microsoft 365 Education テナントの SDS を設定する
- テナントのMicrosoft 365 Education
- グローバル管理者のアクセス許可が必要
SDS アクセスと初回サインイン
SDS 管理 ポータルにアクセスするには、Web ブラウザーを起動し、[sds.microsoft.com] に移動し、Microsoft 365 Global 管理 アカウントを使用してサインインします。
[開始する] を選択します。
[続行] を選択します。
次の手順の前に、サービスがテナントにプロビジョニングされるまで少し待ちます。
[ 新しい受信フローの作成] を選択します。 [次へ] を選んで続行します。
データ ソースを選択します。 OneRoster API の場合は、[ データに接続する] オプションを選択します。
形式を選択します。 OneRoster API の場合は、オプション API を選択します。 [次へ] を選んで続行します。
プロバイダーの一覧から SIS/SMS プロバイダーを選択する必要があります。 選択したら、[ 次へ ] を選択して続行します。
注:
SIS/SMS プロバイダーが一覧に含まれていない場合は、「 OneRoster プロバイダーの概要 」を参照してください。パイロット テストに参加する手順や、OneRoster プロバイダーとして追加するためにプロバイダーに送信する情報を参照してください。
SIS/SMS への接続を有効にするには、接続資格情報を指定する必要があります。
Web アクセス URL: ONERoster API に SIS/SMS でアクセスできる URL
SIS/SMS OneRoster API への接続に使用されるクライアント ID
SIS/SMS OneRoster API への接続に使用されるクライアント シークレット
アクセス トークン URL。SIS/SMS OneRoster API が OAuth2 を使用した認証用に構成されている場合は、接続に使用するアクセス トークン URL エンドポイントも指定する必要があります。 エンドポイントは Web アクセス URL とは異なります。
[次へ] を選んで続行します。
次に、最後の画面で入力した情報に基づいて、SIS/SMS への接続をテストします。
問題がない場合は、通知が表示され、[ 次へ ] を選択して続行できます。
接続を確立できない場合は、通知が届き、[ 戻る ] を選択して、提供された情報を確認して更新できます。
現在の学年を選択し、2023 年や 2022 年から 2023 年などのフレンドリ名を指定します。 (文字は utf8 である必要があります。または自動的に削除されます)。
重要
年度は、年単位の履歴データを構築するのに役立つ受信データを関連付けるために使用されます。 このアプローチは、学年と暦年に合わせて調整されます。 たとえば、学年が 2022 年 8 月 15 日から 2023 年 6 月 15 日に終了する場合、選択する学年の値は 2023 年の終了年になります。 詳細については、学年処理に関するページを参照してください。
学年の開始日と終了日を入力します。
プロバイダーからサポートされているオプションのデータ機能に基づいて、他のデータを含めるために [オン] (既定値) が選択されているトグルが表示されます。 必要に応じて、トグルを選択してオフにすることができます。 トグルがオフになっていて、オンにできない場合は、プロバイダーのプロファイルが現在、オプションのデータの提供をサポートしていないことを意味します。 プロバイダーが省略可能なデータの送信をサポートしている場合の詳細については、「 OneRoster API プロバイダーの概要」を参照してください。
このソースの定義された学年に基づいて SDS がデータの同期を停止する日付を入力します。 入力した学期末日にデータの同期を停止するのが最も一般的です。
[次へ] を選んで続行します。
![[学年] と [同期日の停止] を求めるスクリーンショット。](images/data-ingestion-with-sds-or-api-12.png)
ユーザー ID ルール のオプションを選択します。 スタッフロールと学生ロールの両方を選択します。
注:
ユーザー マッチングは受信フローで実行され、Microsoft Entra ID内のユーザー オブジェクトの書き込みまたは更新は行われません。 照合が実行され、Education データ レイクに格納されます。 詳細については、「 Microsoft 365 Manage Users with the match link forward with the outbound flow」を参照してください。
- ソースからの属性: SIS/SMS から送信されるデータに基づくユーザー属性。
- 使用可能なソース オプションは、ユーザー名とEmailです。
- 一致する属性: 一致するMicrosoft Entra IDのユーザー プロパティ。
- 一致オプションMicrosoft Entra ID使用できるのは、UserPrincipalName と Mail です。
- (省略可能)ユーザー データに @domain 値が含まれていない場合は、一覧からドメインを選択します。
警告
ドメインの選択は省略可能であり、 ソースから 選択した属性に基づく受信データに @domain 値が含まれていない場合にのみ使用する必要があります。 SDS はチェックせず、レコードに値がない場合は追加されます。 SDS は、ドメインの選択をすべてのレコードに追加します。これにより、@domain@domainが発生する可能性があり、Microsoft Entra ID内のユーザーとの既存のユーザー マッピングに対する一致がそれらのインスタンスで見つからない可能性があります。
注意
SIS/SMS ユーザー (たとえば、スタッフ ロール グループ内のユーザー) を @domain1 または @domain2 または @domain3 に関連付けることができる場合は、ソース データに含まれる @domain を、ソース の選択から 選択した属性 (例: prefix@domain) に基づいてソース データに含める必要があります。 これは、属性が一致するために必要です。 UserPrincipalName または Mail は、一致する正しいMicrosoft Entraユーザーを見つけます。
OneRoster API v1.1 仕様では、ユーザーごとに 1 つのロールのみを渡すことができます。 複数の組織に関連付けられている場合は、1 人のユーザーに対して同じロールのみを複数の組織に渡すことができます。 organizationごとに 1 つのロールがあるため、レコードは isPrimary 'True' としてマークされます。
重要
Microsoft 365 Manage Users フローを構成する場合、これらのルールは、オプションが [一致しないユーザーの作成] にアクティブ化されている場合に使用され、Microsoft Entra UserPrincipalName プロパティのコンストラクトを定義します。
選択内容に問題がなければ、[ 次へ ] を選択して続行します。
![ユーザー ID ルールのプロンプトを示すスクリーンショット。]](images/data-ingestion-with-sds-or-api-13.png)
- ソースからの属性: SIS/SMS から送信されるデータに基づくユーザー属性。
レビューと作成に関するページに記載されている情報を確認します。 すべてが正しければ、[ 次へ ] ボタンを選択します。 そうでない場合は、正しい場所に戻ります。
![レビューと作成のスクリーンショット。]](images/data-ingestion-with-sds-or-api-14.png)
![[作成] を選択した後の処理のスクリーンショット。](images/data-ingestion-with-sds-or-api-15.png)
受信データ フローが作成され、最初の実行が保留中の場合は、[ 完了 ] ボタンを選択します。 もう一度確認して、最初の実行の状態を確認します。
![[ホーム ダッシュボード] と [データの管理] アクションを示すスクリーンショット。](images/manage-data-microsoft-365-1.png)
ヒント
Connect データ構成 を定義した直後、アクティブな初回実行時、または最初の実行が完了した後で、データの管理構成を設定できます。
実行の状態をチェックするには、[ホーム] ダッシュボード ページに戻ります。
データに問題がない場合は、[ホーム] ダッシュボードに "データ エラーまたは警告が見つかりません" と表示され、"前回の実行時にデータ エラーや警告が発生しませんでした。 素晴らしい作業を続けてください。
データに問題が見つかった場合は、[ホーム] ダッシュボードに [データに問題がいくつか見つかりました] と表示され、 同期の正常性を調査することをお勧めします。
![[学年] と [同期日の停止] を求めるスクリーンショット。](images/data-ingestion-with-sds-or-api-12.png#lightbox)
![ユーザー ID ルールのプロンプトを示すスクリーンショット。]](images/data-ingestion-with-sds-or-api-13.png#lightbox)
![レビューと作成のスクリーンショット。]](images/data-ingestion-with-sds-or-api-14.png#lightbox)
![[作成] を選択した後の処理のスクリーンショット。](images/data-ingestion-with-sds-or-api-15.png#lightbox)
![[ホーム ダッシュボード] と [データの管理] アクションを示すスクリーンショット。](images/manage-data-microsoft-365-1.png#lightbox)