EduRoster.Read | Graph Permissions

Permission Details

Delegated Permission

Read users' view of the roster

Allows the app to read the structure of schools and classes in an organization's roster and education-specific information about users to be read on behalf of the user.

Permission ID: a4389601-22d9-4096-ac18-36a927199112

Properties

Microsoft Graph v1.0 endpoint-derived-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property	Type	Description
`classCode`	`String`Nullable	Class code used by the school to identify the class.
`createdBy`	`identitySet`	Entity who created the class
`description`	`String`Nullable	Description of the class.
`displayName`	`String`	Name of the class.
`externalId`	`String`Nullable	ID of the class from the syncing system.
`externalSource`	`educationExternalSource`	How this class was created. The possible values are: sis, manual.
`externalSourceDetail`	`String`Nullable	The name of the external source this resource was generated from.
`externalName`	`String`Nullable	Name of the class in the syncing system.
`grade`	`String`Nullable	Grade level of the class.
`id`	`String`	Object identifier. Inherited from entity.
`mailNickname`	`String`	Mail name for sending email to all members, if this is enabled.
`term`	`educationTerm`	Term for this class.
`assignmentCategories`	`educationCategory collection`	All categories associated with this class. Nullable.
`assignmentDefaults`	`object`	Specifies class-level defaults respected by new assignments created in the class.
`assignments`	`educationAssignment collection`	All assignments associated with this class. Nullable.

Showing 15 of 22 properties.

JSON Representation

Microsoft Graph v1.0 endpoint-derived-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "@odata.type": "#microsoft.graph.educationClass",
  "description": "String",
  "displayName": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "classCode": "String",
  "externalName": "String",
  "externalId": "String",
  "externalSource": "String",
  "externalSourceDetail": "String",
  "grade": "String",
  "id": "String (identifier)",
  "mailNickname": "String",
  "term": {
    "@odata.type": "microsoft.graph.educationTerm"
  }
}

Relationships

Microsoft Graph v1.0 endpoint-derived-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

Relationship	Type	Description
`assignments`	`educationAssignment collection`	All assignments associated with this class. Nullable.
`assignmentCategories`	`educationCategory collection`	All categories associated with this class. Nullable.
`assignmentDefaults`	`educationAssignmentDefaults collection`	Specifies class-level defaults respected by new assignments created in the class.
`assignmentSettings`	`educationAssignmentSettings collection`	Specifies class-level assignments settings.
`group`	`group`	The underlying Microsoft 365 group object.
`members`	`educationUser collection`	All users in the class. Nullable.
`modules`	`[educationModule] collection`	All modules in the class. Nullable.
`schools`	`educationSchool collection`	All schools that this class is associated with. Nullable.
`teachers`	`educationUser collection`	All teachers in the class. Nullable.

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/education/classes/delta`
GET `/education/me/user`
GET `/education/schools/{educationSchoolId}/administrativeUnit`
GET `/education/schools/delta`
GET `/education/users/{id}/user`
GET `/education/users/delta`

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/education/classes/{id}/group`
GET `/education/classes/delta`
GET `/education/me/user`
GET `/education/schools/{id}/administrativeUnit`
GET `/education/schools/delta`
GET `/education/users/{id}/user`
GET `/education/users/delta`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgEducationClassDelta` /education/classes/delta educationClass: delta
`Get-MgEducationMeUser` /education/me/user Get educationUser
`Get-MgEducationSchoolDelta` /education/schools/delta educationSchool: delta
`Get-MgEducationUserDelta` /education/users/delta educationUser: delta

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgBetaEducationClassDelta` /education/classes/delta educationClass: delta
`Get-MgBetaEducationClassGroup` /education/classes/{id}/group Get group
`Get-MgBetaEducationMeUser` /education/me/user Get user
`Get-MgBetaEducationSchoolAdministrativeUnit` /education/schools/{id}/administrativeUnit Get administrativeUnit
`Get-MgBetaEducationSchoolDelta` /education/schools/delta educationSchool: delta
`Get-MgBetaEducationUserDelta` /education/users/delta educationUser: delta

Code Examples

C# / .NET SDK

educationClass: delta

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Classes.Delta.GetAsDeltaGetResponseAsync();

JavaScript

educationClass: delta

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/education/classes/delta')
	.get();

PowerShell

educationClass: delta

View official example on Microsoft Learn

Import-Module Microsoft.Graph.Education

Get-MgEducationClassDelta

Python

educationClass: delta

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.education.classes.delta.get()

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Delegated permissions and search for EduRoster.Read

4

Grant Admin Consent

This delegated permission requires admin consent.