SharePoint Embedded
Microsoft SharePoint Embedded is a cloud-based file and document management system suitable for use in any application. SharePoint Embedded is an API-only solution that enables app developers to harness the power of the Microsoft 365 file and document storage platform for any app, and is suitable for enterprises building line-of-business applications and ISVs building multitenant applications.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| spe-connector@service.microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://learn.microsoft.com/en-us/sharepoint/dev/embedded/overview |
| Privacy policy | https://privacy.microsoft.com/ |
| Categories | Content and Files |
Getting Started
Before you can use the SharePoint Embedded connector, you'll need to create a SharePoint Embedded application. See the SharePoint Embedded documentation to learn more and get started.
Grant Access to the SharePoint Embedded Connector
In order for the SharePoint Embedded connector to interact with file storage containers and content in a tenant, you'll need to create an applicationPermissionGrant for the SharePoint Embedded connector application on the containerTypeRegistration for that tenant. This allows the SharePoint Embedded connector access to your app's specific container type on a tenant.
Grant full permissions to the SharePoint Embedded connector application id e8e1b0bf-140f-4b8b-8e94-fbe8937fad04 for delegated calls using the Microsoft Graph API.
PUT /storage/fileStorage/containerTypeRegistrations/{containerTypeId}/applicationPermissionGrants/e8e1b0bf-140f-4b8b-8e94-fbe8937fad04
Content-Type: application/json
{
"delegatedPermissions": ["full"],
"applicationPermissions": ["none"]
}
Refer to the Create fileStorageContainerTypeAppPermissionGrant API reference article to learn more.
Known Issues and Limitations
- Maximum supported file size with the Create file task is 10MB
- Creating containers is not available with the connector
- Only delegated auth is supported
Actions
| Activate container |
Activate a container |
| Check in file |
This operation checks in a file that's been checked out in a SharePoint Embedded container. |
| Check out file |
This operation checks out a file in a SharePoint Embedded container, which prevents others from editing the document. |
| Create container column |
Create a column that defines the schema of the container |
| Create container permission |
Create a permission on a container |
| Create file |
This operation creates a file and returns the driveItem's metadata. |
| Create file preview |
This operation creates a preview for a file in a SharePoint Embedded container. |
| Create folder |
This operation creates a new folder in a SharePoint Embedded container, either at the root level or within another folder. |
| Create sharing link |
This operation creates a sharing link for a file in a SharePoint Embedded container. |
| Delete container |
Delete a container |
| Delete container column |
Delete a column that defines the schema of the container |
| Delete container permission |
Delete a permission on a container |
| Delete file |
This operation deletes a file in a SharePoint Embedded container. |
| Delete file version |
This operation deletes a specific version of a file in a SharePoint Embedded container. |
| Delete recycled container |
Permanently delete a recycled container |
| Delete recycled items |
This operation permanently deletes one or more recycled items from a SharePoint Embedded container's recycle bin. |
| Delete sharing permission |
This operation deletes a specific sharing permission for a file in a SharePoint Embedded container. |
| Discard check out |
This operation discards the check out of a file in a SharePoint Embedded container. |
| Get a container |
Get a container |
| Get container column |
Get a column of the container |
| Get container custom properties |
Get custom properties of a container |
| Get file content |
This operation gets the content of a file. |
| Get file properties |
This operation gets the properties of a file in a SharePoint Embedded container. |
| Get file version |
This operation gets a specific version of a file in a SharePoint Embedded container. |
| Get sharing permission |
This operation gets a specific sharing permission for a file in a SharePoint Embedded container. |
| Get thumbnail |
This operation gets a specific thumbnail for a file in a SharePoint Embedded container. |
| List container columns |
List columns that define the schema of the container |
| List container permissions |
List permissions on a container |
| List containers |
List containers |
| List file fields |
This operation gets the list item fields (metadata) associated with a file in a SharePoint Embedded container. |
| List file versions |
This operation lists the previous versions of a file in a SharePoint Embedded container. |
| List item sharing permissions |
This operation lists the sharing permissions for an item in a SharePoint Embedded container. |
| List items in container |
This operation gets the list of files and subfolders in a container. |
| List recycled containers |
List recycled containers |
| List recycled items |
This operation lists the items in the recycle bin of a SharePoint Embedded container. |
| List thumbnails |
This operation lists the available thumbnails for a file in a SharePoint Embedded container. |
| Rename file |
This operation renames a file in a SharePoint Embedded container. |
| Restore recycled container |
Restore a recycled container |
| Restore recycled items |
This operation restores one or more recycled items from a SharePoint Embedded container's recycle bin. |
| Send sharing invitation |
This operation sends a sharing invitation for a file in a SharePoint Embedded container. |
| Set file fields |
This operation updates the list item fields (metadata) associated with a file in a SharePoint Embedded container. Use null values to clear field values. |
| Update container |
Update a container |
| Update container custom properties |
Update custom properties of a container |
| Update container permission |
Update a permission on a container |
| Update file content |
This operation updates the content of a file. |
Activate container
Activate a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
Check in file
This operation checks in a file that's been checked out in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Comment
|
comment | string |
A check-in comment that's associated with the version |
|
|
Check In As
|
checkInAs | string |
The status of the document after check-in (published or minor) |
Check out file
This operation checks out a file in a SharePoint Embedded container, which prevents others from editing the document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
Create container column
Create a column that defines the schema of the container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
|
object |
Returns
Create container permission
Create a permission on a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
Permission Roles
|
roles | True | array of string |
The roles to be granted to the user |
|
User Principal Name
|
userPrincipalName | True | string |
The identity user principal name |
Returns
Create file
This operation creates a file and returns the driveItem's metadata.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Parent ID
|
parent-id | True | string |
Drive item ID of parent folder, or 'root' |
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File Name
|
file-name | True | string |
The name of the file |
|
File Content (Base64)
|
body | True | byte |
Base64 encoded file content |
Returns
Drive item metadata
- Body
- DriveItem
Create file preview
This operation creates a preview for a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Page
|
page | integer |
Specifies the page number of the document to preview |
|
|
Zoom Level
|
zoom | float |
Specifies the zoom level of the document preview (e.g. 0.5, 1.0, 1.5) |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Get URL
|
getUrl | string |
A URL that can be used to retrieve the preview using a GET request |
|
Post Parameters
|
postParameters | string |
Parameters that can be used with the postUrl property to retrieve the preview using a POST request |
|
Post URL
|
postUrl | string |
A URL that can be used to retrieve the preview using a POST request |
Create folder
This operation creates a new folder in a SharePoint Embedded container, either at the root level or within another folder.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
Parent Folder ID
|
parent-id | True | string |
The ID of the parent folder where the new folder will be created. Use 'root' to create a folder at the container's root level, or provide a specific folder ID to create a nested folder. |
|
Folder Name
|
name | True | string |
The name of the folder to create |
|
Conflict Behavior
|
@microsoft.graph.conflictBehavior | string |
What to do if a folder with the same name already exists |
Returns
Drive item metadata
- Body
- DriveItem
Create sharing link
This operation creates a sharing link for a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Link Type
|
type | True | string |
The type of sharing link to create. |
|
Link Scope
|
scope | string |
The scope of the sharing link |
|
|
Expiration Date
|
expirationDateTime | date-time |
The date and time when the link expires (yyyy-MM-ddTHH:mm:ssZ) |
Returns
Represents a sharing link for a file or folder
- Body
- SharingLink
Delete container
Delete a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
Delete container column
Delete a column that defines the schema of the container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
Column ID
|
column-id | True | string |
The column ID |
Delete container permission
Delete a permission on a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
Permission ID
|
permission-id | True | string |
The permission id |
Delete file
This operation deletes a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
Delete file version
This operation deletes a specific version of a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Version ID
|
version-id | True | string |
The unique identifier of the version to delete |
Delete recycled container
Permanently delete a recycled container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
Delete recycled items
This operation permanently deletes one or more recycled items from a SharePoint Embedded container's recycle bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
Item IDs
|
ids | True | array of string |
Array of recycled item IDs to permanently delete |
Delete sharing permission
This operation deletes a specific sharing permission for a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Permission ID
|
permission-id | True | string |
The unique identifier of the permission to delete |
Discard check out
This operation discards the check out of a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
Get a container
Get a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
Returns
- Body
- FileStorageContainer
Get container column
Get a column of the container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
Column ID
|
column-id | True | string |
The column ID |
Returns
Get container custom properties
Get custom properties of a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
Returns
Get file content
This operation gets the content of a file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
Get file properties
This operation gets the properties of a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
Returns
Drive item metadata
- Body
- DriveItem
Get file version
This operation gets a specific version of a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Version ID
|
version-id | True | string |
The unique identifier of the version |
Returns
Represents a version of a file
- Body
- FileVersion
Get sharing permission
This operation gets a specific sharing permission for a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Permission ID
|
permission-id | True | string |
The unique identifier of the permission |
Returns
Represents a permission for a file or folder
Get thumbnail
This operation gets a specific thumbnail for a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Thumbnail ID
|
thumbnail-id | True | string |
The unique identifier of the thumbnail set |
|
Size
|
size | True | string |
The size of the thumbnail to retrieve |
Returns
Represents a single thumbnail
- Body
- Thumbnail
List container columns
List columns that define the schema of the container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
Filter
|
$filter | string |
The filter to apply to the results |
Returns
List container permissions
List permissions on a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
Returns
List containers
List containers
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container Type ID
|
containerType | True | string |
List containers of the specified container type |
Returns
List file fields
This operation gets the list item fields (metadata) associated with a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ETag
|
@odata.etag | string |
The ETag value for the fields |
List file versions
This operation lists the previous versions of a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
Returns
Represents a collection of file versions
- Body
- FileVersions
List item sharing permissions
This operation lists the sharing permissions for an item in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
Item ID
|
file-id | True | string |
The unique identifier of the item |
Returns
Represents a list of permissions for a file or folder
List items in container
This operation gets the list of files and subfolders in a container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
Parent Folder ID
|
parentId | True | string |
The ID of the parent folder to list items from. Use 'root' to get items from the container's root level, or provide a specific folder ID to get items from that folder |
|
Filter
|
$filter | string |
Filter criteria for the results (OData format) eg: parentReference/id eq '{{folderId}}' AND contains(listitem/fields/FileLeafRef, {{user_name_string}}) |
|
|
Select
|
$select | string |
Properties to include in results (comma-separated) |
|
|
Expand
|
$expand | string |
Related resources to expand in the response |
|
|
Top
|
$top | integer |
The number of results to return |
|
|
Order By
|
$orderby | string |
Field(s) and direction to sort results by |
Returns
Represents a page of drive items.
List recycled containers
List recycled containers
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container Type ID
|
containerType | True | string |
List recycled containers of the specified container type |
Returns
List recycled items
This operation lists the items in the recycle bin of a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
Returns
A collection of items in the recycle bin
List thumbnails
This operation lists the available thumbnails for a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
Returns
Represents a collection of thumbnail sets
- Body
- ThumbnailSets
Rename file
This operation renames a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Name
|
name | string |
The new name of the file |
Returns
Drive item metadata
- Body
- DriveItem
Restore recycled container
Restore a recycled container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
Returns
- Body
- FileStorageContainer
Restore recycled items
This operation restores one or more recycled items from a SharePoint Embedded container's recycle bin.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
Item IDs
|
ids | True | array of string |
Array of recycled item IDs to restore |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of object | |
|
Item ID
|
value.id | string |
The ID of the restored item |
Send sharing invitation
This operation sends a sharing invitation for a file in a SharePoint Embedded container.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Require Sign In
|
requireSignIn | True | boolean |
Indicates whether the recipient of the invitation is required to sign-in to view the shared item |
|
Roles
|
roles | True | array of string |
The permissions granted to the recipients of the sharing invitation |
|
Email
|
string |
The email address of the recipient |
||
|
Alias
|
alias | string |
The alias of the recipient (in the case of a Microsoft 365 recipient) |
|
|
Object ID
|
objectId | string |
The unique identifier of the recipient in Azure Active Directory |
|
|
Message
|
message | True | string |
A custom message sent as part of the sharing invitation |
|
Send Invitation
|
sendInvitation | True | boolean |
If true, a sharing link is sent to the recipients. If false, a permission is created but no invitation message is sent. |
Returns
Represents a list of permissions for a file or folder
Set file fields
This operation updates the list item fields (metadata) associated with a file in a SharePoint Embedded container. Use null values to clear field values.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
|
object |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ETag
|
@odata.etag | string |
The ETag value for the fields |
Update container
Update a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
Description
|
description | string |
The container description |
|
|
Display Name
|
displayName | string |
The container name |
|
|
OCR Enabled
|
isOcrEnabled | boolean |
Whether OCR (Optical Character Recognition) is enabled for the container |
|
|
Item Minor Version Limit
|
itemMinorVersionLimit | integer |
The maximum number of minor versions to retain for items in the container |
|
|
Item Versioning Enabled
|
isItemVersioningEnabled | boolean |
Whether item versioning is enabled for the container |
Returns
- Body
- FileStorageContainer
Update container custom properties
Update custom properties of a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
|
object |
Returns
Update container permission
Update a permission on a container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
The container ID |
|
Permission ID
|
permission-id | True | string |
The permission id |
|
Permission Roles
|
roles | True | array of string |
The roles to be granted to the user |
Returns
Update file content
This operation updates the content of a file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
file-id | True | string |
The unique identifier of the file |
|
Container ID
|
container-id | True | string |
The unique identifier of the container |
|
File Content (Base64)
|
body | True | byte |
Base64 encoded file content |
Returns
The content of the file
- File content
- binary
Triggers
| Monitor item changes in a container |
Trigger when items are added, modified, or deleted in a SharePoint Embedded container |
Monitor item changes in a container
Trigger when items are added, modified, or deleted in a SharePoint Embedded container
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Container ID
|
container-id | True | string |
ID of the container to monitor |
|
Polling Interval (seconds)
|
pollingInterval | integer |
How often to check for changes (60-3600 seconds, default: 300) |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of DriveItem |
The list of changed items |
|
@odata.deltaLink
|
@odata.deltaLink | string |
Delta link for the next polling request |
|
@odata.context
|
@odata.context | string |
@odata.context |
Definitions
FileStorageContainer
| Name | Path | Type | Description |
|---|---|---|---|
|
Container ID
|
id | string |
The container ID |
|
Container Type ID
|
containerTypeId | string |
The id of the container type this container belongs to |
|
Description
|
description | string |
The container description |
|
Display Name
|
displayName | string |
The container name |
|
Created Time
|
createdDateTime | date-time |
The container creation date and time |
|
customProperties
|
customProperties | FileStorageContainer.CustomProperties | |
|
permissions
|
permissions | FileStorageContainer.Permissions | |
|
status
|
status | string |
The container status |
FileStorageContainer.List
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of FileStorageContainer |
FileStorageContainer.Permissions
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
FileStorageContainer.Permission |
FileStorageContainer.Permission
| Name | Path | Type | Description |
|---|---|---|---|
|
Permission ID
|
id | string |
The permission id |
|
Permission Roles
|
roles | FileStorageContainer.Permission.Roles |
The roles to be granted to the user |
|
Display Name
|
grantedToV2.user.displayName | string |
The identity display name |
|
Email
|
grantedToV2.user.email | string |
The identity email |
|
User Principal Name
|
grantedToV2.user.userPrincipalName | string |
The identity user principal name |
FileStorageContainer.Permission.Roles
The roles to be granted to the user
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
string |
FileStorageContainer.Permissions.List
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | FileStorageContainer.Permissions |
FileStorageContainer.CustomProperties
FileStorageContainer.Column
| Name | Path | Type | Description |
|---|---|---|---|
|
Column ID
|
id | string |
The unique identifier for the column |
|
Column Name
|
name | string |
The display name of the column |
|
Description
|
description | string |
Description of the column |
|
Enforce Unique Values
|
enforceUniqueValues | boolean |
Whether the column values must be unique |
|
Hidden
|
hidden | boolean |
Whether the column is displayed in the UI |
|
Indexed
|
indexed | boolean |
Whether the column is indexed |
|
Required
|
required | boolean |
Whether the column is required |
|
Read Only
|
readOnly | boolean |
Whether the column values can be modified |
|
Column Group
|
columnGroup | string |
The group this column belongs to |
|
Display Name
|
displayName | string |
The display name of the column |
|
Is Deletable
|
isDeletable | boolean |
Indicates whether this column can be deleted. |
|
Is Reorderable
|
isReorderable | boolean |
Indicates whether this column can be reordered. |
|
Is Sealed
|
isSealed | boolean |
Specifies whether the column can be changed. |
|
Propagate Changes
|
propagateChanges | boolean |
If true, changes to this column will be propagated to lists that implement the column. |
|
Default Value Column - Formula
|
defaultValue.formula | string |
The formula used to compute the default value for the column. |
|
Default Value Column - Value
|
defaultValue.value | string |
The direct value to use as the default value for the column. |
|
Text Column - Max Length
|
text.maxLength | integer |
Maximum length of text |
|
Text Column - Allow Multiple Lines
|
text.allowMultipleLines | boolean |
Whether to allow multiple lines of text |
|
Text Column - Append Changes
|
text.appendChangesToExistingText | boolean |
Whether updates to this column should append to existing text |
|
Text Column - Lines for Editing
|
text.linesForEditing | integer |
Number of lines of text to show in editing controls |
|
Text Column - Text Type
|
text.textType | string |
The type of text being stored |
|
Number Column - Decimal Places
|
number.decimalPlaces | string |
How many decimal places to show |
|
Number Column - Display As
|
number.displayAs | string |
How to display the number |
|
Number Column - Maximum
|
number.maximum | number |
Maximum allowed value |
|
Number Column - Minimum
|
number.minimum | number |
Minimum allowed value |
|
boolean
|
boolean | object |
Settings for boolean columns |
|
DateTime Column - Display As
|
dateTime.displayAs | string |
How to display the date and time |
|
DateTime Column - Format
|
dateTime.format | string |
Whether to include time with the date |
|
Choice Column - Allow Text Entry
|
choice.allowTextEntry | boolean |
Whether custom values can be entered |
|
Choice Column - Choices
|
choice.choices | array of string |
The list of choices for the column |
|
Choice Column - Display As
|
choice.displayAs | string |
How to display the choices |
|
Lookup Column - Allow Multiple Values
|
lookup.allowMultipleValues | boolean |
Whether multiple values can be selected |
|
Lookup Column - Allow Unlimited Length
|
lookup.allowUnlimitedLength | boolean |
Whether values in the column should be able to exceed the standard limit of 255 characters. |
|
Lookup Column - List ID
|
lookup.listId | string |
The ID of the list this lookup gets information from |
|
Lookup Column - Primary Lookup Column ID
|
lookup.primaryLookupColumnId | string |
The ID of the column to get information from |
|
Currency Column - Locale
|
currency.locale | string |
The locale for the currency |
|
PersonOrGroup Column - Allow Multiple Selection
|
personOrGroup.allowMultipleSelection | boolean |
Whether multiple people or groups can be selected |
|
PersonOrGroup Column - Choose From Type
|
personOrGroup.chooseFromType | string |
The types of people or groups that can be selected |
|
PersonOrGroup Column - Display As
|
personOrGroup.displayAs | string |
How to display the people or groups |
|
HyperlinkOrPicture Column - Is Picture
|
hyperlinkOrPicture.isPicture | boolean |
Whether the hyperlink is a picture |
|
Calculated Column - Formula
|
calculated.formula | string |
The formula for the calculation |
|
Calculated Column - Output Type
|
calculated.outputType | string |
The type of the output |
|
Calculated Column - Format
|
calculated.format | string |
Whether to include time with the date |
|
Geolocation Column
|
geolocation | object |
Settings for location columns |
|
Thumbnail Column Properties
|
thumbnail | object |
Settings for thumbnail columns |
|
Content Approval Status Column Properties
|
contentApprovalStatus | object |
This column stores content approval status. |
|
Term Column - Allow Multiple Values
|
term.allowMultipleValues | boolean |
Whether multiple values can be selected |
|
Term Column - Show Fully Qualified Name
|
term.showFullyQualifiedName | boolean |
Specifies whether to display the entire term path or only the term label. |
|
Content Type ID
|
sourceContentType.id | string |
The ID of the content type. |
|
Content Type Name
|
sourceContentType.name | string |
The name of the content type. |
FileStorageContainer.Columns.List
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of FileStorageContainer.Column |
DriveItemCollectionPage
Represents a page of drive items.
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of DriveItem |
Collection of drive items. |
|
@odata.nextLink
|
@odata.nextLink | string |
A URL which can be used to retrieve the next page. |
DriveItem
Drive item metadata
| Name | Path | Type | Description |
|---|---|---|---|
|
Download URL
|
@microsoft.graph.downloadUrl | string |
A URL that can be used to download this item's content |
|
Download URL (No Auth)
|
@microsoft.graph.downloadUrlNoAuth | string |
A URL that can be used to download this item's content without authentication |
|
ID
|
id | string |
The unique identifier of the file or folder |
|
Name
|
name | string |
The name of the file or folder |
|
Size
|
size | integer |
The file or folder size in bytes |
|
Web URL
|
webUrl | string |
URL that displays the item in the browser |
|
Created Time
|
createdDateTime | date-time |
The date and time the file or folder was created |
|
Last Modified Time
|
lastModifiedDateTime | date-time |
The date and time the file or folder was last modified |
|
ETag
|
eTag | string |
The etag of the file or folder |
|
CTag
|
cTag | string |
A tag indicating the content has changed |
|
Drive Type
|
parentReference.driveType | string |
Type of drive containing the item |
|
Drive ID
|
parentReference.driveId | string |
ID of the drive containing the item |
|
Parent ID
|
parentReference.id | string |
ID of the parent folder |
|
Parent Name
|
parentReference.name | string |
Name of the parent folder |
|
Parent Path
|
parentReference.path | string |
Path to the parent folder |
|
Site ID
|
parentReference.siteId | string |
ID of the site containing the item |
|
Application ID
|
createdBy.application.id | string |
ID of the application that created the item |
|
Application Name
|
createdBy.application.displayName | string |
Display name of the application that created the item |
|
User ID
|
createdBy.user.id | string |
ID of the user who created the item |
|
User Name
|
createdBy.user.displayName | string |
Display name of the user who created the item |
|
Application ID
|
lastModifiedBy.application.id | string |
ID of the application that last modified the item |
|
Application Name
|
lastModifiedBy.application.displayName | string |
Display name of the application that last modified the item |
|
User ID
|
lastModifiedBy.user.id | string |
ID of the user who last modified the item |
|
User Name
|
lastModifiedBy.user.displayName | string |
Display name of the user who last modified the item |
|
MIME Type
|
file.mimeType | string |
The MIME type of the file |
|
QuickXor Hash
|
file.hashes.quickXorHash | string |
The QuickXor hash of the file |
|
Created Time
|
fileSystemInfo.createdDateTime | date-time |
The date and time the file or folder was created on the file system |
|
Last Modified Time
|
fileSystemInfo.lastModifiedDateTime | date-time |
The date and time the file or folder was last modified on the file system |
|
Child Count
|
folder.childCount | integer |
Number of items in the folder |
|
Sharing Scope
|
shared.scope | string |
The scope of sharing (users, organization, or anyone) |
SharingLink
Represents a sharing link for a file or folder
| Name | Path | Type | Description |
|---|---|---|---|
|
Link ID
|
id | string |
The unique identifier for the sharing link |
|
Link Type
|
link.type | string |
The type of sharing link (view, edit, embed) |
|
Link Scope
|
link.scope | string |
The scope of the sharing link |
|
Web URL
|
link.webUrl | string |
The URL for the sharing link |
|
displayName
|
link.application.displayName | string |
The display name of the application |
|
id
|
link.application.id | string |
The unique identifier for the application |
SharingPermissionResponse
Represents a permission for a file or folder
| Name | Path | Type | Description |
|---|---|---|---|
|
Permission ID
|
id | string |
The unique identifier of the permission |
|
Roles
|
roles | array of string |
The roles granted for this permission |
|
Share ID
|
shareId | string |
A unique token that can be used to access this shared item via the shares API |
|
Display Name
|
grantedTo.user.displayName | string |
The display name of the user |
|
Email
|
grantedTo.user.email | string |
The email address of the user |
|
User ID
|
grantedTo.user.id | string |
The unique identifier of the user |
|
Link Scope
|
link.scope | string |
The scope of the link |
|
Link Type
|
link.type | string |
The type of the link |
|
Web URL
|
link.webUrl | string |
The URL of the link |
|
Email
|
invitation.email | string |
The email address the invitation was sent to |
|
Sign In Required
|
invitation.signInRequired | boolean |
Whether sign-in is required to access the shared item |
|
Expiration Date Time
|
expirationDateTime | date-time |
The date and time at which the permission expires |
|
Granted To Identities
|
grantedToIdentities | array of object |
When specified, restricts sharing to only the users listed |
|
Display Name
|
grantedToIdentities.user.displayName | string |
The display name of the user |
|
Email
|
grantedToIdentities.user.email | string |
The email address of the user |
|
User ID
|
grantedToIdentities.user.id | string |
The unique identifier of the user |
SharingPermissionsList
Represents a list of permissions for a file or folder
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of SharingPermissionResponse |
FileVersion
Represents a version of a file
| Name | Path | Type | Description |
|---|---|---|---|
|
Version ID
|
id | string |
The ID of the version |
|
Modified By
|
lastModifiedBy.user.displayName | string |
The name of the user who modified the version |
|
User ID
|
lastModifiedBy.user.id | string |
The ID of the user who modified the version |
|
Last Modified
|
lastModifiedDateTime | date-time |
The date and time when this version was last modified |
|
Size
|
size | integer |
The size of the version in bytes |
|
Publication Level
|
publication.level | string |
The publication level of this version (published or checkout) |
|
Version ID
|
publication.versionId | string |
The ID of the version being published |
FileVersions
Represents a collection of file versions
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of FileVersion |
The collection of file versions |
ThumbnailSet
Represents a set of thumbnails for a file
| Name | Path | Type | Description |
|---|---|---|---|
|
Thumbnail Set ID
|
id | string |
The unique identifier of the thumbnail set |
|
large
|
large | Thumbnail |
Represents a single thumbnail |
|
medium
|
medium | Thumbnail |
Represents a single thumbnail |
|
small
|
small | Thumbnail |
Represents a single thumbnail |
|
source
|
source | Thumbnail |
Represents a single thumbnail |
Thumbnail
Represents a single thumbnail
| Name | Path | Type | Description |
|---|---|---|---|
|
Height
|
height | integer |
The height of the thumbnail, in pixels |
|
Width
|
width | integer |
The width of the thumbnail, in pixels |
|
URL
|
url | string |
The URL to the thumbnail |
ThumbnailSets
Represents a collection of thumbnail sets
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of ThumbnailSet |
The collection of thumbnail sets |
RecycleBinItem
Represents an item in the recycle bin
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Unique identifier of the recycled item |
|
Name
|
name | string |
Name of the recycled item |
|
Size
|
size | integer |
Size of the item in bytes |
|
Deleted Date
|
deletedDateTime | date-time |
Date and time when the item was deleted |
|
Deleted From Location
|
deletedFromLocation | string |
Relative URL of the location that originally contained the item |
|
Title
|
title | string |
Title of the recycled item |
|
Deleted By
|
deletedBy.user.displayName | string |
The display name of the user who deleted the item |
|
Email
|
deletedBy.user.email | string |
The email of the user who deleted the item |
|
User ID
|
deletedBy.user.id | string |
The unique identifier of the user who deleted the item |
RecycleBinItemCollection
A collection of items in the recycle bin
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of RecycleBinItem |
The collection of items in the recycle bin |
binary
This is the basic data type 'binary'.