メンバーを一覧表示する

  • [アーティクル]

名前空間: 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

注:

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

委任されたシナリオの場合、呼び出し元のユーザーはメンバー ユーザーであるか、次のMicrosoft Entraロールの少なくとも 1 つを持っている必要があります。

  • ディレクトリ リーダー
  • ディレクトリ製作者
  • アプリケーション管理者
  • セキュリティ閲覧者
  • セキュリティ管理者
  • 特権ロール管理者
  • クラウド アプリケーション管理者
  • カスタマー ロックボックス アクセス承認者
  • Dynamics 365管理者
  • Power BI 管理者
  • Azure Information Protection 管理者
  • Desktop Analytics管理者
  • ライセンス管理者
  • Microsoft マネージド デスクトップ管理者
  • Teams 通信管理者
  • Teams 通信サポート エンジニア
  • Teams 通信サポート スペシャリスト
  • Teams 管理者
  • Insights 管理者
  • コンプライアンス データ管理者
  • セキュリティ オペレーター
  • Kaizala 管理者
  • グローバル閲覧者
  • ディレクトリレビュー担当者

アプリケーションが directoryObject 型コレクションを返すリレーションシップを照会する場合、特定の派生型 (デバイスなど) を読み取るアクセス許可がない場合、その型のメンバーは返されますが、情報は限られています。 この動作により、アプリケーションはディレクトリのセットに依存するのではなく、必要な最小限の特権のアクセス許可を要求できます 。*アクセス 許可。 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。

HTTP 要求

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

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

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

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

要求ヘッダー

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

要求本文

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

応答

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

例

例 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"
    }
  ]
}