Sites.ReadWrite.All
Allows the application to edit or delete documents and list items in all site collections on behalf of the signed-in user.
Graph Methods
Type: A = Application Permission, D = Delegate Permission
Delegate Permission
Id | 89fe6a52-be36-487e-b7d8-d061c450a026 |
Consent Type | User |
Display String | Edit or delete items in all site collections |
Description | Allows the application to edit or delete documents and list items in all site collections on behalf of the signed-in user. |
Application Permission
Id | 9492366f-7969-46a4-8d15-ed1a20078fff |
Display String | Read and write items in all site collections |
Description | Allows the app to create, read, update, and delete documents and list items in all site collections without a signed in user. |
Resources
contentType
Property | Type | Description |
---|---|---|
associatedHubsUrls | Collection(string) | List of canonical URLs for hub sites with which this content type is associated to. This will contain all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type will be applied to the lists in the enforced sites. |
description | string | The descriptive text for the item. |
documentSet | documentSet][] | [Document Set metadata. |
documentTemplate | [documentSetContent][] | Document template metadata. To make sure that documents have consistent content across a site and its subsites, you can associate a Word, Excel, or PowerPoint template with a site content type. |
group | string | The name of the group this content type belongs to. Helps organize related content types. |
hidden | Boolean | Indicates whether the content type is hidden in the list's 'New' menu. |
id | string | The unique identifier of the content type. |
inheritedFrom | [itemReference][] | If this content type is inherited from another scope (like a site), provides a reference to the item where the content type is defined. |
isBuiltIn | Boolean | Specifies if a content type is a built-in content type. |
name | string | The name of the content type. |
order | [contentTypeOrder][] | Specifies the order in which the content type appears in the selection UI. |
parentId | string | The unique identifier of the content type. |
propagateChanges | Boolean | If true , any changes made to the content type will be pushed to inherited content types and lists that implement the content type. |
readOnly | Boolean | If true , the content type can't be modified unless this value is first set to false . |
sealed | Boolean | If true , the content type can't be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types. |
deleted
Property | Type | Description |
---|---|---|
state | String | Represents the state of the deleted item. |
documentSetVersion
Property | Type | Description |
---|---|---|
comment | string | Comment about the captured version. |
createdBy | identitySet | User who captured the version. |
createdDateTime | dateTime | Date and time when this version was created. |
id | string | The ID of the version. Read-only. Inherited from listItemVersion. |
items | documentSetVersionItem collection | Items within the document set that are captured as part of this version. |
lastModifiedBy | identitySet | Identity of the user which last modified the version. Read-only. Inherited from listItemVersion. |
lastModifiedDateTime | dateTimeOffset | Date and time when the version was last modified. Read-only. Inherited from listItemVersion. |
published | publicationFacet | Indicates the publication status of this particular version. Read-only. Inherited from listItemVersion. |
shouldCaptureMinorVersion | boolean | If true , minor versions of items are also captured; otherwise, only major versions will be captured. Default value is false . |
drive
Property | Type | Description |
---|---|---|
createdBy | [identitySet][] | Identity of the user, device, or application which created the item. Read-only. |
createdDateTime | dateTimeOffset | Date and time of item creation. Read-only. |
description | String | Provide a user-visible description of the drive. Read-write. |
driveType | String | Describes the type of drive represented by this resource. OneDrive personal drives will return personal . OneDrive for Business will return business . SharePoint document libraries will return documentLibrary . Read-only. |
id | String | The unique identifier of the drive. Read-only. |
lastModifiedBy | [identitySet][] | Identity of the user, device, and application which last modified the item. Read-only. |
lastModifiedDateTime | dateTimeOffset | Date and time the item was last modified. Read-only. |
name | string | The name of the item. Read-write. |
owner | identitySet | Optional. The user account that owns the drive. Read-only. |
quota | quota | Optional. Information about the drive's storage space quota. Read-only. |
sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. This property is not returned by default and must be selected using the $select query parameter. |
system | [systemFacet][] | If present, indicates that this is a system-managed drive. Read-only. |
webUrl | string (url) | URL that displays the resource in the browser. Read-only. |
driveItem
Property | Type | Description |
---|---|---|
audio | [audio][] | Audio metadata, if the item is an audio file. Read-only. Read-only. Only on OneDrive Personal. |
bundle | [bundle][] | Bundle metadata, if the item is a bundle. Read-only. |
content | Stream | The content stream, if the item represents a file. |
createdBy | [identitySet][] | Identity of the user, device, and application which created the item. Read-only. |
createdDateTime | DateTimeOffset | Date and time of item creation. Read-only. |
cTag | String | An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only. |
deleted | [deleted][] | Information about the deleted state of the item. Read-only. |
description | String | Provides a user-visible description of the item. Read-write. Only on OneDrive Personal. |
eTag | String | eTag for the entire item (metadata + content). Read-only. |
file | [file][] | File metadata, if the item is a file. Read-only. |
fileSystemInfo | [fileSystemInfo][] | File system information on client. Read-write. |
folder | [folder][] | Folder metadata, if the item is a folder. Read-only. |
id | String | The unique identifier of the item within the Drive. Read-only. |
image | [image][] | Image metadata, if the item is an image. Read-only. |
lastModifiedBy | [identitySet][] | Identity of the user, device, and application which last modified the item. Read-only. |
lastModifiedDateTime | DateTimeOffset | Date and time the item was last modified. Read-only. |
location | [geoCoordinates][] | Location metadata, if the item has location data. Read-only. |
malware | [malware][] | Malware metadata, if the item was detected to contain malware. Read-only. |
name | String | The name of the item (filename and extension). Read-write. |
package | [package][] | If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only. |
parentReference | [itemReference][] | Parent information, if the item has a parent. Read-write. |
pendingOperations | [pendingOperations][] | If present, indicates that one or more operations that might affect the state of the driveItem are pending completion. Read-only. |
photo | [photo][] | Photo metadata, if the item is a photo. Read-only. |
publication | [publicationFacet][] | Provides information about the published or checked-out state of an item, in locations that support such actions. This property is not returned by default. Read-only. |
remoteItem | [remoteItem][] | Remote item data, if the item is shared from a drive other than the one being accessed. Read-only. |
root | [root][] | If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. |
searchResult | [searchResult][] | Search metadata, if the item is from a search result. Read-only. |
shared | [shared][] | Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only. |
sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
size | Int64 | Size of the item in bytes. Read-only. |
specialFolder | [specialFolder][] | If the current item is also available as a special folder, this facet is returned. Read-only. |
video | [video][] | Video metadata, if the item is a video. Read-only. |
webDavUrl | String | WebDAV compatible URL for the item. |
webUrl | String | URL that displays the resource in the browser. Read-only. |
driverecipient
extractSensitivityLabelsResult
Property | Type | Description |
---|---|---|
labels | sensitivityLabelAssignment collection | List of sensitivity labels assigned to a file. |
fieldvalueset
resourceVisualization
Property | Type | Description |
---|---|---|
title | String | The item's title text. |
type | String | The item's media type. Can be used for filtering for a specific file based on a specific type. See below for supported types. |
mediaType | String | The item's media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Note that not all Media Mime Types are supported. |
previewImageUrl | String | A URL leading to the preview image for the item. |
previewText | String | A preview text for the item. |
containerWebUrl | String | A path leading to the folder in which the item is stored. |
containerDisplayName | String | A string describing where the item is stored. For example, the name of a SharePoint site or the user name identifying the owner of the OneDrive storing the item. |
containerType | String | Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness. |
sharedInsight
Property | Type | Description |
---|---|---|
id | String | Unique identifier of the relationship. Read only. |
lastShared | sharingDetail | Details about the shared item. Read only. |
resourceVisualization | resourceVisualization | Properties that you can use to visualize the document in your experience. Read-only |
resourceReference | resourceReference | Reference properties of the shared document, such as the url and type of the document. Read-only |
sharingDetail
Property | Type | Description |
---|---|---|
sharedDateTime | DateTimeOffset | The date and time the file was last shared. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. |
sharingSubject | String | The subject with which the document was shared. |
sharingType | String | Determines the way the document was shared, can be by a "Link", "Attachment", "Group", "Site". |
sharedBy | insightIdentity | The user who shared the document. |
sharingReference | resourceReference |
trending
Property | Type | Description |
---|---|---|
id | String | Unique identifier of the relationship. Read only. |
weight | Double | Value indicating how much the document is currently trending. The larger the number, the more the document is currently trending around the user (the more relevant it is). Returned documents are sorted by this value. |
resourceVisualization | resourceVisualization | Properties that you can use to visualize the document in your experience. |
resourceReference | resourceReference | Reference properties of the trending document, such as the url and type of the document. |
lastModifiedDateTime | DateTimeOffset |
usedInsight
Property | Type | Description |
---|---|---|
id | String | Unique identifier of the relationship. Read only. |
lastUsed | usageDetails | Information about when the item was last viewed or modified by the user. Read only. |
resourceVisualization | resourceVisualization | Properties that you can use to visualize the document in your experience. Read-only |
resourceReference | resourceReference | Reference properties of the used document, such as the url and type of the document. Read-only |
itemActivity
Property | Type | Description |
---|---|---|
id | string | The unique identifier of the activity. Read-only. |
access | [accessAction][] | An item was accessed. |
actor | [identitySet][] | Identity of who performed the action. Read-only. |
activityDateTime | DateTimeOffset | Details about when the activity took place. Read-only. |
itemActivityStat
Property | Type | Description |
---|---|---|
incompleteData | [incompleteData][] | Indicates that the statistics in this interval are based on incomplete data. Read-only. |
isTrending | Boolean | Indicates whether the item is "trending." Read-only. |
startDateTime | DateTimeOffset | When the interval starts. Read-only. |
endDateTime | DateTimeOffset | When the interval ends. Read-only. |
create | [itemActionStat][] | Statistics about the create actions in this interval. Read-only. |
edit | [itemActionStat][] | Statistics about the edit actions in this interval. Read-only. |
delete | [itemActionStat][] | Statistics about the delete actions in this interval. Read-only. |
move | [itemActionStat][] | Statistics about the move actions in this interval. Read-only. |
access | [itemActionStat][] | Statistics about the **a |
itemAnalytics
Property | Type | Description |
---|---|---|
allTime | [itemActivityStat][] | Analytics over the item's lifespan. |
lastSevenDays | [itemActivityStat][] | Analytics for the last seven days. |
ItemReference
Property | Type | Description |
---|---|---|
driveId | String | Unique identifier of the drive instance that contains the item. Read-only. |
driveType | String | Identifies the type of drive. See [drive][] resource for values. |
id | String | Unique identifier of the item in the drive. Read-only. |
name | String | The name of the item being referenced. Read-only. |
path | String | Path that can be used to navigate to the item. Read-only. |
shareId | String | A unique identifier for a shared resource that can be accessed via the [Shares][] API. |
sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
siteId | String | For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource. The value is the same as the id property of that site][] resource. It is an [opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated. |
list
listitem
ListItemVersion
Permission
Property | Type | Description |
---|---|---|
id | String | The unique identifier of the permission among all permissions on the item. Read-only. |
grantedToV2 | [SharePointIdentitySet][] | For user type permissions, the details of the users and applications for this permission. Read-only. |
grantedToIdentitiesV2 | Collection([SharePointIdentitySet][]) | For link type permissions, the details of the users to whom permission was granted. Read-only. |
invitation | [SharingInvitation][] | Details of any associated sharing invitation for this permission. Read-only. |
inheritedFrom | ItemReference | Provides a reference to the ancestor of the current permission, if it is inherited from an ancestor. Read-only. |
link | [SharingLink][] | Provides the link details of the current permission, if it is a link type permissions. Read-only. |
roles | Collection of String | The type of permission, for example, read . See below for the full list of roles. Read-only. |
shareId | String | A unique token that can be used to access this shared item via the shares API. Read-only. |
expirationDateTime | DateTimeOffset | A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there is no expiration set for this permission. Optional. |
hasPassword | Boolean | Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only.. |
grantedTo (deprecated) | IdentitySet | For user type permissions, the details of the users and applications for this permission. Read-only. |
grantedToIdentities (deprecated) | Collection(IdentitySet) | For type permissions, the details of the users to whom permission was granted. Read-only. |
RemoteItem
richLongRunningOperation
Property | Type | Description |
---|---|---|
createdDateTime | DateTimeOffset | The date and time when this operation was created. |
error | publicError | Error that caused the operation to fail. |
id | String | Unique identifier for the operation. Inherited from entity. |
lastActionDateTime | DateTimeOffset | The date and time when the last action was performed on this operation. |
percentageComplete | Int32 | A value between 0 and 100 that indicates the progress of the operation. |
resourceId | String | The unique identifier for the result. |
resourceLocation | String | The canonical URL of the resource. |
status | longRunningOperationStatus | The status of the long-running operation. Possible values are: notStarted , running , succeeded , failed , unknownFutureValue . |
statusDetail | String | The detail about the status value. |
type | String | The type of the operation. |
SharedDriveItem
Property | Type | Description |
---|---|---|
id | String | The unique identifier for the share being accessed. |
name | String | The display name of the shared item. |
owner | IdentitySet | Information about the owner of the shared item being referenced. |
SharingInvitation
SharingLink
Property | Type | Description |
---|---|---|
application | [identity][] | The app the link is associated with. |
type | String | The type of the link created. |
scope | String | The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant. |
preventsDownload | Boolean | If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint. |
webHtml | String | For embed links, this property contains the HTML code for an <iframe> element that will embed the item in a webpage. |
webUrl | String | A URL that opens the item in the browser on the OneDrive website. |
site
Property | Type | Description |
---|---|---|
id | string | The unique identifier of the item. Read-only. |
createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. |
description | string | The descriptive text for the site. |
displayName | string | The full title for the site. Read-only. |
eTag | string | ETag for the item. Read-only. |
lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. |
name | string | The name / title of the item. |
root | root | If present, indicates that this is the root site in the site collection. Read-only. |
sharepointIds | sharepointIds | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
siteCollection | siteCollection | Provides details about the site's site collection. Available only on the root site. Read-only. |
webUrl | string (url) | URL that displays the item in the browser. Read-only. |
sitepage
Property | Type | Description |
---|---|---|
contentType | [contentTypeInfo][] | The content type of the page. |
siteSettings
Property | Type | Description |
---|---|---|
languageTag | String | The language tag for the language used on this site. |
timeZone | String | Indicates the time offset for the time zone of the site from Coordinated Universal Time (UTC). |
subscription
Property | Type | Description | Supported Resources |
---|---|---|---|
applicationId | String | Optional. Identifier of the application used to create the subscription. Read-only. | All |
changeType | String | Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: created , updated , deleted . Multiple values can be combined using a comma-separated list. Note: updated changeType. updated and deleted changeType. |
All |
clientState | String | Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification. |
All |
creatorId | String | Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the id of the service principal corresponding to the app. Read-only. | All |
encryptionCertificate | String | Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true . |
All |
encryptionCertificateId | String | Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. | All |
expirationDateTime | DateTimeOffset | Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see the table below. | All |
id | String | Optional. Unique identifier for the subscription. Read-only. | All |
includeResourceData | Boolean | Optional. When set to true , change notifications include resource data (such as content of a chat message). |
All |
latestSupportedTlsVersion | String | Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0 , v1_1 , v1_2 , v1_3 . For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2 . |
All |
lifecycleNotificationUrl | String | Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications. This URL must make use of the HTTPS protocol. |
All |
notificationQueryOptions | String | Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. |
Universal Print Service |
notificationUrl | String | Required. The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol. | All |
notificationUrlAppId | String | Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received. | All |
resource | String | Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/ ). See the possible resource path values for each supported resource. |
All |
systemfacet
Thumbnail
Property | Type | Description |
---|---|---|
height | Int32 | The height of the thumbnail, in pixels. |
sourceItemId | String | The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested. |
url | String | The URL used to fetch the thumbnail content. |
width | Int32 | The width of the thumbnail, in pixels. |
content | Stream | The content stream for the thumbnail. |
ThumbnailSet
Property | Type | Description |
---|---|---|
id | String | The id within the item. Read-only. |
large | Thumbnail | A 1920x1920 scaled thumbnail. |
medium | Thumbnail | A 176x176 scaled thumbnail. |
small | Thumbnail | A 48x48 cropped thumbnail. |
source | Thumbnail | A custom thumbnail image or the original image used to generate other thumbnails. |
uploadSession
Property | Type | Description |
---|---|---|
expirationDateTime | DateTimeOffset | The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached. |
nextExpectedRanges | String collection | A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format "start-end" (e.g. "0-26" to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value "{start}", the location in the file where the next upload should begin. |
uploadUrl | String | The URL endpoint that accepts PUT requests for byte ranges of the file. |