inboundSharedUserProfiles: exportPersonalData

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 request to export the personal data for an inboundSharedUserProfile.

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) CrossTenantUserProfileSharing.Read.All CrossTenantUserProfileSharing.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application CrossTenantUserProfileSharing.Read.All CrossTenantUserProfileSharing.ReadWrite.All

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Global Reader is the least privileged role supported for this operation.

HTTP request

POST /directory/inboundSharedUserProfiles/{userId}/exportPersonalData

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

In the request body, supply JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Parameter Type Description
storageLocation String The storage location to download the exported data to. This can be an Azure Storage Account.

Response

If successful, this method returns a 202 Accepted response code and a Location header in the response body pointing to the storage location of the exported data.

Examples

Request

POST https://graph.microsoft.com/beta/directory/inboundSharedUserProfiles/c228b2ae-c4fb-4eda-9620-7e73dddd1cac/exportPersonalData

{
    "storageLocation": "MyStorageAccount"
}

Response

HTTP/1.1 202 Accepted

{
    "Location": "https://graph.microsoft.com/v1.0/dataPolicyOperations/d007e3da-cd9b-4b02-8d66-422403c53e3f",
    "Retry-After": 60
}