Create sharePointGroupMember

2025-04-18

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new sharePointGroupMember object within a sharePointGroup. A sharePointGroup can have up to 5,000 users. For more information on service limits, see SharePoint online limits. Users and Microsoft 365 groups are supported as viable identities for sharePointGroupMember. The newly created sharePointGroupMember immediately inherits driveItem permissions that have been granted to the sharePointGroup. It may take several minutes for substrate-related functionality, such as search and Copilot, to reflect the addition of the new sharePointGroupMember.

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)	Not supported.	Not supported.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	FileStorageContainer.Selected	Not available.

Note

In addition to Microsoft Graph permissions, applications calling this API must at least have the AddPermissions container type-level permission on the container type of the corresponding containers. For more information, see container types. To learn more about container type-level permissions, see SharePoint Embedded authorization.

HTTP request

POST /storage/fileStorage/containers/{fileStorageContainerId}/sharePointGroups/{sharePointGroupId}/members

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, supply a JSON representation of the sharePointGroupMember object.

You can specify the following property when you create a sharePointGroupMember.

Property	Type	Description
identity	sharePointIdentitySet	The identity of the sharePointGroupMember. Required.

Response

If successful, this method returns a 201 Created response code and a sharePointGroupMember object in the response body.

Examples

Request

The following example shows a request that creates a sharePointGroupMember using their user principal name.

POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/sharePointGroups/10/members
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sharePointGroupMember",
  "identity": {
    "user": {
      "userPrincipalName": "john.smith@contoso.com"
    }
  }
}


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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new SharePointGroupMember
{
	OdataType = "#microsoft.graph.sharePointGroupMember",
	Identity = new SharePointIdentitySet
	{
		User = new Identity
		{
			AdditionalData = new Dictionary<string, object>
			{
				{
					"userPrincipalName" , "john.smith@contoso.com"
				},
			},
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Storage.FileStorage.Containers["{fileStorageContainer-id}"].SharePointGroups["{sharePointGroup-id}"].Members.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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



mgc-beta storage file-storage containers share-point-groups members create --file-storage-container-id {fileStorageContainer-id} --share-point-group-id {sharePointGroup-id} --body '{\
  "@odata.type": "#microsoft.graph.sharePointGroupMember",\
  "identity": {\
    "user": {\
      "userPrincipalName": "john.smith@contoso.com"\
    }\
  }\
}\
'

Important

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



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

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

requestBody := graphmodels.NewSharePointGroupMember()
identity := graphmodels.NewSharePointIdentitySet()
user := graphmodels.NewIdentity()
additionalData := map[string]interface{}{
	"userPrincipalName" : "john.smith@contoso.com", 
}
user.SetAdditionalData(additionalData)
identity.SetUser(user)
requestBody.SetIdentity(identity)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
members, err := graphClient.Storage().FileStorage().Containers().ByFileStorageContainerId("fileStorageContainer-id").SharePointGroups().BySharePointGroupId("sharePointGroup-id").Members().Post(context.Background(), requestBody, nil)

Important

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


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SharePointGroupMember sharePointGroupMember = new SharePointGroupMember();
sharePointGroupMember.setOdataType("#microsoft.graph.sharePointGroupMember");
SharePointIdentitySet identity = new SharePointIdentitySet();
Identity user = new Identity();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("userPrincipalName", "john.smith@contoso.com");
user.setAdditionalData(additionalData);
identity.setUser(user);
sharePointGroupMember.setIdentity(identity);
SharePointGroupMember result = graphClient.storage().fileStorage().containers().byFileStorageContainerId("{fileStorageContainer-id}").sharePointGroups().bySharePointGroupId("{sharePointGroup-id}").members().post(sharePointGroupMember);

Important

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


const options = {
	authProvider,
};

const client = Client.init(options);

const sharePointGroupMember = {
  '@odata.type': '#microsoft.graph.sharePointGroupMember',
  identity: {
    user: {
      userPrincipalName: 'john.smith@contoso.com'
    }
  }
};

await client.api('/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/sharePointGroups/10/members')
	.version('beta')
	.post(sharePointGroupMember);

Important

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


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\SharePointGroupMember;
use Microsoft\Graph\Beta\Generated\Models\SharePointIdentitySet;
use Microsoft\Graph\Beta\Generated\Models\Identity;


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

$requestBody = new SharePointGroupMember();
$requestBody->setOdataType('#microsoft.graph.sharePointGroupMember');
$identity = new SharePointIdentitySet();
$identityUser = new Identity();
$additionalData = [
	'userPrincipalName' => 'john.smith@contoso.com',
];
$identityUser->setAdditionalData($additionalData);
$identity->setUser($identityUser);
$requestBody->setIdentity($identity);

$result = $graphServiceClient->storage()->fileStorage()->containers()->byFileStorageContainerId('fileStorageContainer-id')->sharePointGroups()->bySharePointGroupId('sharePointGroup-id')->members()->post($requestBody)->wait();

Important

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


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.share_point_group_member import SharePointGroupMember
from msgraph_beta.generated.models.share_point_identity_set import SharePointIdentitySet
from msgraph_beta.generated.models.identity import Identity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = SharePointGroupMember(
	odata_type = "#microsoft.graph.sharePointGroupMember",
	identity = SharePointIdentitySet(
		user = Identity(
			additional_data = {
					"user_principal_name" : "john.smith@contoso.com",
			}
		),
	),
)

result = await graph_client.storage.file_storage.containers.by_file_storage_container_id('fileStorageContainer-id').share_point_groups.by_share_point_group_id('sharePointGroup-id').members.post(request_body)

Important

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 with a JSON object that represents the created member.

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sharePointGroupMember",
  "id": "aTowIy5mfG1lbWJlcnNoaXB8YWRtaW5AYTgzMGVkYWQ5MDUwODQ5c3Bncm91cHRlc3QyLm9ubWljcm9zb2Z0LmNvbQ",
  "identity": {
    "@odata.type": "microsoft.graph.sharePointIdentitySet",
    "user": {
      "displayName": "John Smith",
      "email": "john.smith@contoso.onmicrosoft.com"
    }
  }
}

Share via

Create sharePointGroupMember

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources