Connectors Reference

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.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

GetUploadUrl (string instanceId)

Get Upload Url for CSV Profle

GetSynchronizationprofiles ()

Get Profiles

PostStartSync (string instanceId)

Verify Uploaded Files and Start Sync

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

GetSynchronizationprofilesResponse

 

GetUploadUrlResponse

 

PostStartSyncResponse

 

 

Actions:

GetUploadUrl

Summary: Get Upload Url for CSV Profle

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

 

Syntax:

MicrosoftSchoolDataSync.GetUploadUrl (string instanceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

instanceId

string

(The GUID portion of the URL found on the Profile Details page)

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

True

 

Returns:

          Type:GetUploadUrlResponse

 

GetSynchronizationprofiles

Summary: Get Profiles

Description: Get all the synchronization profiles in a tenant

 

Syntax:

MicrosoftSchoolDataSync.GetSynchronizationprofiles ()

 

Returns:

          Type:GetSynchronizationprofilesResponse

 

PostStartSync

Summary: Verify Uploaded Files and Start Sync

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

 

Syntax:

MicrosoftSchoolDataSync.PostStartSync (string instanceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

instanceId

string

(The GUID portion of the URL found on the Profile Details page)

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

True

 

Returns:

          Type:PostStartSyncResponse

 


 

GetSynchronizationprofilesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

@odata.context

@odata.context

value

array of (ValueItem)

value

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

display name

display name

state

string

state

state

handleSpecialCharacterConstraint

boolean

handle special character constraint

handle special character constraint

termStartDate

string

term start date

term start date

termEndDate

string

term end date

term end date

dateFormat

string

date format

date format

id

string

id

id

dataProvider

DataProvider

data provider

data provider

identitySynchronizationConfiguration

IdentitySynchronizationConfiguration

identity synchronization configuration

identity synchronization configuration

licensesToAssign

array of (LicensesToAssignItem)

licenses to assign

licenses to assign

 

DataProvider

Summary: data provider

Description: data provider

 

          Properties:

Name

Type

Summary

@odata.type

string

@odata.type

@odata.type

customizations

Customizations

customizations

customizations

 

Customizations

Summary: customizations

Description: customizations

 

          Properties:

Name

Type

Summary

school

School

school

school

section

Section

section

section

student

Student

student

student

teacher

Teacher

teacher

teacher

studentEnrollment

StudentEnrollment

student enrollment

student enrollment

teacherRoster

TeacherRoster

teacher roster

teacher roster

 

School

Summary: school

Description: school

 

          Properties:

Name

Type

Summary

optionalPropertiesToSync

array of (string)

optional properties to sync

optional properties to sync

synchronizationStartDate

string(date-time)

synchronization start date

synchronization start date

isSyncDeferred

boolean

is sync deferred

is sync deferred

allowDisplayNameUpdate

boolean

allow display name update

allow display name update

 

Section

Summary: section

Description: section

 

          Properties:

Name

Type

Summary

optionalPropertiesToSync

array of (string)

optional properties to sync

optional properties to sync

synchronizationStartDate

string(date-time)

synchronization start date

synchronization start date

isSyncDeferred

boolean

is sync deferred

is sync deferred

allowDisplayNameUpdate

boolean

allow display name update

allow display name update

 

Student

Summary: student

Description: student

 

          Properties:

Name

Type

Summary

optionalPropertiesToSync

array of (string)

optional properties to sync

optional properties to sync

synchronizationStartDate

string(date-time)

synchronization start date

synchronization start date

isSyncDeferred

boolean

is sync deferred

is sync deferred

allowDisplayNameUpdate

boolean

allow display name update

allow display name update

 

Teacher

Summary: teacher

Description: teacher

 

          Properties:

Name

Type

Summary

optionalPropertiesToSync

array of (string)

optional properties to sync

optional properties to sync

synchronizationStartDate

string(date-time)

synchronization start date

synchronization start date

isSyncDeferred

boolean

is sync deferred

is sync deferred

allowDisplayNameUpdate

boolean

allow display name update

allow display name update

 

StudentEnrollment

Summary: student enrollment

Description: student enrollment

 

          Properties:

Name

Type

Summary

optionalPropertiesToSync

array of (string)

optional properties to sync

optional properties to sync

synchronizationStartDate

string(date-time)

synchronization start date

synchronization start date

isSyncDeferred

boolean

is sync deferred

is sync deferred

allowDisplayNameUpdate

boolean

allow display name update

allow display name update

 

TeacherRoster

Summary: teacher roster

Description: teacher roster

 

          Properties:

Name

Type

Summary

optionalPropertiesToSync

array of (string)

optional properties to sync

optional properties to sync

synchronizationStartDate

string(date-time)

synchronization start date

synchronization start date

isSyncDeferred

boolean

is sync deferred

is sync deferred

allowDisplayNameUpdate

boolean

allow display name update

allow display name update

 

IdentitySynchronizationConfiguration

Summary: identity synchronization configuration

Description: identity synchronization configuration

 

          Properties:

Name

Type

Summary

@odata.type

string

@odata.type

@odata.type

userDomains

array of (UserDomainsItem)

user domains

user domains

matchingOptions

array of (MatchingOptionsItem)

matching options

matching options

 

UserDomainsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

appliesTo

string

applies to

applies to

name

string

name

name

 

MatchingOptionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

appliesTo

string

applies to

applies to

sourcePropertyName

string

source property name

source property name

targetPropertyName

string

target property name

target property name

targetDomain

string

target domain

target domain

 

LicensesToAssignItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

appliesTo

string

applies to

applies to

skuIds

array of (string)

sku Ids

sku Ids

 


 

GetUploadUrlResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

@odata.context

@odata.context

value

string

value

value


 

PostStartSyncResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

@odata.context

string

@odata.context

@odata.context

value

array of (ValueItem)

value

value

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary