Show / Hide Table of Contents

EduAdministration.ReadWrite.All

Manage the state and settings of all Microsoft education apps.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A GET /education/synchronizationProfiles
V1 A GET /education/synchronizationProfiles/{id}
V1 A GET /education/synchronizationProfiles/{id}/errors
V1 A GET /education/synchronizationProfiles/{id}/profileStatus
V1 A GET /education/synchronizationProfiles/{id}/uploadUrl
V1 A POST /education/synchronizationProfiles/{id}/pause
V1 A POST /education/synchronizationProfiles/{id}/reset
V1 A POST /education/synchronizationProfiles/{id}/resume
V1 A POST /education/synchronizationProfiles/{id}/start

Application Permission

Id 9bc431c3-b8bc-4a8d-a219-40f10f92eff6
Display String Manage education app settings
Description Manage the state and settings of all Microsoft education apps.

Resources

educationCsvDataProvider

Property Type Description
customizations [educationSynchronizationCustomizations] Optional customizations to be applied to the synchronization profile.

educationFileSynchronizationVerificationMessage

Property Type Description
type string Type of the message. Possible values are: error, warning, information.
filename string Source file that contains the error.
description string Detailed information about the message type.

educationSynchronizationError

Property Type Description
id String The unique identifier for the resource. (read-only)
entryType String Represents the sync entity (school, section, student, teacher).
errorCode String Represents the error code for this error.
errorMessage String Contains a description of the error.
joiningValue String The unique identifier for the entry.
recordedDateTime DateTimeOffset The time of occurrence of this error.
reportableIdentifier String The identifier of this error entry.

educationSynchronizationProfile

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][fullsync] or [match existing][dirsync] AAD Users.
licensesToAssign [educationSynchronizationLicenseAssignment] collection License setup configuration.
state educationSynchronizationProfileState The state of the profile. Possible values are: provisioning, provisioned, provisioningFailed, deleting, deletionFailed.

educationSynchronizationProfileStatus

Property Type Description
errorCount Int64 Number of errors during synchronization.
id String The unique identifier for the resource. Read-only.
lastActivityDateTime DateTimeOffset Date and time when most recent changes were observed in the profile.
lastSynchronizationDateTime DateTimeOffset Date and time of the most recent successful synchronization.
status educationSynchronizationStatus The status of a sync. The possible values are: paused, inProgress, success, error, validationError, quarantined, unknownFutureValue, extracting, validating. Note that you must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: extracting, validating.
statusMessage String Status message for the synchronization stage of the current profile.
In This Article
Back to top Created by merill | Submit feedback