メンバーを一覧表示する

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

この API を使用して、管理単位のメンバー リスト (ユーザー、グループ、およびデバイス) を取得します。

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

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

アクセス許可

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

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All

重要

アプリケーションが directoryObject 型のコレクションを返すリレーションシップをクエリするときに、特定のリソース型を読み取るアクセス許可がない場合、その型のメンバーが返されますが、情報は限られます。 たとえば、@odata.type プロパティでは、オブジェクト型と ID だけが返され、その他のプロパティは null と表示されます。 この動作により、アプリケーションは、Directory.* 権限が付与されたアクセス許可のセットに依存するのではなく、必要な最小限のアクセス許可を要求できます。 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。

注:

管理単位で非表示のメンバーシップを持つメンバーを表示するには、アプリに Member.Read.Hidden 委任またはアプリケーションアクセス許可が付与されている必要があります。

職場または学校アカウントを使用する委任されたシナリオでは、サインインしているユーザーはメンバー ユーザーであるか、サポートされている Microsoft Entra ロール またはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てられている必要があります。 この操作では、次の最小特権ロールがサポートされています。

Microsoft Entra ロール 制限事項 キー ロールのアクセス許可
ディレクトリ リーダー 管理単位の基本的なプロパティを読み取る microsoft.directory/administrativeUnits/standard/read
ディレクトリ リーダー 管理単位のメンバーを読み取る microsoft.directory/administrativeUnits/members/read
グローバル閲覧者 メンバーを含む、管理単位のすべてのプロパティを読み取る microsoft.directory/administrativeUnits/allProperties/read
特権ロール管理者 管理単位 (メンバーを含む) の作成と管理 microsoft.directory/administrativeUnits/allProperties/allTasks

HTTP 要求

GET /administrativeUnits/{id}/members
GET /administrativeUnits/{id}/members/$ref

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

このメソッド ($refなしで使用される場合) は、$search、$count、$filterなど、応答をカスタマイズするのに役立つ OData クエリ パラメーターをサポートします。 OData キャストも有効になります。たとえば、キャストして、管理単位のメンバーであるユーザーのみを取得できます。

$search は displayName プロパティと description プロパティでのみサポートされています。 クエリの中には、ConsistencyLevel ヘッダーの設定を eventual および $count に使用した場合にのみサポートされるものもあります。 詳細については、「ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
ConsistencyLevel 最終的。 このヘッダーと $count は、$search を使用する場合、または $filter の特別な使用をする場合に必要です。 ConsistencyLevel と $count の使用の詳細については、「ディレクトリ オブジェクトに対する高度なクエリ機能」を参照してください。

要求本文

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

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文の ユーザー、 グループ、または デバイス オブジェクトのコレクションを返します。 要求の最後に $ref を追加すると、メンバーの @odata.id URL のみのコレクションが返されます。

例

例 1: メンバー オブジェクトを一覧表示する

要求

次の要求では、管理単位のメンバーが一覧表示され、ユーザーやグループのコレクションが返されます。

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members

応答

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

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

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

{
  "value":[
    {
      "@odata.type":"#microsoft.graph.user",
      "id":"492c5308-59fd-4740-9c83-4b3db07a6d70"
      "accountEnabled":true,
      "businessPhones":[],
      "companyName":null,
      "displayName":"Demo User"
    },
    {
      "@odata.type":"#microsoft.graph.group",
      "id":"07eaa5c7-c9b6-45cf-8ff7-3147d5122caa",
      "description":"This group is the best ever",
      "displayName":"Awesome group"
    }
  ]
}

例 2: メンバー参照を一覧表示する

要求

次の要求では、管理単位のメンバー参照が一覧表示され、メンバーへの @odata.id 参照のコレクションが返されます。

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members/$ref

応答

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

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

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

{
  "value":[
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/492c5308-59fd-4740-9c83-4b3db07a6d70"
    },
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/07eaa5c7-c9b6-45cf-8ff7-3147d5122caa"
    }
  ]
}