Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
The SharePoint cross-tenant migration APIs enable organizations to manage the tasks and identity mappings during tenant-to-tenant migrations. These APIs are used to migrate a specific source resource in a source organization to a target organization.
How to use the SharePoint migration task API
The migration process involves three key steps using the following operations:
- Create a sharePointMigrationTask to migrate a resource from the source organization to the target organization.
- Get the sharePointMigrationTask that was previously created, using the ID, sourceUserPrincipalName, sourceSiteUrl, or sourceGroupObjectId of the task.
- Cancel the migration task queued for processing.
Common use cases
The Microsoft Graph API provides methods that support the common use cases for SharePoint cross-tenant migration.
| Use cases | REST resources |
|---|---|
| Migrate a specific user in a source tenant to a target tenant | sharePointUserMigrationTaskParameters |
| Migrate a specific regular site in a source tenant to a target tenant | sharePointSiteMigrationTaskParameters |
| Migrate a specific group-connected site in a source tenant to a target tenant | sharePointGroupMigrationTaskParameters |
| Retrieve a specific group identity mapping and perform delta operations on group identity mappings | sharePointGroupIdentityMapping |
| Retrieve a specific user identity mapping and perform delta operations on user identity mappings | sharePointUserIdentityMapping |
Next steps
Use the Microsoft Graph API to manage the tasks and identity mappings during tenant-to-tenant migrations. To learn more:
- Explore the resources and methods that are most helpful to your scenario.
- Try the API in the Graph Explorer.