EduRoster.ReadBasic
Allows the app to read a limited subset of the properties from the structure of schools and classes in an organization's roster and a limited subset of properties about users to be read on behalf of the user. Includes name, status, education role, email address and photo.
In short
EduRoster.ReadBasic is a delegated permission in the Microsoft Graph API, grouped under the EduRoster category. Allows the app to read a limited subset of the properties from the structure of schools and classes in an organization's roster and a limited subset of properties about users to be read on behalf of the user. Includes name, status, education role, email address and photo. It grants read-only access to resources. This delegated permission requires admin consent.
Permission Details
Read a limited subset of users' view of the roster
Allows the app to read a limited subset of the properties from the structure of schools and classes in an organization's roster and a limited subset of properties about users to be read on behalf of the user. Includes name, status, education role, email address and photo.
5d186531-d1bf-4f07-8cea-7c42119e1bd9
Properties
Properties is shown from stable Microsoft Graph v1.0 metadata.
| Property | Type | Description |
|---|---|---|
classCode |
StringNullable |
Class code used by the school to identify the class. |
createdBy |
identitySet |
Entity who created the class |
description |
StringNullable |
Description of the class. |
displayName |
String |
Name of the class. |
externalId |
StringNullable |
ID of the class from the syncing system. |
externalSource |
educationExternalSource |
How this class was created. The possible values are: sis, manual. |
externalSourceDetail |
StringNullable |
The name of the external source this resource was generated from. |
externalName |
StringNullable |
Name of the class in the syncing system. |
grade |
StringNullable |
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
JSON representation is shown from stable Microsoft Graph v1.0 metadata.
{
"@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
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
Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.
Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.
Code Examples
// 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();
const options = {
authProvider,
};
const client = Client.init(options);
let delta = await client.api('/education/classes/delta')
.get();
Import-Module Microsoft.Graph.Education
Get-MgEducationClassDelta
# 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
Navigate to Azure Portal
Go to App registrations in Microsoft Entra admin center
Add API Permission
Select your app → API permissions → Add a permission → Microsoft Graph
Select Permission Type
Choose Delegated permissions and search for EduRoster.ReadBasic
Grant Admin Consent
This delegated permission requires admin consent.
Frequently asked questions
What is the EduRoster.ReadBasic Microsoft Graph permission?
EduRoster.ReadBasic is a delegated permission in the Microsoft Graph API, grouped under the EduRoster category. Allows the app to read a limited subset of the properties from the structure of schools and classes in an organization's roster and a limited subset of properties about users to be read on behalf of the user. Includes name, status, education role, email address and photo. It grants read-only access to resources. This delegated permission requires admin consent. It is mapped to the Microsoft Graph educationclass resource type. 43 documented Microsoft Graph REST methods require it. 33 Microsoft Graph PowerShell commands are documented for it.
Is EduRoster.ReadBasic an application or a delegated permission?
EduRoster.ReadBasic is a delegated permission only. It grants access on behalf of a signed-in user and cannot be used for app-only access.
Does EduRoster.ReadBasic require admin consent?
This delegated permission requires admin consent.
What is the permission ID (GUID) for EduRoster.ReadBasic?
For EduRoster.ReadBasic, the delegated (OAuth2 scope) ID is 5d186531-d1bf-4f07-8cea-7c42119e1bd9. These are the real Microsoft Graph identifiers and can be used directly in an app registration manifest.