directoryObject: getMemberGroups

名前空間: microsoft.graph

重要

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

指定した ユーザーグループサービス プリンシパル組織の連絡先デバイスまたはディレクトリ オブジェクト がメンバーであるグループのすべてのグループ ID を返します。 この関数は、推移的です。

この API は、最大 11,000 個のグループ ID を返します。 11,000 個を超える結果がある場合は、Directory_ResultSizeLimitExceededエラー コードを含む400 Bad Requestエラーが返されます。 Directory_ResultSizeLimitExceeded エラー コードが表示される場合は、代わりにリスト グループ推移的 memberOf API を使用してください。

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

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

アクセス許可

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

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

ここでは、オブジェクト タイプに関係なく、 任意の ディレクトリ オブジェクトを読み取ることができます。 操作の範囲を特定のオブジェクト タイプにし、特権が低いアクセス許可を使用するには、このページの他のアクセス許可の表を参照してください。

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

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

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) 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

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

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) 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

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

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

HTTP 要求

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

POST /directoryObjects/{id}/getMemberGroups

サインインしたユーザーまたはその他のユーザーのグループ メンバーシップ。

POST /me/getMemberGroups
POST /users/{id | userPrincipalName}/getMemberGroups

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

POST /groups/{id}/getMemberGroups

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

POST /servicePrincipals/{id}/getMemberGroups

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

POST /contacts/{id}/getMemberGroups

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

POST /devices/{id}/getMemberGroups

要求ヘッダー

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

要求本文

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

パラメーター 説明
securityEnabledOnly ブール値 true エンティティがメンバーであるセキュリティ グループのみを返すように指定します。エンティティがメンバーであるすべてのグループとディレクトリ ロールを返すように指定 falsetrue セキュリティが有効なグループを返すユーザーまたはサービス プリンシパルに対してのみ指定できます。

応答

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

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

要求

POST https://graph.microsoft.com/beta/directoryObjects/0049d944-a805-4680-9f54-3ab292090309/getMemberGroups
Content-type: application/json

{
    "securityEnabledOnly": false
}

応答

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

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(Edm.String)",
    "value": [
        "a8daa1fb-d24c-47d0-9e9e-c99e83394e3e"
    ]
}

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

要求

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

{
  "securityEnabledOnly": true
}

応答

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(Edm.String)",
    "value": [
        "6239671a-0db6-4e8b-9d2f-f280efb5a181",
        "2e2f1227-1586-45ae-bf51-fccc1de72625",
        "f5987b5a-61f6-4c31-9fa2-7bfb845c8d2a"
    ]
}