directoryObject: getMemberGroups

[アーティクル]
08/17/2023

名前空間: microsoft.graph

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

この API は、最大 11,000 個のグループ ID を返します。 11,000 を超える結果が使用可能な場合は、エラーコードでエラーがDirectory_ResultSizeLimitExceeded返400 Bad Requestされます。回避策として、 List グループ推移的メンバーOf API を使用します。

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

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

アクセス許可

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

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

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	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.Read.All と GroupMember.Read.All、User.Read.All、Group.Read.All、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.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、Device.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.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` エンティティがメンバーであるセキュリティグループのみを返すように指定するには、 `false` エンティティがメンバーであるすべてのグループとディレクトリロールを返す必要があることを指定します。 `true` は、ユーザーまたはサービスプリンシパルがセキュリティが有効なグループを返す場合にのみ指定できます。

応答

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

例

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

要求

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

{
    "securityEnabledOnly": false
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.DirectoryObjects.Item.GetMemberGroups;

var requestBody = new GetMemberGroupsPostRequestBody
{
	SecurityEnabledOnly = false,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DirectoryObjects["{directoryObject-id}"].GetMemberGroups.PostAsGetMemberGroupsPostResponseAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc directory-objects get-member-groups post --directory-object-id {directoryObject-id} --body '{\
    "securityEnabledOnly": false\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdirectoryobjects "github.com/microsoftgraph/msgraph-sdk-go/directoryobjects"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphdirectoryobjects.NewGetMemberGroupsPostRequestBody()
securityEnabledOnly := false
requestBody.SetSecurityEnabledOnly(&securityEnabledOnly) 

getMemberGroups, err := graphClient.DirectoryObjects().ByDirectoryObjectId("directoryObject-id").GetMemberGroups().PostAsGetMemberGroupsPostResponse(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.directoryobjects.item.getmembergroups.GetMemberGroupsPostRequestBody getMemberGroupsPostRequestBody = new com.microsoft.graph.directoryobjects.item.getmembergroups.GetMemberGroupsPostRequestBody();
getMemberGroupsPostRequestBody.setSecurityEnabledOnly(false);
var result = graphClient.directoryObjects().byDirectoryObjectId("{directoryObject-id}").getMemberGroups().post(getMemberGroupsPostRequestBody);


const options = {
	authProvider,
};

const client = Client.init(options);

const string = {
    securityEnabledOnly: false
};

await client.api('/directoryObjects/0049d944-a805-4680-9f54-3ab292090309/getMemberGroups')
	.post(string);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\GetMemberGroupsPostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new GetMemberGroupsPostRequestBody();
$requestBody->setSecurityEnabledOnly(false);

$result = $graphServiceClient->directoryObjects()->byDirectoryObjectId('directoryObject-id')->getMemberGroups()->post($requestBody)->wait();


Import-Module Microsoft.Graph.DirectoryObjects

$params = @{
	securityEnabledOnly = $false
}

Get-MgDirectoryObjectMemberGroup -DirectoryObjectId $directoryObjectId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.get_member_groups_post_request_body import GetMemberGroupsPostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = GetMemberGroupsPostRequestBody(
	security_enabled_only = False,
)

result = await graph_client.directory_objects.by_directory_object_id('directoryObject-id').get_member_groups.post(request_body)

応答

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

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

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

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

要求

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

{
  "securityEnabledOnly": true
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Me.GetMemberGroups;

var requestBody = new GetMemberGroupsPostRequestBody
{
	SecurityEnabledOnly = true,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.GetMemberGroups.PostAsGetMemberGroupsPostResponseAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users get-member-groups post --user-id {user-id} --body '{\
  "securityEnabledOnly": true\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphusers.NewItemGetMemberGroupsPostRequestBody()
securityEnabledOnly := true
requestBody.SetSecurityEnabledOnly(&securityEnabledOnly) 

getMemberGroups, err := graphClient.Me().GetMemberGroups().PostAsGetMemberGroupsPostResponse(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.users.item.getmembergroups.GetMemberGroupsPostRequestBody getMemberGroupsPostRequestBody = new com.microsoft.graph.users.item.getmembergroups.GetMemberGroupsPostRequestBody();
getMemberGroupsPostRequestBody.setSecurityEnabledOnly(true);
var result = graphClient.me().getMemberGroups().post(getMemberGroupsPostRequestBody);


const options = {
	authProvider,
};

const client = Client.init(options);

const string = {
  securityEnabledOnly: true
};

await client.api('/me/getMemberGroups')
	.post(string);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\GetMemberGroupsPostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new GetMemberGroupsPostRequestBody();
$requestBody->setSecurityEnabledOnly(true);

$result = $graphServiceClient->me()->getMemberGroups()->post($requestBody)->wait();


Import-Module Microsoft.Graph.Users.Actions

$params = @{
	securityEnabledOnly = $true
}

# A UPN can also be used as -UserId.
Get-MgUserMemberGroup -UserId $userId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.get_member_groups_post_request_body import GetMemberGroupsPostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = GetMemberGroupsPostRequestBody(
	security_enabled_only = True,
)

result = await graph_client.me.get_member_groups.post(request_body)

応答

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(Edm.String)",
    "value": [
        "6239671a-0db6-4e8b-9d2f-f280efb5a181",
        "2e2f1227-1586-45ae-bf51-fccc1de72625",
        "1dae9306-be75-4c3c-99ec-0316a4342c84",
        "0e2d1bbb-76f8-4140-bda7-2a858b74507e",
        "0049d944-a805-4680-9f54-3ab292090309",
        "a8daa1fb-d24c-47d0-9e9e-c99e83394e3e",
        "6f204729-1b8f-4067-bcc9-98fb6c069ffd",
        "59afd38d-441a-4358-b074-8b9b1e7de52f",
        "64ed3df3-53c7-4d4d-ac5c-5c8dd4dafe33",
        "8b676bab-4b1e-419e-a253-7f5aca97d739",
        "be4ef325-9fa8-40d7-b375-4758853ddf52",
        "f5987b5a-61f6-4c31-9fa2-7bfb845c8d2a"
    ]
}

directoryObject: getMemberGroups

アクセス許可

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

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

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

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

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

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

HTTP 要求

要求ヘッダー

要求本文

応答

例

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

要求

応答

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

要求

応答

フィードバック

フィードバック

その他のリソース

directoryObject: getMemberGroups

アクセス許可

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

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

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

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

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

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

HTTP 要求

要求ヘッダー

要求本文

応答

例

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

要求

応答

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

要求

応答

フィードバック

フィードバック

その他のリソース

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

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

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

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

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

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

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

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