Microsoft Graph での教育機関 API の操作
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft Graph の教育 API は、学校、学生、教師、クラス、登録、課題など、教育シナリオに関連する情報を使用して、Microsoft 365 のリソースとデータを強化します。 これにより、教育関連のリソースと統合するソリューションのビルドが簡単になります。
教育 API には、名簿リソースと、Microsoft Teamsの名簿サービスと割り当てサービスとの対話に使用できる割り当てリソースが含まれます。 これらのリソースを使用して、学校の名簿を管理し、学生の課題を自動化できます。
Authorization
Microsoft Graph で教育 API を呼び出すには、アプリがアクセス トークンを取得する必要があります。 アクセス トークンの詳細については、「Microsoft Graph を呼び出すためのトークンの取得」を参照してください。 アプリには、適切なアクセス許可も必要です。 詳細については、「教育機関アクセス許可」を参照してください。
学校の IT 管理者が同意できるようにする、アプリのアクセス許可
Microsoft Graph の教育機関 API と統合されたアプリを展開するには、まず学校の IT 管理者が、アプリが要求するアクセス許可に同意する必要があります。 アクセス許可が変更にならない限り、この同意は一度だけ与えられる必要があります。 管理者が同意した後、アプリはテナント内のすべてのユーザーに対してプロビジョニングされます。
同意ダイアログ ボックスをトリガーするには、次の REST 呼び出しを使用します。
GET https://login.microsoftonline.com/{tenant}/adminconsent?
client_id={clientId}&state=12345&redirect_uri={redirectUrl}
パラメーター | 説明 |
---|---|
テナント | 学校のテナント ID です。 onmicrosoft.com を含む、完全な ID を使用します。 |
clientId | アプリのクライアント ID です。 |
redirectUrl | アプリのリダイレクト URL です。 |
名簿
名簿 API により、Microsoft School Data Sync でプロビジョニングされた学校の Microsoft 365 テナントからデータを抽出できます。これらの API により、学校、部署、教師、学生、名簿に関する情報にアクセスできます。 API は、アプリのみの (同期) シナリオと、アプリ + ユーザー (対話型) シナリオの両方をサポートします。 対話型シナリオをサポートする API は、API を呼び出すユーザー ロールに基づく、領域に適した RBAC ポリシーを適用します。 これにより、テナント内の管理構成に関わらず、一貫した API および最小のポリシー サーフェスが提供されます。 さらに、API は教育機関に特有のアクセス許可も提供し、適切なユーザーがデータに確実にアクセスできるようにします。
名簿 API を使用すれば、アプリ ユーザーは次のことを把握できます。
- 自分が誰か
- 自分が出席する、または教えるクラス
- 何を、いつまでにする必要があるか
名簿 API は、次の重要なリソースを提供します。
- educationSchool - 学校を示します。
- educationClass - 学校内のクラスを示します。
- educationTerm - 学年度の指定された部分を示します。
- educationTeacher - プライマリ ロールが 'Teacher' であるユーザーを示します。
- educationStudent - プライマリ ロールが 'student' であるユーザーを示します。
名簿 API は次のシナリオをサポートします。
- すべての学校を一覧表示する
- 授業が実施されている学校を一覧表示する
- ユーザーの学校を一覧表示する
- すべてのクラスを取得する
- 学校内のクラスを取得する
- ユーザーのクラスを一覧表示する
- 学校にクラスを追加する
- クラスの学生と教師を取得する
- クラスにメンバーを追加する
- クラスの教師を一覧表示する
- 学校内のユーザーを取得する
かだい
課題関連の教育機関 API を使用して、Microsoft Teams で課題と統合できます。 Microsoft 365 for Education の Microsoft Teams は、同じ教育機関 API に基づいており、API で実行できるユース ケースを提供します。 アプリは、これらの API を使用して割り当てのライフサイクルを通して割り当てを操作できます。
割り当て API は、次の重要なリソースを提供します。
- educationAssignment - 割り当て API のコア オブジェクト。 学習の一環としてクラスの学生またはチーム メンバーに割り当てられたタスクあるいは作業ユニットを表します。
- educationSubmission - 課題に対して個人 (またはグループ) が提出するリソースと、その課題に関連する成績とフィードバックを表します。
- educationResource - 割り当てられるまたは提出される学習オブジェクトを表します。 educationResource は、educationAssignment および/または educationSubmission に関連付けられています。
割り当て API は次のシナリオをサポートします。
課題関連の教育期間 API の一般的なユース ケースを次に示します。
ユース ケース | 説明 | 関連項目 |
---|---|---|
課題を作成する | 外部システムは、クラスの課題を作成し、その課題にリソースを添付することができます。 | 課題の作成 |
課題の情報を表示する | 分析アプリケーションは、課題と学生の提出物 (日付や成績など) に関する情報を取得します。 | 課題を取得する |
学生の提出物を追跡する | アプリでは、評価する必要がある学生からの提出物の数を示す Teacher Dashboard 機能を提供できます。 | 提出リソース |
授業
クラスワークをワンストップ ショップとして使用して、課題、OneNote クラス ノートブック ページ、Web リンク、ファイル、Teams チャネルなどのクラス リソースを作成および整理できます。 つまり、必要なものを見つけるために、複数のアプリやプラットフォームを移動する必要がなくなりました。 Classwork を使用すると、学生がクラス内を移動し、すべてを 1 か所で表示するのに役立つコンテンツとリソースのビューをキュレーションできます。
Classwork API には、次の重要なリソースが用意されています。
- educationModule - モジュールはクラスに関連付けられています。 体系的な方法で編成された個々の学習リソースのグループを表します。
- educationModuleResource - モジュールに関連付けられているリソースを格納するラッパー オブジェクト。 学生はこのリソースを更新できません。これは、教師から学生への配布資料であり、有効にするものはありません。
次の一覧は、Classwork API でサポートされるシナリオを示しています。
モジュール
educationModule リソースでは、次のシナリオがサポートされています。
- モジュールを一覧表示する
- モジュールを作成する
- モジュールを取得する
- モジュールを更新する
- モジュールを削除する
- モジュールをピン留めする
- モジュールのピン留めを外す
- モジュールを公開する
- モジュール リソース フォルダーを設定する
モジュール リソース
educationModuleResource リソースでは、次のシナリオがサポートされています。
一般的なユース ケース
次の表は、モジュール関連の教育 API の一般的なユース ケースを示しています。
ユース ケース | 説明 | 関連項目 |
---|---|---|
モジュールを作成する | モジュールを作成できるのは、クラスの教師だけです。 モジュールはドラフト状態で開始されます。つまり、学生は公開されるまでモジュールを表示しません。 | educationModule を作成する |
モジュールを一覧表示する | 教師またはアプリケーションのアクセス許可を持つアプリケーションは、クラスのすべてのモジュール オブジェクトを表示できます。 学生は公開されたモジュールのみを表示できます。 | クラス モジュールを一覧表示する |
モジュールを発行する |
educationModule の状態を元のdraft 状態からpublished 状態に変更します。 |
educationModule: publish |
モジュールにリソースを作成する | この操作を実行できるのは教師だけです。 | educationModuleResource を作成する |
モジュール リソースを一覧表示する | モジュールに関連付けられている educationModuleResource オブジェクトをすべて取得します。 この操作を実行できるのは、アプリケーションのアクセス許可を持つ教師、学生、アプリケーションだけです。 | モジュール リソースを一覧表示する |
学校データ同期管理
School Data Sync は、Microsoft Entra ID と Microsoft 365 を使用して、学生情報システムから名簿データをインポートおよび同期するプロセスを自動化するのに役立ちます。 Microsoft Graph の学校データ同期管理 API を使用して、CSV ファイルまたはサポートされている SIS API コネクタから同期を設定できます。
学校データ同期管理 API では、次のシナリオがサポートされています。
- 同期プロファイルを一覧表示する
- 同期プロファイルを取得する
- 同期プロファイルを作成する
- 同期プロファイルを削除する
- 進行中の同期を一時停止する
- 一時停止した同期を再開する
- 同期をリセットする
- アップロードされたファイルの同期を開始する
- アップロード URL を取得する
- 同期の状態を取得する
- 同期エラーを取得する
次の手順
Microsoft Graph 教育 API を使用して、学生の課題と学校名簿にアクセスする教育ソリューションを構築します。 詳細情報
- 自分のシナリオに最も役立つリソースと方法を検討する。
- Graph エクスプローラーで API を試す。