Share via


Microsoft School Data Sync

Simplify class management in Office 365. School Data Sync reads rosters from your SIS and creates classes and groups for Microsoft Teams, Intune for Education, and third party applications.

Connect to School Data Sync to upload school and roster information, manage your sync profile.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://sds.microsoft.com/

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get Profiles

Get all the synchronization profiles in a tenant

Get Upload Url for CSV Profle

Gets the SAS Url for uploading csv files for a given profile

Verify Uploaded Files and Start Sync

Triggers validation of uploaded files and starts sync if no errors are found.

Get Profiles

Get all the synchronization profiles in a tenant

Returns

Name Path Type Description
@odata.context
@odata.context string

@odata.context

value
value array of object

value

display name
value.displayName string

display name

state
value.state string

state

handle special character constraint
value.handleSpecialCharacterConstraint boolean

handle special character constraint

term start date
value.termStartDate string

term start date

term end date
value.termEndDate string

term end date

date format
value.dateFormat string

date format

id
value.id string

id

@odata.type
value.dataProvider.@odata.type string

@odata.type

optional properties to sync
value.dataProvider.customizations.school.optionalPropertiesToSync array of string

optional properties to sync

synchronization start date
value.dataProvider.customizations.school.synchronizationStartDate date-time

synchronization start date

is sync deferred
value.dataProvider.customizations.school.isSyncDeferred boolean

is sync deferred

allow display name update
value.dataProvider.customizations.school.allowDisplayNameUpdate boolean

allow display name update

optional properties to sync
value.dataProvider.customizations.section.optionalPropertiesToSync array of string

optional properties to sync

synchronization start date
value.dataProvider.customizations.section.synchronizationStartDate date-time

synchronization start date

is sync deferred
value.dataProvider.customizations.section.isSyncDeferred boolean

is sync deferred

allow display name update
value.dataProvider.customizations.section.allowDisplayNameUpdate boolean

allow display name update

optional properties to sync
value.dataProvider.customizations.student.optionalPropertiesToSync array of string

optional properties to sync

synchronization start date
value.dataProvider.customizations.student.synchronizationStartDate date-time

synchronization start date

is sync deferred
value.dataProvider.customizations.student.isSyncDeferred boolean

is sync deferred

allow display name update
value.dataProvider.customizations.student.allowDisplayNameUpdate boolean

allow display name update

optional properties to sync
value.dataProvider.customizations.teacher.optionalPropertiesToSync array of string

optional properties to sync

synchronization start date
value.dataProvider.customizations.teacher.synchronizationStartDate date-time

synchronization start date

is sync deferred
value.dataProvider.customizations.teacher.isSyncDeferred boolean

is sync deferred

allow display name update
value.dataProvider.customizations.teacher.allowDisplayNameUpdate boolean

allow display name update

optional properties to sync
value.dataProvider.customizations.studentEnrollment.optionalPropertiesToSync array of string

optional properties to sync

synchronization start date
value.dataProvider.customizations.studentEnrollment.synchronizationStartDate date-time

synchronization start date

is sync deferred
value.dataProvider.customizations.studentEnrollment.isSyncDeferred boolean

is sync deferred

allow display name update
value.dataProvider.customizations.studentEnrollment.allowDisplayNameUpdate boolean

allow display name update

optional properties to sync
value.dataProvider.customizations.teacherRoster.optionalPropertiesToSync array of string

optional properties to sync

synchronization start date
value.dataProvider.customizations.teacherRoster.synchronizationStartDate date-time

synchronization start date

is sync deferred
value.dataProvider.customizations.teacherRoster.isSyncDeferred boolean

is sync deferred

allow display name update
value.dataProvider.customizations.teacherRoster.allowDisplayNameUpdate boolean

allow display name update

@odata.type
value.identitySynchronizationConfiguration.@odata.type string

@odata.type

user domains
value.identitySynchronizationConfiguration.userDomains array of object

user domains

applies to
value.identitySynchronizationConfiguration.userDomains.appliesTo string

applies to

name
value.identitySynchronizationConfiguration.userDomains.name string

name

matching options
value.identitySynchronizationConfiguration.matchingOptions array of object

matching options

applies to
value.identitySynchronizationConfiguration.matchingOptions.appliesTo string

applies to

source property name
value.identitySynchronizationConfiguration.matchingOptions.sourcePropertyName string

source property name

target property name
value.identitySynchronizationConfiguration.matchingOptions.targetPropertyName string

target property name

target domain
value.identitySynchronizationConfiguration.matchingOptions.targetDomain string

target domain

licenses to assign
value.licensesToAssign array of object

licenses to assign

applies to
value.licensesToAssign.appliesTo string

applies to

sku Ids
value.licensesToAssign.skuIds array of string

sku Ids

Get Upload Url for CSV Profle

Gets the SAS Url for uploading csv files for a given profile

Parameters

Name Key Required Type Description
The GUID portion of the URL found on the Profile Details page
instanceId True string

The instanceId of a profile is the GUID portion of the URL found on the Profile Details page

Returns

Name Path Type Description
@odata.context
@odata.context string

@odata.context

value
value string

value

Verify Uploaded Files and Start Sync

Triggers validation of uploaded files and starts sync if no errors are found.

Parameters

Name Key Required Type Description
The GUID portion of the URL found on the Profile Details page
instanceId True string

The instanceId of a profile is the GUID portion of the URL found on the Profile Details page

Returns

Name Path Type Description
@odata.context
@odata.context string

@odata.context

value
value array of object

value