directoryObject: checkMemberGroups

名前空間: microsoft.graph

重要

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

指定した グループ ID の一覧でメンバーシップを確認し、指定したオブジェクトがメンバーであるグループの ID をその一覧から返します。 指定したオブジェクトには、次のいずれかの型を指定できます。

この関数は、推移的です。

要求ごとに、最大 20 のグループを確認できます。 この関数は、Microsoft Entra IDでプロビジョニングされたすべてのグループをサポートします。 Microsoft 365 グループには他のグループを含めることはできませんので、Microsoft 365 グループのメンバーシップは常に直接的です。

重要

Microsoft Graph では、 groupIds コレクションが 1 つの要求として評価されます。 要求が無効な場合 (不正な形式のグループ ID など)、要求全体が失敗します。 呼び出し元が特定のグループ (たとえば、非表示のメンバーシップを持つグループ) を評価するためのアクセス権を持っていない場合、応答には、呼び出し元が評価を許可されているグループのみが含まれる場合があります。

注:

応答時間は、グループの入れ子の深さとメンバーシップ サイズなど、テナントのディレクトリ構造によって異なります。 Microsoft Graph では、推移的なメンバーシップ API の待機時間ターゲットは公開されません。

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

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

アクセス許可

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

ディレクトリ オブジェクトのグループ メンバーシップ

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

注:

Directory.* アクセス許可を使用すると、この API を使用して、サポートされているディレクトリ オブジェクトの種類を取得できます。 特定の種類のみを取得するには、リソースに固有のアクセス許可を使用できます。

サインインしているユーザーのグループ メンバーシップ

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

他のユーザーのグループ メンバーシップ

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

グループのグループ メンバーシップ

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

サービス プリンシパルのグループ メンバーシップ

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

組織の連絡先のグループ メンバーシップ

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

デバイスのグループ メンバーシップ

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

重要

非表示のメンバーシップを持つグループの メンバーシップを評価するには、追加のアクセス権が必要です。

  • アプリケーションのアクセス許可: アプリには Member.Read.Hidden アクセス許可が必要です。
  • 委任されたアクセス許可: サインインしているユーザーは、非表示メンバーシップ グループのメンバーである必要があります。

どちらの条件も満たされない場合、非表示メンバーシップ グループは評価されず、それらのグループ ID は応答から省略されます。

HTTP 要求

ディレクトリ オブジェクトのグループ メンバーシップ (ユーザー、グループ、サービス プリンシパル、または組織の連絡先)。

POST /directoryObjects/{id}/checkMemberGroups

サインインしているユーザーのグループ メンバーシップ。

POST /me/checkMemberGroups

他のユーザーのグループ メンバーシップ。

POST /users/{id | userPrincipalName}/checkMemberGroups

グループのグループ メンバーシップ。

POST /groups/{id}/checkMemberGroups

サービス プリンシパルのグループ メンバーシップ。

POST /servicePrincipals/{id}/checkMemberGroups

組織の連絡先のグループ メンバーシップ。

POST /contacts/{id}/checkMemberGroups

デバイスのグループ メンバーシップ。

POST /devices/{id}/checkMemberGroups

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 説明
groupIds String collection メンバーシップを確認するためのグループのオブジェクト ID を含むコレクションです。 最大 20 グループを指定することが可能です。

応答

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

例 1: ディレクトリ オブジェクトのグループ メンバーシップを確認する

要求

POST https://graph.microsoft.com/beta/directoryObjects/4562bcc8-c436-4f95-b7c0-4f8ce89dca5e/checkMemberGroups
Content-type: application/json

{
    "groupIds": [
        "f448435d-3ca7-4073-8152-a1fd73c0fd09",
        "bd7c6263-4dd5-4ae8-8c96-556e1c0bece6",
        "93670da6-d731-4366-94b5-abed40b6016b",
        "f5484ab1-4d4d-41ec-a9b8-754b3957bfc7",
        "c9103f26-f3cf-4004-a611-2a14e81b8f79"
    ]
}

応答

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

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(Edm.String)",
    "value": [
        "f448435d-3ca7-4073-8152-a1fd73c0fd09",
        "93670da6-d731-4366-94b5-abed40b6016b",
        "f5484ab1-4d4d-41ec-a9b8-754b3957bfc7",
        "c9103f26-f3cf-4004-a611-2a14e81b8f79"
    ]
}

例 2: サインインしているユーザーのグループ メンバーシップを確認する

要求

POST https://graph.microsoft.com/beta/me/checkMemberGroups
Content-type: application/json

{
  "groupIds": [
        "fee2c45b-915a-4a64-b130-f4eb9e75525e",
        "4fe90ae7-065a-478b-9400-e0a0e1cbd540"
  ]
}

応答

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(Edm.String)",
  "value": [
        "fee2c45b-915a-4a64-b130-f4eb9e75525e"
  ]
}