メンバーを一覧表示する

名前空間: microsoft.graph

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

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

注: 管理単位で非表示メンバーシップのメンバーを一覧表示するには、Member.Read.Hidden アクセス許可が必要です。

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

HTTP 要求

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

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

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

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。必須。
ConsistencyLevel 最終的。 このヘッダーと $count は、$search を使用する場合、または $filter の特別な使用をする場合に必要です。 ConsistencyLevel および $count の使用方法の詳細については、「Azure AD ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。

要求本文

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

応答

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

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

要求

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

GET https://graph.microsoft.com/v1.0/directory/administrativeUnits/c5729e7c-988e-417b-b287-14f5bd4711d8/members

応答

以下は、応答の例です。

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
    "value": [
        {
            "@odata.type": "#microsoft.graph.device",
            "id": "7c06cd31-7c30-4f3b-a5c3-444cd8dd63ac",
            "accountEnabled": true,
            "deviceId": "6fa60d52-01e7-4b18-8055-4759461fc16b",
            "displayName": "Test Windows device",
            "operatingSystem": "Windows"
        },
        {
            "@odata.type": "#microsoft.graph.device",
            "id": "c530e1f6-7b4c-4313-840e-cf1a99ec3b38",
            "accountEnabled": false,
            "deviceId": "4c299165-6e8f-4b45-a5ba-c5d250a707ff",
            "displayName": "Test Linux device",
            "operatingSystem": "linux"
        }
    ]
}

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

要求

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

GET https://graph.microsoft.com/v1.0/directory/administrativeUnits/{id}/members/$ref

応答

以下は、応答の例です。

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

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

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