Edit

Share via

Create sharePointGroupMember

  • Article

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.

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"
    }
  }
}

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"
    }
  }
}