educationClass のメンバーを一覧表示する

  • [アーティクル]

名前空間: microsoft.graph

educationClass の educationUser メンバーを取得します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) EduRoster.ReadBasic 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション EduRoster.Read.All EduRoster.ReadWrite.All, Member.Read.Hidden

注:

委任されたトークンを使用した場合、メンバーは自分のクラスに関する情報以外を参照できません。

HTTP 要求

GET /education/classes/{id}/members

オプションのクエリ パラメーター

このメソッドは、応答をカスタマイズするための$search、$count、および$filterを含むOData クエリ パラメーターをサポートします。

このリソースのアイテムを追加または更新すると、 $count と $search クエリ パラメーターを共に使用するように特別にインデックスが作成されます。 アイテムを追加または更新してから、インデックスで使用できるようになるまでに少し時間がかかる場合があります。

OData クエリ オプションの詳細については、「OData クエリ パラメーター」を参照してください。

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で educationUser オブジェクトのコレクションを返します。

例

要求

次の例は要求を示しています。

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

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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": {}
    }
  ]
}