Microsoft Graph での教育機関 API の操作
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
Microsoft Graph の教育機関 Api は、教育機関、学生、教師、クラス、登録、割り当てなどの教育シナリオに関連する情報を使用して、Microsoft 365 のリソースとデータを強化します。 これにより、教育関連のリソースと統合するソリューションのビルドが簡単になります。
教育機関 Api には、Microsoft Teams の名簿および assignment サービスと対話するために使用できる名簿リソースと割り当てリソースが含まれています。 これらのリソースを使用して、学校の名簿を管理し、学生の課題を自動化することができます。
認証
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 は次のシナリオをサポートします。
- すべての学校を一覧表示する
- 授業が実施されている学校を一覧表示する
- ユーザーの学校を一覧表示する
- すべてのクラスを取得する
- 学校内のクラスを取得する
- ユーザーのクラスを一覧表示する
- 学校にクラスを追加する
- クラスの学生と教師を取得する
- クラスにメンバーを追加する
- クラスの教師を一覧表示する
- 学校内のユーザーを取得する
Assignments
割り当てに関連する教育機関 Api を使用して、Microsoft Teams の割り当てと統合することができます。 Microsoft 365 の教育機関向け microsoft Teams は同じ教育機関 Api に基づいており、Api を使用してできることについてのユースケースが提供されています。 アプリでは、これらの Api を使用して、割り当てライフサイクルを通じて割り当てを操作できます。
割り当て Api は、次の主要なリソースを提供します。
- educationAssignment -割り当て API のコアオブジェクト。 学生またはチームのメンバーに割り当てられた、学習の一部としてクラス内の1つまたは複数の作業の単位を表します。
- educationSubmission -個人 (またはグループ) が割り当てに関して提出するリソース、およびその割り当てに関する関連する成績とフィードバックを表します。
- educationResource -割り当てまたは送信される learning オブジェクトを表します。 EducationResourceは、 EducationAssignmentまたはeducationSubmissionに関連付けられています。
割り当て Api は、次のシナリオをサポートします。
割り当てに関連する教育機関 Api の一般的なユースケースを次に示します。
| ユースケース | 説明 | 関連項目 |
|---|---|---|
| 割り当ての作成 | 外部システムでは、クラスの割り当てを作成し、リソースを割り当てに割り当てることができます。 | 割り当てを作成する |
| 割り当て情報の読み取り | 分析アプリケーションは、日付や成績など、割り当てと学生の送信に関する情報を取得できます。 | 割り当てを取得する |
| 受講者の送信を追跡する | アプリは教師ダッシュボードを提供することができます。これは、学生からの、採点する必要がある送信の数を示します。 | 提出リソース |
School data sync management
School Data Sync は、Azure Active Directory (azure AD) と Microsoft 365 を使用して、学生情報システムから名簿データをインポートおよび同期するプロセスを自動化するのに便利です。 Microsoft Graph の school data sync 管理 Api を使用して、CSV ファイルまたはサポートされている SIS API コネクタから同期をセットアップすることができます。
School data sync 管理 Api は、次のシナリオをサポートします。
- 同期プロファイルの一覧表示
- 同期プロファイルを取得する
- 同期プロファイルの作成
- 同期プロファイルの削除
- 進行中の同期を一時停止する
- 一時停止した同期を再開する
- 同期をリセットする
- アップロードしたファイルの同期を開始する
- アップロード URL を取得する
- 同期の状態を取得する
- 同期エラーを取得する
新機能
この API セットに関する 最新機能や更新プログラム を検索してください。
次の手順
Microsoft Graph エデュケーション Api を使用して、学生の課題と学校の名簿にアクセスする教育ソリューションを構築します。 詳細情報
- 自分のシナリオに最も役立つリソースと方法を検討する。
- Graph エクスプローラーで API を試す。
フィードバック
フィードバックの送信と表示