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 |
Name |
Summary |
Get Upload Url for CSV Profle |
|
Get Profiles |
|
Verify Uploaded Files and Start Sync |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
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
Summary: Get Profiles
Description: Get all the synchronization profiles in a tenant
Syntax:
MicrosoftSchoolDataSync.GetSynchronizationprofiles ()
Returns:
Type:GetSynchronizationprofilesResponse
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:
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string @odata.context |
@odata.context |
value |
array of (ValueItem) value |
value |
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 |
data provider |
data provider |
identitySynchronizationConfiguration |
IdentitySynchronizationConfiguration identity synchronization configuration |
identity synchronization configuration |
licensesToAssign |
array of (LicensesToAssignItem) licenses to assign |
licenses to assign |
Summary: data provider
Description: data provider
Properties:
Name |
Type |
Summary |
@odata.type |
string @odata.type |
@odata.type |
customizations |
customizations |
customizations |
Summary: customizations
Description: customizations
Properties:
Name |
Type |
Summary |
school |
school |
school |
section |
section |
section |
student |
student |
student |
teacher |
teacher |
teacher |
studentEnrollment |
student enrollment |
student enrollment |
teacherRoster |
teacher roster |
teacher roster |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Summary:
Description:
Properties:
Name |
Type |
Summary |
appliesTo |
string applies to |
applies to |
name |
string name |
name |
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 |
Summary:
Description:
Properties:
Name |
Type |
Summary |
appliesTo |
string applies to |
applies to |
skuIds |
array of (string) sku Ids |
sku Ids |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string @odata.context |
@odata.context |
value |
string value |
value |
Summary:
Description:
Properties:
Name |
Type |
Summary |
@odata.context |
string @odata.context |
@odata.context |
value |
array of (ValueItem) value |
value |
Summary:
Description:
Properties:
Name |
Type |
Summary |