Update sharePointGroupIdentityMapping

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.

Perform delta patch operations on group identity mappings for cross-organization migration. This operation supports bulk add, update, and delete actions for both Microsoft 365 groups and regular Microsoft Entra groups. Maximum of 50 items allowed in the value array.

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)	SharePointCrossTenantMigration.Manage.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	SharePointCrossTenantMigration.Manage.All	Not available.

HTTP request

PATCH /solutions/sharePoint/migrations/crossOrganizationGroupMappings

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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
groupType	sharePointIdentityMappingGroupType	Indicates the type of group. The possible values are: none, regularGroup, m365Group, unknownFutureValue.
sourceGroupIdentity	identity	The identity information of the source group.
sourceOrganizationId	Guid	The unique identifier of the source organization in the migration. Inherited from sharePointIdentityMapping.
targetGroupIdentity	identity	The identity information of the target group.
targetGroupMigrationData	sharePointIdentityMappingGroupMigrationData	Additional migration-specific data for the target group.

Response

If successful, this method returns a 200 OK response code and a collection of updated sharePointGroupIdentityMapping objects in the response body.

Examples

Request

The following example shows a request that includes both updates and removals using the @removed annotation.

PATCH https://graph.microsoft.com/beta/solutions/sharePoint/migrations/crossOrganizationGroupMappings
Content-Type: application/json

{
  "@context": "#$delta",
  "value": [
    {
      "sourceOrganizationId": "11111111-1111-1111-1111-111111111111",
      "groupType": "m365Group",
      "sourceGroupIdentity": {
        "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      },
      "targetGroupIdentity": {
        "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
      },
      "targetGroupMigrationData": {
        "mailNickname": "targetGroup"
      }
    },
    {
      "@removed": {
        "reason": "deleted"
      },
      "sourceGroupIdentity": {
        "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    }
  ]
}

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#solutions/sharePoint/migrations/crossOrganizationGroupMappings/$delta",
  "value": [
    {
      "id": "AQAAAAIAAABhYWFhYWFhYS1hYWFhLWFhYWEtYWFhYS1hYWFhYWFhYWFhYWE",
      "sourceOrganizationId": "11111111-1111-1111-1111-111111111111",
      "groupType": "m365Group",
      "sourceGroupIdentity": {
        "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      },
      "targetGroupIdentity": {
        "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
      },
      "targetGroupMigrationData": {
        "mailNickname": "targetGroup"
      }
    },
    {
      "id": "AQAAAAIAAABhYWFhYWFhYS1hYWFhLWFhYWEtYWFhYS1hYWFhYWFhYWFhYWE",
      "sourceGroupIdentity": {
        "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    }
  ]
}