Microsoft Graph での教育機関 API の操作
Microsoft Graph の教育機関 API は、Microsoft 365 のリソースとデータを、学校、学生、教師、クラス、入学を含む教育機関のシナリオと関連する情報によって強化します。 これにより、教育関連のリソースと統合するソリューションのビルドが簡単になります。
教育機関 API には名簿リソースや割り当てリソースが含まれ、Microsoft Teams の名簿サービスとのやり取りに使用できます。 これらのリソースを使用して、学校の名簿を管理できます。
認証
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 機能を提供できます。 | 提出リソース |
次の手順
Microsoft Graph 教育機関 API を使用して、学校の名簿にアクセスする教育機関向けソリューションをビルドする。 詳細情報
- 自分のシナリオに最も役立つリソースと方法を検討する。
- Graph エクスプローラーで API を試す。