グループ メンバーを一覧表示する

名前空間: microsoft.graph

重要

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

グループのダイレクト メンバーの一覧を取得します。 グループには、ユーザー、連絡先、デバイス、サービス プリンシパル、およびその他のグループをメンバーとして含めることができます。 この操作は推移的ではありません。

グループに100以上のメンバーが含まれている場合は、回答の中に結果の次のページへの URL を含む、@odata.nextLink プロパティが返されます。 そのプロパティが存在する場合は、「アプリの Microsoft Graph のデータをアプリでページングするする」で説明されているように、各回答の @odata.nextLink URL を使用して、すべての結果が返されるまで追加の要求を続けます。

アクセス許可

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

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

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

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

HTTP 要求

GET /groups/{id}/members

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

このメソッドは、応答をカスタマイズするための$search$count、および$filterを含むOData クエリ パラメーターをサポートします。 また、OData キャストも有効です。たとえば、グループのメンバーであるユーザーのみを取得することができます。 displayName プロパティで$searchを使用できます。 このリソースのアイテムを追加または更新すると、 $count$search クエリ パラメーターを共に使用するように特別にインデックスが作成されます。 アイテムを追加または更新してから、インデックスで使用できるようになるまでに少し時間がかかる場合があります。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。必須。
ConsistencyLevel 最終的。 このヘッダーおよび$countは、$search$filter$orderby、または OData キャスト クエリ パラメーターを使用する場合に必要です。 最新の状態に更新されていない可能性があるインデックスを使用しています。

要求本文

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

応答

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

例 1: グループのダイレクト メンバーシップを取得する

要求

要求の例を次に示します。

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

応答

応答の例を次に示します。

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

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

{
  "value": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "mail": "group1@contoso.com",
      "mailEnabled": true,
      "mailNickname": "Contoso1",
      "securityEnabled": true
    }
  ]
}

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

要求

要求の例を次に示します。

GET https://graph.microsoft.com/beta/groups/{id}/members/$count
ConsistencyLevel: eventual

応答

応答の例を次に示します。

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

893

例 3: OData キャストを使用して、ユーザー メンバーシップ数のみを取得する

要求

要求の例を次に示します。

GET https://graph.microsoft.com/beta/groups/{id}/members/microsoft.graph.user/$count
ConsistencyLevel: eventual

応答

応答の例を次に示します。

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

893

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

要求

要求の例を次に示します。

GET https://graph.microsoft.com/beta/groups/{id}/members/microsoft.graph.user?$count=true&$orderby=displayName&$search="displayName:Pr"&$select=displayName,id
ConsistencyLevel: eventual

応答

応答の例を次に示します。

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

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#users(displayName,id)",
  "@odata.count":7,
  "value":[
    {
      "displayName":"Joseph Price",
      "id":"11111111-2222-3333-4444-555555555555"
    },
    {
      "displayName":"Preston Morales",
      "id":"11111111-2222-3333-4444-555555555555"
    }
  ]
}

例 5: $filter を使用して、「A」で始まる表示名のグループ メンバーシップを取得する (返されたオブジェクトの数も含む)

要求

要求の例を次に示します。

GET https://graph.microsoft.com/beta/groups/{id}/members?$count=true&$filter=startswith(displayName, 'a')
ConsistencyLevel: eventual

応答

応答の例を次に示します。

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

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

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

例 6: OData キャストを使用して、グループ メンバーとして追加されたサービス プリンシパルを取得する

要求

要求の例を次に示します。

GET https://graph.microsoft.com/beta/groups/3802e9bb-0951-4e18-b9eb-f934b4241194/members/microsoft.graph.servicePrincipal

応答

応答の例を次に示します。

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#servicePrincipals",
  "value": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "deletedDateTime": null,
      "accountEnabled": true,
      "appDisplayName": "Contoso Azure App",
      "appId": "11111111-2222-3333-4444-555555555555",
    }
  ]
}