educationSynchronizationProfile を作成する (非推奨)
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
注意
Education Synchronization Profile API は非推奨となり、2024 年 12 月 31 日にデータの返しを停止します。 新しい Industry Data API に移行する方法の詳細については、「 School Data Sync (クラシック)からの移行」を参照してください。
テナントに新しい学校データ 同期プロファイル の要求を作成します。 状態を照会 して、プロファイルの状態を取得します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | EduAdministration.ReadWrite | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | サポートされていません。 | サポートされていません。 |
HTTP 要求
POST /education/synchronizationProfiles
要求ヘッダー
| 名前 | 型 | 説明 |
|---|---|---|
| Authorization | string | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | string | Application/json。 必須です。 |
要求本文
要求本文で、 educationSynchronizationProfile オブジェクトの JSON 表現を指定します。
応答
成功した場合、このメソッドは応答コード 202 Accepted と、応答本文に educationSynchronizationProfile オブジェクトを返します。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/education/synchronizationProfiles
Content-type: application/json
{
"displayName": "Test Profile",
"dataProvider": {
"@odata.type": "#microsoft.graph.educationCsvDataProvider",
"customizations": {
"student": {
"optionalPropertiesToSync": [
"State ID",
"Middle Name"
]
}
}
},
"identitySynchronizationConfiguration": {
"@odata.type": "#microsoft.graph.educationIdentityCreationConfiguration",
"userDomains": [
{
"appliesTo": "student",
"name": "testschool.edu"
},
{
"appliesTo": "teacher",
"name": "testschool.edu"
}
]
},
"licensesToAssign": [
{
"appliesTo": "teacher",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
},
{
"appliesTo": "student",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
}
]
}
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-type: application/json
{
"displayName": "Test Profile",
"state": "provisioning",
"id": "86904b1e-c7d0-4ead-b13a-98f11fc400ee",
"dataProvider": {
"@odata.type": "#microsoft.graph.educationCsvDataProvider",
"customizations": {
"school": {
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"section": {
"optionalPropertiesToSync": [
"Term Name",
"Course Number",
"Periods"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"student": {
"optionalPropertiesToSync": [
"State ID",
"Middle Name"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"teacher": {
"optionalPropertiesToSync": [
"State ID",
"Teacher Number",
"Status",
"Middle Name",
"Secondary Email",
"Title",
"Qualification"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"studentEnrollment": {
"synchronizationStartDate": "0001-01-01T00:00:00Z",
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"teacherRoster": {
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
}
}
},
"identitySynchronizationConfiguration": {
"@odata.type": "#microsoft.graph.educationIdentityCreationConfiguration",
"userDomains": [
{
"appliesTo": "student",
"name": "testschool.edu"
},
{
"appliesTo": "teacher",
"name": "testschool.edu"
}
]
},
"licensesToAssign": [
{
"appliesTo": "teacher",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
},
{
"appliesTo": "student",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
}
]
}