Edit

Share via

Create fileStorageContainerTypeRegistration

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 or replace a fileStorageContainerTypeRegistration object. This method registers a fileStorageContainerType in the tenant.

For standard containers, billing must be valid for the registration to complete successfully.

Important

  • An application can only register a fileStorageContainerType that it owns, either using app-only or delegated tokens.
  • The registration of a container type in a newly created tenant can fail if the tenant isn't yet fully ready. You might need to wait at least an hour before you can register a container type in a new tenant.

Settings can't be modified during registration.

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 permission Higher privileged permissions
Delegated (work or school account) FileStorageContainerTypeReg.Selected FileStorageContainerTypeReg.Manage.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application FileStorageContainerTypeReg.Selected Not available.

Note:

  • When delegated tokens are used, either the SharePoint Embedded admin role or the Global admin role is required.
  • The registration must be done in the context of the application that owns the fileStorageContainerType.

HTTP request

To register a fileStorageContainerType in the current tenant.

PUT /storage/fileStorage/containerTypeRegistrations/{fileStorageContainerTypeId}

Note: Use the PUT method. This request creates a fileStorageContainertypeRegistration object with the provided ID (fileStorageContainerTypeId).

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 fileStorageContainerTypeRegistration object.

You can specify the following property when you create a fileStorageContainerTypeRegistration.

Property Type Description
applicationPermissionGrants fileStorageContainerTypeAppPermissionGrant collection The access privileges of applications on containers of a specific fileStorageContainerType. Optional.

Response

If successful, this method returns a 201 Created response code and a fileStorageContainerTypeRegistration object in the response body.

Examples

Example 1: Create a fileStorageContainerTypeRegistration for a trial fileStorageContainerType

The following example shows how to create a fileStorageContainerTypeRegistration for a trial fileStorageContainerType with some applicationPermissionGrants.

Request

The following example shows a request.

PUT https://graph.microsoft.com/beta/storage/fileStorage/containerTypeRegistrations/de988700-d700-020e-0a00-0831f3042f00
Content-Type: application/json

{
  "applicationPermissionGrants": [
    {
      "appId": "11335700-9a00-4c00-84dd-0c210f203f00",
      "delegatedPermissions": ["readContent", "writeContent"],
      "applicationPermissions": ["full"]
    },
    {
      "appId": "d893fd02-3578-4c7f-bd85-12fc3358af48",
      "delegatedPermissions": ["readContent"],
      "applicationPermissions": ["read"]
    }
  ]
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.fileStorageContainerTypeRegistration",
  "id": "de988700-d700-020e-0a00-0831f3042f00",
  "name": "Test Trial Container",
  "owningAppId": "11335700-9a00-4c00-84dd-0c210f203f00",
  "billingClassification": "trial",
  "billingStatus": "valid",
  "registeredDateTime": "01/20/2025",
  "expirationDateTime": "02/20/2025",
  "etag": "RVRhZw==",
  "settings": {
    "@odata.type": "microsoft.graph.fileStorageContainerTypeRegistrationSettings",
    "sharingCapability": "disabled",
    "urlTemplate": "https://app.contoso.com/redirect?tenant={tenant-id}&drive={drive-id}&folder={folder-id}&item={item-id}",
    "isDiscoverabilityEnabled": true,
    "isSearchEnabled": true,
    "isItemVersioningEnabled": true,
    "itemMajorVersionLimit": 50,
    "maxStoragePerContainerInBytes": 104857600,
    "isSharingRestricted": false
  },
  "applicationPermissionGrants": [
    {
      "appId": "11335700-9a00-4c00-84dd-0c210f203f00",
      "delegatedPermissions": ["readContent", "writeContent"],
      "applicationPermissions": ["full"]
    },
    {
      "appId": "d893fd02-3578-4c7f-bd85-12fc3358af48",
      "delegatedPermissions": ["readContent"],
      "applicationPermissions": ["read"]
    }
  ]
}

Example 2: Create a fileStorageContainerTypeRegistration for a standard fileStorageContainerType where billing setup isn't completed

The following example shows how to create a fileStorageContainerTypeRegistration for a standard fileStorageContainerType where the billing setup isn't completed.

Request

The following example shows a request.

PUT https://graph.microsoft.com/beta/storage/fileStorage/containerTypeRegistrations/52a2630c-5e6a-41ff-8645-15406bafe66a
Content-Type: application/json

{
  "applicationPermissionGrants": [
    {
      "appId": "11335700-9a00-4c00-84dd-0c210f203f00",
      "delegatedPermissions": ["readContent", "writeContent"],
      "applicationPermissions": ["full"]
    }
  ]
}

Response

The following example shows the response.

HTTP/1.1 405 Method Not Allowed
  • Last updated on