directoryObject: checkMemberObjects

Namespace: microsoft.graph

Check for membership in a list of group IDs, administrative unit IDs, or directory role IDs, for the IDs of the specified user, group, service principal, organizational contact, device, or directory object. This method is transitive.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Memberships for a directory object

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Directory.Read.All
Delegated (personal Microsoft account)	Not supported.
Application	Directory.Read.All

Memberships for a user

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	User.Read, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All

Memberships for a group

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All

Memberships for a service principal

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All

Memberships for an organizational contact

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Directory.Read.All, Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Directory.Read.All, Directory.ReadWrite.All

Memberships for a device

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Device.Read.All, Directory.Read.All, Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

HTTP request

Memberships for a directory object.

POST /directoryObjects/{id}/checkMemberObjects

Memberships for a user.

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

Memberships for a group.

POST /groups/{id}/checkMemberObjects

Memberships for a service principal.

POST /servicePrincipals/{id}/checkMemberObjects

Memberships for an organizational contact.

POST /contacts/{id}/checkMemberObjects

Memberships for a device.

POST /devices/{id}/checkMemberObjects

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter	Type	Description
ids	String collection	A collection that contains the object IDs of the groups, administrative units, directory roles, or roleTemplate IDs of directory roles, in which to check membership. You can specify up to 20 objects.

Response

If successful, this method returns a 200 OK response code and a new String collection object in the response body.

Examples

The following is an example of how to call this API.

Request

The following example shows a request.

HTTP

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

{
  "ids": [
    "80a963dd-84af-4eb8-b2a6-781e444d4fb0",
    "62e90394-69f5-4237-9190-012177145e10",
    "86a64f51-3a64-4cc6-a8c8-6b8f000c0f52",
    "ac38546e-ddf3-437a-ac5c-27a94cd7a0f1"
  ]
}

C#

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

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

var requestBody = new CheckMemberObjectsPostRequestBody
{
	Ids = new List<string>
	{
		"80a963dd-84af-4eb8-b2a6-781e444d4fb0",
		"62e90394-69f5-4237-9190-012177145e10",
		"86a64f51-3a64-4cc6-a8c8-6b8f000c0f52",
		"ac38546e-ddf3-437a-ac5c-27a94cd7a0f1",
	},
};

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

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc users check-member-objects post --user-id {user-id} --body '{\
  "ids": [\
    "80a963dd-84af-4eb8-b2a6-781e444d4fb0",\
    "62e90394-69f5-4237-9190-012177145e10",\
    "86a64f51-3a64-4cc6-a8c8-6b8f000c0f52",\
    "ac38546e-ddf3-437a-ac5c-27a94cd7a0f1"\
  ]\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

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.NewItemCheckMemberObjectsPostRequestBody()
ids := []string {
	"80a963dd-84af-4eb8-b2a6-781e444d4fb0",
	"62e90394-69f5-4237-9190-012177145e10",
	"86a64f51-3a64-4cc6-a8c8-6b8f000c0f52",
	"ac38546e-ddf3-437a-ac5c-27a94cd7a0f1",
}
requestBody.SetIds(ids)

checkMemberObjects, err := graphClient.Me().CheckMemberObjects().PostAsCheckMemberObjectsPostResponse(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.users.item.checkmemberobjects.CheckMemberObjectsPostRequestBody checkMemberObjectsPostRequestBody = new com.microsoft.graph.users.item.checkmemberobjects.CheckMemberObjectsPostRequestBody();
LinkedList<String> ids = new LinkedList<String>();
ids.add("80a963dd-84af-4eb8-b2a6-781e444d4fb0");
ids.add("62e90394-69f5-4237-9190-012177145e10");
ids.add("86a64f51-3a64-4cc6-a8c8-6b8f000c0f52");
ids.add("ac38546e-ddf3-437a-ac5c-27a94cd7a0f1");
checkMemberObjectsPostRequestBody.setIds(ids);
var result = graphClient.me().checkMemberObjects().post(checkMemberObjectsPostRequestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const string = {
  ids: [
    '80a963dd-84af-4eb8-b2a6-781e444d4fb0',
    '62e90394-69f5-4237-9190-012177145e10',
    '86a64f51-3a64-4cc6-a8c8-6b8f000c0f52',
    'ac38546e-ddf3-437a-ac5c-27a94cd7a0f1'
  ]
};

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

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

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


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

$requestBody = new CheckMemberObjectsPostRequestBody();
$requestBody->setIds(['80a963dd-84af-4eb8-b2a6-781e444d4fb0', '62e90394-69f5-4237-9190-012177145e10', '86a64f51-3a64-4cc6-a8c8-6b8f000c0f52', 'ac38546e-ddf3-437a-ac5c-27a94cd7a0f1', 	]);

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

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Users.Actions

$params = @{
	ids = @(
	"80a963dd-84af-4eb8-b2a6-781e444d4fb0"
"62e90394-69f5-4237-9190-012177145e10"
"86a64f51-3a64-4cc6-a8c8-6b8f000c0f52"
"ac38546e-ddf3-437a-ac5c-27a94cd7a0f1"
)
}

# A UPN can also be used as -UserId.
Confirm-MgUserMemberObject -UserId $userId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.check_member_objects_post_request_body import CheckMemberObjectsPostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = CheckMemberObjectsPostRequestBody(
	ids = [
		"80a963dd-84af-4eb8-b2a6-781e444d4fb0",
		"62e90394-69f5-4237-9190-012177145e10",
		"86a64f51-3a64-4cc6-a8c8-6b8f000c0f52",
		"ac38546e-ddf3-437a-ac5c-27a94cd7a0f1",
	],
)

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

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "value": [
    "80a963dd-84af-4eb8-b2a6-781e444d4fb0", 
    "62e90394-69f5-4237-9190-012177145e10"
  ]
}