EduAdministration.ReadWrite

Manage the state and settings of all Microsoft education apps on behalf of the user.

Merill's Note

For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the EduAdministration.ReadWrite permission.

If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the Export-MsIdAppConsentGrantReport command. See How To: Run a quick OAuth app audit of your tenant

Category	Application	Delegated
Identifier	-	63589852-04e3-46b4-bae9-15d5b1050748
DisplayText	-	Manage education app settings
Description	-	Manage the state and settings of all Microsoft education apps on behalf of the user.
AdminConsentRequired	Yes	Yes

Graph Methods

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	DELETE /education/synchronizationProfiles/{id}
	GET /education/synchronizationProfiles
	GET /education/synchronizationProfiles/{id}
	GET /education/synchronizationProfiles/{id}/errors
	GET /education/synchronizationProfiles/{id}/profileStatus
	GET /education/synchronizationProfiles/{id}/uploadUrl
	POST /education/synchronizationProfiles
	POST /education/synchronizationProfiles/{id}/pause
	POST /education/synchronizationProfiles/{id}/reset
	POST /education/synchronizationProfiles/{id}/resume
	POST /education/synchronizationProfiles/{id}/start
	PUT /education/synchronizationProfiles

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgBetaEducationSynchronizationProfile
	Get-MgBetaEducationSynchronizationProfileError
	Get-MgBetaEducationSynchronizationProfileStatus
	Invoke-MgBetaUploadEducationSynchronizationProfileUrl
	New-MgBetaEducationSynchronizationProfile
	Remove-MgBetaEducationSynchronizationProfile
	Reset-MgBetaEducationSynchronizationProfile
	Resume-MgBetaEducationSynchronizationProfile
	Start-MgBetaEducationSynchronizationProfile
	Suspend-MgBetaEducationSynchronizationProfile

Resources

Granting this permission allows the calling application to access (and/or update) the following information in your tenant.

Graph reference: educationcsvdataprovider

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

Graph reference: 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.

Graph reference: 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.

Graph reference: 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] Microsoft Entra users.
licensesToAssign	[educationSynchronizationLicenseAssignment] collection	License setup configuration.
state	educationSynchronizationProfileState	The state of the profile. Possible values are: `provisioning`, `provisioned`, `provisioningFailed`, `deleting`, `deletionFailed`.

Graph reference: 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.

Table of Contents

EduAdministration.ReadWrite

Graph Methods

Resources