Remove member

Namespace: microsoft.graph

Remove a member from a group via the members navigation property. You can't remove a member from groups with dynamic memberships.

This API is available in the following national cloud deployments.

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

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	GroupMember.ReadWrite.All	Directory.ReadWrite.All, Group.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	GroupMember.ReadWrite.All	Directory.ReadWrite.All, Group.ReadWrite.All

In delegated scenarios, the signed-in user must also be assigned a supported Microsoft Entra role or a custom role with the microsoft.directory/groups/members/update role permission. The following least privileged roles are supported for this operation, except for role-assignable groups:

• Group owners
• Directory Writers
• Groups Administrator
• Identity Governance Administrator
• User Administrator
• Exchange Administrator - for Microsoft 365 groups only
• SharePoint Administrator - for Microsoft 365 groups only
• Teams Administrator - for Microsoft 365 groups only
• Yammer Administrator - for Microsoft 365 groups only
• Intune Administrator - for security groups only

To remove members from a role-assignable group, the app must also be assigned the RoleManagement.ReadWrite.Directory permission and the calling user must be assigned a supported Microsoft Entra role. Privileged Role Administrator is the least privileged role that is supported for this operation.

HTTP request

DELETE /groups/{id}/members/{id}/$ref

Caution

If /$ref is not appended to the request and the calling app has permissions to manage the member object type, the member object will also be deleted from Microsoft Entra ID; otherwise, a 403 Forbidden error is returned. For example, an app with both GroupMember.ReadWrite.All and User.ReadWrite.All permissions will delete a user. You can restore specific objects through the Restore deleted items API.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns 204 No Content response code. It doesn't return anything in the response body.

Example

Request

The following example shows a request.

HTTP

DELETE https://graph.microsoft.com/v1.0/groups/{group-id}/members/{directory-object-id}/$ref

C#

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Groups["{group-id}"].Members["{directoryObject-id}"].Ref.DeleteAsync();

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

CLI

mgc groups members ref-by-id delete --group-id {group-id} --directory-object-id {directoryObject-id}

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

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Groups().ByGroupId("group-id").Members().ByDirectoryObjectId("directoryObject-id").Ref().Delete(context.Background(), 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);

graphClient.groups().byGroupId("{group-id}").members().byDirectoryObjectId("{directoryObject-id}").ref().delete();

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);

await client.api('/groups/{group-id}/members/{directory-object-id}/$ref')
	.delete();

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;


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


$graphServiceClient->groups()->byGroupId('group-id')->members()->byDirectoryObjectId('directoryObject-id')->ref()->delete()->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.Groups

Remove-MgGroupMemberDirectoryObjectByRef -GroupId $groupId -DirectoryObjectId $directoryObjectId

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

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.groups.by_group_id('group-id').members.by_directory_object_id('directoryObject-id').ref.delete()

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

In the request, specify the identifier of the group and the identifier of the directory object you want to remove.

Response

The following example shows the response.

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

HTTP/1.1 204 No Content

Related content

• Add member to team
• Update member's role in team
• Remove member from team