デバイス メンバーシップを一覧表示する

  • [アーティクル]

名前空間: microsoft.graph

このデバイスが直接メンバーであるグループと管理単位を取得します。 この操作は推移的ではありません。

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

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

アクセス許可

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

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

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

HTTP 要求

ID またはdeviceId を使用してデバイスをアドレス指定できます。

GET /devices/{id}/memberOf
GET /devices(deviceId='{deviceId}')/memberOf

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

このメソッドは、応答のカスタマイズに $select役立つ、 $search、 $count、および $filterOData クエリ パラメーター をサポートします。 OData キャストも有効になっています。たとえば、キャストして、デバイスがメンバーである directoryRoles だけを取得できます。 displayName プロパティと description プロパティで $search を使用できます。 既定のページ サイズと最大ページ サイズはそれぞれ 100 オブジェクトと 999 オブジェクトです。

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

要求ヘッダー

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

要求本文

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

応答

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

例

例 1: デバイスが直接メンバーであるグループを取得する

要求

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

GET https://graph.microsoft.com/v1.0/devices/{id}/memberOf

応答

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

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

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.group",
      "id": "id-value",
      "createdDateTime": null,
      "description": "All users at the company",
      "displayName": "All Users",
      "groupTypes": [],
      "mailEnabled": false,
      "securityEnabled": true,
    }
  ]
}

例 2: 全メンバーシップ数のみを取得する

要求

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

GET https://graph.microsoft.com/v1.0/devices/{id}/memberOf/$count
ConsistencyLevel: eventual

応答

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

HTTP/1.1 200 OK
Content-type: text/plain

394

例 3: OData キャストと$searchを使用して、返されたオブジェクトの数を含む文字 'Video' を含む表示名を持つメンバーシップを取得する

要求

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

GET https://graph.microsoft.com/v1.0/devices/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:Video"
ConsistencyLevel: eventual

応答

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

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

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups",
  "@odata.count":1396,
  "value":[
    {
      "displayName":"SFA Videos",
      "mail":"SFAVideos@service.contoso.com",
      "mailNickname":"SFAVideos"
    }
  ]
}

例 4: OData キャストと$filterを使用して、返されたオブジェクトの数を含む文字 'A' で始まる表示名を持つメンバーシップを取得する

要求

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

GET https://graph.microsoft.com/v1.0/devices/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$filter=startswith(displayName, 'A')
ConsistencyLevel: eventual

応答

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

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

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups",
  "@odata.count":76,
  "value":[
    {
      "displayName":"AAD Contoso Videos",
      "mail":"AADContosoVideos@contoso.com",
      "mailEnabled":true,
      "mailNickname":"AADContoso_Videos",
      "securityEnabled":true
    }
  ]
}