educationSynchronizationProfile resource type

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.

Represents a set of configurations used to synchronize education entities and roster information from a source directory to Azure Active Directory (Azure AD). This resource provides a programmatic representation used in School Data Sync.

Methods

Method	Return Type	Description
List profiles	educationSynchronizationProfile collection	Get a list of all the synchronization profiles in the tenant.
Get profile	educationSynchronizationProfile	Retrieve a specific profile given the profile identifier.
Create profile	None	Create a new synchronization profile.
Delete profile	educationSynchronizationProfile	Delete a specific profile given the profile identifier.
Pause profile	None	Pause an ongoing synchronization.
Resume profile	None	Resume a paused synchronization.
Reset profile	None	Reset the state of the profile and restart synchronization.
Start CSV profile	educationFileSynchronizationVerificationMessagecollection	Verify the uploaded source files and start synchronization. Applies only when the data provider is educationCsvDataProvider.
Get CSV upload URL	string	Return the short-lived URL to upload CSV data files. Applies only when the data provider is educationCsvDataProvider.
Get status	educationsynchronizationProfileStatus	Return the status of a specific synchronization profile.
Get errors	educationSynchronizationError collection	Get all the errors generated during synchronization.

Properties

Property	Type	Description
id	String	The unique identifier for the resource. (read-only)
displayName	String	Name of the configuration profile for syncing identities.
dataProvider	educationSynchronizationDataProvider	The data provider used for the profile.
expirationDate	Date	The date the profile should be considered expired and cease syncing. Provide the date in YYYY-MM-DD format, following ISO 8601. Maximum value is 18 months from profile creation. (optional)
handleSpecialCharacterConstraint	Bool	Determines if School Data Sync should automatically replace unsupported special characters while syncing from source.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Determines how the Profile should create new or match existing AAD Users.
licensesToAssign	educationSynchronizationLicenseAssignment collection	License setup configuration.
state	educationSynchronizationProfileState	The state of the profile. Possible values are: provisioning, provisioned, provisioningFailed, deleting, deletionFailed.

Relationships

Relationship	Type	Description
errors	educationSynchronizationError collection	All errors associated with this synchronization profile.
profileStatus	educationSynchronizationProfileStatus	The synchronization status.

Data Providers

Each educationSynchronizationProfile must specify one of the follow data providers to use as the synchronization source.

Data Provider	Description
educationCsvDataProvider	CSV files uploaded to the Profile's SAS URL
educationOneRosterApiDataProvider	OneRoster v1.1 API
educationPowerSchoolDataProvider	PowerSchool API

JSON representation

The following is a JSON representation of the educationSynchronizationProfile resource.

{
  "id": "String",
  "displayName": "String",
  "state": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileState"
  },
  "profileStatus": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
  },
  "errors": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
    }
  ],
  "dataProvider": {
    "@odata.type": "microsoft.graph.educationCsvDataProvider"
  },
  "identitySynchronizationConfiguration": {
    "@odata.type": "microsoft.graph.educationIdentitySynchronizationConfiguration"
  },
  "licensesToAssign": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment"
    }
  ],
  "handleSpecialCharacterConstraint": "Boolean",
  "expirationDate": "Date"
}