ESC
Type to search...

EduRoster.ReadBasic

Export JSON
Export CSV
Copy URL
Print
Delegated Read User Scope

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.

Delegated Access App-Only Access

Permission Details

Delegated Permission Admin consent required

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.

Graph Methods

Delegated access App-only access
Methods
GET /education/classes
GET /education/classes/{id}
GET /education/classes/{id}/members
GET /education/classes/{id}/schools
GET /education/classes/{id}/teachers
GET /education/classes/delta
GET /education/me
GET /education/me/classes
GET /education/me/schools
GET /education/me/taughtClasses
GET /education/me/user
GET /education/schools
GET /education/schools/{educationSchoolId}
GET /education/schools/{educationSchoolId}/administrativeUnit
GET /education/schools/{educationSchoolId}/classes
GET /education/schools/delta
GET /education/users/{educationUserId}/schools
GET /education/users/{educationUserId}/taughtClasses
GET /education/users/{id}
GET /education/users/{id}/classes
GET /education/users/{id}/user
GET /education/users/delta
Methods
GET /education/classes
GET /education/classes/{id}
GET /education/classes/{id}/group
GET /education/classes/{id}/members
GET /education/classes/{id}/schools
GET /education/classes/{id}/teachers
GET /education/classes/delta
GET /education/me
GET /education/me/classes
GET /education/me/schools
GET /education/me/user
GET /education/schools
GET /education/schools/{id}/administrativeUnit
GET /education/schools/{id}/classes
GET /education/schools/delta
GET /education/users/{id}
GET /education/users/{id}/classes
GET /education/users/{id}/schools
GET /education/users/{id}/user
GET /education/users/delta
GET /education/users/schools

Code Examples

C# / .NET SDK
// Install: dotnet add package Microsoft.Graph
// Install: dotnet add package Azure.Identity
using Microsoft.Graph;
using Azure.Identity;

// Delegated permissions - interactive user sign-in
var scopes = new[] { "EduRoster.ReadBasic" };
var options = new InteractiveBrowserCredentialOptions
{
    ClientId = "YOUR_CLIENT_ID",
    TenantId = "YOUR_TENANT_ID",
    RedirectUri = new Uri("http://localhost")
};
var credential = new InteractiveBrowserCredential(options);
var graphClient = new GraphServiceClient(credential, scopes);

// Example: GET /me
var result = await graphClient.Me.GetAsync();
Console.WriteLine($"User: {result?.DisplayName}");
JavaScript / TypeScript
// npm install @azure/msal-browser @microsoft/microsoft-graph-client
import { PublicClientApplication } from "@azure/msal-browser";
import { Client } from "@microsoft/microsoft-graph-client";
import { AuthCodeMSALBrowserAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/authCodeMsalBrowser";

const msalConfig = {
    auth: {
        clientId: "YOUR_CLIENT_ID",
        authority: "https://login.microsoftonline.com/YOUR_TENANT_ID"
    }
};

const pca = new PublicClientApplication(msalConfig);
await pca.initialize();

// Delegated: Login with required scope
const loginResponse = await pca.loginPopup({
    scopes: ["EduRoster.ReadBasic"]
});

const authProvider = new AuthCodeMSALBrowserAuthenticationProvider(pca, {
    account: loginResponse.account,
    scopes: ["EduRoster.ReadBasic"],
    interactionType: "popup"
});

const graphClient = Client.initWithMiddleware({ authProvider });

// Example: GET /me
const result = await graphClient.api("/me").get();
console.log(result);
PowerShell
# Install Microsoft Graph PowerShell module
Install-Module Microsoft.Graph -Scope CurrentUser

# Delegated access - interactive sign-in
Connect-MgGraph -Scopes "EduRoster.ReadBasic"

# Verify connection
Get-MgContext | Select-Object Account, TenantId, Scopes

# Example: GET /me
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/me"
$result | ConvertTo-Json -Depth 5


# Always disconnect when done
Disconnect-MgGraph
Python
# pip install msgraph-sdk azure-identity
from azure.identity import InteractiveBrowserCredential, ClientSecretCredential
from msgraph import GraphServiceClient
import asyncio

# Delegated permissions - interactive browser sign-in
credential = InteractiveBrowserCredential(
    client_id="YOUR_CLIENT_ID",
    tenant_id="YOUR_TENANT_ID"
)
scopes = ["EduRoster.ReadBasic"]
client = GraphServiceClient(credential, scopes)

async def get_data():
    # Example: GET /me
    result = await client.me.get()
    print(f"User: {result.display_name}")
    return result

asyncio.run(get_data())

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.ReadBasic

4

Grant Admin Consent

This permission requires admin consent. Grant consent in the Azure portal.