Edit

Share via

Update sharePointUserIdentityMapping

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 user identity mappings for cross-organization migration. Supports bulk add, update, and delete operations in a single request. 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/crossOrganizationUserMappings

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
sourceUserIdentity userIdentity The identity information of the source user.
sourceOrganizationId Guid The unique identifier of the source organization in the migration. Inherited from sharePointIdentityMapping.
targetUserIdentity userIdentity The identity information of the target user.
targetUserMigrationData sharePointIdentityMappingUserMigrationData Additional migration-specific data for the target user.
userType sharePointIdentityMappingUserType Indicates the type of user. The possible values are: none, regularUser, adminUser, guestUser, unknownFutureValue.

Response

If successful, this method returns a 200 OK response code and a collection of updated sharePointUserIdentityMapping 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/crossOrganizationUserMappings
Content-Type: application/json

{
  "@context": "#$delta",
  "value": [
    {
      "sourceOrganizationId": "11111111-1111-1111-1111-111111111111",
      "userType": "regularUser",
      "sourceUserIdentity": {
        "userPrincipalName": "user1@contoso.com"
      },
      "targetUserIdentity": {
        "userPrincipalName": "admin@a830edad9050849ken005.onmicrosoft.com"
      },
      "targetUserMigrationData": {
        "email": "admin@a830edad9050849ken005.onmicrosoft.com"
      }
    },
    {
      "@removed": {
        "reason": "deleted"
      },
      "sourceUserIdentity": {
        "userPrincipalName": "user1@contoso.com"
      }
    }
  ]
}

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/crossOrganizationUserMappings/$delta",
  "value": [
    {
      "id": "AQAAAAEAAAB1c2VyMUBjb250b3NvLmNvbQ",
      "sourceOrganizationId": "11111111-1111-1111-1111-111111111111",
      "userType": "regularUser",
      "sourceUserIdentity": {
        "userPrincipalName": "user1@contoso.com"
      },
      "targetUserIdentity": {
        "userPrincipalName": "admin@a830edad9050849ken005.onmicrosoft.com"
      },
      "targetUserMigrationData": {
        "email": "admin@a830edad9050849ken005.onmicrosoft.com"
      }
    },
    {
      "id": "AQAAAAEAAAB1c2VyMUBjb250b3NvLmNvbQ",
      "sourceUserIdentity": {
        "userPrincipalName": "user1@contoso.com"
      }
    }
  ]
}
  • Last updated on