openapi: 3.0.4
info:
title: Files
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
paths:
/drives:
get:
tags:
- drives.drive
summary: Get entities from drives
operationId: listDrive
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- 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.driveCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- drives.drive
summary: Add new entity to drives
operationId: createDrive
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}':
get:
tags:
- drives.drive
summary: Get entity from drives by key
operationId: getDrive
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- 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 entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drives.drive
summary: Update entity in drives
operationId: updateDrive
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- drives.drive
summary: Delete entity from drives
operationId: deleteDrive
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/items':
get:
tags:
- drives.driveItem
summary: 'drive: sharedWithMe'
description: Get a list of driveItem objects shared with the owner of a drive. The driveItems returned from the sharedWithMe method always include the remoteItem facet that indicates they are items from a different drive.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/drive-sharedwithme?view=graph-rest-1.0
operationId: listItem
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- $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'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- drives.driveItem
summary: Create new navigation property to items for drives
operationId: createItem
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/items/{driveItem-id}':
get:
tags:
- drives.driveItem
summary: Get items from drives
description: All items contained in the drive. Read-only. Nullable.
operationId: getItem
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- 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'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drives.driveItem
summary: Update the navigation property items in drives
operationId: updateItem
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- drives.driveItem
summary: Delete navigation property items for drives
operationId: deleteItem
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/items/{driveItem-id}/children':
get:
tags:
- drives.driveItem
summary: List children of a driveItem
description: Return a collection of DriveItems in the children relationship of a DriveItem. DriveItems with a non-null folder or package facet can have one or more child DriveItems.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-list-children?view=graph-rest-1.0
operationId: listChildren
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- $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'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- drives.driveItem
summary: Create new navigation property to children for drives
operationId: createChildren
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/items/{driveItem-id}/children/{driveItem-id1}':
get:
tags:
- drives.driveItem
summary: Get children from drives
description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
operationId: getChildren
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItem-id1
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- 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'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/items/{driveItem-id}/children/{driveItem-id1}/content':
get:
tags:
- drives.driveItem
summary: Get content for the navigation property children from drives
description: 'The content stream, if the item represents a file.'
operationId: getChildrenContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItem-id1
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $format
in: query
description: Format of the content
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- drives.driveItem
summary: Update content for the navigation property children in drives
description: 'The content stream, if the item represents a file.'
operationId: setChildrenContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItem-id1
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
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'
default:
$ref: '#/components/responses/error'
delete:
tags:
- drives.driveItem
summary: Delete content for the navigation property children in drives
description: 'The content stream, if the item represents a file.'
operationId: deleteChildrenContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItem-id1
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/drives/{drive-id}/items/{driveItem-id}/children/$count':
get:
tags:
- drives.driveItem
summary: Get the number of the resource
operationId: getChildrenCount
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/drives/{drive-id}/items/{driveItem-id}/content':
get:
tags:
- drives.driveItem
summary: Get content for the navigation property items from drives
description: 'The content stream, if the item represents a file.'
operationId: getItemsContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $format
in: query
description: Format of the content
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- drives.driveItem
summary: Update content for the navigation property items in drives
description: 'The content stream, if the item represents a file.'
operationId: setItemsContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
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'
default:
$ref: '#/components/responses/error'
delete:
tags:
- drives.driveItem
summary: Delete content for the navigation property items in drives
description: 'The content stream, if the item represents a file.'
operationId: deleteItemsContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.assignSensitivityLabel':
post:
tags:
- drives.driveItem
summary: Invoke action assignSensitivityLabel
operationId: assignSentitivityLabel
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
sensitivityLabelId:
type: string
nullable: true
assignmentMethod:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabelAssignmentMethod'
justificationText:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.checkin':
post:
tags:
- drives.driveItem
summary: Invoke action checkin
description: 'Check in a checked out driveItem resource, which makes the version of the document available to others.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-checkin?view=graph-rest-1.0
operationId: checkin
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
checkInAs:
type: string
nullable: true
comment:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.checkout':
post:
tags:
- drives.driveItem
summary: Invoke action checkout
description: 'Check out a driveItem resource to prevent others from editing the document, and prevent your changes from being visible until the documented is checked in.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-checkout?view=graph-rest-1.0
operationId: checkout
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.copy':
post:
tags:
- drives.driveItem
summary: Invoke action copy
operationId: copy
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
name:
type: string
nullable: true
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
childrenOnly:
type: boolean
default: false
nullable: true
includeAllVersionHistory:
type: boolean
default: false
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.createLink':
post:
tags:
- drives.driveItem
summary: Invoke action createLink
description: "Create a link to share a driveItem driveItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\nIf a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-createlink?view=graph-rest-1.0
operationId: createLink
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
type:
type: string
nullable: true
scope:
type: string
nullable: true
expirationDateTime:
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
format: date-time
nullable: true
password:
type: string
nullable: true
message:
type: string
nullable: true
recipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveRecipient'
retainInheritedPermissions:
type: boolean
default: false
nullable: true
sendNotification:
type: boolean
default: false
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.createUploadSession':
post:
tags:
- drives.driveItem
summary: Invoke action createUploadSession
operationId: createUploadSession
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
item:
$ref: '#/components/schemas/microsoft.graph.driveItemUploadableProperties'
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.discardCheckout':
post:
tags:
- drives.driveItem
summary: Invoke action discardCheckout
description: Discard the check out of a driveItem. This action releases a driveItem resource that was previously checked out. Any changes made to the item while it was checked out are discarded. The same user that performed the checkout must discard it. Another alternative is to use application permissions.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-discardcheckout?view=graph-rest-1.0
operationId: discardCheckout
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.extractSensitivityLabels':
post:
tags:
- drives.driveItem
summary: Invoke action extractSensitivityLabels
operationId: extractSensitivityLabel
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extractSensitivityLabelsResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.follow':
post:
tags:
- drives.driveItem
summary: Invoke action follow
description: Follow a driveItem.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-follow?view=graph-rest-1.0
operationId: follow
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.invite':
post:
tags:
- drives.driveItem
summary: Invoke action invite
description: "Sends a sharing invitation for a driveItem.\nA sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-invite?view=graph-rest-1.0
operationId: invite
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
requireSignIn:
type: boolean
default: false
nullable: true
roles:
type: array
items:
type: string
nullable: true
sendInvitation:
type: boolean
default: false
nullable: true
message:
type: string
nullable: true
recipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveRecipient'
retainInheritedPermissions:
type: boolean
default: false
nullable: true
expirationDateTime:
type: string
nullable: true
password:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of permission
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.permanentDelete':
post:
tags:
- drives.driveItem
summary: Invoke action permanentDelete
operationId: permanentDelete
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.preview':
post:
tags:
- drives.driveItem
summary: Invoke action preview
operationId: preview
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
page:
type: string
nullable: true
zoom:
type: number
format: double
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.itemPreviewInfo'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.restore':
post:
tags:
- drives.driveItem
summary: Invoke action restore
description: Restore a driveItem that has been deleted and is currently in the recycle bin.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-restore?view=graph-rest-1.0
operationId: restore
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
name:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.search(q=''{q}'')':
get:
tags:
- drives.driveItem
summary: Invoke function search
description: "Search the hierarchy of items for items matching a query.\nYou can search within a folder hierarchy, a whole drive, or files shared with the current user."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-search?view=graph-rest-1.0
operationId: search
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: q
in: path
description: 'Usage: q=''{q}'''
required: true
style: simple
schema:
type: string
nullable: true
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of driveItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.unfollow':
post:
tags:
- drives.driveItem
summary: Invoke action unfollow
description: Unfollow a driveItem.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-unfollow?view=graph-rest-1.0
operationId: unfollow
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/{driveItem-id}/microsoft.graph.validatePermission':
post:
tags:
- drives.driveItem
summary: Invoke action validatePermission
operationId: validatePermission
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
challengeToken:
type: string
nullable: true
password:
type: string
additionalProperties: true
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/items/$count':
get:
tags:
- drives.driveItem
summary: Get the number of the resource
operationId: getItemCount
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/drives/{drive-id}/microsoft.graph.recent()':
get:
tags:
- drives.drive.Functions
summary: Invoke function recent
description: "List a set of items that have been recently used by the signed in user.\nThis collection includes items that are in the user's drive and items they have access to from other drives."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/drive-recent?view=graph-rest-1.0
operationId: recent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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/recentResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/drives/{drive-id}/microsoft.graph.search(q=''{q}'')':
get:
tags:
- drives.drive.Functions
summary: Invoke function search
description: "Search the hierarchy of items for items matching a query.\nYou can search within a folder hierarchy, a whole drive, or files shared with the current user."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-search?view=graph-rest-1.0
operationId: searchWithinDriveItem
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: q
in: path
description: 'Usage: q=''{q}'''
required: true
style: simple
schema:
type: string
nullable: true
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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/searchResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/drives/{drive-id}/microsoft.graph.sharedWithMe()':
get:
tags:
- drives.drive.Functions
summary: Invoke function sharedWithMe
description: Get a list of driveItem objects shared with the owner of a drive. The driveItems returned from the sharedWithMe method always include the remoteItem facet that indicates they are items from a different drive.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/drive-sharedwithme?view=graph-rest-1.0
operationId: sharedWithMe
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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/sharedWithMeResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/drives/{drive-id}/root':
get:
tags:
- drives.driveItem
summary: Get root from drives
description: The root folder of the drive. Read-only.
operationId: getRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- 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'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drives.driveItem
summary: Update the navigation property root in drives
operationId: updateRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- drives.driveItem
summary: Delete navigation property root for drives
operationId: deleteRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/root/children':
get:
tags:
- drives.driveItem
summary: Get children from drives
description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
operationId: listChildrenInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- $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'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- drives.driveItem
summary: Create new navigation property to children for drives
operationId: createChildrenInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/root/children/{driveItem-id}':
get:
tags:
- drives.driveItem
summary: Get children from drives
description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
operationId: getChildrenInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- 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'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/drives/{drive-id}/root/children/{driveItem-id}/content':
get:
tags:
- drives.driveItem
summary: Get content for the navigation property children from drives
description: 'The content stream, if the item represents a file.'
operationId: getChildrenContentInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $format
in: query
description: Format of the content
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- drives.driveItem
summary: Update content for the navigation property children in drives
description: 'The content stream, if the item represents a file.'
operationId: setChildrenContentInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
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'
default:
$ref: '#/components/responses/error'
delete:
tags:
- drives.driveItem
summary: Delete content for the navigation property children in drives
description: 'The content stream, if the item represents a file.'
operationId: deleteChildrenContentInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItem-id
in: path
description: The unique identifier of driveItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/drives/{drive-id}/root/children/$count':
get:
tags:
- drives.driveItem
summary: Get the number of the resource
operationId: getChildrenCountInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/drives/{drive-id}/root/content':
get:
tags:
- drives.driveItem
summary: Get content for the navigation property root from drives
description: 'The content stream, if the item represents a file.'
operationId: getRootContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: $format
in: query
description: Format of the content
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- drives.driveItem
summary: Update content for the navigation property root in drives
description: 'The content stream, if the item represents a file.'
operationId: setRootContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
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'
default:
$ref: '#/components/responses/error'
delete:
tags:
- drives.driveItem
summary: Delete content for the navigation property root in drives
description: 'The content stream, if the item represents a file.'
operationId: deleteRootContent
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/drives/{drive-id}/root/microsoft.graph.assignSensitivityLabel':
post:
tags:
- drives.driveItem
summary: Invoke action assignSensitivityLabel
operationId: assignSentitivityLabelInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
sensitivityLabelId:
type: string
nullable: true
assignmentMethod:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabelAssignmentMethod'
justificationText:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.checkin':
post:
tags:
- drives.driveItem
summary: Invoke action checkin
description: 'Check in a checked out driveItem resource, which makes the version of the document available to others.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-checkin?view=graph-rest-1.0
operationId: checkinInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
checkInAs:
type: string
nullable: true
comment:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.checkout':
post:
tags:
- drives.driveItem
summary: Invoke action checkout
description: 'Check out a driveItem resource to prevent others from editing the document, and prevent your changes from being visible until the documented is checked in.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-checkout?view=graph-rest-1.0
operationId: checkoutInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.copy':
post:
tags:
- drives.driveItem
summary: Invoke action copy
operationId: copyInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
name:
type: string
nullable: true
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
childrenOnly:
type: boolean
default: false
nullable: true
includeAllVersionHistory:
type: boolean
default: false
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.createLink':
post:
tags:
- drives.driveItem
summary: Invoke action createLink
description: "Create a link to share a driveItem driveItem. The createLink action creates a new sharing link if the specified link type doesn't already exist for the calling application.\nIf a sharing link of the specified type already exists for the app, the existing sharing link is returned. DriveItem resources inherit sharing permissions from their ancestors."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-createlink?view=graph-rest-1.0
operationId: createLinkInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
type:
type: string
nullable: true
scope:
type: string
nullable: true
expirationDateTime:
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
format: date-time
nullable: true
password:
type: string
nullable: true
message:
type: string
nullable: true
recipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveRecipient'
retainInheritedPermissions:
type: boolean
default: false
nullable: true
sendNotification:
type: boolean
default: false
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.createUploadSession':
post:
tags:
- drives.driveItem
summary: Invoke action createUploadSession
operationId: createUploadSessionInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
item:
$ref: '#/components/schemas/microsoft.graph.driveItemUploadableProperties'
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.uploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.discardCheckout':
post:
tags:
- drives.driveItem
summary: Invoke action discardCheckout
description: Discard the check out of a driveItem. This action releases a driveItem resource that was previously checked out. Any changes made to the item while it was checked out are discarded. The same user that performed the checkout must discard it. Another alternative is to use application permissions.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-discardcheckout?view=graph-rest-1.0
operationId: discardCheckoutInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.extractSensitivityLabels':
post:
tags:
- drives.driveItem
summary: Invoke action extractSensitivityLabels
operationId: extractSensitivityLabelsInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extractSensitivityLabelsResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.follow':
post:
tags:
- drives.driveItem
summary: Invoke action follow
description: Follow a driveItem.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-follow?view=graph-rest-1.0
operationId: followInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.invite':
post:
tags:
- drives.driveItem
summary: Invoke action invite
description: "Sends a sharing invitation for a driveItem.\nA sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-invite?view=graph-rest-1.0
operationId: inviteInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
requireSignIn:
type: boolean
default: false
nullable: true
roles:
type: array
items:
type: string
nullable: true
sendInvitation:
type: boolean
default: false
nullable: true
message:
type: string
nullable: true
recipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveRecipient'
retainInheritedPermissions:
type: boolean
default: false
nullable: true
expirationDateTime:
type: string
nullable: true
password:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of permission
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/drives/{drive-id}/root/microsoft.graph.permanentDelete':
post:
tags:
- drives.driveItem
summary: Invoke action permanentDelete
operationId: permanentDeleteInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.preview':
post:
tags:
- drives.driveItem
summary: Invoke action preview
operationId: previewInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
page:
type: string
nullable: true
zoom:
type: number
format: double
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.itemPreviewInfo'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.restore':
post:
tags:
- drives.driveItem
summary: Invoke action restore
description: Restore a driveItem that has been deleted and is currently in the recycle bin.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-restore?view=graph-rest-1.0
operationId: restoreInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
name:
type: string
nullable: true
additionalProperties: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.search(q=''{q}'')':
get:
tags:
- drives.driveItem
summary: Invoke function search
description: "Search the hierarchy of items for items matching a query.\nYou can search within a folder hierarchy, a whole drive, or files shared with the current user."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-search?view=graph-rest-1.0
operationId: searchInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
- name: q
in: path
description: 'Usage: q=''{q}'''
required: true
style: simple
schema:
type: string
nullable: true
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of driveItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/drives/{drive-id}/root/microsoft.graph.unfollow':
post:
tags:
- drives.driveItem
summary: Invoke action unfollow
description: Unfollow a driveItem.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/driveitem-unfollow?view=graph-rest-1.0
operationId: unfollowInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/drives/{drive-id}/root/microsoft.graph.validatePermission':
post:
tags:
- drives.driveItem
summary: Invoke action validatePermission
operationId: validatePermissionInRoot
parameters:
- name: drive-id
in: path
description: The unique identifier of drive
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
challengeToken:
type: string
nullable: true
password:
type: string
additionalProperties: true
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
components:
schemas:
microsoft.graph.drive:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: drive
type: object
properties:
driveType:
type: string
description: Describes the type of drive represented by this resource. OneDrive personal drives return personal. OneDrive for Business returns business. SharePoint document libraries return documentLibrary. Read-only.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
quota:
$ref: '#/components/schemas/microsoft.graph.quota'
sharePointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
bundles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection of bundles (albums and multi-select-shared sets of items). Only in personal OneDrive.
x-ms-navigationProperty: true
following:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: The list of items the user is following. Only in OneDrive for Business.
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: All items contained in the drive. Read-only. Nullable.
x-ms-navigationProperty: true
list:
$ref: '#/components/schemas/microsoft.graph.list'
root:
$ref: '#/components/schemas/microsoft.graph.driveItem'
special:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection of common folders available in OneDrive. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.driveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: driveItem
type: object
properties:
audio:
$ref: '#/components/schemas/microsoft.graph.audio'
bundle:
$ref: '#/components/schemas/microsoft.graph.bundle'
content:
type: string
description: 'The content stream, if the item represents a file.'
format: base64url
nullable: true
cTag:
type: string
description: An eTag for the content of the item. This eTag isn't changed if only the metadata is changed. Note This property isn't returned if the item is a folder. Read-only.
nullable: true
deleted:
$ref: '#/components/schemas/microsoft.graph.deleted'
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
image:
$ref: '#/components/schemas/microsoft.graph.image'
location:
$ref: '#/components/schemas/microsoft.graph.geoCoordinates'
malware:
$ref: '#/components/schemas/microsoft.graph.malware'
package:
$ref: '#/components/schemas/microsoft.graph.package'
pendingOperations:
$ref: '#/components/schemas/microsoft.graph.pendingOperations'
photo:
$ref: '#/components/schemas/microsoft.graph.photo'
publication:
$ref: '#/components/schemas/microsoft.graph.publicationFacet'
remoteItem:
$ref: '#/components/schemas/microsoft.graph.remoteItem'
root:
$ref: '#/components/schemas/microsoft.graph.root'
searchResult:
$ref: '#/components/schemas/microsoft.graph.searchResult'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: number
description: Size of the item in bytes. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: WebDAV compatible URL for the item.
nullable: true
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
x-ms-navigationProperty: true
listItem:
$ref: '#/components/schemas/microsoft.graph.listItem'
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
retentionLabel:
$ref: '#/components/schemas/microsoft.graph.itemRetentionLabel'
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the item. Only supported on the root of a drive.
x-ms-navigationProperty: true
thumbnails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.thumbnailSet'
description: 'Collection of thumbnailSet objects associated with the item. For more information, see getting thumbnails. Read-only. Nullable.'
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItemVersion'
description: 'The list of previous versions of the item. For more info, see getting previous versions. Read-only. Nullable.'
x-ms-navigationProperty: true
workbook:
$ref: '#/components/schemas/microsoft.graph.workbook'
additionalProperties: true
microsoft.graph.user:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: user
type: object
properties:
aboutMe:
type: string
description: A freeform text entry field for the user to describe themselves. Returned only on $select.
nullable: true
accountEnabled:
type: boolean
description: 'true if the account is enabled; otherwise, false. This property is required when a user is created. Returned only on $select. Supports $filter (eq, ne, not, and in).'
nullable: true
ageGroup:
type: string
description: 'Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions. Returned only on $select. Supports $filter (eq, ne, not, and in).'
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: 'The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn''t differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).'
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
description: The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and not).
authorizationInfo:
$ref: '#/components/schemas/microsoft.graph.authorizationInfo'
birthday:
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 birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Returned only on $select.'
format: date-time
businessPhones:
type: array
items:
type: string
description: 'The telephone numbers for the user. NOTE: Although it''s a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith).'
city:
type: string
description: 'The city where the user is located. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
companyName:
type: string
description: 'The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters.Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
consentProvidedForMinor:
type: string
description: 'Sets whether consent was obtained for minors. Allowed values: null, Granted, Denied, and NotRequired. For more information, see legal age group property definitions. Returned only on $select. Supports $filter (eq, ne, not, and in).'
nullable: true
country:
type: string
description: 'The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
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: 'The date and time the user was created, in ISO 8601 format and UTC. The value can''t be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
creationType:
type: string
description: 'Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by a guest signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, not, in).'
nullable: true
customSecurityAttributes:
$ref: '#/components/schemas/microsoft.graph.customSecurityAttributeValue'
department:
type: string
description: 'The name of the department in which the user works. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).'
nullable: true
deviceEnrollmentLimit:
maximum: 2147483647
minimum: -2147483648
type: number
description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
format: int32
displayName:
type: string
description: 'The name displayed in the address book for the user. This value is usually the combination of the user''s first name, middle initial, and family name. This property is required when a user is created and it can''t be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search.'
nullable: true
employeeHireDate:
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 date and time when the user was hired or will start work in a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
employeeId:
type: string
description: 'The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
employeeLeaveDateTime:
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 date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator (least privilege), Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.'
format: date-time
nullable: true
employeeOrgData:
$ref: '#/components/schemas/microsoft.graph.employeeOrgData'
employeeType:
type: string
description: 'Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).'
nullable: true
externalUserState:
type: string
description: 'For a guest invited to the tenant using the invitation API, this property represents the invited user''s invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Returned only on $select. Supports $filter (eq, ne, not , in).'
nullable: true
externalUserStateChangeDateTime:
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: 'Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, not , in).'
format: date-time
nullable: true
faxNumber:
type: string
description: 'The fax number of the user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
givenName:
type: string
description: 'The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
hireDate:
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 hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Returned only on $select. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.'
format: date-time
identities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectIdentity'
description: 'Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) with limitations.'
imAddresses:
type: array
items:
type: string
nullable: true
description: 'The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).'
interests:
type: array
items:
type: string
nullable: true
description: A list for the user to describe their interests. Returned only on $select.
isManagementRestricted:
type: boolean
description: 'true if the user is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select.'
nullable: true
isResourceAccount:
type: boolean
description: Don't use – reserved for future use.
nullable: true
jobTitle:
type: string
description: 'The user''s job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
lastPasswordChangeDateTime:
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 time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select.'
format: date-time
nullable: true
legalAgeGroupClassification:
type: string
description: 'Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, Undefined, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Returned only on $select.'
nullable: true
licenseAssignmentStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseAssignmentState'
description: State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on $select.
mail:
type: string
description: 'The SMTP address for the user, for example, jeff@contoso.com. Changes to this property update the user''s proxyAddresses collection to include the value as an SMTP address. This property can''t contain accent characters. NOTE: We don''t recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).'
nullable: true
mailboxSettings:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
mailNickname:
type: string
description: 'The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
mobilePhone:
type: string
description: 'The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.'
nullable: true
mySite:
type: string
description: The URL for the user's site. Returned only on $select.
nullable: true
officeLocation:
type: string
description: 'The office location in the user''s place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
onPremisesDistinguishedName:
type: string
description: Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select.
nullable: true
onPremisesDomainName:
type: string
description: 'Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select.'
nullable: true
onPremisesExtensionAttributes:
$ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
onPremisesImmutableId:
type: string
description: 'This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you''re using a federated domain for the user''s userPrincipalName (UPN) property. NOTE: The $ and _ characters can''t be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).'
nullable: true
onPremisesLastSyncDateTime:
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: 'Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError'
description: 'Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, not, ge, le).'
onPremisesSamAccountName:
type: string
description: 'Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
onPremisesSecurityIdentifier:
type: string
description: Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq including on null values).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn''t being synced and can be managed in Microsoft Entra ID. Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
onPremisesUserPrincipalName:
type: string
description: 'Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
otherMails:
type: array
items:
type: string
description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. Can store up to 250 values, each with a limit of 250 characters. NOTE: This property can''t contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).'
passwordPolicies:
type: string
description: 'Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values).'
nullable: true
passwordProfile:
$ref: '#/components/schemas/microsoft.graph.passwordProfile'
pastProjects:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their past projects. Returned only on $select.
postalCode:
type: string
description: 'The postal code for the user''s postal address. The postal code is specific to the user''s country or region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
preferredDataLocation:
type: string
description: 'The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.'
nullable: true
preferredLanguage:
type: string
description: 'The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: ''en-US'', or ''es-ES''. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)'
nullable: true
preferredName:
type: string
description: The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.
nullable: true
print:
$ref: '#/components/schemas/microsoft.graph.userPrint'
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
description: 'The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le).'
proxyAddresses:
type: array
items:
type: string
description: 'For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. Changes to the mail property update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
responsibilities:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their responsibilities. Returned only on $select.
schools:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate the schools they attended. Returned only on $select.
securityIdentifier:
type: string
description: 'Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).'
nullable: true
serviceProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
showInAddressList:
type: boolean
description: Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
nullable: true
signInActivity:
$ref: '#/components/schemas/microsoft.graph.signInActivity'
signInSessionsValidFromDateTime:
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: 'Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select.'
format: date-time
nullable: true
skills:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their skills. Returned only on $select.
state:
type: string
description: 'The state or province in the user''s address. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
streetAddress:
type: string
description: 'The street address of the user''s place of business. Maximum length is 1,024 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
surname:
type: string
description: 'The user''s surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
usageLocation:
type: string
description: 'A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries/regions. Examples include: US, JP, and GB. Not nullable. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user''s email name. The general format is alias@domain, where the domain must be present in the tenant''s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: This property can''t contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, '' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.'
nullable: true
userType:
type: string
description: 'A string value that can be used to classify user types in your directory. The possible values are Member and Guest. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for members and guests, see What are the default user permissions in Microsoft Entra ID?'
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userActivity'
description: The user's activities across devices. Read-only. Nullable.
x-ms-navigationProperty: true
agreementAcceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: The user's terms of use acceptance statuses. Read-only. Nullable.
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles a user is granted for an application. Supports $expand.
x-ms-navigationProperty: true
authentication:
$ref: '#/components/schemas/microsoft.graph.authentication'
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
description: The user's calendar groups. Read-only. Nullable.
x-ms-navigationProperty: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The user's calendars. Read-only. Nullable.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
chats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chat'
x-ms-navigationProperty: true
cloudClipboard:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot'
contactFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The user's contacts folders. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The user's contacts. Read-only. Nullable.
x-ms-navigationProperty: true
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Directory objects that the user created. Read-only. Nullable.
x-ms-navigationProperty: true
dataSecurityAndGovernance:
$ref: '#/components/schemas/microsoft.graph.userDataSecurityAndGovernance'
deviceManagementTroubleshootingEvents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent'
description: The list of troubleshooting events for this user.
x-ms-navigationProperty: true
directReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: A collection of drives available for this user. Read-only.
x-ms-navigationProperty: true
employeeExperience:
$ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable.
x-ms-navigationProperty: true
followedSites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
x-ms-navigationProperty: true
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
insights:
$ref: '#/components/schemas/microsoft.graph.itemInsights'
joinedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.team'
x-ms-navigationProperty: true
licenseDetails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
description: A collection of this user's license details. Read-only.
x-ms-navigationProperty: true
mailFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The user's mail folders. Read-only. Nullable.
x-ms-navigationProperty: true
managedAppRegistrations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppRegistration'
description: Zero or more managed app registrations that belong to the user.
x-ms-navigationProperty: true
managedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
description: The managed devices associated with the user.
x-ms-navigationProperty: true
manager:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The messages in a mailbox or folder. Read-only. Nullable.
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
onlineMeetings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
description: 'Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.'
x-ms-navigationProperty: true
outlook:
$ref: '#/components/schemas/microsoft.graph.outlookUser'
ownedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Devices the user owns. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects the user owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
people:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.person'
description: People that are relevant to the user. Read-only. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: List all resource-specific permission grants of a user.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: The collection of the user's profile photos in different sizes. Read-only.
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/microsoft.graph.plannerUser'
presence:
$ref: '#/components/schemas/microsoft.graph.presence'
registeredDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects.
x-ms-navigationProperty: true
scopedRoleMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
x-ms-navigationProperty: true
settings:
$ref: '#/components/schemas/microsoft.graph.userSettings'
solutions:
$ref: '#/components/schemas/microsoft.graph.userSolutionRoot'
sponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The users and groups responsible for this guest''s privileges in the tenant and keeping the guest''s information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand.'
x-ms-navigationProperty: true
teamwork:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
todo:
$ref: '#/components/schemas/microsoft.graph.todo'
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The groups, including nested groups, and directory roles that a user is a member of. Nullable.'
x-ms-navigationProperty: true
additionalProperties: true
description: Represents a Microsoft Entra user account.
microsoft.graph.mailboxSettings:
title: mailboxSettings
type: object
properties:
archiveFolder:
type: string
description: Folder ID of an archive folder for the user.
nullable: true
automaticRepliesSetting:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
dateFormat:
type: string
description: The date format for the user's mailbox.
nullable: true
delegateMeetingMessageDeliveryOptions:
$ref: '#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions'
language:
$ref: '#/components/schemas/microsoft.graph.localeInfo'
timeFormat:
type: string
description: The time format for the user's mailbox.
nullable: true
timeZone:
type: string
description: The default time zone for the user's mailbox.
nullable: true
userPurpose:
$ref: '#/components/schemas/microsoft.graph.userPurpose'
workingHours:
$ref: '#/components/schemas/microsoft.graph.workingHours'
additionalProperties: true
microsoft.graph.itemAnalytics:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemAnalytics
type: object
properties:
allTime:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
itemActivityStats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
x-ms-navigationProperty: true
lastSevenDays:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
additionalProperties: true
microsoft.graph.itemActivityStat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemActivityStat
type: object
properties:
access:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
create:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
delete:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
edit:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
endDateTime:
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: When the interval ends. Read-only.
format: date-time
nullable: true
incompleteData:
$ref: '#/components/schemas/microsoft.graph.incompleteData'
isTrending:
type: boolean
description: Indicates whether the item is 'trending.' Read-only.
nullable: true
move:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
startDateTime:
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: When the interval starts. Read-only.
format: date-time
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivity'
description: Exposes the itemActivities represented in this itemActivityStat resource.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.itemActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemActivity
type: object
properties:
access:
$ref: '#/components/schemas/microsoft.graph.accessAction'
activityDateTime:
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: Details about when the activity took place. Read-only.
format: date-time
nullable: true
actor:
$ref: '#/components/schemas/microsoft.graph.identitySet'
driveItem:
$ref: '#/components/schemas/microsoft.graph.driveItem'
additionalProperties: true
microsoft.graph.listItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: listItem
type: object
properties:
contentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
documentSetVersions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetVersion'
description: Version information for a document set version created by a user.
x-ms-navigationProperty: true
driveItem:
$ref: '#/components/schemas/microsoft.graph.driveItem'
fields:
$ref: '#/components/schemas/microsoft.graph.fieldValueSet'
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItemVersion'
description: The list of previous versions of the list item.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.documentSetVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.listItemVersion'
- title: documentSetVersion
type: object
properties:
comment:
type: string
description: Comment about the captured version.
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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 when this version was created.
format: date-time
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetVersionItem'
description: Items within the document set that are captured as part of this version.
shouldCaptureMinorVersion:
type: boolean
description: 'If true, minor versions of items are also captured; otherwise, only major versions are captured. The default value is false.'
nullable: true
additionalProperties: true
microsoft.graph.fieldValueSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: fieldValueSet
type: object
additionalProperties: true
microsoft.graph.driveRecipient:
title: driveRecipient
type: object
properties:
alias:
type: string
description: 'The alias of the domain object, for cases where an email address is unavailable (for example, security groups).'
nullable: true
email:
type: string
description: 'The email address for the recipient, if the recipient has an associated email address.'
nullable: true
objectId:
type: string
description: The unique identifier for the recipient in the directory.
nullable: true
additionalProperties: true
microsoft.graph.permission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: permission
type: object
properties:
expirationDateTime:
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: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there's no expiration set for this permission. Optional.
format: date-time
nullable: true
grantedTo:
$ref: '#/components/schemas/microsoft.graph.identitySet'
grantedToIdentities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identitySet'
description: 'For type permissions, the details of the users to whom permission was granted. Read-only.'
grantedToIdentitiesV2:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
description: 'For link type permissions, the details of the users to whom permission was granted. Read-only.'
grantedToV2:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
hasPassword:
type: boolean
description: Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only..
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
invitation:
$ref: '#/components/schemas/microsoft.graph.sharingInvitation'
link:
$ref: '#/components/schemas/microsoft.graph.sharingLink'
roles:
type: array
items:
type: string
nullable: true
description: 'The type of permission, for example, read. See below for the full list of roles. Read-only.'
shareId:
type: string
description: A unique token that can be used to access this shared item via the shares API. Read-only.
nullable: true
additionalProperties: true
microsoft.graph.listItemVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItemVersion'
- title: listItemVersion
type: object
properties:
fields:
$ref: '#/components/schemas/microsoft.graph.fieldValueSet'
additionalProperties: true
microsoft.graph.sensitivityLabelAssignmentMethod:
title: sensitivityLabelAssignmentMethod
enum:
- standard
- privileged
- auto
- unknownFutureValue
type: string
microsoft.graph.itemReference:
title: itemReference
type: object
properties:
driveId:
type: string
description: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a drive. Read-only.
nullable: true
driveType:
type: string
description: Identifies the type of drive. Only returned if the item is located in a drive. See drive resource for values.
nullable: true
id:
type: string
description: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
nullable: true
name:
type: string
description: The name of the item being referenced. Read-only.
nullable: true
path:
type: string
description: Percent-encoded path that can be used to navigate to the item. Read-only.
nullable: true
shareId:
type: string
description: A unique identifier for a shared resource that can be accessed via the Shares API.
nullable: true
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteId:
type: string
description: 'For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem 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.'
nullable: true
additionalProperties: true
microsoft.graph.driveItemUploadableProperties:
title: driveItemUploadableProperties
type: object
properties:
description:
type: string
description: Provides a user-visible description of the item. Read-write. Only on OneDrive Personal.
nullable: true
driveItemSource:
$ref: '#/components/schemas/microsoft.graph.driveItemSource'
fileSize:
type: number
description: Provides an expected file size to perform a quota check before uploading. Only on OneDrive Personal.
format: int64
nullable: true
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
mediaSource:
$ref: '#/components/schemas/microsoft.graph.mediaSource'
name:
type: string
description: The name of the item (filename and extension). Read-write.
nullable: true
additionalProperties: true
microsoft.graph.uploadSession:
title: uploadSession
type: object
properties:
expirationDateTime:
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 date and time in UTC that the upload session expires. The complete file must be uploaded before this expiration time is reached. Each fragment uploaded during the session extends the expiration time.
format: date-time
nullable: true
nextExpectedRanges:
type: array
items:
type: string
nullable: true
description: 'A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format ''start-end'' (for example ''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:
type: string
description: The URL endpoint that accepts PUT requests for byte ranges of the file.
nullable: true
additionalProperties: true
microsoft.graph.extractSensitivityLabelsResult:
title: extractSensitivityLabelsResult
type: object
properties:
labels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabelAssignment'
description: List of sensitivity labels assigned to a file.
additionalProperties: true
ReferenceNumeric:
enum:
- '-INF'
- INF
- NaN
type: string
nullable: true
microsoft.graph.itemPreviewInfo:
title: itemPreviewInfo
type: object
properties:
getUrl:
type: string
nullable: true
postParameters:
type: string
nullable: true
postUrl:
type: string
nullable: true
additionalProperties: true
microsoft.graph.itemRetentionLabel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemRetentionLabel
type: object
properties:
isLabelAppliedExplicitly:
type: boolean
description: 'Specifies whether the label is applied explicitly on the item. True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only.'
nullable: true
labelAppliedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
labelAppliedDateTime:
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 date and time when the label was applied on the item. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
name:
type: string
description: The retention label on the document. Read-write.
nullable: true
retentionSettings:
$ref: '#/components/schemas/microsoft.graph.retentionLabelSettings'
additionalProperties: true
microsoft.graph.subscription:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: subscription
type: object
properties:
applicationId:
type: string
description: Optional. Identifier of the application used to create the subscription. Read-only.
nullable: true
changeType:
type: string
description: 'Required. Indicates the type of change in the subscribed resource that raises a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType. Use updated to receive notifications when user or group is created, updated, or soft deleted. Use deleted to receive notifications when user or group is permanently deleted.'
clientState:
type: string
description: 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.
nullable: true
creatorId:
type: string
description: '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.'
nullable: true
encryptionCertificate:
type: string
description: 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.
nullable: true
encryptionCertificateId:
type: string
description: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data.
nullable: true
expirationDateTime:
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: '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. Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time. For the maximum supported subscription length of time, see Subscription lifetime.'
format: date-time
includeResourceData:
type: boolean
description: 'Optional. When set to true, change notifications include resource data (such as content of a chat message).'
nullable: true
latestSupportedTlsVersion:
type: string
description: 'Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v10, v11, v12, v13. 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.'
nullable: true
lifecycleNotificationUrl:
type: string
description: 'Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol. For more information, see Reduce missing subscriptions and change notifications.'
nullable: true
notificationQueryOptions:
type: string
description: '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 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. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.'
nullable: true
notificationUrl:
type: string
description: Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications.
notificationUrlAppId:
type: string
description: Optional. The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.
nullable: true
resource:
type: string
description: Required. Specifies the resource that is monitored for changes. Don't include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource.
additionalProperties: true
microsoft.graph.thumbnailSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: thumbnailSet
type: object
properties:
large:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
medium:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
small:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
source:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
additionalProperties: true
microsoft.graph.driveItemVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItemVersion'
- title: driveItemVersion
type: object
properties:
content:
type: string
description: The content stream for this version of the item.
format: base64url
nullable: true
size:
type: number
description: Indicates the size of the content stream for this version of the item.
format: int64
nullable: true
additionalProperties: true
microsoft.graph.list:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: list
type: object
properties:
displayName:
type: string
description: The displayable title of the list.
nullable: true
list:
$ref: '#/components/schemas/microsoft.graph.listInfo'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of field definitions for this list.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types present in this list.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItem'
description: All items contained in the list.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the list.
x-ms-navigationProperty: true
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the list.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.columnDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnDefinition
type: object
properties:
boolean:
$ref: '#/components/schemas/microsoft.graph.booleanColumn'
calculated:
$ref: '#/components/schemas/microsoft.graph.calculatedColumn'
choice:
$ref: '#/components/schemas/microsoft.graph.choiceColumn'
columnGroup:
type: string
description: 'For site columns, the name of the group this column belongs to. Helps organize related columns.'
nullable: true
contentApprovalStatus:
$ref: '#/components/schemas/microsoft.graph.contentApprovalStatusColumn'
currency:
$ref: '#/components/schemas/microsoft.graph.currencyColumn'
dateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeColumn'
defaultValue:
$ref: '#/components/schemas/microsoft.graph.defaultColumnValue'
description:
type: string
description: The user-facing description of the column.
nullable: true
displayName:
type: string
description: The user-facing name of the column.
nullable: true
enforceUniqueValues:
type: boolean
description: 'If true, no two list items may have the same value for this column.'
nullable: true
geolocation:
$ref: '#/components/schemas/microsoft.graph.geolocationColumn'
hidden:
type: boolean
description: Specifies whether the column is displayed in the user interface.
nullable: true
hyperlinkOrPicture:
$ref: '#/components/schemas/microsoft.graph.hyperlinkOrPictureColumn'
indexed:
type: boolean
description: Specifies whether the column values can be used for sorting and searching.
nullable: true
isDeletable:
type: boolean
description: Indicates whether this column can be deleted.
nullable: true
isReorderable:
type: boolean
description: Indicates whether values in the column can be reordered. Read-only.
nullable: true
isSealed:
type: boolean
description: Specifies whether the column can be changed.
nullable: true
lookup:
$ref: '#/components/schemas/microsoft.graph.lookupColumn'
name:
type: string
description: 'The API-facing name of the column as it appears in the fields on a listItem. For the user-facing name, see displayName.'
nullable: true
number:
$ref: '#/components/schemas/microsoft.graph.numberColumn'
personOrGroup:
$ref: '#/components/schemas/microsoft.graph.personOrGroupColumn'
propagateChanges:
type: boolean
description: 'If ''true'', changes to this column will be propagated to lists that implement the column.'
nullable: true
readOnly:
type: boolean
description: Specifies whether the column values can be modified.
nullable: true
required:
type: boolean
description: Specifies whether the column value isn't optional.
nullable: true
sourceContentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
term:
$ref: '#/components/schemas/microsoft.graph.termColumn'
text:
$ref: '#/components/schemas/microsoft.graph.textColumn'
thumbnail:
$ref: '#/components/schemas/microsoft.graph.thumbnailColumn'
type:
$ref: '#/components/schemas/microsoft.graph.columnTypes'
validation:
$ref: '#/components/schemas/microsoft.graph.columnValidation'
sourceColumn:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
additionalProperties: true
microsoft.graph.contentType:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentType
type: object
properties:
associatedHubsUrls:
type: array
items:
type: string
nullable: true
description: 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 is applied to the lists in the enforced sites.
description:
type: string
description: The descriptive text for the item.
nullable: true
documentSet:
$ref: '#/components/schemas/microsoft.graph.documentSet'
documentTemplate:
$ref: '#/components/schemas/microsoft.graph.documentSetContent'
group:
type: string
description: The name of the group this content type belongs to. Helps organize related content types.
nullable: true
hidden:
type: boolean
description: Indicates whether the content type is hidden in the list's 'New' menu.
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
isBuiltIn:
type: boolean
description: Specifies if a content type is a built-in content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
order:
$ref: '#/components/schemas/microsoft.graph.contentTypeOrder'
parentId:
type: string
description: The unique identifier of the content type.
nullable: true
propagateChanges:
type: boolean
description: 'If true, any changes made to the content type are pushed to inherited content types and lists that implement the content type.'
nullable: true
readOnly:
type: boolean
description: 'If true, the content type can''t be modified unless this value is first set to false.'
nullable: true
sealed:
type: boolean
description: '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.'
nullable: true
base:
$ref: '#/components/schemas/microsoft.graph.contentType'
baseTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types that are ancestors of this content type.
x-ms-navigationProperty: true
columnLinks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnLink'
description: The collection of columns that are required by this content type.
x-ms-navigationProperty: true
columnPositions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: Column order information in a content type.
x-ms-navigationProperty: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions for this content type.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.columnLink:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnLink
type: object
properties:
name:
type: string
description: The name of the column in this content type.
nullable: true
additionalProperties: true
microsoft.graph.richLongRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- title: richLongRunningOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
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
additionalProperties: true
description: The status of a long-running operation.
microsoft.graph.sharedDriveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: sharedDriveItem
type: object
properties:
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
driveItem:
$ref: '#/components/schemas/microsoft.graph.driveItem'
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: All driveItems contained in the sharing root. This collection cannot be enumerated.
x-ms-navigationProperty: true
list:
$ref: '#/components/schemas/microsoft.graph.list'
listItem:
$ref: '#/components/schemas/microsoft.graph.listItem'
permission:
$ref: '#/components/schemas/microsoft.graph.permission'
root:
$ref: '#/components/schemas/microsoft.graph.driveItem'
site:
$ref: '#/components/schemas/microsoft.graph.site'
additionalProperties: true
microsoft.graph.site:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: site
type: object
properties:
displayName:
type: string
description: The full title for the site. Read-only.
nullable: true
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
isPersonalSite:
type: boolean
description: Identifies whether the site is personal or not. Read-only.
nullable: true
root:
$ref: '#/components/schemas/microsoft.graph.root'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteCollection:
$ref: '#/components/schemas/microsoft.graph.siteCollection'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions reusable across lists under this site.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types defined for this site.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The collection of drives (document libraries) under this site.
x-ms-navigationProperty: true
externalColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseItem'
description: Used to address any item contained in this site. This collection can't be enumerated.
x-ms-navigationProperty: true
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.list'
description: The collection of lists under this site.
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the site.
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseSitePage'
description: The collection of pages in the baseSitePages list in this site.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The permissions associated with the site. Nullable.
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The collection of the sub-sites under this site.
x-ms-navigationProperty: true
termStore:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
termStores:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
description: The collection of termStores under this site.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.baseItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: baseItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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 item creation. Read-only.
format: date-time
description:
type: string
description: Provides a user-visible description of the item. Optional.
nullable: true
eTag:
type: string
description: ETag for the item. Read-only.
nullable: true
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
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 the item was last modified. Read-only.
format: date-time
name:
type: string
description: The name of the item. Read-write.
nullable: true
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
webUrl:
type: string
description: 'URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.'
nullable: true
createdByUser:
$ref: '#/components/schemas/microsoft.graph.user'
lastModifiedByUser:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties: true
microsoft.graph.identitySet:
title: identitySet
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
device:
$ref: '#/components/schemas/microsoft.graph.identity'
user:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties: true
microsoft.graph.quota:
title: quota
type: object
properties:
deleted:
type: number
description: 'Total space consumed by files in the recycle bin, in bytes. Read-only.'
format: int64
nullable: true
remaining:
type: number
description: 'Total space remaining before reaching the capacity limit, in bytes. Read-only.'
format: int64
nullable: true
state:
type: string
description: Enumeration value that indicates the state of the storage space. Read-only.
nullable: true
storagePlanInformation:
$ref: '#/components/schemas/microsoft.graph.storagePlanInformation'
total:
type: number
description: 'Total allowed storage space, in bytes. Read-only.'
format: int64
nullable: true
used:
type: number
description: 'Total space used, in bytes. Read-only.'
format: int64
nullable: true
additionalProperties: true
microsoft.graph.sharepointIds:
title: sharepointIds
type: object
properties:
listId:
type: string
description: The unique identifier (guid) for the item's list in SharePoint.
nullable: true
listItemId:
type: string
description: An integer identifier for the item within the containing list.
nullable: true
listItemUniqueId:
type: string
description: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
nullable: true
siteId:
type: string
description: The unique identifier (guid) for the item's site collection (SPSite).
nullable: true
siteUrl:
type: string
description: The SharePoint URL for the site that contains the item.
nullable: true
tenantId:
type: string
description: The unique identifier (guid) for the tenancy.
nullable: true
webId:
type: string
description: The unique identifier (guid) for the item's site (SPWeb).
nullable: true
additionalProperties: true
microsoft.graph.systemFacet:
title: systemFacet
type: object
additionalProperties: true
microsoft.graph.audio:
title: audio
type: object
properties:
album:
type: string
description: The title of the album for this audio file.
nullable: true
albumArtist:
type: string
description: The artist named on the album for the audio file.
nullable: true
artist:
type: string
description: The performing artist for the audio file.
nullable: true
bitrate:
type: number
description: Bitrate expressed in kbps.
format: int64
nullable: true
composers:
type: string
description: The name of the composer of the audio file.
nullable: true
copyright:
type: string
description: Copyright information for the audio file.
nullable: true
disc:
maximum: 32767
minimum: -32768
type: number
description: The number of the disc this audio file came from.
format: int16
nullable: true
discCount:
maximum: 32767
minimum: -32768
type: number
description: The total number of discs in this album.
format: int16
nullable: true
duration:
type: number
description: 'Duration of the audio file, expressed in milliseconds'
format: int64
nullable: true
genre:
type: string
description: The genre of this audio file.
nullable: true
hasDrm:
type: boolean
description: Indicates if the file is protected with digital rights management.
nullable: true
isVariableBitrate:
type: boolean
description: Indicates if the file is encoded with a variable bitrate.
nullable: true
title:
type: string
description: The title of the audio file.
nullable: true
track:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of the track on the original disc for this audio file.
format: int32
nullable: true
trackCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of tracks on the original disc for this audio file.
format: int32
nullable: true
year:
maximum: 2147483647
minimum: -2147483648
type: number
description: The year the audio file was recorded.
format: int32
nullable: true
additionalProperties: true
microsoft.graph.bundle:
title: bundle
type: object
properties:
album:
$ref: '#/components/schemas/microsoft.graph.album'
childCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of children contained immediately within this container.
format: int32
nullable: true
additionalProperties: true
microsoft.graph.deleted:
title: deleted
type: object
properties:
state:
type: string
description: Represents the state of the deleted item.
nullable: true
additionalProperties: true
microsoft.graph.file:
title: file
type: object
properties:
hashes:
$ref: '#/components/schemas/microsoft.graph.hashes'
mimeType:
type: string
description: The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only.
nullable: true
processingMetadata:
type: boolean
nullable: true
additionalProperties: true
microsoft.graph.fileSystemInfo:
title: fileSystemInfo
type: object
properties:
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: The UTC date and time the file was created on a client.
format: date-time
nullable: true
lastAccessedDateTime:
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 the file was last accessed. Available for the recent file list only.
format: date-time
nullable: true
lastModifiedDateTime:
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 the file was last modified on a client.
format: date-time
nullable: true
additionalProperties: true
microsoft.graph.folder:
title: folder
type: object
properties:
childCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of children contained immediately within this container.
format: int32
nullable: true
view:
$ref: '#/components/schemas/microsoft.graph.folderView'
additionalProperties: true
microsoft.graph.image:
title: image
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. Height of the image, in pixels. Read-only.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. Width of the image, in pixels. Read-only.'
format: int32
nullable: true
additionalProperties: true
microsoft.graph.geoCoordinates:
title: geoCoordinates
type: object
properties:
altitude:
type: number
description: 'Optional. The altitude (height), in feet, above sea level for the item. Read-only.'
format: double
nullable: true
latitude:
type: number
description: 'Optional. The latitude, in decimal, for the item. Read-only.'
format: double
nullable: true
longitude:
type: number
description: 'Optional. The longitude, in decimal, for the item. Read-only.'
format: double
nullable: true
additionalProperties: true
microsoft.graph.malware:
title: malware
type: object
properties:
description:
type: string
description: Contains the virus details for the malware facet.
nullable: true
additionalProperties: true
microsoft.graph.package:
title: package
type: object
properties:
type:
type: string
description: 'A string indicating the type of package. While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.'
nullable: true
additionalProperties: true
microsoft.graph.pendingOperations:
title: pendingOperations
type: object
properties:
pendingContentUpdate:
$ref: '#/components/schemas/microsoft.graph.pendingContentUpdate'
additionalProperties: true
microsoft.graph.photo:
title: photo
type: object
properties:
cameraMake:
type: string
description: Camera manufacturer. Read-only.
nullable: true
cameraModel:
type: string
description: Camera model. Read-only.
nullable: true
exposureDenominator:
type: number
description: The denominator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
exposureNumerator:
type: number
description: The numerator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
fNumber:
type: number
description: The F-stop value from the camera. Read-only.
format: double
nullable: true
focalLength:
type: number
description: The focal length from the camera. Read-only.
format: double
nullable: true
iso:
maximum: 2147483647
minimum: -2147483648
type: number
description: The ISO value from the camera. Read-only.
format: int32
nullable: true
orientation:
maximum: 32767
minimum: -32768
type: number
description: The orientation value from the camera. Writable on OneDrive Personal.
format: int16
nullable: true
takenDateTime:
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: Represents the date and time the photo was taken. Read-only.
format: date-time
nullable: true
additionalProperties: true
microsoft.graph.publicationFacet:
title: publicationFacet
type: object
properties:
checkedOutBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
level:
type: string
description: The state of publication for this document. Either published or checkout. Read-only.
nullable: true
versionId:
type: string
description: The unique identifier for the version that is visible to the current caller. Read-only.
nullable: true
additionalProperties: true
microsoft.graph.remoteItem:
title: remoteItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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 item creation. Read-only.
format: date-time
nullable: true
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
id:
type: string
description: Unique identifier for the remote item in its drive. Read-only.
nullable: true
image:
$ref: '#/components/schemas/microsoft.graph.image'
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
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 the item was last modified. Read-only.
format: date-time
nullable: true
name:
type: string
description: Optional. Filename of the remote item. Read-only.
nullable: true
package:
$ref: '#/components/schemas/microsoft.graph.package'
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: number
description: Size of the remote item. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: DAV compatible URL for the item.
nullable: true
webUrl:
type: string
description: URL that displays the resource in the browser. Read-only.
nullable: true
additionalProperties: true
microsoft.graph.root:
title: root
type: object
additionalProperties: true
microsoft.graph.searchResult:
title: searchResult
type: object
properties:
onClickTelemetryUrl:
type: string
description: A callback URL that can be used to record telemetry information. The application should issue a GET on this URL if the user interacts with this item to improve the quality of results.
nullable: true
additionalProperties: true
microsoft.graph.shared:
title: shared
type: object
properties:
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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
additionalProperties: true
microsoft.graph.specialFolder:
title: specialFolder
type: object
properties:
name:
type: string
description: The unique identifier for this item in the /drive/special collection
nullable: true
additionalProperties: true
microsoft.graph.video:
title: video
type: object
properties:
audioBitsPerSample:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio bits per sample.
format: int32
nullable: true
audioChannels:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio channels.
format: int32
nullable: true
audioFormat:
type: string
description: 'Name of the audio format (AAC, MP3, etc.).'
nullable: true
audioSamplesPerSecond:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio samples per second.
format: int32
nullable: true
bitrate:
maximum: 2147483647
minimum: -2147483648
type: number
description: Bit rate of the video in bits per second.
format: int32
nullable: true
duration:
type: number
description: Duration of the file in milliseconds.
format: int64
nullable: true
fourCC:
type: string
description: '''Four character code'' name of the video format.'
nullable: true
frameRate:
type: number
description: Frame rate of the video.
format: double
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Height of the video, in pixels.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Width of the video, in pixels.'
format: int32
nullable: true
additionalProperties: true
microsoft.graph.workbook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbook
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.workbookApplication'
comments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookComment'
description: Represents a collection of comments in a workbook.
x-ms-navigationProperty: true
functions:
$ref: '#/components/schemas/microsoft.graph.workbookFunctions'
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookOperation'
description: 'The status of workbook operations. Getting an operation collection is not supported, but you can get the status of a long-running operation if the Location header is returned in the response. Read-only.'
x-ms-navigationProperty: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
description: Represents a collection of tables associated with the workbook. Read-only.
x-ms-navigationProperty: true
worksheets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
description: Represents a collection of worksheets associated with the workbook. Read-only.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.directoryObject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: directoryObject
type: object
properties:
deletedDateTime:
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 when this object was deleted. Always null when the object hasn't been deleted.
format: date-time
nullable: true
additionalProperties: true
microsoft.graph.assignedLicense:
title: assignedLicense
type: object
properties:
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
description: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
format: uuid
nullable: true
additionalProperties: true
microsoft.graph.assignedPlan:
title: assignedPlan
type: object
properties:
assignedDateTime:
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 date and time at which the plan was assigned. The Timestamp type 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.'
format: date-time
nullable: true
capabilityStatus:
type: string
description: 'Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.'
nullable: true
service:
type: string
description: 'The name of the service; for example, exchange.'
nullable: true
servicePlanId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.'
format: uuid
nullable: true
additionalProperties: true
microsoft.graph.authorizationInfo:
title: authorizationInfo
type: object
properties:
certificateUserIds:
type: array
items:
type: string
nullable: true
additionalProperties: true
microsoft.graph.customSecurityAttributeValue:
title: customSecurityAttributeValue
type: object
additionalProperties: true
microsoft.graph.employeeOrgData:
title: employeeOrgData
type: object
properties:
costCenter:
type: string
description: The cost center associated with the user. Returned only on $select. Supports $filter.
nullable: true
division:
type: string
description: The name of the division in which the user works. Returned only on $select. Supports $filter.
nullable: true
additionalProperties: true
microsoft.graph.objectIdentity:
title: objectIdentity
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
additionalProperties: true
microsoft.graph.licenseAssignmentState:
title: licenseAssignmentState
type: object
properties:
assignedByGroup:
type: string
nullable: true
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
error:
type: string
nullable: true
lastUpdatedDateTime:
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
format: date-time
nullable: true
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
state:
type: string
nullable: true
additionalProperties: true
microsoft.graph.onPremisesExtensionAttributes:
title: onPremisesExtensionAttributes
type: object
properties:
extensionAttribute1:
type: string
description: First customizable extension attribute.
nullable: true
extensionAttribute10:
type: string
description: Tenth customizable extension attribute.
nullable: true
extensionAttribute11:
type: string
description: Eleventh customizable extension attribute.
nullable: true
extensionAttribute12:
type: string
description: Twelfth customizable extension attribute.
nullable: true
extensionAttribute13:
type: string
description: Thirteenth customizable extension attribute.
nullable: true
extensionAttribute14:
type: string
description: Fourteenth customizable extension attribute.
nullable: true
extensionAttribute15:
type: string
description: Fifteenth customizable extension attribute.
nullable: true
extensionAttribute2:
type: string
description: Second customizable extension attribute.
nullable: true
extensionAttribute3:
type: string
description: Third customizable extension attribute.
nullable: true
extensionAttribute4:
type: string
description: Fourth customizable extension attribute.
nullable: true
extensionAttribute5:
type: string
description: Fifth customizable extension attribute.
nullable: true
extensionAttribute6:
type: string
description: Sixth customizable extension attribute.
nullable: true
extensionAttribute7:
type: string
description: Seventh customizable extension attribute.
nullable: true
extensionAttribute8:
type: string
description: Eighth customizable extension attribute.
nullable: true
extensionAttribute9:
type: string
description: Ninth customizable extension attribute.
nullable: true
additionalProperties: true
microsoft.graph.onPremisesProvisioningError:
title: onPremisesProvisioningError
type: object
properties:
category:
type: string
description: 'Category of the provisioning error. Note: Currently, there is only one possible value. Possible value: PropertyConflict - indicates a property value is not unique. Other objects contain the same value for the property.'
nullable: true
occurredDateTime:
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 date and time at which the error occurred.
format: date-time
nullable: true
propertyCausingError:
type: string
description: 'Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress'
nullable: true
value:
type: string
description: Value of the property causing the error.
nullable: true
additionalProperties: true
microsoft.graph.passwordProfile:
title: passwordProfile
type: object
properties:
forceChangePasswordNextSignIn:
type: boolean
description: true if the user must change their password on the next sign-in; otherwise false.
nullable: true
forceChangePasswordNextSignInWithMfa:
type: boolean
description: 'If true, at next sign-in, the user must perform a multifactor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multifactor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.'
nullable: true
password:
type: string
description: 'The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next sign-in. The password must satisfy minimum requirements as specified by the user''s passwordPolicies property. By default, a strong password is required.'
nullable: true
additionalProperties: true
microsoft.graph.userPrint:
title: userPrint
type: object
properties:
recentPrinterShares:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printerShare'
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.provisionedPlan:
title: provisionedPlan
type: object
properties:
capabilityStatus:
type: string
description: 'Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.'
nullable: true
provisioningStatus:
type: string
description: 'The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn''t provisioned and is in an error state.PendingInput - The service isn''t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn''t activated in the tenant.'
nullable: true
service:
type: string
description: 'The name of the service; for example, ''AccessControlS2S''.'
nullable: true
additionalProperties: true
microsoft.graph.serviceProvisioningError:
title: serviceProvisioningError
type: object
properties:
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: The date and time at which the error occurred.
format: date-time
nullable: true
isResolved:
type: boolean
description: Indicates whether the error has been attended to.
nullable: true
serviceInstance:
type: string
description: 'Qualified service instance (for example, ''SharePoint/Dublin'') that published the service error information.'
nullable: true
additionalProperties: true
microsoft.graph.signInActivity:
title: signInActivity
type: object
properties:
lastNonInteractiveSignInDateTime:
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 last non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted (either successfully or unsuccessfully) to sign in to the directory on behalf of a user. Because some users may use clients to access tenant resources rather than signing into your tenant directly, you can use the non-interactive sign-in date to along with lastSignInDateTime to identify inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains non-interactive sign-ins going back to May 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
format: date-time
nullable: true
lastNonInteractiveSignInRequestId:
type: string
description: Request identifier of the last non-interactive sign-in performed by this user.
nullable: true
lastSignInDateTime:
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 last interactive sign-in date and time for a specific user. This property records the last time a user attempted an interactive sign-in to the directory—whether the attempt was successful or not. Note: Since unsuccessful attempts are also logged, this value might not accurately reflect actual system usage. For tracking actual account access, please use the lastSuccessfulSignInDateTime property. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
lastSignInRequestId:
type: string
description: Request identifier of the last interactive sign-in performed by this user.
nullable: true
lastSuccessfulSignInDateTime:
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 date and time of the user''s most recent successful interactive or non-interactive sign-in. Use this property if you need to determine when the account was truly accessed. This field can be used to build reports, such as inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains interactive sign-ins going back to April 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
format: date-time
nullable: true
lastSuccessfulSignInRequestId:
type: string
description: The request ID of the last successful sign-in.
nullable: true
additionalProperties: true
microsoft.graph.userActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userActivity
type: object
properties:
activationUrl:
type: string
description: Required. URL used to launch the activity in the best native experience represented by the appId. Might launch a web-based app if no native app exists.
activitySourceHost:
type: string
description: 'Required. URL for the domain representing the cross-platform identity mapping for the app. Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. You must have a unique file and domain (or sub domain) per cross-platform app identity. For example, a separate file and domain is needed for Word vs. PowerPoint.'
appActivityId:
type: string
description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
appDisplayName:
type: string
description: Optional. Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
nullable: true
contentInfo:
$ref: '#/components/schemas/microsoft.graph.Json'
contentUrl:
type: string
description: 'Optional. Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).'
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: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
nullable: true
expirationDateTime:
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: Set by the server. DateTime in UTC when the object expired on the server.
format: date-time
nullable: true
fallbackUrl:
type: string
description: 'Optional. URL used to launch the activity in a web-based app, if available.'
nullable: true
lastModifiedDateTime:
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: Set by the server. DateTime in UTC when the object was modified on the server.
format: date-time
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.status'
userTimezone:
type: string
description: Optional. The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
nullable: true
visualElements:
$ref: '#/components/schemas/microsoft.graph.visualInfo'
historyItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
description: Optional. NavigationProperty/Containment; navigation property to the activity's historyItems.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.agreementAcceptance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreementAcceptance
type: object
properties:
agreementFileId:
type: string
description: The identifier of the agreement file accepted by the user.
nullable: true
agreementId:
type: string
description: The identifier of the agreement.
nullable: true
deviceDisplayName:
type: string
description: The display name of the device used for accepting the agreement.
nullable: true
deviceId:
type: string
description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
nullable: true
deviceOSType:
type: string
description: The operating system used to accept the agreement.
nullable: true
deviceOSVersion:
type: string
description: The operating system version of the device used to accept the agreement.
nullable: true
expirationDateTime:
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 expiration date time of the acceptance. The Timestamp type 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. Supports $filter (eq, ge, le) and eq for null values.'
format: date-time
nullable: true
recordedDateTime:
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 Timestamp type 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.'
format: date-time
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptanceState'
userDisplayName:
type: string
description: Display name of the user when the acceptance was recorded.
nullable: true
userEmail:
type: string
description: Email of the user when the acceptance was recorded.
nullable: true
userId:
type: string
description: The identifier of the user who accepted the agreement. Supports $filter (eq).
nullable: true
userPrincipalName:
type: string
description: UPN of the user when the acceptance was recorded.
nullable: true
additionalProperties: true
microsoft.graph.appRoleAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: appRoleAssignment
type: object
properties:
appRoleId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The identifier (id) for the app role that''s assigned to the principal. This app role must be exposed in the appRoles property on the resource application''s service principal (resourceId). If the resource application hasn''t declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.'
format: uuid
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: 'The time when the app role assignment was created. The Timestamp type 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.'
format: date-time
nullable: true
principalDisplayName:
type: string
description: 'The display name of the user, group, or service principal that was granted the app role assignment. Maximum length is 256 characters. Read-only. Supports $filter (eq and startswith).'
nullable: true
principalId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.'
format: uuid
nullable: true
principalType:
type: string
description: 'The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.'
nullable: true
resourceDisplayName:
type: string
description: The display name of the resource app's service principal to which the assignment is made. Maximum length is 256 characters.
nullable: true
resourceId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
format: uuid
nullable: true
additionalProperties: true
microsoft.graph.authentication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authentication
type: object
properties:
emailMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
description: The email address registered to a user for authentication.
x-ms-navigationProperty: true
fido2Methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
description: Represents the FIDO2 security keys registered to a user for authentication.
x-ms-navigationProperty: true
methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
description: Represents all authentication methods registered to a user.
x-ms-navigationProperty: true
microsoftAuthenticatorMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod'
description: The details of the Microsoft Authenticator app registered to a user for authentication.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
description: 'Represents the status of a long-running operation, such as a password reset operation.'
x-ms-navigationProperty: true
passwordMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
description: 'Represents the password registered to a user for authentication. For security, the password itself is never returned in the object, but action can be taken to reset a password.'
x-ms-navigationProperty: true
phoneMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
description: The phone numbers registered to a user for authentication.
x-ms-navigationProperty: true
platformCredentialMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod'
description: Represents a platform credential instance registered to a user on Mac OS.
x-ms-navigationProperty: true
softwareOathMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod'
description: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
x-ms-navigationProperty: true
temporaryAccessPassMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
description: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
x-ms-navigationProperty: true
windowsHelloForBusinessMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod'
description: Represents the Windows Hello for Business authentication method registered to a user for authentication.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.calendar:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendar
type: object
properties:
allowedOnlineMeetingProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.'
canEdit:
type: boolean
description: 'true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who shared a calendar and granted write access.'
nullable: true
canShare:
type: boolean
description: 'true if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it.'
nullable: true
canViewPrivateItems:
type: boolean
description: 'If true, the user can read calendar items that have been marked private, false otherwise.'
nullable: true
changeKey:
type: string
description: 'Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
color:
$ref: '#/components/schemas/microsoft.graph.calendarColor'
defaultOnlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
hexColor:
type: string
description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.'
nullable: true
isDefaultCalendar:
type: boolean
description: 'true if this is the default calendar where new events are created by default, false otherwise.'
nullable: true
isRemovable:
type: boolean
description: Indicates whether this user calendar can be deleted from the user mailbox.
nullable: true
isTallyingResponses:
type: boolean
description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
nullable: true
name:
type: string
description: The calendar name.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
calendarPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
description: The permissions of the users with whom the calendar is shared.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The events in the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.calendarGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarGroup
type: object
properties:
changeKey:
type: string
description: 'Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
classId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The class identifier. Read-only.
format: uuid
nullable: true
name:
type: string
description: The group name.
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The calendars in the calendar group. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.event:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: event
type: object
properties:
allowNewTimeProposals:
type: boolean
description: 'true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. The default is true.'
nullable: true
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendee'
description: The collection of attendees for the event.
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The preview of the message associated with the event. It's in text format.
nullable: true
cancelledOccurrences:
type: array
items:
type: string
description: 'Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called canceled occurences.Returned only on $select in a Get operation which specifies the ID (seriesMasterId property value) of a series master event.'
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
hasAttachments:
type: boolean
description: Set to true if the event has attachments.
nullable: true
hideAttendees:
type: boolean
description: 'When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. The default is false.'
nullable: true
iCalUId:
type: string
description: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isAllDay:
type: boolean
description: 'Set to true if the event lasts all day. If true, regardless of whether it''s a single-day or multi-day event, start, and endtime must be set to midnight and be in the same time zone.'
nullable: true
isCancelled:
type: boolean
description: Set to true if the event has been canceled.
nullable: true
isDraft:
type: boolean
description: 'Set to true if the user has updated the meeting in Outlook but hasn''t sent the updates to attendees. Set to false if all changes are sent, or if the event is an appointment without any attendees.'
nullable: true
isOnlineMeeting:
type: boolean
description: 'True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently, Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.'
nullable: true
isOrganizer:
type: boolean
description: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). It also applies if a delegate organized the event on behalf of the owner.
nullable: true
isReminderOn:
type: boolean
description: Set to true if an alert is set to remind the user of the event.
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.location'
locations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: 'The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection are removed and replaced by the new location value.'
onlineMeeting:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingInfo'
onlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
onlineMeetingUrl:
type: string
description: 'A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.'
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.recipient'
originalEndTimeZone:
type: string
description: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
originalStart:
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: 'Represents the start time of an event when it''s initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
originalStartTimeZone:
type: string
description: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderMinutesBeforeStart:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of minutes before the event start time that the reminder alert occurs.
format: int32
nullable: true
responseRequested:
type: boolean
description: 'Default is true, which represents the organizer would like an invitee to send a response to the event.'
nullable: true
responseStatus:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
sensitivity:
$ref: '#/components/schemas/microsoft.graph.sensitivity'
seriesMasterId:
type: string
description: 'The ID for the recurring series master item, if this event is part of a recurring series.'
nullable: true
showAs:
$ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
subject:
type: string
description: The text of the event's subject line.
nullable: true
transactionId:
type: string
description: 'A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. It''s useful when low network connectivity causes the client to time out before receiving a response from the server for the client''s prior create-event request. After you set transactionId when creating an event, you can''t change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.'
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.eventType'
webLink:
type: string
description: 'The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can''t be accessed from within an iFrame.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
exceptionOccurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'Contains the id property values of the event instances that are exceptions in a recurring series.Exceptions can differ from other occurrences in a recurring series, such as the subject, start or end times, or attendees. Exceptions don''t include canceled occurrences.Returned only on $select and $expand in a GET operation that specifies the ID (seriesMasterId property value) of a series master event.'
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the event. Nullable.
x-ms-navigationProperty: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.chat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chat
type: object
properties:
chatType:
$ref: '#/components/schemas/microsoft.graph.chatType'
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 at which the chat was created. Read-only.
format: date-time
nullable: true
isHiddenForAllMembers:
type: boolean
description: Indicates whether the chat is hidden for all its members. Read-only.
nullable: true
lastUpdatedDateTime:
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 at which the chat was renamed or the list of members was last changed. Read-only.
format: date-time
nullable: true
onlineMeetingInfo:
$ref: '#/components/schemas/microsoft.graph.teamworkOnlineMeetingInfo'
tenantId:
type: string
description: The identifier of the tenant in which the chat was created. Read-only.
nullable: true
topic:
type: string
description: (Optional) Subject or topic for the chat. Only available for group chats.
nullable: true
viewpoint:
$ref: '#/components/schemas/microsoft.graph.chatViewpoint'
webUrl:
type: string
description: 'The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: A collection of all the apps in the chat. Nullable.
x-ms-navigationProperty: true
lastMessagePreview:
$ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of all the members in the chat. Nullable.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the chat. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: A collection of permissions granted to apps for the chat.
x-ms-navigationProperty: true
pinnedMessages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
description: A collection of all the pinned messages in the chat. Nullable.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the chat. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.cloudClipboardRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudClipboardRoot
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
description: Represents a collection of Cloud Clipboard items.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.contactFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contactFolder
type: object
properties:
displayName:
type: string
description: The folder's display name.
nullable: true
parentFolderId:
type: string
description: The ID of the folder's parent folder.
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The collection of child folders in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The contacts in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.contact:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: contact
type: object
properties:
assistantName:
type: string
description: The name of the contact's assistant.
nullable: true
birthday:
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 contact''s birthday. The Timestamp type 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'
format: date-time
nullable: true
businessAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
businessHomePage:
type: string
description: The business home page of the contact.
nullable: true
businessPhones:
type: array
items:
type: string
nullable: true
description: The contact's business phone numbers.
children:
type: array
items:
type: string
nullable: true
description: The names of the contact's children.
companyName:
type: string
description: The name of the contact's company.
nullable: true
department:
type: string
description: The contact's department.
nullable: true
displayName:
type: string
description: 'The contact''s display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation.'
nullable: true
emailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
description: The contact's email addresses.
fileAs:
type: string
description: The name the contact is filed under.
nullable: true
generation:
type: string
description: The contact's suffix.
nullable: true
givenName:
type: string
description: The contact's given name.
nullable: true
homeAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
homePhones:
type: array
items:
type: string
nullable: true
description: The contact's home phone numbers.
imAddresses:
type: array
items:
type: string
nullable: true
description: The contact's instant messaging (IM) addresses.
initials:
type: string
description: The contact's initials.
nullable: true
jobTitle:
type: string
description: The contact’s job title.
nullable: true
manager:
type: string
description: The name of the contact's manager.
nullable: true
middleName:
type: string
description: The contact's middle name.
nullable: true
mobilePhone:
type: string
description: The contact's mobile phone number.
nullable: true
nickName:
type: string
description: The contact's nickname.
nullable: true
officeLocation:
type: string
description: The location of the contact's office.
nullable: true
otherAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
parentFolderId:
type: string
description: The ID of the contact's parent folder.
nullable: true
personalNotes:
type: string
description: The user's notes about the contact.
nullable: true
profession:
type: string
description: The contact's profession.
nullable: true
spouseName:
type: string
description: The name of the contact's spouse/partner.
nullable: true
surname:
type: string
description: The contact's surname.
nullable: true
title:
type: string
description: The contact's title.
nullable: true
yomiCompanyName:
type: string
description: The phonetic Japanese company name of the contact.
nullable: true
yomiGivenName:
type: string
description: The phonetic Japanese given name (first name) of the contact.
nullable: true
yomiSurname:
type: string
description: The phonetic Japanese surname (last name) of the contact.
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.userDataSecurityAndGovernance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.dataSecurityAndGovernance'
- title: userDataSecurityAndGovernance
type: object
properties:
activities:
$ref: '#/components/schemas/microsoft.graph.activitiesContainer'
protectionScopes:
$ref: '#/components/schemas/microsoft.graph.userProtectionScopeContainer'
additionalProperties: true
microsoft.graph.deviceManagementTroubleshootingEvent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceManagementTroubleshootingEvent
type: object
properties:
correlationId:
type: string
description: Id used for tracing the failure in the service.
nullable: true
eventDateTime:
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: Time when the event occurred .
format: date-time
additionalProperties: true
description: Event representing an general failure.
microsoft.graph.employeeExperienceUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: employeeExperienceUser
type: object
properties:
learningCourseActivities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
type: object
additionalProperties: true
microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassification
type: object
properties:
overrides:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.itemInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.officeGraphInsights'
- title: itemInsights
type: object
additionalProperties: true
microsoft.graph.team:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: team
type: object
properties:
classification:
type: string
description: An optional label. Typically describes the data or business sensitivity of the team. Must match one of a preconfigured set in the tenant's directory.
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: Timestamp at which the team was created.
format: date-time
nullable: true
description:
type: string
description: 'An optional description for the team. Maximum length: 1,024 characters.'
nullable: true
displayName:
type: string
description: The name of the team.
nullable: true
firstChannelName:
type: string
description: 'The name of the first channel in the team. This is an optional property, only used during team creation and isn''t returned in methods to get and list teams.'
nullable: true
funSettings:
$ref: '#/components/schemas/microsoft.graph.teamFunSettings'
guestSettings:
$ref: '#/components/schemas/microsoft.graph.teamGuestSettings'
internalId:
type: string
description: A unique ID for the team that was used in a few places such as the audit log/Office 365 Management Activity API.
nullable: true
isArchived:
type: boolean
description: Whether this team is in read-only mode.
nullable: true
memberSettings:
$ref: '#/components/schemas/microsoft.graph.teamMemberSettings'
messagingSettings:
$ref: '#/components/schemas/microsoft.graph.teamMessagingSettings'
specialization:
$ref: '#/components/schemas/microsoft.graph.teamSpecialization'
summary:
$ref: '#/components/schemas/microsoft.graph.teamSummary'
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
visibility:
$ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
webUrl:
type: string
description: 'A hyperlink that goes to the team in the Microsoft Teams client. You get this URL when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.'
nullable: true
allChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels either hosted in or shared with the team (incoming channels).
x-ms-navigationProperty: true
channels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: The collection of channels and messages associated with the team.
x-ms-navigationProperty: true
group:
$ref: '#/components/schemas/microsoft.graph.group'
incomingChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels shared with the team.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: The apps installed in this team.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: Members and owners of the team.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
description: The async operations that ran or are running on this team.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: A collection of permissions granted to apps to access the team.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
primaryChannel:
$ref: '#/components/schemas/microsoft.graph.channel'
schedule:
$ref: '#/components/schemas/microsoft.graph.schedule'
tags:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
description: The tags associated with the team.
x-ms-navigationProperty: true
template:
$ref: '#/components/schemas/microsoft.graph.teamsTemplate'
additionalProperties: true
microsoft.graph.licenseDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: licenseDetails
type: object
properties:
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePlanInfo'
description: Information about the service plans assigned with the license. Read-only. Not nullable.
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only.
format: uuid
nullable: true
skuPartNumber:
type: string
description: 'Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.'
nullable: true
additionalProperties: true
microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: mailFolder
type: object
properties:
childFolderCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of immediate child mailFolders in the current mailFolder.
format: int32
nullable: true
displayName:
type: string
description: The mailFolder's display name.
nullable: true
isHidden:
type: boolean
description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the mailFolder's parent mailFolder.
nullable: true
totalItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder.
format: int32
nullable: true
unreadItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder marked as unread.
format: int32
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The collection of child folders in the mailFolder.
x-ms-navigationProperty: true
messageRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.messageRule'
description: The collection of rules that apply to the user's Inbox folder.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The collection of messages in the mailFolder.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.managedAppRegistration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppRegistration
type: object
properties:
appIdentifier:
$ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
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
additionalProperties: true
description: The ManagedAppEntity is the base entity type for all other entity types under app management workflow.
microsoft.graph.managedDevice:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedDevice
type: object
properties:
activationLockBypassCode:
type: string
description: 'The code that allows the Activation Lock on managed device to be bypassed. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity in LIST call. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
androidSecurityPatchLevel:
type: string
description: Android security patch level. This property is read-only.
nullable: true
readOnly: true
azureADDeviceId:
type: string
description: The unique identifier for the Azure Active Directory device. Read only. This property is read-only.
nullable: true
readOnly: true
azureADRegistered:
type: boolean
description: Whether the device is Azure Active Directory registered. This property is read-only.
nullable: true
readOnly: true
complianceGracePeriodExpirationDateTime:
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 DateTime when device compliance grace period expires. This property is read-only.
format: date-time
readOnly: true
complianceState:
$ref: '#/components/schemas/microsoft.graph.complianceState'
configurationManagerClientEnabledFeatures:
$ref: '#/components/schemas/microsoft.graph.configurationManagerClientEnabledFeatures'
deviceActionResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceActionResult'
description: List of ComplexType deviceActionResult objects. This property is read-only.
readOnly: true
deviceCategoryDisplayName:
type: string
description: Device category display name. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.
nullable: true
readOnly: true
deviceEnrollmentType:
$ref: '#/components/schemas/microsoft.graph.deviceEnrollmentType'
deviceHealthAttestationState:
$ref: '#/components/schemas/microsoft.graph.deviceHealthAttestationState'
deviceName:
type: string
description: Name of the device. This property is read-only.
nullable: true
readOnly: true
deviceRegistrationState:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationState'
easActivated:
type: boolean
description: Whether the device is Exchange ActiveSync activated. This property is read-only.
readOnly: true
easActivationDateTime:
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: Exchange ActivationSync activation time of the device. This property is read-only.
format: date-time
readOnly: true
easDeviceId:
type: string
description: Exchange ActiveSync Id of the device. This property is read-only.
nullable: true
readOnly: true
emailAddress:
type: string
description: Email(s) for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
enrolledDateTime:
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: Enrollment time of the device. Supports $filter operator 'lt' and 'gt'. This property is read-only.
format: date-time
readOnly: true
enrollmentProfileName:
type: string
description: 'Name of the enrollment profile assigned to the device. Default value is empty string, indicating no enrollment profile was assgined. This property is read-only.'
nullable: true
readOnly: true
ethernetMacAddress:
type: string
description: 'Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
exchangeAccessState:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessState'
exchangeAccessStateReason:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessStateReason'
exchangeLastSuccessfulSyncDateTime:
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: Last time the device contacted Exchange. This property is read-only.
format: date-time
readOnly: true
freeStorageSpaceInBytes:
type: number
description: Free Storage in Bytes. Default value is 0. Read-only. This property is read-only.
format: int64
readOnly: true
iccid:
type: string
description: 'Integrated Circuit Card Identifier, it is A SIM card''s unique identification number. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
imei:
type: string
description: IMEI. This property is read-only.
nullable: true
readOnly: true
isEncrypted:
type: boolean
description: Device encryption status. This property is read-only.
readOnly: true
isSupervised:
type: boolean
description: Device supervised status. This property is read-only.
readOnly: true
jailBroken:
type: string
description: Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.
nullable: true
readOnly: true
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: The date and time that the device last completed a successful sync with Intune. Supports $filter operator 'lt' and 'gt'. This property is read-only.
format: date-time
readOnly: true
managedDeviceName:
type: string
description: Automatically generated name to identify a device. Can be overwritten to a user friendly name.
nullable: true
managedDeviceOwnerType:
$ref: '#/components/schemas/microsoft.graph.managedDeviceOwnerType'
managementAgent:
$ref: '#/components/schemas/microsoft.graph.managementAgentType'
managementCertificateExpirationDate:
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: Reports device management certificate expiration date. This property is read-only.
format: date-time
readOnly: true
manufacturer:
type: string
description: Manufacturer of the device. This property is read-only.
nullable: true
readOnly: true
meid:
type: string
description: MEID. This property is read-only.
nullable: true
readOnly: true
model:
type: string
description: Model of the device. This property is read-only.
nullable: true
readOnly: true
notes:
type: string
description: 'Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.'
nullable: true
operatingSystem:
type: string
description: 'Operating system of the device. Windows, iOS, etc. This property is read-only.'
nullable: true
readOnly: true
osVersion:
type: string
description: Operating system version of the device. This property is read-only.
nullable: true
readOnly: true
partnerReportedThreatState:
$ref: '#/components/schemas/microsoft.graph.managedDevicePartnerReportedHealthState'
phoneNumber:
type: string
description: Phone number of the device. This property is read-only.
nullable: true
readOnly: true
physicalMemoryInBytes:
type: number
description: 'Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.'
format: int64
readOnly: true
remoteAssistanceSessionErrorDetails:
type: string
description: An error string that identifies issues when creating Remote Assistance session objects. This property is read-only.
nullable: true
readOnly: true
remoteAssistanceSessionUrl:
type: string
description: 'Url that allows a Remote Assistance session to be established with the device. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. This property is read-only.'
nullable: true
readOnly: true
requireUserEnrollmentApproval:
type: boolean
description: Reports if the managed iOS device is user approval enrollment. This property is read-only.
nullable: true
readOnly: true
serialNumber:
type: string
description: SerialNumber. This property is read-only.
nullable: true
readOnly: true
subscriberCarrier:
type: string
description: Subscriber Carrier. This property is read-only.
nullable: true
readOnly: true
totalStorageSpaceInBytes:
type: number
description: Total Storage in Bytes. This property is read-only.
format: int64
readOnly: true
udid:
type: string
description: 'Unique Device Identifier for iOS and macOS devices. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
userDisplayName:
type: string
description: User display name. This property is read-only.
nullable: true
readOnly: true
userId:
type: string
description: Unique Identifier for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
userPrincipalName:
type: string
description: Device user principal name. This property is read-only.
nullable: true
readOnly: true
wiFiMacAddress:
type: string
description: Wi-Fi MAC. This property is read-only.
nullable: true
readOnly: true
deviceCategory:
$ref: '#/components/schemas/microsoft.graph.deviceCategory'
deviceCompliancePolicyStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicyState'
description: Device compliance policy states for this device.
x-ms-navigationProperty: true
deviceConfigurationStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
description: Device configuration states for this device.
x-ms-navigationProperty: true
logCollectionRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceLogCollectionResponse'
description: List of log collection requests
x-ms-navigationProperty: true
users:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
description: The primary users associated with the managed device.
x-ms-navigationProperty: true
windowsProtectionState:
$ref: '#/components/schemas/microsoft.graph.windowsProtectionState'
additionalProperties: true
description: 'Devices that are managed or pre-enrolled through Intune. Limited support for $filter: Only properties whose descriptions mention support for $filter may be used, and combinations of those filtered properties must use ''and'', not ''or''.'
microsoft.graph.message:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: message
type: object
properties:
bccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Bcc: recipients for the message.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The first 255 characters of the message body. It is in text format.
nullable: true
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the message.'
conversationId:
type: string
description: The ID of the conversation the email belongs to.
nullable: true
conversationIndex:
type: string
description: Indicates the position of the message within the conversation.
format: base64url
nullable: true
flag:
$ref: '#/components/schemas/microsoft.graph.followupFlag'
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as
.'
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
internetMessageHeaders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
internetMessageId:
type: string
description: The message ID in the format specified by RFC2822.
nullable: true
isDeliveryReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
isDraft:
type: boolean
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
nullable: true
isRead:
type: boolean
description: Indicates whether the message has been read.
nullable: true
isReadReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the message's parent mailFolder.
nullable: true
receivedDateTime:
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 date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
replyTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses to use when replying.
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
sentDateTime:
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 date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
subject:
type: string
description: The subject of the message.
nullable: true
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the message.'
uniqueBody:
$ref: '#/components/schemas/microsoft.graph.itemBody'
webLink:
type: string
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: The fileAttachment and itemAttachment attachments for the message.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the message. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.oAuth2PermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: oAuth2PermissionGrant
type: object
properties:
clientId:
type: string
description: The object id (not appId) of the client service principal for the application that's authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
consentType:
type: string
description: 'Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Nonadmin users might be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).'
nullable: true
principalId:
type: string
description: 'The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal. Supports $filter (eq only).'
nullable: true
resourceId:
type: string
description: The id of the resource service principal to which access is authorized. This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).
scope:
type: string
description: 'A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3,850 characters in length.'
nullable: true
additionalProperties: true
microsoft.graph.onenote:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenote
type: object
properties:
notebooks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.notebook'
description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
description: 'The status of OneNote operations. Getting an operations collection isn''t supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.'
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
description: 'The image and other file resources in OneNote pages. Getting a resources collection isn''t supported, but you can get the binary content of a specific resource. Read-only. Nullable.'
x-ms-navigationProperty: true
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.onlineMeeting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingBase'
- title: onlineMeeting
type: object
properties:
attendeeReport:
type: string
description: The content stream of the attendee report of a Microsoft Teams live event. Read-only.
format: base64url
nullable: true
broadcastSettings:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingSettings'
creationDateTime:
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 meeting creation time in UTC. Read-only.
format: date-time
nullable: true
endDateTime:
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 meeting end time in UTC. Required when you create an online meeting.
format: date-time
nullable: true
externalId:
type: string
description: The external ID that is a custom identifier. Optional.
nullable: true
isBroadcast:
type: boolean
description: Indicates whether this meeting is a Teams live event.
nullable: true
meetingTemplateId:
type: string
description: The ID of the meeting template.
nullable: true
participants:
$ref: '#/components/schemas/microsoft.graph.meetingParticipants'
startDateTime:
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 meeting start time in UTC.
format: date-time
nullable: true
recordings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
description: The recordings of an online meeting. Read-only.
x-ms-navigationProperty: true
transcripts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
description: The transcripts of an online meeting. Read-only.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.outlookUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookUser
type: object
properties:
masterCategories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
description: A list of categories defined for the user.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.person:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: person
type: object
properties:
birthday:
type: string
description: The person's birthday.
nullable: true
companyName:
type: string
description: The name of the person's company.
nullable: true
department:
type: string
description: The person's department.
nullable: true
displayName:
type: string
description: The person's display name.
nullable: true
givenName:
type: string
description: The person's given name.
nullable: true
imAddress:
type: string
description: The instant message voice over IP (VOIP) session initiation protocol (SIP) address for the user. Read-only.
nullable: true
isFavorite:
type: boolean
description: True if the user has flagged this person as a favorite.
nullable: true
jobTitle:
type: string
description: The person's job title.
nullable: true
officeLocation:
type: string
description: The location of the person's office.
nullable: true
personNotes:
type: string
description: Free-form notes that the user has taken about this person.
nullable: true
personType:
$ref: '#/components/schemas/microsoft.graph.personType'
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: The person's phone numbers.
postalAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: The person's addresses.
profession:
type: string
description: The person's profession.
nullable: true
scoredEmailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scoredEmailAddress'
description: The person's email addresses.
surname:
type: string
description: The person's surname.
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person''s email name. The general format is alias@domain.'
nullable: true
websites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.website'
description: The person's websites.
yomiCompany:
type: string
description: The phonetic Japanese name of the person's company.
nullable: true
additionalProperties: true
microsoft.graph.resourceSpecificPermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: resourceSpecificPermissionGrant
type: object
properties:
clientAppId:
type: string
description: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.
nullable: true
clientId:
type: string
description: ID of the Microsoft Entra app that has been granted access. Read-only.
nullable: true
permission:
type: string
description: The name of the resource-specific permission. Read-only.
nullable: true
permissionType:
type: string
description: 'The type of permission. Possible values are: Application, Delegated. Read-only.'
nullable: true
resourceAppId:
type: string
description: ID of the Microsoft Entra app that is hosting the resource. Read-only.
nullable: true
additionalProperties: true
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
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
additionalProperties: true
microsoft.graph.plannerUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerUser
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Returns the plannerPlans shared with the user.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.presence:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: presence
type: object
properties:
activity:
type: string
description: 'The supplemental information to a user''s availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.'
nullable: true
availability:
type: string
description: 'The base presence information for a user. Possible values are Available, availableIdle, Away, beRightBack, Busy, busyIdle, DoNotDisturb, Offline, presenceUnknown.'
nullable: true
outOfOfficeSettings:
$ref: '#/components/schemas/microsoft.graph.outOfOfficeSettings'
sequenceNumber:
type: string
description: The lexicographically sortable string stamp that represents the version of a presence object.
nullable: true
readOnly: true
statusMessage:
$ref: '#/components/schemas/microsoft.graph.presenceStatusMessage'
additionalProperties: true
microsoft.graph.scopedRoleMembership:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: scopedRoleMembership
type: object
properties:
administrativeUnitId:
type: string
description: Unique identifier for the administrative unit that the directory role is scoped to
roleId:
type: string
description: Unique identifier for the directory role that the member is in.
roleMemberInfo:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties: true
microsoft.graph.userSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSettings
type: object
properties:
contributionToContentDiscoveryAsOrganizationDisabled:
type: boolean
description: 'Reflects the organization level setting controlling delegate access to the trending API. When set to true, the organization doesn''t have access to Office Delve. The relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected for the whole organization. This setting is read-only and can only be changed by administrators in the SharePoint admin center.'
contributionToContentDiscoveryDisabled:
type: boolean
description: 'When set to true, the delegate access to the user''s trending API is disabled. When set to true, documents in the user''s Office Delve are disabled. When set to true, the relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected. Users can control this setting in Office Delve.'
itemInsights:
$ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
shiftPreferences:
$ref: '#/components/schemas/microsoft.graph.shiftPreferences'
storage:
$ref: '#/components/schemas/microsoft.graph.userStorage'
windows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.userSolutionRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSolutionRoot
type: object
properties:
workingTimeSchedule:
$ref: '#/components/schemas/microsoft.graph.workingTimeSchedule'
additionalProperties: true
microsoft.graph.userTeamwork:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userTeamwork
type: object
properties:
locale:
type: string
description: 'Represents the location that a user selected in Microsoft Teams and doesn''t follow the Office''s locale setting. A user''s locale is represented by their preferred language and country or region. For example, en-us. The language component follows two-letter codes as defined in ISO 639-1, and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.'
nullable: true
region:
type: string
description: 'Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user''s region (if available). For users without multigeo licenses, the property contains the organization''s region.The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.'
nullable: true
associatedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
description: The list of associatedTeamInfo objects that a user is associated with.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation'
description: The apps installed in the personal scope of this user.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.todo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todo
type: object
properties:
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
description: The task lists in the users mailbox.
x-ms-navigationProperty: true
additionalProperties: true
microsoft.graph.automaticRepliesSetting:
title: automaticRepliesSetting
type: object
properties:
externalAudience:
$ref: '#/components/schemas/microsoft.graph.externalAudienceScope'
externalReplyMessage:
type: string
description: 'The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.'
nullable: true
internalReplyMessage:
type: string
description: 'The automatic reply to send to the audience internal to the signed-in user''s organization, if Status is AlwaysEnabled or Scheduled.'
nullable: true
scheduledEndDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
scheduledStartDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
status:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesStatus'
additionalProperties: true
microsoft.graph.delegateMeetingMessageDeliveryOptions:
title: delegateMeetingMessageDeliveryOptions
enum:
- sendToDelegateAndInformationToPrincipal
- sendToDelegateAndPrincipal
- sendToDelegateOnly
type: string
microsoft.graph.localeInfo:
title: localeInfo
type: object
properties:
displayName:
type: string
description: 'A name representing the user''s locale in natural language, for example, ''English (United States)''.'
nullable: true
locale:
type: string
description: 'A locale representation for the user, which includes the user''s preferred language and country/region. For example, ''en-us''. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.'
nullable: true
additionalProperties: true
microsoft.graph.userPurpose:
title: userPurpose
enum:
- user
- linked
- shared
- room
- equipment
- others
- unknownFutureValue
type: string
microsoft.graph.workingHours:
title: workingHours
type: object
properties:
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: The days of the week on which the user works.
endTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user stops working.
format: time
nullable: true
startTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user starts working.
format: time
nullable: true
timeZone:
$ref: '#/components/schemas/microsoft.graph.timeZoneBase'
additionalProperties: true
microsoft.graph.entity:
title: entity
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
additionalProperties: true
microsoft.graph.itemActionStat:
title: itemActionStat
type: object
properties:
actionCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of times the action took place. Read-only.
format: int32
nullable: true
actorCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of distinct actors that performed the action. Read-only.
format: int32
nullable: true
additionalProperties: true
microsoft.graph.incompleteData:
title: incompleteData
type: object
properties:
missingDataBeforeDateTime:
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 service does not have source data before the specified time.
format: date-time
nullable: true
wasThrottled:
type: boolean
description: Some data was not recorded due to excessive activity.
nullable: true
additionalProperties: true
microsoft.graph.accessAction:
title: accessAction
type: object
additionalProperties: true
microsoft.graph.contentTypeInfo:
title: contentTypeInfo
type: object
properties:
id:
type: string
description: The ID of the content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
additionalProperties: true
microsoft.graph.documentSetVersionItem:
title: documentSetVersionItem
type: object
properties:
itemId:
type: string
description: The unique identifier for the item.
nullable: true
title:
type: string
description: The title of the item.
nullable: true
versionId:
type: string
description: The version ID of the item.
nullable: true
additionalProperties: true
microsoft.graph.sharePointIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: sharePointIdentitySet
type: object
properties:
group:
$ref: '#/components/schemas/microsoft.graph.identity'
siteGroup:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
siteUser:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
additionalProperties: true
microsoft.graph.sharingInvitation:
title: sharingInvitation
type: object
properties:
email:
type: string
description: The email address provided for the recipient of the sharing invitation. Read-only.
nullable: true
invitedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
redeemedBy:
type: string
nullable: true
signInRequired:
type: boolean
description: If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only.
nullable: true
additionalProperties: true
microsoft.graph.sharingLink:
title: sharingLink
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
preventsDownload:
type: boolean
description: '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.'
nullable: true
scope:
type: string
description: '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.'
nullable: true
type:
type: string
description: The type of the link created.
nullable: true
webHtml:
type: string
description: 'For embed links, this property contains the HTML code for an