Create an educationSynchronizationProfile
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Create a request for a new school data synchronization profile in the tenant. Query the status to get the status of the profile.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions |
---|---|
Delegated (work or school account) | EduAdministration.ReadWrite |
Delegated (personal Microsoft account | Not supported. |
Application | Not supported. |
HTTP request
POST /education/synchronizationProfiles
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. |
Content-Type | string | Application/json. Required. |
Request body
In the request body, supply a JSON representation of the educationSynchronizationProfile object.
Response
If successful, this method returns a 202 Accepted
response code and an educationSynchronizationProfile object in the response body.
Example
Request
The following is an example of the request.
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"
]
}
]
}
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability.
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"
]
}
]
}
Feedback
Submit and view feedback for