List members of an educationClass

Namespace: microsoft.graph

Retrieves the educationUser members of an educationClass.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	EduRoster.ReadBasic
Delegated (personal Microsoft account)	Not supported
Application	EduRoster.Read.All, EduRoster.ReadWrite.All plus Member.Read.Hidden

Note

Note that if the delegated token is used, members can only see information about their own classes.

HTTP request

GET /education/classes/{id}/members

Optional query parameters

This method supports the OData query parameters to help customize the response, including $search, $count, and $filter.

When items are added or updated for this resource, they are specially indexed for use with the $count and $search query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.

For more information on OData query options, see OData query parameters.

Request headers

Header	Value
Authorization	Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of educationUser objects in the response body.

Example

Request

The following is an example of the request.

HTTP

GET https://graph.microsoft.com/v1.0/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212/members

C#

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Education.Classes["{educationClass-id}"].Members.GetAsync();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let members = await client.api('/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212/members')
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

EducationUserCollectionWithReferencesPage members = graphClient.education().classes("7e4ec76c-8276-43ef-ba10-9aaa197cb212").members()
	.buildRequest()
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


result, err := graphClient.Education().ClassesById("educationClass-id").Members().Get(context.Background(), nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Education

Get-MgEducationClassMember -EducationClassId $educationClassId

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);


$requestResult = $graphServiceClient->education()->classesById('educationClass-id')->members()->get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.educationUser)",
    "value": [
        {
            "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
            "accountEnabled": true,
            "displayName": "Adele Vance",
            "givenName": "Adele",
            "surname": "Vance",
            "userPrincipalName": "AdeleV@M365x214355.onmicrosoft.com",
            "userType": "Member",
            "primaryRole": "teacher",
            "onPremisesInfo": {
                "immutableId": null
            },
            "teacher": {}
        },
        {
            "id": "b66ecf79-a093-4d51-86e0-efcc4531f37a",
            "accountEnabled": true,
            "displayName": "Christie Cline",
            "givenName": "Christie",
            "surname": "Cline",
            "userPrincipalName": "ChristieC@M365x214355.onmicrosoft.com",
            "userType": "Member",
            "primaryRole": "student",
            "onPremisesInfo": {
                "immutableId": null
            },
            "student": {}
        },
        {
            "id": "f5289423-7233-4d60-831a-fe107a8551cc",
            "accountEnabled": true,
            "displayName": "Ben Walters",
            "givenName": "Ben",
            "surname": "Walters",
            "userPrincipalName": "BenW@M365x214355.onmicrosoft.com",
            "userType": "Member",
            "primaryRole": "student",
            "onPremisesInfo": {
                "immutableId": null
            },
            "student": {}
        },
        {
            "id": "48d31887-5fad-4d73-a9f5-3c356e68a038",
            "accountEnabled": true,
            "displayName": "Megan Bowen",
            "givenName": "Megan",
            "surname": "Bowen",
            "userPrincipalName": "MeganB@M365x214355.onmicrosoft.com",
            "userType": "Member",
            "primaryRole": "teacher",
            "onPremisesInfo": {
                "immutableId": null
            },
            "teacher": {}
        },
        {
            "id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755",
            "accountEnabled": true,
            "displayName": "Allan Deyoung",
            "givenName": "Allan",
            "surname": "Deyoung",
            "userPrincipalName": "AllanD@M365x214355.onmicrosoft.com",
            "userType": "Member",
            "primaryRole": "student",
            "onPremisesInfo": {
                "immutableId": null
            },
            "student": {}
        }
    ]
}