Répertorier les membres d’un educationClass

  • Article

Espace de noms: microsoft.graph

Récupère les membres educationUser d’un educationClass.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) EduRoster.ReadBasic Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application EduRoster.Read.All EduRoster.ReadWrite.All, Member.Read.Hidden

Remarque

Notez que, si le jeton délégué est utilisé, les membres peuvent voir uniquement les informations concernant leurs propres cours.

Requête HTTP

GET /education/classes/{id}/members

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse, y compris $search, $count et $filter.

Lors de l’ajout ou de la mise à jour d’éléments pour cette ressource, ceux-ci sont spécialement indexés pour être utilisés avec les paramètres de requête $count et $search. Il peut y avoir un petit délai entre le moment où un élément est ajouté ou mis à jour et le moment où il est disponible dans l’index.

Si vous souhaitez en savoir plus sur les options de requête OData, veuillez consulter la rubrique relative aux paramètres de requête OData.

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et une collection d’objets educationUser dans le corps de la réponse.

Exemple

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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@contoso.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@contoso.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@contoso.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@contoso.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@contoso.com",
      "userType": "Member",
      "primaryRole": "student",
      "onPremisesInfo": {
        "immutableId": null
      },
      "student": {}
    }
  ]
}