Edit

fileStorageContainer: transferPrincipalOwnership

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.

Transfer the principal ownership of a user-owned fileStorageContainer from one user to another. The principal owner is a special role whose lifecycle is tied to the container; when the principal owner is deleted from the tenant, the container is automatically deleted.

This action is restricted to enterprise (non-MSA) tenants and user-owned containers only. The caller must be a tenant administrator with either the Global Administrator or SharePoint Embedded Administrator role.

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

Note

In addition to Microsoft Graph permissions, your app must have the necessary container type-level permission or permissions to call this API. For more information, see container types. To learn more about container type-level permissions, see SharePoint Embedded authorization.

Note

When delegated permissions are used, the caller must be a tenant administrator with either the Global Administrator or SharePoint Embedded Administrator role.

HTTP request

POST /storage/fileStorage/containers/{fileStorageContainerId}/transferPrincipalOwnership

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 parameters.

The following table lists the parameters that are required when you call this action.

Parameter Type Description
transferTo identitySet The identity of the new principal owner. You can specify the user by either user.id or user.userPrincipalName. Required.

Response

If successful, this action returns a 204 No Content response code.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/transferPrincipalOwnership
Content-Type: application/json

{
  "transferTo": {
    "user": {
      "userPrincipalName": "newowner@contoso.com"
    }
  }
}

Response

The following example shows the response.

HTTP/1.1 204 No Content
  • Last updated on