openapi: 3.1.0
info:
title: Microsoft Graph Admin Admin.admin shares.driveItem API
description: 'Microsoft Graph API for managing administrative resources in Microsoft Entra ID.
This API enables administrators to manage Microsoft Edge browser settings, Internet Explorer mode configurations,
site lists, shared browser sites, Microsoft 365 Apps installation options, people insights, service announcements,
SharePoint settings, Copilot administration, directory administrative units, and admin consent policies.'
version: 1.0.0
contact:
name: Microsoft Graph API Support
url: https://developer.microsoft.com/graph
servers:
- url: https://graph.microsoft.com/v1.0
description: Microsoft Graph API v1.0 endpoint
tags:
- name: shares.driveItem
x-ms-docs-toc-type: page
paths:
/shares/{sharedDriveItem-id}/driveItem:
description: Provides operations to manage the driveItem property of the microsoft.graph.sharedDriveItem entity.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Accessing shared DriveItems
description: Access a shared DriveItem or a collection of shared items by using a shareId or sharing URL. To use a sharing URL with this API, your app needs to transform the URL into a sharing token.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/shares-get?view=graph-rest-1.0
operationId: shares.GetDriveItem
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/shares/{sharedDriveItem-id}/driveItem/content:
description: Provides operations to manage the media for the sharedDriveItem entity.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Get content for the navigation property driveItem from shares
description: The content stream, if the item represents a file.
operationId: shares.GetDriveItemContent
parameters:
- name: $format
in: query
description: Format of the content
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- shares.driveItem
summary: Microsoft Graph Update content for the navigation property driveItem in shares
description: The content stream, if the item represents a file.
operationId: shares.UpdateDriveItemContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- shares.driveItem
summary: Microsoft Graph Delete content for the navigation property driveItem in shares
description: The content stream, if the item represents a file.
operationId: shares.DeleteDriveItemContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/shares/{sharedDriveItem-id}/items:
description: Provides operations to manage the items property of the microsoft.graph.sharedDriveItem entity.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Get items from shares
description: All driveItems contained in the sharing root. This collection cannot be enumerated.
operationId: shares.ListItems
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.driveItemCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
/shares/{sharedDriveItem-id}/items/{driveItem-id}:
description: Provides operations to manage the items property of the microsoft.graph.sharedDriveItem entity.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Get items from shares
description: All driveItems contained in the sharing root. This collection cannot be enumerated.
operationId: shares.GetItems
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/shares/{sharedDriveItem-id}/items/{driveItem-id}/content:
description: Provides operations to manage the media for the sharedDriveItem entity.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
schema:
type: string
x-ms-docs-key-type: driveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Get content for the navigation property items from shares
description: The content stream, if the item represents a file.
operationId: shares.GetItemsContent
parameters:
- name: $format
in: query
description: Format of the content
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- shares.driveItem
summary: Microsoft Graph Update content for the navigation property items in shares
description: The content stream, if the item represents a file.
operationId: shares.UpdateItemsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- shares.driveItem
summary: Microsoft Graph Delete content for the navigation property items in shares
description: The content stream, if the item represents a file.
operationId: shares.DeleteItemsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/shares/{sharedDriveItem-id}/items/$count:
description: Provides operations to count the resources in the collection.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Get the number of the resource
operationId: shares.items.GetCount-245c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/shares/{sharedDriveItem-id}/root:
description: Provides operations to manage the root property of the microsoft.graph.sharedDriveItem entity.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Get root from shares
description: Used to access the underlying driveItem. Deprecated -- use driveItem instead.
operationId: shares.GetRoot
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/shares/{sharedDriveItem-id}/root/content:
description: Provides operations to manage the media for the sharedDriveItem entity.
parameters:
- name: sharedDriveItem-id
in: path
description: The unique identifier of sharedDriveItem
required: true
schema:
type: string
x-ms-docs-key-type: sharedDriveItem
get:
tags:
- shares.driveItem
summary: Microsoft Graph Get content for the navigation property root from shares
description: The content stream, if the item represents a file.
operationId: shares.GetRootContent
parameters:
- name: $format
in: query
description: Format of the content
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- shares.driveItem
summary: Microsoft Graph Update content for the navigation property root in shares
description: The content stream, if the item represents a file.
operationId: shares.UpdateRootContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- shares.driveItem
summary: Microsoft Graph Delete content for the navigation property root in shares
description: The content stream, if the item represents a file.
operationId: shares.DeleteRootContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
components:
schemas:
microsoft.graph.richLongRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- title: richLongRunningOperation
required:
- '@odata.type'
type: object
properties:
error:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.publicError'
- type: object
nullable: true
description: Error that caused the operation to fail.
percentageComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: A value between 0 and 100 that indicates the progress of the operation.
format: int32
nullable: true
resourceId:
type: string
description: The unique identifier for the result.
nullable: true
type:
type: string
description: The type of the operation.
nullable: true
'@odata.type':
type: string
description: The status of a long-running operation.
x-ms-discriminator-value: '#microsoft.graph.richLongRunningOperation'
microsoft.graph.workbookWorksheet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookWorksheet
required:
- '@odata.type'
type: object
properties:
name:
type: string
description: The display name of the worksheet.
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: number
description: The zero-based position of the worksheet within the workbook.
format: int32
visibility:
type: string
description: 'The visibility of the worksheet. The possible values are: Visible, Hidden, VeryHidden.'
charts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChart'
description: The list of charts that are part of the worksheet. Read-only.
x-ms-navigationProperty: true
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: The list of names that are associated with the worksheet. Read-only.
x-ms-navigationProperty: true
pivotTables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookPivotTable'
description: The list of piot tables that are part of the worksheet.
x-ms-navigationProperty: true
protection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheetProtection'
- type: object
nullable: true
description: The sheet protection object for a worksheet. Read-only.
x-ms-navigationProperty: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
description: The list of tables that are part of the worksheet. Read-only.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.workbookWorksheet'
microsoft.graph.phoneType:
title: phoneType
enum:
- home
- business
- mobile
- other
- assistant
- homeFax
- businessFax
- otherFax
- pager
- radio
type: string
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
required:
- '@odata.type'
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: The height of the photo. Read-only.
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: The width of the photo. Read-only.
format: int32
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.profilePhoto'
microsoft.graph.teamworkHostedContent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkHostedContent
required:
- '@odata.type'
type: object
properties:
contentBytes:
type: string
description: Write only. Bytes for the hosted content (such as images).
format: base64url
nullable: true
contentType:
type: string
description: Write only. Content type. such as image/png, image/jpg.
nullable: true
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.chatMessageHostedContent': '#/components/schemas/microsoft.graph.chatMessageHostedContent'
microsoft.graph.objectIdentity:
title: objectIdentity
required:
- '@odata.type'
type: object
properties:
issuer:
type: string
description: Specifies the issuer of the identity, for example facebook.com. 512 character limit. For local accounts (where signInType isn't federated), this property is the local default domain name for the tenant, for example contoso.com. For guests from other Microsoft Entra organizations, this is the domain of the federated organization, for example contoso.com. For more information about filtering behavior for this property, see Filtering on the identities property of a user.
nullable: true
issuerAssignedId:
type: string
description: 'Specifies the unique identifier assigned to the user by the issuer. 64 character limit. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress (or a custom string that starts with emailAddress like emailAddress1), issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with an alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _ For more information about filtering behavior for this property, see Filtering on the identities property of a user.'
nullable: true
signInType:
type: string
description: Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity updates the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, are performed when setting or updating a userPrincipalName identity. Extra validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. For more information about filtering behavior for this property, see Filtering on the identities property of a user.
nullable: true
'@odata.type':
type: string
microsoft.graph.managedAppRegistration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppRegistration
required:
- '@odata.type'
type: object
properties:
appIdentifier:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
- type: object
nullable: true
description: The app package Identifier
applicationVersion:
type: string
description: App version
nullable: true
createdDateTime:
pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: Date and time of creation
format: date-time
deviceName:
type: string
description: Host device name
nullable: true
deviceTag:
type: string
description: App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.
nullable: true
deviceType:
type: string
description: Host device type
nullable: true
flaggedReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppFlaggedReason'
description: Zero or more reasons an app registration is flagged. E.g. app running on rooted device
lastSyncDateTime:
pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: Date and time of last the app synced with management service.
format: date-time
managementSdkVersion:
type: string
description: App management SDK version
nullable: true
platformVersion:
type: string
description: Operating System version
nullable: true
userId:
type: string
description: The user Id to who this app registration belongs.
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
appliedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policys already applied on the registered app when it last synchronized with managment service.
x-ms-navigationProperty: true
intendedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policies admin intended for the app as of now.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppOperation'
description: Zero or more long running operations triggered on the app registration.
x-ms-navigationProperty: true
'@odata.type':
type: string
description: The ManagedAppEntity is the base entity type for all other entity types under app management workflow.
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.androidManagedAppRegistration': '#/components/schemas/microsoft.graph.androidManagedAppRegistration'
'#microsoft.graph.iosManagedAppRegistration': '#/components/schemas/microsoft.graph.iosManagedAppRegistration'
microsoft.graph.termColumn:
title: termColumn
required:
- '@odata.type'
type: object
properties:
allowMultipleValues:
type: boolean
description: Specifies whether the column allows more than one value.
nullable: true
showFullyQualifiedName:
type: boolean
description: Specifies whether to display the entire term path or only the term label.
nullable: true
parentTerm:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.termStore.term'
- type: object
nullable: true
x-ms-navigationProperty: true
termSet:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.termStore.set'
- type: object
nullable: true
x-ms-navigationProperty: true
'@odata.type':
type: string
microsoft.graph.shared:
title: shared
required:
- '@odata.type'
type: object
properties:
owner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The identity of the owner of the shared item. Read-only.
scope:
type: string
description: 'Indicates the scope of how the item is shared. The possible values are: anonymous, organization, or users. Read-only.'
nullable: true
sharedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The identity of the user who shared the item. Read-only.
sharedDateTime:
pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: The UTC date and time when the item was shared. Read-only.
format: date-time
nullable: true
'@odata.type':
type: string
microsoft.graph.settingValue:
title: settingValue
required:
- '@odata.type'
type: object
properties:
name:
type: string
description: Name of the setting (as defined by the groupSettingTemplate).
nullable: true
value:
type: string
description: Value of the setting.
nullable: true
'@odata.type':
type: string
microsoft.graph.managementAgentType:
title: managementAgentType
enum:
- eas
- mdm
- easMdm
- intuneClient
- easIntuneClient
- configurationManagerClient
- configurationManagerClientMdm
- configurationManagerClientMdmEas
- unknown
- jamf
- googleCloudDevicePolicyController
- microsoft365ManagedMdm
- msSense
type: string
x-ms-enum:
name: managementAgentType
modelAsString: false
values:
- value: eas
description: The device is managed by Exchange server.
name: eas
- value: mdm
description: The device is managed by Intune MDM.
name: mdm
- value: easMdm
description: The device is managed by both Exchange server and Intune MDM.
name: easMdm
- value: intuneClient
description: Intune client managed.
name: intuneClient
- value: easIntuneClient
description: The device is EAS and Intune client dual managed.
name: easIntuneClient
- value: configurationManagerClient
description: The device is managed by Configuration Manager.
name: configurationManagerClient
- value: configurationManagerClientMdm
description: The device is managed by Configuration Manager and MDM.
name: configurationManagerClientMdm
- value: configurationManagerClientMdmEas
description: The device is managed by Configuration Manager, MDM and Eas.
name: configurationManagerClientMdmEas
- value: unknown
description: Unknown management agent type.
name: unknown
- value: jamf
description: The device attributes are fetched from Jamf.
name: jamf
- value: googleCloudDevicePolicyController
description: The device is managed by Google's CloudDPC.
name: googleCloudDevicePolicyController
- value: microsoft365ManagedMdm
description: This device is managed by Microsoft 365 through Intune.
name: microsoft365ManagedMdm
microsoft.graph.workbookCommentReply:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookCommentReply
required:
- '@odata.type'
type: object
properties:
content:
type: string
description: The content of the reply.
nullable: true
contentType:
type: string
# --- truncated at 32 KB (1008 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/microsoft-graph-shares-driveitem-api-openapi.yml