openapi: 3.0.4
info:
title: Files
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
security:
- azureaadv2: []
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
$ref: '#/components/responses/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/Drive'
required: true
responses:
"2XX":
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/Drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}:
get:
tags:
- drives.drive
summary: Get entity from drives by key
operationId: getDrive
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drives.drive
summary: Update entity in drives
operationId: updateDrive
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/Drive'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Drive'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
$ref: '#/components/responses/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
required: true
responses:
"2XX":
description: Created navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/items/{driveItemId}:
get:
tags:
- drives.driveItem
summary: Get items from drives
description: All items contained in the drive. Read-only. Nullable.
operationId: getItem
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
$ref: '#/components/responses/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
required: true
responses:
"2XX":
description: Created navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/items/{driveItemId}/children/{driveItemId1}:
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItemId1
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/items/{driveItemId}/children/{driveItemId1}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItemId1
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $format
in: query
description: Format of the content
required: false
style: form
explode: false
schema:
type: string
x-ballerina-name: format
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItemId1
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: driveItemId1
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
/drives/{driveId}/items/{driveItemId}/children/$count:
get:
tags:
- drives.driveItem
summary: Get the number of the resource
operationId: getChildrenCount
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $format
in: query
description: Format of the content
required: false
style: form
explode: false
schema:
type: string
x-ballerina-name: format
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
/drives/{driveId}/items/{driveItemId}/microsoft.graph.assignSensitivityLabel:
post:
tags:
- drives.driveItem
summary: Invoke action assignSensitivityLabel
operationId: assignSentitivityLabel
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphAssignSensitivityLabelBody'
required: true
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCheckinBody'
required: true
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/{driveId}/items/{driveItemId}/microsoft.graph.copy:
post:
tags:
- drives.driveItem
summary: Invoke action copy
operationId: copy
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCopyBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/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.
If 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCreateLinkBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Permission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/microsoft.graph.createUploadSession:
post:
tags:
- drives.driveItem
summary: Invoke action createUploadSession
operationId: createUploadSession
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCreateUploadSessionBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/{driveId}/items/{driveItemId}/microsoft.graph.extractSensitivityLabels:
post:
tags:
- drives.driveItem
summary: Invoke action extractSensitivityLabels
operationId: extractSensitivityLabel
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractSensitivityLabelsResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/microsoft.graph.invite:
post:
tags:
- drives.driveItem
summary: Invoke action invite
description: |-
Sends a sharing invitation for a driveItem.
A 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphInviteBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionOfPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/drives/{driveId}/items/{driveItemId}/microsoft.graph.permanentDelete:
post:
tags:
- drives.driveItem
summary: Invoke action permanentDelete
operationId: permanentDelete
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/{driveId}/items/{driveItemId}/microsoft.graph.preview:
post:
tags:
- drives.driveItem
summary: Invoke action preview
operationId: preview
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphPreviewBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemPreviewInfo'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphRestoreBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/{driveItemId}/microsoft.graph.search(q='{q}'):
get:
tags:
- drives.driveItem
summary: Invoke function search
description: |-
Search the hierarchy of items for items matching a query.
You 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: q
in: path
description: "Usage: q='{q}'"
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $orderby
in: query
description: Order items by property values
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionOfDriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/drives/{driveId}/items/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/{driveId}/items/{driveItemId}/microsoft.graph.validatePermission:
post:
tags:
- drives.driveItem
summary: Invoke action validatePermission
operationId: validatePermission
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphValidatePermissionBody'
required: true
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/items/$count:
get:
tags:
- drives.driveItem
summary: Get the number of the resource
operationId: getItemCount
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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/{driveId}/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.
This 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $orderby
in: query
description: Order items by property values
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
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/{driveId}/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.
You 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: q
in: path
description: "Usage: q='{q}'"
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $orderby
in: query
description: Order items by property values
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
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/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $orderby
in: query
description: Order items by property values
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
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/{driveId}/root:
get:
tags:
- drives.driveItem
summary: Get root from drives
description: The root folder of the drive. Read-only.
operationId: getRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/root:{pathToItem}:
get:
tags:
- drives.driveItem
summary: Get root from drives
description: The root folder of the drive. Read-only.
operationId: getItemByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToItem
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- drives.driveItem
summary: Delete navigation property root for drives
operationId: deleteItemByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToItem
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- drives.driveItem
summary: Update the navigation property root in drives
operationId: updateItemByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToItem
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
$ref: '#/components/responses/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
required: true
responses:
"2XX":
description: Created navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/root:{pathToFolder}:/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: listItemsByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToFolder
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
- $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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
$ref: '#/components/responses/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: createItemByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToFolder
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
required: true
responses:
"2XX":
description: Created navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/root:{pathToItem}:/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: getChildrenContentByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToItem
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
- name: $format
in: query
description: Format of the content
required: false
style: form
explode: false
schema:
type: string
x-ballerina-name: format
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: setChildrenContentByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToItem
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
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/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: deleteChildrenContentByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToItem
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
/drives/{driveId}/root/children/{driveItemId}:
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $select
in: query
description: Select properties to be returned
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/drives/{driveId}/root/children/{driveItemId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: $format
in: query
description: Format of the content
required: false
style: form
explode: false
schema:
type: string
x-ballerina-name: format
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
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/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: driveItemId
in: path
description: The unique identifier of driveItem
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: driveItem
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
/drives/{driveId}/root/children/$count:
get:
tags:
- drives.driveItem
summary: Get the number of the resource
operationId: getChildrenCountInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: $format
in: query
description: Format of the content
required: false
style: form
explode: false
schema:
type: string
x-ballerina-name: format
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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: If-Match
in: header
description: ETag
required: false
style: simple
explode: false
schema:
type: string
x-ballerina-name: ifMatch
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
/drives/{driveId}/root/microsoft.graph.assignSensitivityLabel:
post:
tags:
- drives.driveItem
summary: Invoke action assignSensitivityLabel
operationId: assignSentitivityLabelInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphAssignSensitivityLabelBody'
required: true
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCheckinBody'
required: true
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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/{driveId}/root/microsoft.graph.copy:
post:
tags:
- drives.driveItem
summary: Invoke action copy
operationId: copyInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCopyBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/root:{pathToItem}:/microsoft.graph.copy:
post:
tags:
- drives.driveItem
summary: Invoke action copy
operationId: copyByPath
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: pathToItem
in: path
description: Path relative to root folder
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCopyBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/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.
If 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCreateLinkBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Permission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/root/microsoft.graph.createUploadSession:
post:
tags:
- drives.driveItem
summary: Invoke action createUploadSession
operationId: createUploadSessionInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphCreateUploadSessionBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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/{driveId}/root/microsoft.graph.extractSensitivityLabels:
post:
tags:
- drives.driveItem
summary: Invoke action extractSensitivityLabels
operationId: extractSensitivityLabelsInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ExtractSensitivityLabelsResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/root/microsoft.graph.invite:
post:
tags:
- drives.driveItem
summary: Invoke action invite
description: |-
Sends a sharing invitation for a driveItem.
A 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphInviteBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionOfPermission'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/drives/{driveId}/root/microsoft.graph.permanentDelete:
post:
tags:
- drives.driveItem
summary: Invoke action permanentDelete
operationId: permanentDeleteInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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/{driveId}/root/microsoft.graph.preview:
post:
tags:
- drives.driveItem
summary: Invoke action preview
operationId: previewInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphPreviewBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemPreviewInfo'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphRestoreBody'
required: true
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/drives/{driveId}/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.
You 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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
- name: q
in: path
description: "Usage: q='{q}'"
required: true
style: simple
explode: false
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
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: select
- name: $orderby
in: query
description: Order items by property values
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: orderby
- name: $expand
in: query
description: Expand related entities
required: false
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
x-ballerina-name: expand
responses:
"2XX":
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionOfDriveItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/drives/{driveId}/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: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
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/{driveId}/root/microsoft.graph.validatePermission:
post:
tags:
- drives.driveItem
summary: Invoke action validatePermission
operationId: validatePermissionInRoot
parameters:
- name: driveId
in: path
description: The unique identifier of drive
required: true
style: simple
explode: false
schema:
type: string
x-ms-docs-key-type: drive
requestBody:
description: Action parameters
content:
application/json:
schema:
$ref: '#/components/schemas/DriveItemIdMicrosoftGraphValidatePermissionBody'
required: true
responses:
"2XX":
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
components:
schemas:
SensitivityLabel:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/SensitivityLabel1'
ActivitiesContainer:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ActivitiesContainer1'
AuthenticationMethod:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/AuthenticationMethod1'
ConfirmedBy:
title: confirmedBy
type: string
enum:
- none
- user
- manager
- unknownFutureValue
x-ms-enum-flags:
isFlags: true
PublicationFacet:
title: publicationFacet
type: object
properties:
checkedOutBy:
$ref: '#/components/schemas/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
OpenShift1:
title: openShift
type: object
properties:
draftOpenShift:
$ref: '#/components/schemas/OpenShiftItem'
isStagedForDeletion:
type: boolean
description: "The openShift is marked for deletion, a process that is finalized\
\ when the schedule is shared."
nullable: true
schedulingGroupId:
type: string
description: The ID of the schedulingGroup that contains the openShift.
nullable: true
sharedOpenShift:
$ref: '#/components/schemas/OpenShiftItem'
additionalProperties: true
TeamworkUserIdentity1:
title: teamworkUserIdentity
type: object
properties:
userIdentityType:
$ref: '#/components/schemas/TeamworkUserIdentityType'
additionalProperties: true
PrintJob1:
title: printJob
type: object
properties:
acknowledgedDateTime:
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 dateTimeOffset when the job was acknowledged. Read-only.
format: date-time
nullable: true
configuration:
$ref: '#/components/schemas/PrintJobConfiguration'
createdBy:
$ref: '#/components/schemas/UserIdentity'
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 DateTimeOffset when the job was created. Read-only.
format: date-time
errorCode:
maximum: 2147483647
minimum: -2147483648
type: number
description: The error code of the print job. Read-only.
format: int32
nullable: true
isFetchable:
type: boolean
description: "If true, document can be fetched by printer."
redirectedFrom:
type: string
description: "Contains the source job URL, if the job has been redirected\
\ from another printer."
nullable: true
redirectedTo:
type: string
description: "Contains the destination job URL, if the job has been redirected\
\ to another printer."
nullable: true
status:
$ref: '#/components/schemas/PrintJobStatus'
documents:
type: array
items:
$ref: '#/components/schemas/PrintDocument'
x-ms-navigationProperty: true
tasks:
type: array
description: A list of printTasks that were triggered by this print job.
items:
$ref: '#/components/schemas/PrintTask'
x-ms-navigationProperty: true
additionalProperties: true
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
GroupSetting1:
title: groupSetting
type: object
properties:
displayName:
type: string
description: "Display name of this group of settings, which comes from the\
\ associated template."
nullable: true
templateId:
type: string
description: Unique identifier for the tenant-level groupSettingTemplates
object that's been customized for this group-level settings object. Read-only.
nullable: true
values:
type: array
description: Collection of name-value pairs corresponding to the name and
defaultValue properties in the referenced groupSettingTemplates object.
items:
$ref: '#/components/schemas/SettingValue'
additionalProperties: true
DeviceCompliancePolicyState1:
title: deviceCompliancePolicyState
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/PolicyPlatformType'
settingCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of how many setting a policy holds
format: int32
settingStates:
type: array
items:
$ref: '#/components/schemas/DeviceCompliancePolicySettingState'
state:
$ref: '#/components/schemas/ComplianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the policy
format: int32
additionalProperties: true
description: Device Compliance Policy State for a given device
Status:
title: status
type: string
enum:
- active
- updated
- deleted
- ignored
- unknownFutureValue
DeviceCategory1:
title: deviceCategory
type: object
properties:
description:
type: string
description: Optional description for the device category.
nullable: true
displayName:
type: string
description: Display name for the device category.
nullable: true
additionalProperties: true
description: "Device categories provides a way to organize your devices. Using\
\ device categories, company administrators can define their own categories\
\ that make sense to their company. These categories can then be applied to\
\ a device in the Intune Azure console or selected by a user during device\
\ enrollment. You can filter reports and create dynamic Azure Active Directory\
\ device groups based on device categories"
WorkbookChartPoint1:
title: workbookChartPoint
type: object
properties:
value:
$ref: '#/components/schemas/Json'
format:
$ref: '#/components/schemas/WorkbookChartPointFormat'
additionalProperties: true
TimeClockSettings:
title: timeClockSettings
type: object
properties:
approvedLocation:
$ref: '#/components/schemas/GeoCoordinates'
additionalProperties: true
ShiftPreferences1:
title: shiftPreferences
type: object
properties:
availability:
type: array
description: Availability of the user to be scheduled for work and its recurrence
pattern.
items:
$ref: '#/components/schemas/ShiftAvailability'
additionalProperties: true
ExternalAudienceScope:
title: externalAudienceScope
type: string
enum:
- none
- contactsOnly
- all
CalendarGroup1:
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
description: The calendars in the calendar group. Navigation property. Read-only.
Nullable.
items:
$ref: '#/components/schemas/Calendar'
x-ms-navigationProperty: true
additionalProperties: true
ChatMessagePolicyViolation:
title: chatMessagePolicyViolation
type: object
properties:
dlpAction:
$ref: '#/components/schemas/ChatMessagePolicyViolationDlpActionTypes'
justificationText:
type: string
description: Justification text provided by the sender of the message when
overriding a policy violation.
nullable: true
policyTip:
$ref: '#/components/schemas/ChatMessagePolicyViolationPolicyTip'
userAction:
$ref: '#/components/schemas/ChatMessagePolicyViolationUserActionTypes'
verdictDetails:
$ref: '#/components/schemas/ChatMessagePolicyViolationVerdictDetailsTypes'
additionalProperties: true
ConversationMember1:
title: conversationMember
type: object
properties:
displayName:
type: string
description: The display name of the user.
nullable: true
roles:
type: array
description: "The roles for that user. This property contains more qualifiers\
\ only when relevant - for example, if the member has owner privileges,\
\ the roles property contains owner as one of the values. Similarly, if\
\ the member is an in-tenant guest, the roles property contains guest\
\ as one of the values. A basic member shouldn't have any values specified\
\ in the roles property. An Out-of-tenant external member is assigned\
\ the owner role."
items:
type: string
nullable: true
visibleHistoryStartDateTime:
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 denoting how far back a conversation's history
is shared with the conversation member. This property is settable only
for members of a chat.
format: date-time
nullable: true
additionalProperties: true
DeviceEnrollmentType:
title: deviceEnrollmentType
type: string
description: Possible ways of adding a mobile device to management
enum:
- unknown
- userEnrollment
- deviceEnrollmentManager
- appleBulkWithUser
- appleBulkWithoutUser
- windowsAzureADJoin
- windowsBulkUserless
- windowsAutoEnrollment
- windowsBulkAzureDomainJoin
- windowsCoManagement
- windowsAzureADJoinUsingDeviceAuth
- appleUserEnrollment
- appleUserEnrollmentWithServiceAccount
- unknownFutureValue
x-ms-enum:
name: deviceEnrollmentType
modelAsString: false
values:
- value: unknown
description: "Default value, enrollment type was not collected."
name: unknown
- value: userEnrollment
description: User driven enrollment through BYOD channel.
name: userEnrollment
- value: deviceEnrollmentManager
description: User enrollment with a device enrollment manager account.
name: deviceEnrollmentManager
- value: appleBulkWithUser
description: "Apple bulk enrollment with user challenge. (DEP, Apple Configurator)"
name: appleBulkWithUser
- value: appleBulkWithoutUser
description: "Apple bulk enrollment without user challenge. (DEP, Apple\
\ Configurator, Mobile Config)"
name: appleBulkWithoutUser
- value: windowsAzureADJoin
description: Windows 10 Entra ID (Azure AD) Join.
name: windowsAzureADJoin
- value: windowsBulkUserless
description: Windows 10 Bulk enrollment through ICD with certificate.
name: windowsBulkUserless
- value: windowsAutoEnrollment
description: Windows 10 automatic enrollment. (Add work account)
name: windowsAutoEnrollment
- value: windowsBulkAzureDomainJoin
description: Windows 10 bulk Entra ID (Azure AD) Join.
name: windowsBulkAzureDomainJoin
- value: windowsCoManagement
description: Windows 10 Co-Management triggered by AutoPilot or Group Policy.
name: windowsCoManagement
- value: windowsAzureADJoinUsingDeviceAuth
description: Windows 10 Entra ID (Azure AD) Join using Device Auth.
name: windowsAzureADJoinUsingDeviceAuth
- value: appleUserEnrollment
description: Indicates the device is enrolled via Apple User Enrollment
with Company Portal. It results in an enrollment with a new partition
for managed apps and data and which supports a limited set of management
capabilities
name: appleUserEnrollment
- value: appleUserEnrollmentWithServiceAccount
description: Indicates the device is enrolled via Apple User Enrollment
with Company Portal using a device enrollment manager user. It results
in an enrollment with a new partition for managed apps and data and which
supports a limited set of management capabilities
name: appleUserEnrollmentWithServiceAccount
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
InferenceClassificationOverride1:
title: inferenceClassificationOverride
type: object
properties:
classifyAs:
$ref: '#/components/schemas/InferenceClassificationType'
senderEmailAddress:
$ref: '#/components/schemas/EmailAddress'
additionalProperties: true
PrinterFeedOrientation:
title: printerFeedOrientation
type: string
enum:
- longEdgeFirst
- shortEdgeFirst
- unknownFutureValue
DriveItem1:
title: driveItem
type: object
properties:
audio:
$ref: '#/components/schemas/Audio'
bundle:
$ref: '#/components/schemas/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/Deleted'
file:
$ref: '#/components/schemas/File'
fileSystemInfo:
$ref: '#/components/schemas/FileSystemInfo'
folder:
$ref: '#/components/schemas/Folder'
image:
$ref: '#/components/schemas/Image'
location:
$ref: '#/components/schemas/GeoCoordinates'
malware:
$ref: '#/components/schemas/Malware'
package:
$ref: '#/components/schemas/Package'
pendingOperations:
$ref: '#/components/schemas/PendingOperations'
photo:
$ref: '#/components/schemas/Photo'
publication:
$ref: '#/components/schemas/PublicationFacet'
remoteItem:
$ref: '#/components/schemas/RemoteItem'
root:
$ref: '#/components/schemas/Root'
searchResult:
$ref: '#/components/schemas/SearchResult'
shared:
$ref: '#/components/schemas/Shared'
sharepointIds:
$ref: '#/components/schemas/SharepointIds'
size:
type: number
description: Size of the item in bytes. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/SpecialFolder'
video:
$ref: '#/components/schemas/Video'
webDavUrl:
type: string
description: WebDAV compatible URL for the item.
nullable: true
analytics:
$ref: '#/components/schemas/ItemAnalytics'
children:
type: array
description: Collection containing Item objects for the immediate children
of Item. Only items representing folders have children. Read-only. Nullable.
items:
$ref: '#/components/schemas/DriveItem'
x-ms-navigationProperty: true
listItem:
$ref: '#/components/schemas/ListItem'
permissions:
type: array
description: The set of permissions for the item. Read-only. Nullable.
items:
$ref: '#/components/schemas/Permission'
x-ms-navigationProperty: true
retentionLabel:
$ref: '#/components/schemas/ItemRetentionLabel'
subscriptions:
type: array
description: The set of subscriptions on the item. Only supported on the
root of a drive.
items:
$ref: '#/components/schemas/Subscription'
x-ms-navigationProperty: true
thumbnails:
type: array
description: "Collection of thumbnailSet objects associated with the item.\
\ For more information, see getting thumbnails. Read-only. Nullable."
items:
$ref: '#/components/schemas/ThumbnailSet'
x-ms-navigationProperty: true
versions:
type: array
description: "The list of previous versions of the item. For more info,\
\ see getting previous versions. Read-only. Nullable."
items:
$ref: '#/components/schemas/DriveItemVersion'
x-ms-navigationProperty: true
workbook:
$ref: '#/components/schemas/Workbook'
additionalProperties: true
DriveItemIdMicrosoftGraphCopyBody:
type: object
properties:
name:
type: string
nullable: true
parentReference:
$ref: '#/components/schemas/ItemReference'
childrenOnly:
type: boolean
nullable: true
default: false
includeAllVersionHistory:
type: boolean
nullable: true
default: false
additionalProperties: true
TeamsAsyncOperation1:
title: teamsAsyncOperation
type: object
properties:
attemptsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of times the operation was attempted before being marked
successful or failed.
format: int32
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: Time when the operation was created.
format: date-time
error:
$ref: '#/components/schemas/OperationError'
lastActionDateTime:
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 async operation was last updated.
format: date-time
operationType:
$ref: '#/components/schemas/TeamsAsyncOperationType'
status:
$ref: '#/components/schemas/TeamsAsyncOperationStatus'
targetResourceId:
type: string
description: "The ID of the object that's created or modified as result\
\ of this async operation, typically a team."
nullable: true
targetResourceLocation:
type: string
description: The location of the object that's created or modified as result
of this async operation. This URL should be treated as an opaque value
and not parsed into its component paths.
nullable: true
additionalProperties: true
ChatMessageFromIdentitySet1:
title: chatMessageFromIdentitySet
type: object
additionalProperties: true
TeamsAppResourceSpecificPermission:
title: teamsAppResourceSpecificPermission
type: object
properties:
permissionType:
$ref: '#/components/schemas/TeamsAppResourceSpecificPermissionType'
permissionValue:
type: string
description: The name of the resource-specific permission.
nullable: true
additionalProperties: true
PlannerExternalReferences:
title: plannerExternalReferences
type: object
additionalProperties: true
OfferShiftRequest:
allOf:
- $ref: '#/components/schemas/ScheduleChangeRequest'
- $ref: '#/components/schemas/OfferShiftRequest1'
PrintMultipageLayout:
title: printMultipageLayout
type: string
enum:
- clockwiseFromTopLeft
- counterclockwiseFromTopLeft
- counterclockwiseFromTopRight
- clockwiseFromTopRight
- counterclockwiseFromBottomLeft
- clockwiseFromBottomLeft
- counterclockwiseFromBottomRight
- clockwiseFromBottomRight
- unknownFutureValue
MeetingAttendanceReport1:
title: meetingAttendanceReport
type: object
properties:
externalEventInformation:
type: array
description: The external information of a virtual event. Returned only
for event organizers or coorganizers. Read-only.
items:
$ref: '#/components/schemas/VirtualEventExternalInformation'
meetingEndDateTime:
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: UTC time when the meeting ended. Read-only.
format: date-time
nullable: true
meetingStartDateTime:
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: UTC time when the meeting started. Read-only.
format: date-time
nullable: true
totalParticipantCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Total number of participants. Read-only.
format: int32
nullable: true
attendanceRecords:
type: array
description: List of attendance records of an attendance report. Read-only.
items:
$ref: '#/components/schemas/AttendanceRecord'
x-ms-navigationProperty: true
additionalProperties: true
ChatMessagePolicyViolationDlpActionTypes:
title: chatMessagePolicyViolationDlpActionTypes
type: string
enum:
- none
- notifySender
- blockAccess
- blockAccessExternal
x-ms-enum-flags:
isFlags: true
TodoTaskList1:
title: todoTaskList
type: object
properties:
displayName:
type: string
description: The name of the task list.
nullable: true
isOwner:
type: boolean
description: True if the user is owner of the given task list.
isShared:
type: boolean
description: True if the task list is shared with other users
wellknownListName:
$ref: '#/components/schemas/WellknownListName'
extensions:
type: array
description: The collection of open extensions defined for the task list.
Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
tasks:
type: array
description: The tasks in this task list. Read-only. Nullable.
items:
$ref: '#/components/schemas/TodoTask'
x-ms-navigationProperty: true
additionalProperties: true
OperationStatus:
title: operationStatus
type: string
enum:
- NotStarted
- Running
- Completed
- Failed
Notebook1:
title: notebook
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default notebook. Read-only.
nullable: true
isShared:
type: boolean
description: "Indicates whether the notebook is shared. If true, the contents\
\ of the notebook can be seen by people other than the owner. Read-only."
nullable: true
links:
$ref: '#/components/schemas/NotebookLinks'
sectionGroupsUrl:
type: string
description: "The URL for the sectionGroups navigation property, which returns\
\ all the section groups in the notebook. Read-only."
nullable: true
sectionsUrl:
type: string
description: "The URL for the sections navigation property, which returns\
\ all the sections in the notebook. Read-only."
nullable: true
userRole:
$ref: '#/components/schemas/OnenoteUserRole'
sectionGroups:
type: array
description: The section groups in the notebook. Read-only. Nullable.
items:
$ref: '#/components/schemas/SectionGroup'
x-ms-navigationProperty: true
sections:
type: array
description: The sections in the notebook. Read-only. Nullable.
items:
$ref: '#/components/schemas/OnenoteSection'
x-ms-navigationProperty: true
additionalProperties: true
Deleted:
title: deleted
type: object
properties:
state:
type: string
description: Represents the state of the deleted item.
nullable: true
additionalProperties: true
WorkbookTableRow1:
title: workbookTableRow
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: number
description: The index of the row within the rows collection of the table.
Zero-based. Read-only.
format: int32
values:
$ref: '#/components/schemas/Json'
additionalProperties: true
WorkbookApplication:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookApplication1'
ServicePlanInfo:
title: servicePlanInfo
type: object
properties:
appliesTo:
type: string
description: The object the service plan can be assigned to. The possible
values are:User - service plan can be assigned to individual users.Company
- service plan can be assigned to the entire tenant.
nullable: true
provisioningStatus:
type: string
description: "The provisioning status of the service plan. 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
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: The unique identifier of the service plan.
format: uuid
nullable: true
servicePlanName:
type: string
description: The name of the service plan.
nullable: true
additionalProperties: true
PlannerGroup1:
title: plannerGroup
type: object
properties:
plans:
type: array
description: Read-only. Nullable. Returns the plannerPlans owned by the
group.
items:
$ref: '#/components/schemas/PlannerPlan'
x-ms-navigationProperty: true
additionalProperties: true
WindowsProtectionState1:
title: windowsProtectionState
type: object
properties:
antiMalwareVersion:
type: string
description: Current anti malware version
nullable: true
deviceState:
$ref: '#/components/schemas/WindowsDeviceHealthState'
engineVersion:
type: string
description: Current endpoint protection engine's version
nullable: true
fullScanOverdue:
type: boolean
description: "When TRUE indicates full scan is overdue, when FALSE indicates\
\ full scan is not overdue. Defaults to setting on client device."
nullable: true
fullScanRequired:
type: boolean
description: "When TRUE indicates full scan is required, when FALSE indicates\
\ full scan is not required. Defaults to setting on client device."
nullable: true
isVirtualMachine:
type: boolean
description: "When TRUE indicates the device is a virtual machine, when\
\ FALSE indicates the device is not a virtual machine. Defaults to setting\
\ on client device."
nullable: true
lastFullScanDateTime:
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 quick scan datetime
format: date-time
nullable: true
lastFullScanSignatureVersion:
type: string
description: Last full scan signature version
nullable: true
lastQuickScanDateTime:
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 quick scan datetime
format: date-time
nullable: true
lastQuickScanSignatureVersion:
type: string
description: Last quick scan signature version
nullable: true
lastReportedDateTime:
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 device health status reported time
format: date-time
nullable: true
malwareProtectionEnabled:
type: boolean
description: When TRUE indicates anti malware is enabled when FALSE indicates
anti malware is not enabled.
nullable: true
networkInspectionSystemEnabled:
type: boolean
description: "When TRUE indicates network inspection system enabled, when\
\ FALSE indicates network inspection system is not enabled. Defaults to\
\ setting on client device."
nullable: true
productStatus:
$ref: '#/components/schemas/WindowsDefenderProductStatus'
quickScanOverdue:
type: boolean
description: "When TRUE indicates quick scan is overdue, when FALSE indicates\
\ quick scan is not overdue. Defaults to setting on client device."
nullable: true
realTimeProtectionEnabled:
type: boolean
description: "When TRUE indicates real time protection is enabled, when\
\ FALSE indicates real time protection is not enabled. Defaults to setting\
\ on client device."
nullable: true
rebootRequired:
type: boolean
description: "When TRUE indicates reboot is required, when FALSE indicates\
\ when TRUE indicates reboot is not required. Defaults to setting on client\
\ device."
nullable: true
signatureUpdateOverdue:
type: boolean
description: "When TRUE indicates signature is out of date, when FALSE indicates\
\ signature is not out of date. Defaults to setting on client device."
nullable: true
signatureVersion:
type: string
description: Current malware definitions version
nullable: true
tamperProtectionEnabled:
type: boolean
description: "When TRUE indicates the Windows Defender tamper protection\
\ feature is enabled, when FALSE indicates the Windows Defender tamper\
\ protection feature is not enabled. Defaults to setting on client device."
nullable: true
detectedMalwareState:
type: array
description: Device malware list
items:
$ref: '#/components/schemas/WindowsDeviceMalwareState'
x-ms-navigationProperty: true
additionalProperties: true
description: Device protection status entity
Workbook:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Workbook1'
SettingSourceType:
title: settingSourceType
type: string
enum:
- deviceConfiguration
- deviceIntent
TeamsAppDefinition1:
title: teamsAppDefinition
type: object
properties:
authorization:
$ref: '#/components/schemas/TeamsAppAuthorization'
createdBy:
$ref: '#/components/schemas/IdentitySet'
description:
type: string
description: Verbose description of the application.
nullable: true
displayName:
type: string
description: The name of the app provided by the app developer.
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
format: date-time
nullable: true
publishingState:
$ref: '#/components/schemas/TeamsAppPublishingState'
shortDescription:
type: string
description: Short description of the application.
nullable: true
teamsAppId:
type: string
description: The ID from the Teams app manifest.
nullable: true
version:
type: string
description: The version number of the application.
nullable: true
bot:
$ref: '#/components/schemas/TeamworkBot'
additionalProperties: true
WorkbookChartLegendFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartLegendFormat1'
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
AuthenticationPhoneType:
title: authenticationPhoneType
type: string
enum:
- mobile
- alternateMobile
- office
- unknownFutureValue
TeamworkUserIdentity:
allOf:
- $ref: '#/components/schemas/Identity'
- $ref: '#/components/schemas/TeamworkUserIdentity1'
DeviceManagementTroubleshootingEvent1:
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
PrintJobConfiguration:
title: printJobConfiguration
type: object
properties:
collate:
type: boolean
description: Whether the printer should collate pages wehen printing multiple
copies of a multi-page document.
nullable: true
colorMode:
$ref: '#/components/schemas/PrintColorMode'
copies:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of copies that should be printed. Read-only.
format: int32
nullable: true
dpi:
maximum: 2147483647
minimum: -2147483648
type: number
description: "The resolution to use when printing the job, expressed in\
\ dots per inch (DPI). Read-only."
format: int32
nullable: true
duplexMode:
$ref: '#/components/schemas/PrintDuplexMode'
feedOrientation:
$ref: '#/components/schemas/PrinterFeedOrientation'
finishings:
type: array
description: Finishing processes to use when printing.
items:
$ref: '#/components/schemas/PrintFinishing'
fitPdfToPage:
type: boolean
description: True to fit each page of a PDF document to a physical sheet
of media; false to let the printer decide how to lay out impressions.
nullable: true
inputBin:
type: string
description: The input bin (tray) to use when printing. See the printer's
capabilities for a list of supported input bins.
nullable: true
margin:
$ref: '#/components/schemas/PrintMargin'
mediaSize:
type: string
description: The media size to use when printing. Supports standard size
names for ISO and ANSI media sizes. Valid values listed in the printerCapabilities
topic.
nullable: true
mediaType:
type: string
description: The default media (such as paper) type to print the document
on.
nullable: true
multipageLayout:
$ref: '#/components/schemas/PrintMultipageLayout'
orientation:
$ref: '#/components/schemas/PrintOrientation'
outputBin:
type: string
description: The output bin to place completed prints into. See the printer's
capabilities for a list of supported output bins.
nullable: true
pageRanges:
type: array
description: The page ranges to print. Read-only.
items:
$ref: '#/components/schemas/IntegerRange'
pagesPerSheet:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of document pages to print on each sheet.
format: int32
nullable: true
quality:
$ref: '#/components/schemas/PrintQuality'
scaling:
$ref: '#/components/schemas/PrintScaling'
additionalProperties: true
WorkbookChart1:
title: workbookChart
type: object
properties:
height:
type: number
description: "Represents the height, in points, of the chart object."
format: double
nullable: true
left:
type: number
description: "The distance, in points, from the left side of the chart to\
\ the worksheet origin."
format: double
nullable: true
name:
type: string
description: Represents the name of a chart object.
nullable: true
top:
type: number
description: "Represents the distance, in points, from the top edge of the\
\ object to the top of row 1 (on a worksheet) or the top of the chart\
\ area (on a chart)."
format: double
nullable: true
width:
type: number
description: "Represents the width, in points, of the chart object."
format: double
nullable: true
axes:
$ref: '#/components/schemas/WorkbookChartAxes'
dataLabels:
$ref: '#/components/schemas/WorkbookChartDataLabels'
format:
$ref: '#/components/schemas/WorkbookChartAreaFormat'
legend:
$ref: '#/components/schemas/WorkbookChartLegend'
series:
type: array
description: Represents either a single series or collection of series in
the chart. Read-only.
items:
$ref: '#/components/schemas/WorkbookChartSeries'
x-ms-navigationProperty: true
title:
$ref: '#/components/schemas/WorkbookChartTitle'
worksheet:
$ref: '#/components/schemas/WorkbookWorksheet'
additionalProperties: true
DataSecurityAndGovernance1:
title: dataSecurityAndGovernance
type: object
properties:
sensitivityLabels:
type: array
items:
$ref: '#/components/schemas/SensitivityLabel'
x-ms-navigationProperty: true
additionalProperties: true
TeamsAppAuthorization:
title: teamsAppAuthorization
type: object
properties:
clientAppId:
type: string
description: The registration ID of the Microsoft Entra app ID associated
with the teamsApp.
nullable: true
requiredPermissionSet:
$ref: '#/components/schemas/TeamsAppPermissionSet'
additionalProperties: true
Event1:
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
description: The collection of attendees for the event.
items:
$ref: '#/components/schemas/Attendee'
body:
$ref: '#/components/schemas/ItemBody'
bodyPreview:
type: string
description: The preview of the message associated with the event. It's
in text format.
nullable: true
cancelledOccurrences:
type: array
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."
items:
type: string
end:
$ref: '#/components/schemas/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/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/Location'
locations:
type: array
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."
items:
$ref: '#/components/schemas/Location'
onlineMeeting:
$ref: '#/components/schemas/OnlineMeetingInfo'
onlineMeetingProvider:
$ref: '#/components/schemas/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/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/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/ResponseStatus'
sensitivity:
$ref: '#/components/schemas/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/FreeBusyStatus'
start:
$ref: '#/components/schemas/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/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
description: "The collection of FileAttachment, ItemAttachment, and referenceAttachment\
\ attachments for the event. Navigation property. Read-only. Nullable."
items:
$ref: '#/components/schemas/Attachment'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/Calendar'
exceptionOccurrences:
type: array
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."
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
extensions:
type: array
description: The collection of open extensions defined for the event. Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
instances:
type: array
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."
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
description: The collection of multi-value extended properties defined for
the event. Read-only. Nullable.
items:
$ref: '#/components/schemas/MultiValueLegacyExtendedProperty'
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
description: The collection of single-value extended properties defined
for the event. Read-only. Nullable.
items:
$ref: '#/components/schemas/SingleValueLegacyExtendedProperty'
x-ms-navigationProperty: true
additionalProperties: true
PrinterShare1:
title: printerShare
type: object
properties:
allowAllUsers:
type: boolean
description: "If true, all users and groups will be granted access to this\
\ printer share. This supersedes the allow lists defined by the allowedUsers\
\ and allowedGroups navigation 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 DateTimeOffset when the printer share was created. Read-only.
format: date-time
viewPoint:
$ref: '#/components/schemas/PrinterShareViewpoint'
allowedGroups:
type: array
description: The groups whose users have access to print using the printer.
items:
$ref: '#/components/schemas/Group'
x-ms-navigationProperty: true
allowedUsers:
type: array
description: The users who have access to print using the printer.
items:
$ref: '#/components/schemas/User'
x-ms-navigationProperty: true
printer:
$ref: '#/components/schemas/Printer'
additionalProperties: true
Shift:
allOf:
- $ref: '#/components/schemas/ChangeTrackedEntity'
- $ref: '#/components/schemas/Shift1'
PasswordAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/PasswordAuthenticationMethod1'
ChatMessage:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ChatMessage1'
ItemActivityStat1:
title: itemActivityStat
type: object
properties:
access:
$ref: '#/components/schemas/ItemActionStat'
create:
$ref: '#/components/schemas/ItemActionStat'
delete:
$ref: '#/components/schemas/ItemActionStat'
edit:
$ref: '#/components/schemas/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/IncompleteData'
isTrending:
type: boolean
description: Indicates whether the item is 'trending.' Read-only.
nullable: true
move:
$ref: '#/components/schemas/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
description: Exposes the itemActivities represented in this itemActivityStat
resource.
items:
$ref: '#/components/schemas/ItemActivity'
x-ms-navigationProperty: true
additionalProperties: true
AssignedLabel:
title: assignedLabel
type: object
properties:
displayName:
type: string
description: The display name of the label. Read-only.
nullable: true
labelId:
type: string
description: The unique identifier of the label.
nullable: true
additionalProperties: true
PrintDocument1:
title: printDocument
type: object
properties:
contentType:
type: string
description: The document's content (MIME) type. Read-only.
nullable: true
displayName:
type: string
description: The document's name. Read-only.
nullable: true
downloadedDateTime:
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 the document was downloaded. Read-only
format: date-time
nullable: true
size:
type: number
description: The document's size in bytes. Read-only.
format: int64
uploadedDateTime:
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 the document was uploaded. Read-only
format: date-time
nullable: true
additionalProperties: true
TeamInfo:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamInfo1'
PlannerUserIds:
title: plannerUserIds
type: object
additionalProperties: true
RecurrenceRangeType:
title: recurrenceRangeType
type: string
enum:
- endDate
- noEnd
- numbered
Term:
title: term
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: Date and time of term creation. Read-only.
format: date-time
nullable: true
descriptions:
type: array
description: Description about term that is dependent on the languageTag.
items:
$ref: '#/components/schemas/TermStoreLocalizedDescription'
labels:
type: array
description: Label metadata for a term.
items:
$ref: '#/components/schemas/TermStoreLocalizedLabel'
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: Last date and time of term modification. Read-only.
format: date-time
nullable: true
properties:
type: array
description: Collection of properties on the term.
items:
$ref: '#/components/schemas/KeyValue'
children:
type: array
description: Children of current term.
items:
$ref: '#/components/schemas/TermStoreTerm'
x-ms-navigationProperty: true
relations:
type: array
description: To indicate which terms are related to the current term as
either pinned or reused.
items:
$ref: '#/components/schemas/TermStoreRelation'
x-ms-navigationProperty: true
set:
$ref: '#/components/schemas/TermStoreSet'
additionalProperties: true
MessageRuleActions:
title: messageRuleActions
type: object
properties:
assignCategories:
type: array
description: A list of categories to be assigned to a message.
items:
type: string
nullable: true
copyToFolder:
type: string
description: The ID of a folder that a message is to be copied to.
nullable: true
delete:
type: boolean
description: Indicates whether a message should be moved to the Deleted
Items folder.
nullable: true
forwardAsAttachmentTo:
type: array
description: The email addresses of the recipients to which a message should
be forwarded as an attachment.
items:
$ref: '#/components/schemas/Recipient'
forwardTo:
type: array
description: The email addresses of the recipients to which a message should
be forwarded.
items:
$ref: '#/components/schemas/Recipient'
markAsRead:
type: boolean
description: Indicates whether a message should be marked as read.
nullable: true
markImportance:
$ref: '#/components/schemas/Importance'
moveToFolder:
type: string
description: The ID of the folder that a message will be moved to.
nullable: true
permanentDelete:
type: boolean
description: Indicates whether a message should be permanently deleted and
not saved to the Deleted Items folder.
nullable: true
redirectTo:
type: array
description: The email addresses to which a message should be redirected.
items:
$ref: '#/components/schemas/Recipient'
stopProcessingRules:
type: boolean
description: Indicates whether subsequent rules should be evaluated.
nullable: true
additionalProperties: true
TermStoreTermGroupScope:
title: termGroupScope
type: string
enum:
- global
- system
- siteCollection
- unknownFutureValue
BroadcastMeetingAudience:
title: broadcastMeetingAudience
type: string
enum:
- roleIsAttendee
- organization
- everyone
- unknownFutureValue
DriveItemSource:
title: driveItemSource
type: object
properties:
application:
$ref: '#/components/schemas/DriveItemSourceApplication'
externalId:
type: string
description: The external identifier for the drive item from the source.
nullable: true
additionalProperties: true
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
ChatMessageInfo:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ChatMessageInfo1'
DocumentSet:
title: documentSet
type: object
properties:
allowedContentTypes:
type: array
description: Content types allowed in document set.
items:
$ref: '#/components/schemas/ContentTypeInfo'
defaultContents:
type: array
description: Default contents of document set.
items:
$ref: '#/components/schemas/DocumentSetContent'
propagateWelcomePageChanges:
type: boolean
description: Specifies whether to push welcome page changes to inherited
content types.
nullable: true
shouldPrefixNameToFile:
type: boolean
description: Indicates whether to add the name of the document set to each
file name.
nullable: true
welcomePageUrl:
type: string
description: Welcome page absolute URL.
nullable: true
sharedColumns:
type: array
items:
$ref: '#/components/schemas/ColumnDefinition'
x-ms-navigationProperty: true
welcomePageColumns:
type: array
items:
$ref: '#/components/schemas/ColumnDefinition'
x-ms-navigationProperty: true
additionalProperties: true
TermStoreRelation:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Relation'
Attendee1:
title: attendee
type: object
properties:
proposedNewTime:
$ref: '#/components/schemas/TimeSlot'
status:
$ref: '#/components/schemas/ResponseStatus'
additionalProperties: true
AutomaticRepliesStatus:
title: automaticRepliesStatus
type: string
enum:
- disabled
- alwaysEnabled
- scheduled
DriveItemIdMicrosoftGraphValidatePermissionBody:
type: object
properties:
challengeToken:
type: string
nullable: true
password:
type: string
additionalProperties: true
ServiceStorageQuotaBreakdown1:
title: serviceStorageQuotaBreakdown
type: object
additionalProperties: true
TeamworkConversationIdentity:
allOf:
- $ref: '#/components/schemas/Identity'
- $ref: '#/components/schemas/TeamworkConversationIdentity1'
PrinterProcessingState:
title: printerProcessingState
type: string
enum:
- unknown
- idle
- processing
- stopped
- unknownFutureValue
PrinterDefaults:
title: printerDefaults
type: object
properties:
colorMode:
$ref: '#/components/schemas/PrintColorMode'
contentType:
type: string
description: The default content (MIME) type to use when processing documents.
nullable: true
copiesPerJob:
maximum: 2147483647
minimum: -2147483648
type: number
description: The default number of copies printed per job.
format: int32
nullable: true
dpi:
maximum: 2147483647
minimum: -2147483648
type: number
description: The default resolution in DPI to use when printing the job.
format: int32
nullable: true
duplexMode:
$ref: '#/components/schemas/PrintDuplexMode'
finishings:
type: array
description: The default set of finishings to apply to print jobs. Valid
values are described in the following table.
items:
$ref: '#/components/schemas/PrintFinishing'
fitPdfToPage:
type: boolean
description: The default fitPdfToPage setting. True to fit each page of
a PDF document to a physical sheet of media; false to let the printer
decide how to lay out impressions.
nullable: true
inputBin:
type: string
description: The default input bin that serves as the paper source.
nullable: true
mediaColor:
type: string
description: The default media (such as paper) color to print the document
on.
nullable: true
mediaSize:
type: string
description: The default media size to use. Supports standard size names
for ISO and ANSI media sizes. Valid values are listed in the printerCapabilities
topic.
nullable: true
mediaType:
type: string
description: The default media (such as paper) type to print the document
on.
nullable: true
multipageLayout:
$ref: '#/components/schemas/PrintMultipageLayout'
orientation:
$ref: '#/components/schemas/PrintOrientation'
outputBin:
type: string
description: The default output bin to place completed prints into. See
the printer's capabilities for a list of supported output bins.
nullable: true
pagesPerSheet:
maximum: 2147483647
minimum: -2147483648
type: number
description: The default number of document pages to print on each sheet.
format: int32
nullable: true
quality:
$ref: '#/components/schemas/PrintQuality'
scaling:
$ref: '#/components/schemas/PrintScaling'
additionalProperties: true
StoragePlanInformation:
title: storagePlanInformation
type: object
properties:
upgradeAvailable:
type: boolean
description: Indicates whether there are higher storage quota plans available.
Read-only.
nullable: true
additionalProperties: true
ManagedAppPolicy1:
title: managedAppPolicy
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 the policy was created.
format: date-time
description:
type: string
description: The policy's description.
nullable: true
displayName:
type: string
description: Policy display name.
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: Last time the policy was modified.
format: date-time
version:
type: string
description: Version of the entity.
nullable: true
additionalProperties: true
description: The ManagedAppPolicy resource represents a base type for platform
specific policies
TeamsApp:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamsApp1'
OnenoteEntityBaseModel:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/OnenoteEntityBaseModel1'
TeamworkOnlineMeetingInfo:
title: teamworkOnlineMeetingInfo
type: object
properties:
calendarEventId:
type: string
description: The identifier of the calendar event associated with the meeting.
nullable: true
joinWebUrl:
type: string
description: The URL that users click to join or uniquely identify the meeting.
nullable: true
organizer:
$ref: '#/components/schemas/TeamworkUserIdentity'
additionalProperties: true
ContentActivity:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ContentActivity1'
AllowedLobbyAdmitterRoles:
title: allowedLobbyAdmitterRoles
type: string
enum:
- organizerAndCoOrganizersAndPresenters
- organizerAndCoOrganizers
- unknownFutureValue
ShiftItem1:
title: shiftItem
type: object
properties:
activities:
type: array
description: "An incremental part of a shift which can cover details of\
\ when and where an employee is during their shift. For example, an assignment\
\ or a scheduled break or lunch. Required."
items:
$ref: '#/components/schemas/ShiftActivity'
displayName:
type: string
description: The shift label of the shiftItem.
nullable: true
notes:
type: string
description: The shift notes for the shiftItem.
nullable: true
additionalProperties: true
MessageRule:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/MessageRule1'
UserTeamwork1:
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
description: The list of associatedTeamInfo objects that a user is associated
with.
items:
$ref: '#/components/schemas/AssociatedTeamInfo'
x-ms-navigationProperty: true
installedApps:
type: array
description: The apps installed in the personal scope of this user.
items:
$ref: '#/components/schemas/UserScopeTeamsAppInstallation'
x-ms-navigationProperty: true
additionalProperties: true
MeetingParticipants:
title: meetingParticipants
type: object
properties:
attendees:
type: array
description: Information about the meeting attendees.
items:
$ref: '#/components/schemas/MeetingParticipantInfo'
organizer:
$ref: '#/components/schemas/MeetingParticipantInfo'
additionalProperties: true
ContentTypeCollectionResponse:
title: Collection of contentType
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/ContentType'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
PlannerOrderHintsByAssignee:
title: plannerOrderHintsByAssignee
type: object
additionalProperties: true
ReferenceNumeric:
type: string
nullable: true
enum:
- -INF
- INF
- NaN
LongRunningOperation:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/LongRunningOperation1'
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/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
DayNote:
allOf:
- $ref: '#/components/schemas/ChangeTrackedEntity'
- $ref: '#/components/schemas/DayNote1'
WorkbookWorksheetProtection1:
title: workbookWorksheetProtection
type: object
properties:
options:
$ref: '#/components/schemas/WorkbookWorksheetProtectionOptions'
protected:
type: boolean
description: Indicates whether the worksheet is protected. Read-only.
additionalProperties: true
WorkbookPivotTable1:
title: workbookPivotTable
type: object
properties:
name:
type: string
description: The name of the pivot table.
nullable: true
worksheet:
$ref: '#/components/schemas/WorkbookWorksheet'
additionalProperties: true
ListItem:
allOf:
- $ref: '#/components/schemas/BaseItem'
- $ref: '#/components/schemas/ListItem1'
DriveItemVersion1:
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
TeamworkBot1:
title: teamworkBot
type: object
additionalProperties: true
NumberColumn:
title: numberColumn
type: object
properties:
decimalPlaces:
type: string
description: How many decimal places to display. See below for information
about the possible values.
nullable: true
displayAs:
type: string
description: "How the value should be presented in the UX. Must be one of\
\ number or percentage. If unspecified, treated as number."
nullable: true
maximum:
type: number
description: The maximum permitted value.
format: double
nullable: true
minimum:
type: number
description: The minimum permitted value.
format: double
nullable: true
additionalProperties: true
OfferShiftRequest1:
title: offerShiftRequest
type: object
properties:
recipientActionDateTime:
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 recipient approved or declined the
request.
format: date-time
nullable: true
readOnly: true
recipientActionMessage:
type: string
description: The message sent by the recipient regarding the request.
nullable: true
recipientUserId:
type: string
description: The recipient's user ID.
nullable: true
senderShiftId:
type: string
description: The sender's shift ID.
nullable: true
additionalProperties: true
SiteCollection:
title: siteCollection
type: object
properties:
archivalDetails:
$ref: '#/components/schemas/SiteArchivalDetails'
dataLocationCode:
type: string
description: The geographic region code for where this site collection resides.
Only present for multi-geo tenants. Read-only.
nullable: true
hostname:
type: string
description: The hostname for the site collection. Read-only.
nullable: true
root:
$ref: '#/components/schemas/Root'
additionalProperties: true
DeviceConfigurationState:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/DeviceConfigurationState1'
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
PlannerPlanDetails1:
title: plannerPlanDetails
type: object
properties:
categoryDescriptions:
$ref: '#/components/schemas/PlannerCategoryDescriptions'
sharedWith:
$ref: '#/components/schemas/PlannerUserIds'
additionalProperties: true
LabelActionSource:
title: labelActionSource
type: string
enum:
- manual
- automatic
- recommended
- none
- unknownFutureValue
ActivityMetadata:
title: activityMetadata
type: object
properties:
activity:
$ref: '#/components/schemas/UserActivityType'
additionalProperties: true
AuthenticationMethod1:
title: authenticationMethod
type: object
additionalProperties: true
PrinterShareViewpoint:
title: printerShareViewpoint
type: object
properties:
lastUsedDateTime:
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 the printer was last used by the signed-in\
\ user. 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
additionalProperties: true
PrinterShare:
allOf:
- $ref: '#/components/schemas/PrinterBase'
- $ref: '#/components/schemas/PrinterShare1'
ActivityHistoryItem1:
title: activityHistoryItem
type: object
properties:
activeDurationSeconds:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Optional. The duration of active user engagement. if not supplied,\
\ this is calculated from the startedDateTime and lastActiveDateTime."
format: int32
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: Optional. UTC DateTime when the activityHistoryItem will undergo
hard-delete. Can be set by the client.
format: date-time
nullable: true
lastActiveDateTime:
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: "Optional. UTC DateTime when the activityHistoryItem (activity\
\ session) was last understood as active or finished - if null, activityHistoryItem\
\ status should be Ongoing."
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: Set by the server. DateTime in UTC when the object was modified
on the server.
format: date-time
nullable: true
startedDateTime:
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. UTC DateTime when the activityHistoryItem (activity
session) was started. Required for timeline history.
format: date-time
status:
$ref: '#/components/schemas/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
activity:
$ref: '#/components/schemas/UserActivity'
additionalProperties: true
DeviceCategory:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/DeviceCategory1'
OnlineMeetingRole:
title: onlineMeetingRole
type: string
enum:
- attendee
- presenter
- unknownFutureValue
- producer
- coorganizer
TeamsApp1:
title: teamsApp
type: object
properties:
displayName:
type: string
description: The name of the catalog app provided by the app developer in
the Microsoft Teams zip app package.
nullable: true
distributionMethod:
$ref: '#/components/schemas/TeamsAppDistributionMethod'
externalId:
type: string
description: The ID of the catalog provided by the app developer in the
Microsoft Teams zip app package.
nullable: true
appDefinitions:
type: array
description: The details for each version of the app.
items:
$ref: '#/components/schemas/TeamsAppDefinition'
x-ms-navigationProperty: true
additionalProperties: true
Printer1:
title: printer
type: object
properties:
hasPhysicalDevice:
type: boolean
description: True if the printer has a physical device for printing. Read-only.
isShared:
type: boolean
description: True if the printer is shared; false otherwise. Read-only.
lastSeenDateTime:
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 most recent dateTimeOffset when a printer interacted with
Universal Print. Read-only.
format: date-time
nullable: true
registeredDateTime:
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 DateTimeOffset when the printer was registered. Read-only.
format: date-time
connectors:
type: array
description: The connectors that are associated with the printer.
items:
$ref: '#/components/schemas/PrintConnector'
x-ms-navigationProperty: true
shares:
type: array
description: "The list of printerShares that are associated with the printer.\
\ Currently, only one printerShare can be associated with the printer.\
\ Read-only. Nullable."
items:
$ref: '#/components/schemas/PrinterShare'
x-ms-navigationProperty: true
taskTriggers:
type: array
description: A list of task triggers that are associated with the printer.
items:
$ref: '#/components/schemas/PrintTaskTrigger'
x-ms-navigationProperty: true
additionalProperties: true
ComplianceStatus:
title: complianceStatus
type: string
enum:
- unknown
- notApplicable
- compliant
- remediated
- nonCompliant
- error
- conflict
- notAssigned
HyperlinkOrPictureColumn:
title: hyperlinkOrPictureColumn
type: object
properties:
isPicture:
type: boolean
description: Specifies whether the display format used for URL columns is
an image or a hyperlink.
nullable: true
additionalProperties: true
Json:
title: Json
type: object
additionalProperties: true
ODataErrorsMainError:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
x-ms-primary-error-message: true
target:
type: string
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/ODataErrorsErrorDetails'
innerError:
$ref: '#/components/schemas/ODataErrorsInnerError'
additionalProperties: true
PlatformCredentialAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/PlatformCredentialAuthenticationMethod1'
ProtectedApplicationMetadata1:
title: protectedApplicationMetadata
type: object
properties:
applicationLocation:
$ref: '#/components/schemas/PolicyLocation'
additionalProperties: true
MeetingParticipantInfo:
title: meetingParticipantInfo
type: object
properties:
identity:
$ref: '#/components/schemas/IdentitySet'
role:
$ref: '#/components/schemas/OnlineMeetingRole'
upn:
type: string
description: User principal name of the participant.
nullable: true
additionalProperties: true
SettingValue:
title: settingValue
type: object
properties:
name:
type: string
description: Name of the setting (as defined by the groupSettingTemplate).
nullable: true
value:
type: string
description: Value of the setting.
nullable: true
additionalProperties: true
ColumnLink1:
title: columnLink
type: object
properties:
name:
type: string
description: The name of the column in this content type.
nullable: true
additionalProperties: true
TeamsAppInstallation:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamsAppInstallation1'
WorkbookChartDataLabelFormat1:
title: workbookChartDataLabelFormat
type: object
properties:
fill:
$ref: '#/components/schemas/WorkbookChartFill'
font:
$ref: '#/components/schemas/WorkbookChartFont'
additionalProperties: true
Person:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Person1'
DateTimeColumn:
title: dateTimeColumn
type: object
properties:
displayAs:
type: string
description: "How the value should be presented in the UX. Must be one of\
\ default, friendly, or standard. See below for more details. If unspecified,\
\ treated as default."
nullable: true
format:
type: string
description: Indicates whether the value should be presented as a date only
or a date and time. Must be one of dateOnly or dateTime
nullable: true
additionalProperties: true
PlannerAssignedToTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerAssignedToTaskBoardTaskFormat1'
TeamMemberSettings:
title: teamMemberSettings
type: object
properties:
allowAddRemoveApps:
type: boolean
description: "If set to true, members can add and remove apps."
nullable: true
allowCreatePrivateChannels:
type: boolean
description: "If set to true, members can add and update private channels."
nullable: true
allowCreateUpdateChannels:
type: boolean
description: "If set to true, members can add and update channels."
nullable: true
allowCreateUpdateRemoveConnectors:
type: boolean
description: "If set to true, members can add, update, and remove connectors."
nullable: true
allowCreateUpdateRemoveTabs:
type: boolean
description: "If set to true, members can add, update, and remove tabs."
nullable: true
allowDeleteChannels:
type: boolean
description: "If set to true, members can delete channels."
nullable: true
additionalProperties: true
WorkbookChartGridlinesFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartGridlinesFormat1'
TermStoreLocalizedName:
title: localizedName
type: object
properties:
languageTag:
type: string
description: The language tag for the label.
nullable: true
name:
type: string
description: The name in the localized language.
nullable: true
additionalProperties: true
User1:
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
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)."
items:
$ref: '#/components/schemas/AssignedLicense'
assignedPlans:
type: array
description: The plans that are assigned to the user. Read-only. Not nullable.
Returned only on $select. Supports $filter (eq and not).
items:
$ref: '#/components/schemas/AssignedPlan'
authorizationInfo:
$ref: '#/components/schemas/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
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)."
items:
type: string
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/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/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
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."
items:
$ref: '#/components/schemas/ObjectIdentity'
imAddresses:
type: array
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)."
items:
type: string
nullable: true
interests:
type: array
description: A list for the user to describe their interests. Returned only
on $select.
items:
type: string
nullable: true
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
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.
items:
$ref: '#/components/schemas/LicenseAssignmentState'
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/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/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
description: "Errors when using Microsoft synchronization product during\
\ provisioning. Returned only on $select. Supports $filter (eq, not, ge,\
\ le)."
items:
$ref: '#/components/schemas/OnPremisesProvisioningError'
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
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)."
items:
type: string
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/PasswordProfile'
pastProjects:
type: array
description: A list for the user to enumerate their past projects. Returned
only on $select.
items:
type: string
nullable: true
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/UserPrint'
provisionedPlans:
type: array
description: "The plans that are provisioned for the user. Read-only. Not\
\ nullable. Returned only on $select. Supports $filter (eq, not, ge, le)."
items:
$ref: '#/components/schemas/ProvisionedPlan'
proxyAddresses:
type: array
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)."
items:
type: string
responsibilities:
type: array
description: A list for the user to enumerate their responsibilities. Returned
only on $select.
items:
type: string
nullable: true
schools:
type: array
description: A list for the user to enumerate the schools they attended.
Returned only on $select.
items:
type: string
nullable: true
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
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)."
items:
$ref: '#/components/schemas/ServiceProvisioningError'
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/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
description: A list for the user to enumerate their skills. Returned only
on $select.
items:
type: string
nullable: true
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
description: The user's activities across devices. Read-only. Nullable.
items:
$ref: '#/components/schemas/UserActivity'
x-ms-navigationProperty: true
agreementAcceptances:
type: array
description: The user's terms of use acceptance statuses. Read-only. Nullable.
items:
$ref: '#/components/schemas/AgreementAcceptance'
x-ms-navigationProperty: true
appRoleAssignments:
type: array
description: Represents the app roles a user is granted for an application.
Supports $expand.
items:
$ref: '#/components/schemas/AppRoleAssignment'
x-ms-navigationProperty: true
authentication:
$ref: '#/components/schemas/Authentication'
calendar:
$ref: '#/components/schemas/Calendar'
calendarGroups:
type: array
description: The user's calendar groups. Read-only. Nullable.
items:
$ref: '#/components/schemas/CalendarGroup'
x-ms-navigationProperty: true
calendars:
type: array
description: The user's calendars. Read-only. Nullable.
items:
$ref: '#/components/schemas/Calendar'
x-ms-navigationProperty: true
calendarView:
type: array
description: The calendar view for the calendar. Read-only. Nullable.
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
chats:
type: array
items:
$ref: '#/components/schemas/Chat'
x-ms-navigationProperty: true
cloudClipboard:
$ref: '#/components/schemas/CloudClipboardRoot'
contactFolders:
type: array
description: The user's contacts folders. Read-only. Nullable.
items:
$ref: '#/components/schemas/ContactFolder'
x-ms-navigationProperty: true
contacts:
type: array
description: The user's contacts. Read-only. Nullable.
items:
$ref: '#/components/schemas/Contact'
x-ms-navigationProperty: true
createdObjects:
type: array
description: Directory objects that the user created. Read-only. Nullable.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
dataSecurityAndGovernance:
$ref: '#/components/schemas/UserDataSecurityAndGovernance'
deviceManagementTroubleshootingEvents:
type: array
description: The list of troubleshooting events for this user.
items:
$ref: '#/components/schemas/DeviceManagementTroubleshootingEvent'
x-ms-navigationProperty: true
directReports:
type: array
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.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/Drive'
drives:
type: array
description: A collection of drives available for this user. Read-only.
items:
$ref: '#/components/schemas/Drive'
x-ms-navigationProperty: true
employeeExperience:
$ref: '#/components/schemas/EmployeeExperienceUser'
events:
type: array
description: The user's events. Default is to show Events under the Default
Calendar. Read-only. Nullable.
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
extensions:
type: array
description: The collection of open extensions defined for the user. Read-only.
Supports $expand. Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
followedSites:
type: array
items:
$ref: '#/components/schemas/Site'
x-ms-navigationProperty: true
inferenceClassification:
$ref: '#/components/schemas/InferenceClassification'
insights:
$ref: '#/components/schemas/ItemInsights'
joinedTeams:
type: array
items:
$ref: '#/components/schemas/Team'
x-ms-navigationProperty: true
licenseDetails:
type: array
description: A collection of this user's license details. Read-only.
items:
$ref: '#/components/schemas/LicenseDetails'
x-ms-navigationProperty: true
mailFolders:
type: array
description: The user's mail folders. Read-only. Nullable.
items:
$ref: '#/components/schemas/MailFolder'
x-ms-navigationProperty: true
managedAppRegistrations:
type: array
description: Zero or more managed app registrations that belong to the user.
items:
$ref: '#/components/schemas/ManagedAppRegistration'
x-ms-navigationProperty: true
managedDevices:
type: array
description: The managed devices associated with the user.
items:
$ref: '#/components/schemas/ManagedDevice'
x-ms-navigationProperty: true
manager:
$ref: '#/components/schemas/DirectoryObject'
memberOf:
type: array
description: The groups and directory roles that the user is a member of.
Read-only. Nullable. Supports $expand.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
messages:
type: array
description: The messages in a mailbox or folder. Read-only. Nullable.
items:
$ref: '#/components/schemas/Message'
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/OAuth2PermissionGrant'
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/Onenote'
onlineMeetings:
type: array
description: "Information about a meeting, including the URL used to join\
\ a meeting, the attendees list, and the description."
items:
$ref: '#/components/schemas/OnlineMeeting'
x-ms-navigationProperty: true
outlook:
$ref: '#/components/schemas/OutlookUser'
ownedDevices:
type: array
description: "Devices the user owns. Read-only. Nullable. Supports $expand\
\ and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1)."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
ownedObjects:
type: array
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)."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
people:
type: array
description: People that are relevant to the user. Read-only. Nullable.
items:
$ref: '#/components/schemas/Person'
x-ms-navigationProperty: true
permissionGrants:
type: array
description: List all resource-specific permission grants of a user.
items:
$ref: '#/components/schemas/ResourceSpecificPermissionGrant'
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/ProfilePhoto'
photos:
type: array
description: The collection of the user's profile photos in different sizes.
Read-only.
items:
$ref: '#/components/schemas/ProfilePhoto'
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/PlannerUser'
presence:
$ref: '#/components/schemas/Presence'
registeredDevices:
type: array
description: Devices that are registered for the user. Read-only. Nullable.
Supports $expand and returns up to 100 objects.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
scopedRoleMemberOf:
type: array
items:
$ref: '#/components/schemas/ScopedRoleMembership'
x-ms-navigationProperty: true
settings:
$ref: '#/components/schemas/UserSettings'
solutions:
$ref: '#/components/schemas/UserSolutionRoot'
sponsors:
type: array
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."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
teamwork:
$ref: '#/components/schemas/UserTeamwork'
todo:
$ref: '#/components/schemas/Todo'
transitiveMemberOf:
type: array
description: "The groups, including nested groups, and directory roles that\
\ a user is a member of. Nullable."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
additionalProperties: true
description: Represents a Microsoft Entra user account
OnenoteUserRole:
title: onenoteUserRole
type: string
enum:
- None
- Owner
- Contributor
- Reader
SharePointIdentitySet1:
title: sharePointIdentitySet
type: object
properties:
group:
$ref: '#/components/schemas/Identity'
siteGroup:
$ref: '#/components/schemas/SharePointIdentity'
siteUser:
$ref: '#/components/schemas/SharePointIdentity'
additionalProperties: true
MeetingChatHistoryDefaultMode:
title: meetingChatHistoryDefaultMode
type: string
enum:
- none
- all
- unknownFutureValue
BodyType:
title: bodyType
type: string
enum:
- text
- html
DeviceManagementTroubleshootingEvent:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/DeviceManagementTroubleshootingEvent1'
LicenseDetails:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/LicenseDetails1'
ManagedAppRegistration1:
title: managedAppRegistration
type: object
properties:
appIdentifier:
$ref: '#/components/schemas/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
description: Zero or more reasons an app registration is flagged. E.g. app
running on rooted device
items:
$ref: '#/components/schemas/ManagedAppFlaggedReason'
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
description: Zero or more policys already applied on the registered app
when it last synchronized with managment service.
items:
$ref: '#/components/schemas/ManagedAppPolicy'
x-ms-navigationProperty: true
intendedPolicies:
type: array
description: Zero or more policies admin intended for the app as of now.
items:
$ref: '#/components/schemas/ManagedAppPolicy'
x-ms-navigationProperty: true
operations:
type: array
description: Zero or more long running operations triggered on the app registration.
items:
$ref: '#/components/schemas/ManagedAppOperation'
x-ms-navigationProperty: true
additionalProperties: true
description: The ManagedAppEntity is the base entity type for all other entity
types under app management workflow
PlannerTaskDetails:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerTaskDetails1'
ScopedRoleMembership1:
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/Identity'
additionalProperties: true
WorkbookChartLineFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartLineFormat1'
UserDataSecurityAndGovernance:
allOf:
- $ref: '#/components/schemas/DataSecurityAndGovernance'
- $ref: '#/components/schemas/UserDataSecurityAndGovernance1'
OfficeGraphInsights1:
title: officeGraphInsights
type: object
properties:
shared:
type: array
description: "Calculated relationship that identifies documents shared with\
\ or by the user. This includes URLs, file attachments, and reference\
\ attachments to OneDrive for work or school and SharePoint files found\
\ in Outlook messages and meetings. This also includes URLs and reference\
\ attachments to Teams conversations. Ordered by recency of share."
items:
$ref: '#/components/schemas/SharedInsight'
x-ms-navigationProperty: true
trending:
type: array
description: "Calculated relationship that identifies documents trending\
\ around a user. Trending documents are calculated based on activity of\
\ the user's closest network of people and include files stored in OneDrive\
\ for work or school and SharePoint. Trending insights help the user to\
\ discover potentially useful content that the user has access to, but\
\ has never viewed before."
items:
$ref: '#/components/schemas/Trending'
x-ms-navigationProperty: true
used:
type: array
description: "Calculated relationship that identifies the latest documents\
\ viewed or modified by a user, including OneDrive for work or school\
\ and SharePoint documents, ranked by recency of use."
items:
$ref: '#/components/schemas/UsedInsight'
x-ms-navigationProperty: true
additionalProperties: true
SharedDriveItem:
allOf:
- $ref: '#/components/schemas/BaseItem'
- $ref: '#/components/schemas/SharedDriveItem1'
Calendar1:
title: calendar
type: object
properties:
allowedOnlineMeetingProviders:
type: array
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."
items:
$ref: '#/components/schemas/OnlineMeetingProviderType'
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/CalendarColor'
defaultOnlineMeetingProvider:
$ref: '#/components/schemas/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/EmailAddress'
calendarPermissions:
type: array
description: The permissions of the users with whom the calendar is shared.
items:
$ref: '#/components/schemas/CalendarPermission'
x-ms-navigationProperty: true
calendarView:
type: array
description: The calendar view for the calendar. Navigation property. Read-only.
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
events:
type: array
description: The events in the calendar. Navigation property. Read-only.
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
description: The collection of multi-value extended properties defined for
the calendar. Read-only. Nullable.
items:
$ref: '#/components/schemas/MultiValueLegacyExtendedProperty'
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
description: The collection of single-value extended properties defined
for the calendar. Read-only. Nullable.
items:
$ref: '#/components/schemas/SingleValueLegacyExtendedProperty'
x-ms-navigationProperty: true
additionalProperties: true
ResourceSpecificPermissionGrant:
allOf:
- $ref: '#/components/schemas/DirectoryObject'
- $ref: '#/components/schemas/ResourceSpecificPermissionGrant1'
TeamGuestSettings:
title: teamGuestSettings
type: object
properties:
allowCreateUpdateChannels:
type: boolean
description: "If set to true, guests can add and update channels."
nullable: true
allowDeleteChannels:
type: boolean
description: "If set to true, guests can delete channels."
nullable: true
additionalProperties: true
PublicError:
title: publicError
type: object
properties:
code:
type: string
description: Represents the error code.
nullable: true
details:
type: array
description: Details of the error.
items:
$ref: '#/components/schemas/PublicErrorDetail'
innerError:
$ref: '#/components/schemas/PublicInnerError'
message:
type: string
description: A non-localized message for the developer.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties: true
WorkbookChartLineFormat1:
title: workbookChartLineFormat
type: object
properties:
color:
type: string
description: The HTML color code that represents the color of lines in the
chart.
nullable: true
additionalProperties: true
AutomaticRepliesSetting:
title: automaticRepliesSetting
type: object
properties:
externalAudience:
$ref: '#/components/schemas/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/DateTimeTimeZone'
scheduledStartDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
status:
$ref: '#/components/schemas/AutomaticRepliesStatus'
additionalProperties: true
DeviceManagementExchangeAccessStateReason:
title: deviceManagementExchangeAccessStateReason
type: string
description: Device Exchange Access State Reason
enum:
- none
- unknown
- exchangeGlobalRule
- exchangeIndividualRule
- exchangeDeviceRule
- exchangeUpgrade
- exchangeMailboxPolicy
- other
- compliant
- notCompliant
- notEnrolled
- unknownLocation
- mfaRequired
- azureADBlockDueToAccessPolicy
- compromisedPassword
- deviceNotKnownWithManagedApp
x-ms-enum:
name: deviceManagementExchangeAccessStateReason
modelAsString: false
values:
- value: none
description: No access state reason discovered from Exchange
name: none
- value: unknown
description: Unknown access state reason
name: unknown
- value: exchangeGlobalRule
description: Access state determined by Exchange Global rule
name: exchangeGlobalRule
- value: exchangeIndividualRule
description: Access state determined by Exchange Individual rule
name: exchangeIndividualRule
- value: exchangeDeviceRule
description: Access state determined by Exchange Device rule
name: exchangeDeviceRule
- value: exchangeUpgrade
description: Access state due to Exchange upgrade
name: exchangeUpgrade
- value: exchangeMailboxPolicy
description: Access state determined by Exchange Mailbox Policy
name: exchangeMailboxPolicy
- value: other
description: Access state determined by Exchange
name: other
- value: compliant
description: Access state granted by compliance challenge
name: compliant
- value: notCompliant
description: Access state revoked by compliance challenge
name: notCompliant
- value: notEnrolled
description: Access state revoked by management challenge
name: notEnrolled
- value: unknownLocation
description: Access state due to unknown location
name: unknownLocation
- value: mfaRequired
description: Access state due to MFA challenge
name: mfaRequired
- value: azureADBlockDueToAccessPolicy
description: Access State revoked by AAD Access Policy
name: azureADBlockDueToAccessPolicy
- value: compromisedPassword
description: Access State revoked by compromised password
name: compromisedPassword
- value: deviceNotKnownWithManagedApp
description: Access state revoked by managed application challenge
name: deviceNotKnownWithManagedApp
CloudClipboardRoot1:
title: cloudClipboardRoot
type: object
properties:
items:
type: array
description: Represents a collection of Cloud Clipboard items.
items:
$ref: '#/components/schemas/CloudClipboardItem'
x-ms-navigationProperty: true
additionalProperties: true
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
TermStoreLocalizedDescription:
title: localizedDescription
type: object
properties:
description:
type: string
description: The description in the localized language.
nullable: true
languageTag:
type: string
description: The language tag for the label.
nullable: true
additionalProperties: true
WorkbookChartAxisFormat1:
title: workbookChartAxisFormat
type: object
properties:
font:
$ref: '#/components/schemas/WorkbookChartFont'
line:
$ref: '#/components/schemas/WorkbookChartLineFormat'
additionalProperties: true
PrintTaskTrigger:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PrintTaskTrigger1'
WorkbookChartAreaFormat1:
title: workbookChartAreaFormat
type: object
properties:
fill:
$ref: '#/components/schemas/WorkbookChartFill'
font:
$ref: '#/components/schemas/WorkbookChartFont'
additionalProperties: true
OnenoteResource1:
title: onenoteResource
type: object
properties:
content:
type: string
description: The content stream
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for downloading the content
nullable: true
additionalProperties: true
ItemBody:
title: itemBody
type: object
properties:
content:
type: string
description: The content of the item.
nullable: true
contentType:
$ref: '#/components/schemas/BodyType'
additionalProperties: true
UserDataSecurityAndGovernance1:
title: userDataSecurityAndGovernance
type: object
properties:
activities:
$ref: '#/components/schemas/ActivitiesContainer'
protectionScopes:
$ref: '#/components/schemas/UserProtectionScopeContainer'
additionalProperties: true
ContactFolder:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ContactFolder1'
PhoneAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/PhoneAuthenticationMethod1'
AssociatedTeamInfo:
allOf:
- $ref: '#/components/schemas/TeamInfo'
- $ref: '#/components/schemas/AssociatedTeamInfo1'
WindowsSettingInstance:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WindowsSettingInstance1'
ODataCountResponse:
type: integer
format: int32
MailFolder1:
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
description: The collection of child folders in the mailFolder.
items:
$ref: '#/components/schemas/MailFolder'
x-ms-navigationProperty: true
messageRules:
type: array
description: The collection of rules that apply to the user's Inbox folder.
items:
$ref: '#/components/schemas/MessageRule'
x-ms-navigationProperty: true
messages:
type: array
description: The collection of messages in the mailFolder.
items:
$ref: '#/components/schemas/Message'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
description: The collection of multi-value extended properties defined for
the mailFolder. Read-only. Nullable.
items:
$ref: '#/components/schemas/MultiValueLegacyExtendedProperty'
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
description: The collection of single-value extended properties defined
for the mailFolder. Read-only. Nullable.
items:
$ref: '#/components/schemas/SingleValueLegacyExtendedProperty'
x-ms-navigationProperty: true
additionalProperties: true
TeamsAppResourceSpecificPermissionType:
title: teamsAppResourceSpecificPermissionType
type: string
enum:
- delegated
- application
- unknownFutureValue
EventType:
title: eventType
type: string
enum:
- singleInstance
- occurrence
- exception
- seriesMaster
TermStoreLocalizedLabel:
title: localizedLabel
type: object
properties:
isDefault:
type: boolean
description: Indicates whether the label is the default label.
nullable: true
languageTag:
type: string
description: The language tag for the label.
nullable: true
name:
type: string
description: The name of the label.
nullable: true
additionalProperties: true
SharedInsight:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/SharedInsight1'
TimeOffItem:
allOf:
- $ref: '#/components/schemas/ScheduleEntity'
- $ref: '#/components/schemas/TimeOffItem1'
SensitivityLabel1:
title: sensitivityLabel
type: object
properties:
actionSource:
$ref: '#/components/schemas/LabelActionSource'
autoTooltip:
type: string
nullable: true
description:
type: string
nullable: true
displayName:
type: string
nullable: true
isDefault:
type: boolean
nullable: true
isEndpointProtectionEnabled:
type: boolean
nullable: true
isScopedToUser:
type: boolean
nullable: true
locale:
type: string
nullable: true
name:
type: string
nullable: true
priority:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
toolTip:
type: string
nullable: true
rights:
$ref: '#/components/schemas/UsageRightsIncluded'
sublabels:
type: array
items:
$ref: '#/components/schemas/SensitivityLabel'
x-ms-navigationProperty: true
additionalProperties: true
WindowsHelloForBusinessAuthenticationMethod1:
title: windowsHelloForBusinessAuthenticationMethod
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 that this Windows Hello for Business key
was registered.
format: date-time
nullable: true
displayName:
type: string
description: The name of the device on which Windows Hello for Business
is registered
nullable: true
keyStrength:
$ref: '#/components/schemas/AuthenticationMethodKeyStrength'
device:
$ref: '#/components/schemas/Device'
additionalProperties: true
UsageRights:
title: usageRights
type: string
enum:
- unknown
- docEdit
- edit
- comment
- export
- forward
- owner
- print
- reply
- replyAll
- view
- extract
- viewRightsData
- editRightsData
- objModel
- accessDenied
- userDefinedProtectionTypeNotSupportedException
- encryptedProtectionTypeNotSupportedException
- purviewClaimsChallengeNotSupportedException
- exception
- unknownFutureValue
x-ms-enum-flags:
isFlags: true
ContentType1:
title: contentType
type: object
properties:
associatedHubsUrls:
type: array
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.
items:
type: string
nullable: true
description:
type: string
description: The descriptive text for the item.
nullable: true
documentSet:
$ref: '#/components/schemas/DocumentSet'
documentTemplate:
$ref: '#/components/schemas/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/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/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/ContentType'
baseTypes:
type: array
description: The collection of content types that are ancestors of this
content type.
items:
$ref: '#/components/schemas/ContentType'
x-ms-navigationProperty: true
columnLinks:
type: array
description: The collection of columns that are required by this content
type.
items:
$ref: '#/components/schemas/ColumnLink'
x-ms-navigationProperty: true
columnPositions:
type: array
description: Column order information in a content type.
items:
$ref: '#/components/schemas/ColumnDefinition'
x-ms-navigationProperty: true
columns:
type: array
description: The collection of column definitions for this content type.
items:
$ref: '#/components/schemas/ColumnDefinition'
x-ms-navigationProperty: true
additionalProperties: true
ScopedRoleMembership:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ScopedRoleMembership1'
SharedDriveItemCollectionResponse:
title: Collection of sharedDriveItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/SharedDriveItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
WeekIndex:
title: weekIndex
type: string
enum:
- first
- second
- third
- fourth
- last
TeamFunSettings:
title: teamFunSettings
type: object
properties:
allowCustomMemes:
type: boolean
description: "If set to true, enables users to include custom memes."
nullable: true
allowGiphy:
type: boolean
description: "If set to true, enables Giphy use."
nullable: true
allowStickersAndMemes:
type: boolean
description: "If set to true, enables users to include stickers and memes."
nullable: true
giphyContentRating:
$ref: '#/components/schemas/GiphyRatingType'
additionalProperties: true
ChannelSummary:
title: channelSummary
type: object
properties:
guestsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of guests in a channel.
format: int32
nullable: true
hasMembersFromOtherTenants:
type: boolean
description: Indicates whether external members are included on the channel.
nullable: true
membersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of members in a channel.
format: int32
nullable: true
ownersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of owners in a channel.
format: int32
nullable: true
additionalProperties: true
PrintTaskDefinition1:
title: printTaskDefinition
type: object
properties:
createdBy:
$ref: '#/components/schemas/AppIdentity'
displayName:
type: string
description: The name of the printTaskDefinition.
tasks:
type: array
description: A list of tasks that have been created based on this definition.
The list includes currently running tasks and recently completed tasks.
Read-only.
items:
$ref: '#/components/schemas/PrintTask'
x-ms-navigationProperty: true
additionalProperties: true
WorkbookChartPointFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartPointFormat1'
DocumentSetContent:
title: documentSetContent
type: object
properties:
contentType:
$ref: '#/components/schemas/ContentTypeInfo'
fileName:
type: string
description: Name of the file in resource folder that should be added as
a default content or a template in the document set.
nullable: true
folderName:
type: string
description: Folder name in which the file will be placed when a new document
set is created in the library.
nullable: true
additionalProperties: true
Recipient:
title: recipient
type: object
properties:
emailAddress:
$ref: '#/components/schemas/EmailAddress'
additionalProperties: true
PlannerAppliedCategories:
title: plannerAppliedCategories
type: object
additionalProperties: true
AttendanceRecord1:
title: attendanceRecord
type: object
properties:
attendanceIntervals:
type: array
description: List of time periods between joining and leaving a meeting.
items:
$ref: '#/components/schemas/AttendanceInterval'
emailAddress:
type: string
description: Email address of the user associated with this attendance record.
nullable: true
externalRegistrationInformation:
$ref: '#/components/schemas/VirtualEventExternalRegistrationInformation'
identity:
$ref: '#/components/schemas/Identity'
registrationId:
type: string
description: Unique identifier of a virtualEventRegistration that is available
to all participants registered for the virtualEventWebinar.
nullable: true
role:
type: string
description: "Role of the attendee. Possible values are: None, Attendee,\
\ Presenter, and Organizer."
nullable: true
totalAttendanceInSeconds:
maximum: 2147483647
minimum: -2147483648
type: number
description: Total duration of the attendances in seconds.
format: int32
nullable: true
additionalProperties: true
ExternalLink:
title: externalLink
type: object
properties:
href:
type: string
description: The URL of the link.
nullable: true
additionalProperties: true
CalendarColor:
title: calendarColor
type: string
enum:
- auto
- lightBlue
- lightGreen
- lightOrange
- lightGray
- lightYellow
- lightTeal
- lightPink
- lightBrown
- lightRed
- maxColor
AssignedLicense:
title: assignedLicense
type: object
properties:
disabledPlans:
type: array
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.
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
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
ManagedDeviceOwnerType:
title: managedDeviceOwnerType
type: string
description: Owner type of device
enum:
- unknown
- company
- personal
- unknownFutureValue
x-ms-enum:
name: managedDeviceOwnerType
modelAsString: false
values:
- value: unknown
description: Unknown device owner type.
name: unknown
- value: company
description: Corporate device owner type.
name: company
- value: personal
description: Personal device owner type.
name: personal
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
WorkbookChartAxisTitleFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartAxisTitleFormat1'
CalendarPermission1:
title: calendarPermission
type: object
properties:
allowedRoles:
type: array
description: "List of allowed sharing or delegating permission levels for\
\ the calendar. Possible values are: none, freeBusyRead, limitedRead,\
\ read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess,\
\ custom."
items:
$ref: '#/components/schemas/CalendarRoleType'
emailAddress:
$ref: '#/components/schemas/EmailAddress'
isInsideOrganization:
type: boolean
description: True if the user in context (recipient or delegate) is inside
the same organization as the calendar owner.
nullable: true
isRemovable:
type: boolean
description: "True if the user can be removed from the list of recipients\
\ or delegates for the specified calendar, false otherwise. The 'My organization'\
\ user determines the permissions other people within your organization\
\ have to the given calendar. You can't remove 'My organization' as a\
\ share recipient to a calendar."
nullable: true
role:
$ref: '#/components/schemas/CalendarRoleType'
additionalProperties: true
TeamsAsyncOperationType:
title: teamsAsyncOperationType
type: string
enum:
- invalid
- cloneTeam
- archiveTeam
- unarchiveTeam
- createTeam
- unknownFutureValue
- teamifyGroup
- createChannel
- archiveChannel
- unarchiveChannel
ScheduleEntityTheme:
title: scheduleEntityTheme
type: string
enum:
- white
- blue
- green
- purple
- pink
- yellow
- gray
- darkBlue
- darkGreen
- darkPurple
- darkPink
- darkYellow
- unknownFutureValue
File:
title: file
type: object
properties:
hashes:
$ref: '#/components/schemas/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
PrintTaskProcessingState:
title: printTaskProcessingState
type: string
enum:
- pending
- processing
- completed
- aborted
- unknownFutureValue
OnenoteEntityHierarchyModel1:
title: onenoteEntityHierarchyModel
type: object
properties:
createdBy:
$ref: '#/components/schemas/IdentitySet'
displayName:
type: string
description: The name of the notebook.
nullable: true
lastModifiedBy:
$ref: '#/components/schemas/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: "The date and time when the notebook was last modified. The\
\ timestamp represents date and time information using ISO 8601 format\
\ and is always in UTC time. For example, midnight UTC on Jan 1, 2014\
\ is 2014-01-01T00:00:00Z. Read-only."
format: date-time
nullable: true
additionalProperties: true
DriveItemVersionCollectionResponse:
title: CollectionOfDriveItemVersion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/DriveItemVersion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
ChecklistItem1:
title: checklistItem
type: object
properties:
checkedDateTime:
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 checklistItem was finished.
format: date-time
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 when the checklistItem was created.
format: date-time
displayName:
type: string
description: Indicates the title of the checklistItem.
nullable: true
isChecked:
type: boolean
description: State that indicates whether the item is checked off or not.
nullable: true
additionalProperties: true
WorkbookChartSeriesFormat1:
title: workbookChartSeriesFormat
type: object
properties:
fill:
$ref: '#/components/schemas/WorkbookChartFill'
line:
$ref: '#/components/schemas/WorkbookChartLineFormat'
additionalProperties: true
ChatMessageFromIdentitySet:
allOf:
- $ref: '#/components/schemas/IdentitySet'
- $ref: '#/components/schemas/ChatMessageFromIdentitySet1'
VirtualEventExternalRegistrationInformation:
title: virtualEventExternalRegistrationInformation
type: object
properties:
referrer:
type: string
description: A URL or string that represents the location from which the
registrant registered. Optional.
nullable: true
registrationId:
type: string
description: "The identifier for a virtualEventExternalRegistrationInformation\
\ object. Optional. If set, the maximum supported length is 256 characters."
nullable: true
additionalProperties: true
PhoneAuthenticationMethod1:
title: phoneAuthenticationMethod
type: object
properties:
phoneNumber:
type: string
description: "The phone number to text or call for authentication. Phone\
\ numbers use the format +{country code} {number}x{extension}, with extension\
\ optional. For example, +1 5555551234 or +1 5555551234x123 are valid.\
\ Numbers are rejected when creating or updating if they don't match the\
\ required format."
nullable: true
phoneType:
$ref: '#/components/schemas/AuthenticationPhoneType'
smsSignInState:
$ref: '#/components/schemas/AuthenticationMethodSignInState'
additionalProperties: true
MeetingAttendanceReport:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/MeetingAttendanceReport1'
Phone:
title: phone
type: object
properties:
language:
type: string
nullable: true
number:
type: string
description: The phone number.
nullable: true
region:
type: string
nullable: true
type:
$ref: '#/components/schemas/PhoneType'
additionalProperties: true
FollowupFlagStatus:
title: followupFlagStatus
type: string
enum:
- notFlagged
- complete
- flagged
WorkingTimeSchedule1:
title: workingTimeSchedule
type: object
additionalProperties: true
ColumnLink:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ColumnLink1'
PolicyLocation:
title: policyLocation
type: object
properties:
value:
type: string
description: "The actual value representing the location. Location value\
\ is specific for concretetype of the policyLocation - policyLocationDomain,\
\ policyLocationUrl, or policyLocationApplication (for example, 'contoso.com',\
\ 'https://partner.contoso.com/upload', '83ef198a-0396-4893-9d4f-d36efbffcaaa')."
additionalProperties: true
PrintTask:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PrintTask1'
GroupLifecyclePolicy1:
title: groupLifecyclePolicy
type: object
properties:
alternateNotificationEmails:
type: string
description: List of email address to send notifications for groups without
owners. Multiple email address can be defined by separating email address
with a semicolon.
nullable: true
groupLifetimeInDays:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Number of days before a group expires and needs to be renewed.\
\ Once renewed, the group expiration is extended by the number of days\
\ defined."
format: int32
nullable: true
managedGroupTypes:
type: string
description: "The group type for which the expiration policy applies. Possible\
\ values are All, Selected or None."
nullable: true
additionalProperties: true
DriveItemSourceApplication:
title: driveItemSourceApplication
type: string
enum:
- teams
- yammer
- sharePoint
- oneDrive
- stream
- powerPoint
- office
- loki
- loop
- other
- unknownFutureValue
ODataErrorsInnerError:
type: object
additionalProperties: true
description: The structure of this object is service-specific
ContentTypeOrder:
title: contentTypeOrder
type: object
properties:
default:
type: boolean
description: Indicates whether this is the default content type
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: number
description: Specifies the position in which the content type appears in
the selection UI.
format: int32
nullable: true
additionalProperties: true
ProfilePhoto1:
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
ProcessContentMetadataBase:
title: processContentMetadataBase
type: object
properties:
content:
$ref: '#/components/schemas/ContentBase'
correlationId:
type: string
description: "An identifier used to group multiple related content entries\
\ (for example, different parts of the same file upload, messages in a\
\ conversation)."
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: "Required. Timestamp indicating when the original content was\
\ created (for example, file creation time, message sent time)."
format: date-time
identifier:
type: string
description: "Required. A unique identifier for this specific content entry\
\ within the context of the calling application or enforcement plane (for\
\ example, message ID, file path/URL)."
isTruncated:
type: boolean
description: "Required. Indicates if the provided content has been truncated\
\ from its original form (for example, due to size limits)."
length:
type: number
description: The length of the original content in bytes.
format: int64
nullable: true
modifiedDateTime:
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. Timestamp indicating when the original content was\
\ last modified. For ephemeral content like messages, this might be the\
\ same as createdDateTime."
format: date-time
name:
type: string
description: "Required. A descriptive name for the content (for example,\
\ file name, web page title, 'Chat Message')."
sequenceNumber:
type: number
description: "A sequence number indicating the order in which content was\
\ generated or should be processed, required when correlationId is used."
format: int64
nullable: true
additionalProperties: true
WorkbookApplication1:
title: workbookApplication
type: object
properties:
calculationMode:
type: string
description: "Returns the calculation mode used in the workbook. Possible\
\ values are: Automatic, AutomaticExceptTables, Manual."
additionalProperties: true
GroupLifecyclePolicy:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/GroupLifecyclePolicy1'
SchedulingGroup:
allOf:
- $ref: '#/components/schemas/ChangeTrackedEntity'
- $ref: '#/components/schemas/SchedulingGroup1'
ColumnDefinitionCollectionResponse:
title: Collection of columnDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/ColumnDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
UserProtectionScopeContainer1:
title: userProtectionScopeContainer
type: object
additionalProperties: true
DriveItemVersion:
allOf:
- $ref: '#/components/schemas/BaseItemVersion'
- $ref: '#/components/schemas/DriveItemVersion1'
Presence1:
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/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/PresenceStatusMessage'
additionalProperties: true
AttachmentSession:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/AttachmentSession1'
Group1:
title: group
type: object
properties:
allowExternalSenders:
type: boolean
description: "Indicates if people external to the organization can send\
\ messages to the group. The default value is false. Returned only on\
\ $select. Supported only on the Get group API (GET /groups/{ID})."
nullable: true
assignedLabels:
type: array
description: "The list of sensitivity label pairs (label ID, label name)\
\ associated with a Microsoft 365 group. Returned only on $select. This\
\ property can be updated only in delegated scenarios where the caller\
\ requires both the Microsoft Graph permission and a supported administrator\
\ role."
items:
$ref: '#/components/schemas/AssignedLabel'
assignedLicenses:
type: array
description: The licenses that are assigned to the group. Returned only
on $select. Supports $filter (eq). Read-only.
items:
$ref: '#/components/schemas/AssignedLicense'
autoSubscribeNewMembers:
type: boolean
description: "Indicates if new members added to the group are autosubscribed\
\ to receive email notifications. You can set this property in a PATCH\
\ request for the group; don't set it in the initial POST request that\
\ creates the group. Default value is false. Returned only on $select.\
\ Supported only on the Get group API (GET /groups/{ID})."
nullable: true
classification:
type: string
description: "Describes a classification for the group (such as low, medium,\
\ or high business impact). Valid values for this property are defined\
\ by creating a ClassificationList setting value, based on the template\
\ definition.Returned by default. Supports $filter (eq, ne, not, ge, le,\
\ startsWith)."
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 of when the group was created. The value can't be\
\ modified and is automatically populated when the group is created. The\
\ Timestamp type represents date and time information using ISO 8601 format\
\ and is always in UTC time. For example, midnight UTC on January 1, 2014\
\ is 2014-01-01T00:00:00Z. Returned by default. Read-only."
format: date-time
nullable: true
description:
type: string
description: "An optional description for the group. Returned by default.\
\ Supports $filter (eq, ne, not, ge, le, startsWith) and $search."
nullable: true
displayName:
type: string
description: "The display name for the group. This property is required\
\ when a group is created and 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), $search, and\
\ $orderby."
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: "Timestamp of when the group is set to expire. It's null for\
\ security groups, but for Microsoft 365 groups, it represents when the\
\ group is set to expire as defined in the groupLifecyclePolicy. The Timestamp\
\ type represents date and time information using ISO 8601 format and\
\ is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z.\
\ Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only."
format: date-time
nullable: true
groupTypes:
type: array
description: "Specifies the group type and its membership. If the collection\
\ contains Unified, the group is a Microsoft 365 group; otherwise, it's\
\ either a security group or a distribution group. For details, see groups\
\ overview.If the collection includes DynamicMembership, the group has\
\ dynamic membership; otherwise, membership is static. Returned by default.\
\ Supports $filter (eq, not)."
items:
type: string
hasMembersWithLicenseErrors:
type: boolean
description: "Indicates whether there are members in this group that have\
\ license errors from its group-based license assignment. This property\
\ is never returned on a GET operation. You can use it as a $filter argument\
\ to get groups that have members with license errors (that is, filter\
\ for this property being true). See an example. Supports $filter (eq)."
nullable: true
hideFromAddressLists:
type: boolean
description: "True if the group isn't displayed in certain parts of the\
\ Outlook UI: the Address Book, address lists for selecting message recipients,\
\ and the Browse Groups dialog for searching groups; otherwise, false.\
\ The default value is false. Returned only on $select. Supported only\
\ on the Get group API (GET /groups/{ID})."
nullable: true
hideFromOutlookClients:
type: boolean
description: "True if the group isn't displayed in Outlook clients, such\
\ as Outlook for Windows and Outlook on the web; otherwise, false. The\
\ default value is false. Returned only on $select. Supported only on\
\ the Get group API (GET /groups/{ID})."
nullable: true
isArchived:
type: boolean
description: "When a group is associated with a team, this property determines\
\ whether the team is in read-only mode.To read this property, use the\
\ /group/{groupId}/team endpoint or the Get team API. To update this property,\
\ use the archiveTeam and unarchiveTeam APIs."
nullable: true
isAssignableToRole:
type: boolean
description: "Indicates whether this group can be assigned to a Microsoft\
\ Entra role. Optional. This property can only be set while creating the\
\ group and is immutable. If set to true, the securityEnabled property\
\ must also be set to true, visibility must be Hidden, and the group can't\
\ be a dynamic group (that is, groupTypes can't contain DynamicMembership).\
\ Only callers with at least the Privileged Role Administrator role can\
\ set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory\
\ permission to set this property or update the membership of such groups.\
\ For more, see Using a group to manage Microsoft Entra role assignmentsUsing\
\ this feature requires a Microsoft Entra ID P1 license. Returned by default.\
\ Supports $filter (eq, ne, not)."
nullable: true
isManagementRestricted:
type: boolean
description: "Indicates whether the group 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 group 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
isSubscribedByMail:
type: boolean
description: "Indicates whether the signed-in user is subscribed to receive\
\ email conversations. The default value is true. Returned only on $select.\
\ Supported only on the Get group API (GET /groups/{ID})."
nullable: true
licenseProcessingState:
$ref: '#/components/schemas/LicenseProcessingState'
mail:
type: string
description: "The SMTP address for the group, for example, 'serviceadmins@contoso.com'.\
\ Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le,\
\ in, startsWith, and eq on null values)."
nullable: true
mailEnabled:
type: boolean
description: "Specifies whether the group is mail-enabled. Required. Returned\
\ by default. Supports $filter (eq, ne, not)."
nullable: true
mailNickname:
type: string
description: "The mail alias for the group, unique for Microsoft 365 groups\
\ in the organization. Maximum length is 64 characters. This property\
\ can contain only characters in the ASCII character set 0 - 127 except\
\ the following characters: @ () / [] ' ; : <> , SPACE. Required. Returned\
\ by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and\
\ eq on null values)."
nullable: true
membershipRule:
type: string
description: "The rule that determines members for this group if the group\
\ is a dynamic group (groupTypes contains DynamicMembership). For more\
\ information about the syntax of the membership rule, see Membership\
\ Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge,\
\ le, startsWith)."
nullable: true
membershipRuleProcessingState:
type: string
description: "Indicates whether the dynamic membership processing is on\
\ or paused. Possible values are On or Paused. Returned by default. Supports\
\ $filter (eq, ne, not, in)."
nullable: true
onPremisesDomainName:
type: string
description: "Contains the on-premises domain FQDN, also called dnsDomainName\
\ synchronized from the on-premises directory. The property is only populated\
\ for customers synchronizing their on-premises directory to Microsoft\
\ Entra ID via Microsoft Entra Connect.Returned by default. Read-only."
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 group was synced with\
\ the on-premises directory. The Timestamp type represents date and time\
\ information using ISO 8601 format and is always in UTC time. For example,\
\ midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by\
\ default. Read-only. Supports $filter (eq, ne, not, ge, le, in)."
format: date-time
nullable: true
onPremisesNetBiosName:
type: string
description: Contains the on-premises netBios name synchronized from the
on-premises directory. The property is only populated for customers synchronizing
their on-premises directory to Microsoft Entra ID via Microsoft Entra
Connect.Returned by default. Read-only.
nullable: true
onPremisesProvisioningErrors:
type: array
description: "Errors when using Microsoft synchronization product during\
\ provisioning. Returned by default. Supports $filter (eq, not)."
items:
$ref: '#/components/schemas/OnPremisesProvisioningError'
onPremisesSamAccountName:
type: string
description: "Contains the on-premises SAM account name synchronized from\
\ the on-premises directory. The property is only populated for customers\
\ synchronizing their on-premises directory to Microsoft Entra ID via\
\ Microsoft Entra Connect.Returned by default. Supports $filter (eq, ne,\
\ not, ge, le, in, startsWith). Read-only."
nullable: true
onPremisesSecurityIdentifier:
type: string
description: Contains the on-premises security identifier (SID) for the
group synchronized from on-premises to the cloud. Read-only. Returned
by default. Supports $filter (eq including on null values).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: "true if this group is synced from an on-premises directory;\
\ false if this group was originally synced from an on-premises directory\
\ but is no longer synced; null if this object has never synced from an\
\ on-premises directory (default). Returned by default. Read-only. Supports\
\ $filter (eq, ne, not, in, and eq on null values)."
nullable: true
preferredDataLocation:
type: string
description: "The preferred data location for the Microsoft 365 group. By\
\ default, the group inherits the group creator's preferred data location.\
\ To set this property, the calling app must be granted the Directory.ReadWrite.All\
\ permission and the user be assigned at least one of the following Microsoft\
\ Entra roles: User Account Administrator Directory Writer Exchange Administrator\
\ SharePoint Administrator For more information about this property,\
\ see OneDrive Online Multi-Geo. Nullable. Returned by default."
nullable: true
preferredLanguage:
type: string
description: "The preferred language for a Microsoft 365 group. Should follow\
\ ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter\
\ (eq, ne, not, ge, le, in, startsWith, and eq on null values)."
nullable: true
proxyAddresses:
type: array
description: "Email addresses for the group that direct to the same group\
\ mailbox. For example: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com'].\
\ The any operator is required to filter expressions on multi-valued properties.\
\ Returned by default. Read-only. Not nullable. Supports $filter (eq,\
\ not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0)."
items:
type: string
renewedDateTime:
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 of when the group was last renewed. This value can't\
\ be modified directly and is only updated via the renew service action.\
\ The Timestamp type represents date and time information using ISO 8601\
\ format and is always in UTC. For example, midnight UTC on January 1,\
\ 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter\
\ (eq, ne, not, ge, le, in). Read-only."
format: date-time
nullable: true
securityEnabled:
type: boolean
description: "Specifies whether the group is a security group. Required.\
\ Returned by default. Supports $filter (eq, ne, not, in)."
nullable: true
securityIdentifier:
type: string
description: "Security identifier of the group, used in Windows scenarios.\
\ Read-only. Returned by default."
nullable: true
serviceProvisioningErrors:
type: array
description: "Errors published by a federated service describing a nontransient,\
\ service-specific error regarding the properties or link from a group\
\ object. Supports $filter (eq, not, for isResolved and serviceInstance)."
items:
$ref: '#/components/schemas/ServiceProvisioningError'
theme:
type: string
description: "Specifies a Microsoft 365 group's color theme. Possible values\
\ are Teal, Purple, Green, Blue, Pink, Orange, or Red. Returned by default."
nullable: true
uniqueName:
type: string
description: The unique identifier that can be assigned to a group and used
as an alternate key. Immutable. Read-only.
nullable: true
unseenCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Count of conversations that received new posts since the signed-in\
\ user last visited the group. Returned only on $select. Supported only\
\ on the Get group API (GET /groups/{ID})."
format: int32
nullable: true
visibility:
type: string
description: "Specifies the group join policy and group content visibility\
\ for groups. Possible values are: Private, Public, or HiddenMembership.\
\ HiddenMembership can be set only for Microsoft 365 groups when the groups\
\ are created. It can't be updated later. Other values of visibility can\
\ be updated after group creation. If visibility value isn't specified\
\ during group creation on Microsoft Graph, a security group is created\
\ as Private by default, and the Microsoft 365 group is Public. Groups\
\ assignable to roles are always Private. To learn more, see group visibility\
\ options. Returned by default. Nullable."
nullable: true
acceptedSenders:
type: array
description: "The list of users or groups allowed to create posts or calendar\
\ events in this group. If this list is nonempty, then only users or groups\
\ listed here are allowed to post."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
appRoleAssignments:
type: array
description: Represents the app roles granted to a group for an application.
Supports $expand.
items:
$ref: '#/components/schemas/AppRoleAssignment'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/Calendar'
calendarView:
type: array
description: The calendar view for the calendar. Read-only.
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
conversations:
type: array
description: The group's conversations.
items:
$ref: '#/components/schemas/Conversation'
x-ms-navigationProperty: true
createdOnBehalfOf:
$ref: '#/components/schemas/DirectoryObject'
drive:
$ref: '#/components/schemas/Drive'
drives:
type: array
description: The group's drives. Read-only.
items:
$ref: '#/components/schemas/Drive'
x-ms-navigationProperty: true
events:
type: array
description: The group's calendar events.
items:
$ref: '#/components/schemas/Event'
x-ms-navigationProperty: true
extensions:
type: array
description: The collection of open extensions defined for the group. Read-only.
Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
groupLifecyclePolicies:
type: array
description: The collection of lifecycle policies for this group. Read-only.
Nullable.
items:
$ref: '#/components/schemas/GroupLifecyclePolicy'
x-ms-navigationProperty: true
memberOf:
type: array
description: "Groups that this group is a member of. HTTP Methods: GET (supported\
\ for all groups). Read-only. Nullable. Supports $expand."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
members:
type: array
description: "The members of this group, who can be users, devices, other\
\ groups, or service principals. Supports the List members, Add member,\
\ and Remove member operations. Nullable. Supports $expand including nested\
\ $select. For example, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName)."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
membersWithLicenseErrors:
type: array
description: A list of group members with license errors from this group-based
license assignment. Read-only.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/Onenote'
owners:
type: array
description: "The owners of the group who can be users or service principals.\
\ Limited to 100 owners. Nullable. If this property isn't specified when\
\ creating a Microsoft 365 group the calling user (admin or non-admin)\
\ is automatically assigned as the group owner. A non-admin user can't\
\ explicitly add themselves to this collection when they're creating the\
\ group. For more information, see the related known issue. For security\
\ groups, the admin user isn't automatically added to this collection.\
\ For more information, see the related known issue. Supports $filter\
\ (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Supports $expand\
\ including nested $select. For example, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName)."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/ResourceSpecificPermissionGrant'
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/ProfilePhoto'
photos:
type: array
description: The profile photos owned by the group. Read-only. Nullable.
items:
$ref: '#/components/schemas/ProfilePhoto'
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/PlannerGroup'
rejectedSenders:
type: array
description: The list of users or groups not allowed to create posts or
calendar events in this group. Nullable
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
settings:
type: array
description: "Settings that can govern this group's behavior, like whether\
\ members can invite guests to the group. Nullable."
items:
$ref: '#/components/schemas/GroupSetting'
x-ms-navigationProperty: true
sites:
type: array
description: The list of SharePoint sites in this group. Access the default
site with /sites/root.
items:
$ref: '#/components/schemas/Site'
x-ms-navigationProperty: true
team:
$ref: '#/components/schemas/Team'
threads:
type: array
description: The group's conversation threads. Nullable.
items:
$ref: '#/components/schemas/ConversationThread'
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
description: "The groups that a group is a member of, either directly or\
\ through nested membership. Nullable."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
transitiveMembers:
type: array
description: The direct and transitive members of a group. Nullable.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
additionalProperties: true
description: Represents a Microsoft Entra group
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/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
Group2:
title: group
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: Date and time of the group creation. Read-only.
format: date-time
nullable: true
description:
type: string
description: Description that gives details on the term usage.
nullable: true
displayName:
type: string
description: Name of the group.
nullable: true
parentSiteId:
type: string
description: ID of the parent site of this group.
nullable: true
scope:
$ref: '#/components/schemas/TermStoreTermGroupScope'
sets:
type: array
description: "All sets under the group in a term [store]."
items:
$ref: '#/components/schemas/TermStoreSet'
x-ms-navigationProperty: true
additionalProperties: true
BaseSitePage1:
title: baseSitePage
type: object
properties:
pageLayout:
$ref: '#/components/schemas/PageLayoutType'
publishingState:
$ref: '#/components/schemas/PublicationFacet'
title:
type: string
description: Title of the sitePage.
nullable: true
additionalProperties: true
TeamworkTag:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamworkTag1'
WindowsMalwareState:
title: windowsMalwareState
type: string
description: Malware current status
enum:
- unknown
- detected
- cleaned
- quarantined
- removed
- allowed
- blocked
- cleanFailed
- quarantineFailed
- removeFailed
- allowFailed
- abandoned
- blockFailed
x-ms-enum:
name: windowsMalwareState
modelAsString: false
values:
- value: unknown
description: Unknown
name: unknown
- value: detected
description: Detected
name: detected
- value: cleaned
description: Cleaned
name: cleaned
- value: quarantined
description: Quarantined
name: quarantined
- value: removed
description: Removed
name: removed
- value: allowed
description: Allowed
name: allowed
- value: blocked
description: Blocked
name: blocked
- value: cleanFailed
description: Clean failed
name: cleanFailed
- value: quarantineFailed
description: Quarantine failed
name: quarantineFailed
- value: removeFailed
description: Remove failed
name: removeFailed
- value: allowFailed
description: Allow failed
name: allowFailed
- value: abandoned
description: Abandoned
name: abandoned
- value: blockFailed
description: Block failed
name: blockFailed
OnenoteEntitySchemaObjectModel:
allOf:
- $ref: '#/components/schemas/OnenoteEntityBaseModel'
- $ref: '#/components/schemas/OnenoteEntitySchemaObjectModel1'
UserIdentity:
allOf:
- $ref: '#/components/schemas/Identity'
- $ref: '#/components/schemas/UserIdentity1'
VirtualEventExternalInformation:
title: virtualEventExternalInformation
type: object
properties:
applicationId:
type: string
description: Identifier of the application that hosts the externalEventId.
Read-only.
nullable: true
externalEventId:
type: string
description: "The identifier for a virtualEventExternalInformation object\
\ that associates the virtual event with an event ID in an external application.\
\ This association bundles all the information (both supported and not\
\ supported in virtualEvent) into one virtual event object. Optional.\
\ If set, the maximum supported length is 256 characters."
nullable: true
additionalProperties: true
LookupColumn:
title: lookupColumn
type: object
properties:
allowMultipleValues:
type: boolean
description: Indicates whether multiple values can be selected from the
source.
nullable: true
allowUnlimitedLength:
type: boolean
description: Indicates whether values in the column should be able to exceed
the standard limit of 255 characters.
nullable: true
columnName:
type: string
description: The name of the lookup source column.
nullable: true
listId:
type: string
description: The unique identifier of the lookup source list.
nullable: true
primaryLookupColumnId:
type: string
description: "If specified, this column is a secondary lookup, pulling an\
\ additional field from the list item looked up by the primary lookup.\
\ Use the list item looked up by the primary as the source for the column\
\ named here."
nullable: true
additionalProperties: true
IntegratedApplicationMetadata:
title: integratedApplicationMetadata
type: object
properties:
name:
type: string
description: The name of the integrated application.
nullable: true
version:
type: string
description: The version number of the integrated application.
nullable: true
additionalProperties: true
AppIdentity:
title: appIdentity
type: object
properties:
appId:
type: string
description: Refers to the unique ID representing application in Microsoft
Entra ID.
nullable: true
displayName:
type: string
description: Refers to the application name displayed in the Microsoft Entra
admin center.
nullable: true
servicePrincipalId:
type: string
description: Refers to the unique ID for the service principal in Microsoft
Entra ID.
nullable: true
servicePrincipalName:
type: string
description: Refers to the Service Principal Name is the Application name
in the tenant.
nullable: true
additionalProperties: true
PlannerTaskDetails1:
title: plannerTaskDetails
type: object
properties:
checklist:
$ref: '#/components/schemas/PlannerChecklistItems'
description:
type: string
description: Description of the task.
nullable: true
previewType:
$ref: '#/components/schemas/PlannerPreviewType'
references:
$ref: '#/components/schemas/PlannerExternalReferences'
additionalProperties: true
WellknownListName:
title: wellknownListName
type: string
enum:
- none
- defaultList
- flaggedEmails
- unknownFutureValue
Group:
allOf:
- $ref: '#/components/schemas/DirectoryObject'
- $ref: '#/components/schemas/Group1'
PlatformCredentialAuthenticationMethod1:
title: platformCredentialAuthenticationMethod
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 that this Platform Credential Key was registered.
format: date-time
nullable: true
displayName:
type: string
description: The name of the device on which Platform Credential is registered.
nullable: true
keyStrength:
$ref: '#/components/schemas/AuthenticationMethodKeyStrength'
platform:
$ref: '#/components/schemas/AuthenticationMethodPlatform'
device:
$ref: '#/components/schemas/Device'
additionalProperties: true
SharedWithChannelTeamInfo:
allOf:
- $ref: '#/components/schemas/TeamInfo'
- $ref: '#/components/schemas/SharedWithChannelTeamInfo1'
PlannerPreviewType:
title: plannerPreviewType
type: string
enum:
- automatic
- noPreview
- checklist
- description
- reference
SensitivityLabelAssignment:
title: sensitivityLabelAssignment
type: object
properties:
assignmentMethod:
$ref: '#/components/schemas/SensitivityLabelAssignmentMethod'
sensitivityLabelId:
type: string
description: The unique identifier for the sensitivity label assigned to
the file.
tenantId:
type: string
description: The unique identifier for the tenant that hosts the file when
this label is applied.
additionalProperties: true
ShiftActivity:
title: shiftActivity
type: object
properties:
code:
type: string
description: Customer defined code for the shiftActivity. Required.
nullable: true
displayName:
type: string
description: The name of the shiftActivity. Required.
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 end date and time for the shiftActivity. 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.\
\ Required."
format: date-time
nullable: true
isPaid:
type: boolean
description: Indicates whether the user should be paid for the activity
during their shift. Required.
nullable: true
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 start date and time for the shiftActivity. 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.\
\ Required."
format: date-time
nullable: true
theme:
$ref: '#/components/schemas/ScheduleEntityTheme'
additionalProperties: true
TimeCardEntry:
title: timeCardEntry
type: object
properties:
breaks:
type: array
description: The clock-in event of the timeCard.
items:
$ref: '#/components/schemas/TimeCardBreak'
clockInEvent:
$ref: '#/components/schemas/TimeCardEvent'
clockOutEvent:
$ref: '#/components/schemas/TimeCardEvent'
additionalProperties: true
LicenseDetails1:
title: licenseDetails
type: object
properties:
servicePlans:
type: array
description: Information about the service plans assigned with the license.
Read-only. Not nullable.
items:
$ref: '#/components/schemas/ServicePlanInfo'
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
TeamworkConversationIdentity1:
title: teamworkConversationIdentity
type: object
properties:
conversationIdentityType:
$ref: '#/components/schemas/TeamworkConversationIdentityType'
additionalProperties: true
UserInsightsSettings:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UserInsightsSettings1'
PlannerAssignedToTaskBoardTaskFormat1:
title: plannerAssignedToTaskBoardTaskFormat
type: object
properties:
orderHintsByAssignee:
$ref: '#/components/schemas/PlannerOrderHintsByAssignee'
unassignedOrderHint:
type: string
description: "Hint value used to order the task on the AssignedTo view of\
\ the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee\
\ dictionary doesn't provide an order hint for the user the task is assigned\
\ to. The format is defined as outlined here."
nullable: true
additionalProperties: true
ProtectedApplicationMetadata:
allOf:
- $ref: '#/components/schemas/IntegratedApplicationMetadata'
- $ref: '#/components/schemas/ProtectedApplicationMetadata1'
ItemRetentionLabel:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ItemRetentionLabel1'
PlannerContainerType:
title: plannerContainerType
type: string
enum:
- group
- unknownFutureValue
- roster
InsightIdentity:
title: insightIdentity
type: object
properties:
address:
type: string
description: The email address of the user who shared the item.
nullable: true
displayName:
type: string
description: The display name of the user who shared the item.
nullable: true
id:
type: string
description: The ID of the user who shared the item.
nullable: true
additionalProperties: true
TeamworkConversationIdentityType:
title: teamworkConversationIdentityType
type: string
enum:
- team
- channel
- chat
- unknownFutureValue
PlannerPlan1:
title: plannerPlan
type: object
properties:
container:
$ref: '#/components/schemas/PlannerPlanContainer'
createdBy:
$ref: '#/components/schemas/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: "Read-only. Date and time at which the plan is 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"
format: date-time
nullable: true
owner:
type: string
description: "Use the container property instead. ID of the group that owns\
\ the plan. After it's set, this property can’t be updated. This property\
\ won't return a valid group ID if the container of the plan isn't a group."
nullable: true
title:
type: string
description: Required. Title of the plan.
buckets:
type: array
description: Read-only. Nullable. Collection of buckets in the plan.
items:
$ref: '#/components/schemas/PlannerBucket'
x-ms-navigationProperty: true
details:
$ref: '#/components/schemas/PlannerPlanDetails'
tasks:
type: array
description: Read-only. Nullable. Collection of tasks in the plan.
items:
$ref: '#/components/schemas/PlannerTask'
x-ms-navigationProperty: true
additionalProperties: true
OnenoteEntityBaseModel1:
title: onenoteEntityBaseModel
type: object
properties:
self:
type: string
description: The endpoint where you can get details about the page. Read-only.
nullable: true
additionalProperties: true
TeamworkTagType:
title: teamworkTagType
type: string
enum:
- standard
- unknownFutureValue
WorkbookWorksheetProtection:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookWorksheetProtection1'
ChatViewpoint:
title: chatViewpoint
type: object
properties:
isHidden:
type: boolean
description: Indicates whether the chat is hidden for the current user.
nullable: true
lastMessageReadDateTime:
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 dateTime up until which the current user has
read chatMessages in a specific chat.
format: date-time
nullable: true
additionalProperties: true
WorkbookFilter1:
title: workbookFilter
type: object
properties:
criteria:
$ref: '#/components/schemas/WorkbookFilterCriteria'
additionalProperties: true
WindowsSettingInstance1:
title: windowsSettingInstance
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: Set by the server. Represents the dateTime in UTC when the
object was created on the server.
format: date-time
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. The object expires at the specified dateTime\
\ in UTC, making it unavailable after that time."
format: date-time
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 if not provided in the request from the Windows
client device. Refers to the user's Windows device that modified the object
at the specified dateTime in UTC.
format: date-time
nullable: true
payload:
type: string
description: Base64-encoded JSON setting value.
additionalProperties: true
TeamworkHostedContent1:
title: teamworkHostedContent
type: object
properties:
contentBytes:
type: string
description: Write only. Bytes for the hosted content (such as images).
format: base64url
nullable: true
contentType:
type: string
description: "Write only. Content type. such as image/png, image/jpg."
nullable: true
additionalProperties: true
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
UsageDetails:
title: usageDetails
type: object
properties:
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 date and time the resource was last accessed by the user.\
\ The timestamp represents date and time information using ISO 8601 format\
\ and is always in UTC time. For example, midnight UTC on Jan 1, 2014\
\ is 2014-01-01T00:00:00Z. Read-only."
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 date and time the resource was last modified by the user.\
\ The timestamp represents date and time information using ISO 8601 format\
\ and is always in UTC time. For example, midnight UTC on Jan 1, 2014\
\ is 2014-01-01T00:00:00Z. Read-only."
format: date-time
nullable: true
additionalProperties: true
WorkbookFunctions1:
title: workbookFunctions
type: object
additionalProperties: true
WorkbookChartAxes1:
title: workbookChartAxes
type: object
properties:
categoryAxis:
$ref: '#/components/schemas/WorkbookChartAxis'
seriesAxis:
$ref: '#/components/schemas/WorkbookChartAxis'
valueAxis:
$ref: '#/components/schemas/WorkbookChartAxis'
additionalProperties: true
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
StorageQuotaBreakdown:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/StorageQuotaBreakdown1'
WindowsDeviceMalwareState1:
title: windowsDeviceMalwareState
type: object
properties:
additionalInformationUrl:
type: string
description: Information URL to learn more about the malware
nullable: true
category:
$ref: '#/components/schemas/WindowsMalwareCategory'
detectionCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of times the malware is detected
format: int32
nullable: true
displayName:
type: string
description: Malware name
nullable: true
executionState:
$ref: '#/components/schemas/WindowsMalwareExecutionState'
initialDetectionDateTime:
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: Initial detection datetime of the malware
format: date-time
nullable: true
lastStateChangeDateTime:
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 time this particular threat was changed
format: date-time
nullable: true
severity:
$ref: '#/components/schemas/WindowsMalwareSeverity'
state:
$ref: '#/components/schemas/WindowsMalwareState'
threatState:
$ref: '#/components/schemas/WindowsMalwareThreatState'
additionalProperties: true
description: Malware detection entity
ListInfo:
title: listInfo
type: object
properties:
contentTypesEnabled:
type: boolean
description: "If true, indicates that content types are enabled for this\
\ list."
nullable: true
hidden:
type: boolean
description: "If true, indicates that the list isn't normally visible in\
\ the SharePoint user experience."
nullable: true
template:
type: string
description: "An enumerated value that represents the base list template\
\ used in creating the list. Possible values include documentLibrary,\
\ genericList, task, survey, announcements, contacts, and more."
nullable: true
additionalProperties: true
WorkbookWorksheet:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookWorksheet1'
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
CalendarGroup:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/CalendarGroup1'
WorkbookChartTitle:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartTitle1'
AgreementAcceptance1:
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/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
ThumbnailSet1:
title: thumbnailSet
type: object
properties:
large:
$ref: '#/components/schemas/Thumbnail'
medium:
$ref: '#/components/schemas/Thumbnail'
small:
$ref: '#/components/schemas/Thumbnail'
source:
$ref: '#/components/schemas/Thumbnail'
additionalProperties: true
Drive:
allOf:
- $ref: '#/components/schemas/BaseItem'
- $ref: '#/components/schemas/Drive1'
SoftwareOathAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/SoftwareOathAuthenticationMethod1'
ScoredEmailAddress:
title: scoredEmailAddress
type: object
properties:
address:
type: string
description: The email address.
nullable: true
itemId:
type: string
nullable: true
relevanceScore:
type: number
description: "The relevance score of the email address. A relevance score\
\ is used as a sort key, in relation to the other returned results. A\
\ higher relevance score value corresponds to a more relevant result.\
\ Relevance is determined by the user’s communication and collaboration\
\ patterns and business relationships."
format: double
nullable: true
selectionLikelihood:
$ref: '#/components/schemas/SelectionLikelihoodInfo'
additionalProperties: true
TextColumn:
title: textColumn
type: object
properties:
allowMultipleLines:
type: boolean
description: Whether to allow multiple lines of text.
nullable: true
appendChangesToExistingText:
type: boolean
description: "Whether updates to this column should replace existing text,\
\ or append to it."
nullable: true
linesForEditing:
maximum: 2147483647
minimum: -2147483648
type: number
description: The size of the text box.
format: int32
nullable: true
maxLength:
maximum: 2147483647
minimum: -2147483648
type: number
description: The maximum number of characters for the value.
format: int32
nullable: true
textType:
type: string
description: The type of text being stored. Must be one of plain or richText
nullable: true
additionalProperties: true
CategoryColor:
title: categoryColor
type: string
enum:
- none
- preset0
- preset1
- preset2
- preset3
- preset4
- preset5
- preset6
- preset7
- preset8
- preset9
- preset10
- preset11
- preset12
- preset13
- preset14
- preset15
- preset16
- preset17
- preset18
- preset19
- preset20
- preset21
- preset22
- preset23
- preset24
UserScopeTeamsAppInstallation:
allOf:
- $ref: '#/components/schemas/TeamsAppInstallation'
- $ref: '#/components/schemas/UserScopeTeamsAppInstallation1'
TeamsAppPublishingState:
title: teamsAppPublishingState
type: string
enum:
- submitted
- rejected
- published
- unknownFutureValue
TeamMessagingSettings:
title: teamMessagingSettings
type: object
properties:
allowChannelMentions:
type: boolean
description: "If set to true, @channel mentions are allowed."
nullable: true
allowOwnerDeleteMessages:
type: boolean
description: "If set to true, owners can delete any message."
nullable: true
allowTeamMentions:
type: boolean
description: "If set to true, @team mentions are allowed."
nullable: true
allowUserDeleteMessages:
type: boolean
description: "If set to true, users can delete their messages."
nullable: true
allowUserEditMessages:
type: boolean
description: "If set to true, users can edit their messages."
nullable: true
additionalProperties: true
OutlookGeoCoordinates:
title: outlookGeoCoordinates
type: object
properties:
accuracy:
type: number
description: "The accuracy of the latitude and longitude. As an example,\
\ the accuracy can be measured in meters, such as the latitude and longitude\
\ are accurate to within 50 meters."
format: double
nullable: true
altitude:
type: number
description: The altitude of the location.
format: double
nullable: true
altitudeAccuracy:
type: number
description: The accuracy of the altitude.
format: double
nullable: true
latitude:
type: number
description: The latitude of the location.
format: double
nullable: true
longitude:
type: number
description: The longitude of the location.
format: double
nullable: true
additionalProperties: true
PrintOrientation:
title: printOrientation
type: string
enum:
- portrait
- landscape
- reverseLandscape
- reversePortrait
- unknownFutureValue
TermStoreGroup:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Group2'
WorkbookChartLegendFormat1:
title: workbookChartLegendFormat
type: object
properties:
fill:
$ref: '#/components/schemas/WorkbookChartFill'
font:
$ref: '#/components/schemas/WorkbookChartFont'
additionalProperties: true
WorkbookTableRow:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookTableRow1'
BroadcastMeetingSettings:
title: broadcastMeetingSettings
type: object
properties:
allowedAudience:
$ref: '#/components/schemas/BroadcastMeetingAudience'
captions:
$ref: '#/components/schemas/BroadcastMeetingCaptionSettings'
isAttendeeReportEnabled:
type: boolean
description: Indicates whether attendee report is enabled for this Teams
live event. Default value is false.
nullable: true
isQuestionAndAnswerEnabled:
type: boolean
description: Indicates whether Q&A is enabled for this Teams live event.
Default value is false.
nullable: true
isRecordingEnabled:
type: boolean
description: Indicates whether recording is enabled for this Teams live
event. Default value is false.
nullable: true
isVideoOnDemandEnabled:
type: boolean
description: Indicates whether video on demand is enabled for this Teams
live event. Default value is false.
nullable: true
additionalProperties: true
TeamsTemplate1:
title: teamsTemplate
type: object
additionalProperties: true
OnenotePage:
allOf:
- $ref: '#/components/schemas/OnenoteEntitySchemaObjectModel'
- $ref: '#/components/schemas/OnenotePage1'
MultiValueLegacyExtendedProperty1:
title: multiValueLegacyExtendedProperty
type: object
properties:
value:
type: array
description: A collection of property values.
items:
type: string
nullable: true
additionalProperties: true
ScheduleEntity:
title: scheduleEntity
type: object
properties:
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
format: date-time
nullable: true
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
format: date-time
nullable: true
theme:
$ref: '#/components/schemas/ScheduleEntityTheme'
additionalProperties: true
LearningCourseActivity:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/LearningCourseActivity1'
ChatMessagePolicyViolationUserActionTypes:
title: chatMessagePolicyViolationUserActionTypes
type: string
enum:
- none
- override
- reportFalsePositive
x-ms-enum-flags:
isFlags: true
TimeOffRequest1:
title: timeOffRequest
type: object
properties:
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 date and time the time off ends in ISO 8601 format and
in UTC time.
format: date-time
nullable: true
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 date and time the time off starts in ISO 8601 format and
in UTC time.
format: date-time
nullable: true
timeOffReasonId:
type: string
description: The reason for the time off.
nullable: true
additionalProperties: true
PlannerBucketTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerBucketTaskBoardTaskFormat1'
AccessAction:
title: accessAction
type: object
additionalProperties: true
UserScopeTeamsAppInstallation1:
title: userScopeTeamsAppInstallation
type: object
properties:
chat:
$ref: '#/components/schemas/Chat'
additionalProperties: true
ItemActivityCollectionResponse:
title: Collection of itemActivity
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/ItemActivity'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
UserActivityType:
title: userActivityType
type: string
enum:
- uploadText
- uploadFile
- downloadText
- downloadFile
- unknownFutureValue
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
PinnedChatMessageInfo:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PinnedChatMessageInfo1'
ScheduleChangeRequest:
allOf:
- $ref: '#/components/schemas/ChangeTrackedEntity'
- $ref: '#/components/schemas/ScheduleChangeRequest1'
WorkbookChartTitle1:
title: workbookChartTitle
type: object
properties:
overlay:
type: boolean
description: Indicates whether the chart title will overlay the chart or
not.
nullable: true
text:
type: string
description: The title text of the chart.
nullable: true
visible:
type: boolean
description: Indicates whether the chart title is visible.
format:
$ref: '#/components/schemas/WorkbookChartTitleFormat'
additionalProperties: true
PrintMargin:
title: printMargin
type: object
properties:
bottom:
maximum: 2147483647
minimum: -2147483648
type: number
description: The margin in microns from the bottom edge.
format: int32
nullable: true
left:
maximum: 2147483647
minimum: -2147483648
type: number
description: The margin in microns from the left edge.
format: int32
nullable: true
right:
maximum: 2147483647
minimum: -2147483648
type: number
description: The margin in microns from the right edge.
format: int32
nullable: true
top:
maximum: 2147483647
minimum: -2147483648
type: number
description: The margin in microns from the top edge.
format: int32
nullable: true
additionalProperties: true
Fido2AuthenticationMethod1:
title: fido2AuthenticationMethod
type: object
properties:
aaGuid:
type: string
description: "Authenticator Attestation GUID, an identifier that indicates\
\ the type (e.g. make and model) of the authenticator."
nullable: true
attestationCertificates:
type: array
description: The attestation certificate(s) attached to this security key.
items:
type: string
nullable: true
attestationLevel:
$ref: '#/components/schemas/AttestationLevel'
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 timestamp when this key was registered to the user.
format: date-time
nullable: true
displayName:
type: string
description: The display name of the key as given by the user.
nullable: true
model:
type: string
description: The manufacturer-assigned model of the FIDO2 security key.
nullable: true
additionalProperties: true
Permission1:
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/IdentitySet'
grantedToIdentities:
type: array
description: "For type permissions, the details of the users to whom permission\
\ was granted. Read-only."
items:
$ref: '#/components/schemas/IdentitySet'
grantedToIdentitiesV2:
type: array
description: "For link type permissions, the details of the users to whom\
\ permission was granted. Read-only."
items:
$ref: '#/components/schemas/SharePointIdentitySet'
grantedToV2:
$ref: '#/components/schemas/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/ItemReference'
invitation:
$ref: '#/components/schemas/SharingInvitation'
link:
$ref: '#/components/schemas/SharingLink'
roles:
type: array
description: "The type of permission, for example, read. See below for the\
\ full list of roles. Read-only."
items:
type: string
nullable: true
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
OAuth2PermissionGrant1:
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
DayOfWeek:
title: dayOfWeek
type: string
enum:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
DriveItemIdMicrosoftGraphRestoreBody:
type: object
properties:
parentReference:
$ref: '#/components/schemas/ItemReference'
name:
type: string
nullable: true
additionalProperties: true
PlannerCategoryDescriptions:
title: plannerCategoryDescriptions
type: object
properties:
category1:
type: string
description: The label associated with Category 1
nullable: true
category10:
type: string
description: The label associated with Category 10
nullable: true
category11:
type: string
description: The label associated with Category 11
nullable: true
category12:
type: string
description: The label associated with Category 12
nullable: true
category13:
type: string
description: The label associated with Category 13
nullable: true
category14:
type: string
description: The label associated with Category 14
nullable: true
category15:
type: string
description: The label associated with Category 15
nullable: true
category16:
type: string
description: The label associated with Category 16
nullable: true
category17:
type: string
description: The label associated with Category 17
nullable: true
category18:
type: string
description: The label associated with Category 18
nullable: true
category19:
type: string
description: The label associated with Category 19
nullable: true
category2:
type: string
description: The label associated with Category 2
nullable: true
category20:
type: string
description: The label associated with Category 20
nullable: true
category21:
type: string
description: The label associated with Category 21
nullable: true
category22:
type: string
description: The label associated with Category 22
nullable: true
category23:
type: string
description: The label associated with Category 23
nullable: true
category24:
type: string
description: The label associated with Category 24
nullable: true
category25:
type: string
description: The label associated with Category 25
nullable: true
category3:
type: string
description: The label associated with Category 3
nullable: true
category4:
type: string
description: The label associated with Category 4
nullable: true
category5:
type: string
description: The label associated with Category 5
nullable: true
category6:
type: string
description: The label associated with Category 6
nullable: true
category7:
type: string
description: The label associated with Category 7
nullable: true
category8:
type: string
description: The label associated with Category 8
nullable: true
category9:
type: string
description: The label associated with Category 9
nullable: true
additionalProperties: true
PendingContentUpdate:
title: pendingContentUpdate
type: object
properties:
queuedDateTime:
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 pending binary operation was queued in UTC
time. Read-only.
format: date-time
nullable: true
additionalProperties: true
OutlookItem:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/OutlookItem1'
InferenceClassificationOverride:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/InferenceClassificationOverride1'
CloudClipboardRoot:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/CloudClipboardRoot1'
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/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
UserPurpose:
title: userPurpose
type: string
enum:
- user
- linked
- shared
- room
- equipment
- others
- unknownFutureValue
BaseItem1:
title: baseItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/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/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/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/User'
lastModifiedByUser:
$ref: '#/components/schemas/User'
additionalProperties: true
LocationType:
title: locationType
type: string
enum:
- default
- conferenceRoom
- homeAddress
- businessAddress
- geoCoordinates
- streetAddress
- hotel
- restaurant
- localBusiness
- postalAddress
TeamInfo1:
title: teamInfo
type: object
properties:
displayName:
type: string
description: The name of the team.
nullable: true
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
team:
$ref: '#/components/schemas/Team'
additionalProperties: true
PrintColorMode:
title: printColorMode
type: string
enum:
- blackAndWhite
- grayscale
- color
- auto
- unknownFutureValue
Shared:
title: shared
type: object
properties:
owner:
$ref: '#/components/schemas/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/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
SharePointIdentity:
allOf:
- $ref: '#/components/schemas/Identity'
- $ref: '#/components/schemas/SharePointIdentity1'
Importance:
title: importance
type: string
enum:
- low
- normal
- high
TimeCardBreak:
title: timeCardBreak
type: object
properties:
breakId:
type: string
description: ID of the timeCardBreak.
nullable: true
end:
$ref: '#/components/schemas/TimeCardEvent'
notes:
$ref: '#/components/schemas/ItemBody'
start:
$ref: '#/components/schemas/TimeCardEvent'
additionalProperties: true
CloudClipboardItem1:
title: cloudClipboardItem
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: Set by the server. DateTime in UTC when the object was created
on the server.
format: date-time
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 expires\
\ and after that the object is no longer available. The default and also\
\ maximum TTL is 12 hours after the creation, but it might change for\
\ performance optimization."
format: date-time
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 if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
format: date-time
nullable: true
payloads:
type: array
description: A cloudClipboardItem can have multiple cloudClipboardItemPayload
objects in the payloads. A window can place more than one clipboard object
on the clipboard. Each one represents the same information in a different
clipboard format.
items:
$ref: '#/components/schemas/CloudClipboardItemPayload'
additionalProperties: true
Subscription:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Subscription1'
OutlookCategory1:
title: outlookCategory
type: object
properties:
color:
$ref: '#/components/schemas/CategoryColor'
displayName:
type: string
description: "A unique name that identifies a category in the user's mailbox.\
\ After a category is created, the name cannot be changed. Read-only."
nullable: true
additionalProperties: true
ChatMessageHostedContent:
allOf:
- $ref: '#/components/schemas/TeamworkHostedContent'
- $ref: '#/components/schemas/ChatMessageHostedContent1'
WorkbookChartFill1:
title: workbookChartFill
type: object
additionalProperties: true
PlannerBucket:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerBucket1'
LearningCourseActivity1:
title: learningCourseActivity
type: object
properties:
completedDateTime:
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 the assignment was completed. Optional.
format: date-time
nullable: true
completionPercentage:
maximum: 2147483647
minimum: -2147483648
type: number
description: The percentage completion value of the course activity. Optional.
format: int32
nullable: true
externalcourseActivityId:
type: string
nullable: true
learnerUserId:
type: string
description: The user ID of the learner to whom the activity is assigned.
Required.
learningContentId:
type: string
description: The ID of the learning content created in Viva Learning. Required.
learningProviderId:
type: string
description: The registration ID of the provider. Required.
nullable: true
status:
$ref: '#/components/schemas/CourseStatus'
additionalProperties: true
CallTranscript1:
title: callTranscript
type: object
properties:
callId:
type: string
description: The unique identifier for the call that is related to this
transcript. Read-only.
nullable: true
content:
type: string
description: The content of the transcript. Read-only.
format: base64url
nullable: true
contentCorrelationId:
type: string
description: The unique identifier that links the transcript with its corresponding
recording. Read-only.
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 at which the transcript was created. 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
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: "Date and time at which the transcription ends. 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
meetingId:
type: string
description: The unique identifier of the online meeting related to this
transcript. Read-only.
nullable: true
meetingOrganizer:
$ref: '#/components/schemas/IdentitySet'
metadataContent:
type: string
description: The time-aligned metadata of the utterances in the transcript.
Read-only.
format: base64url
nullable: true
transcriptContentUrl:
type: string
description: The URL that can be used to access the content of the transcript.
Read-only.
nullable: true
additionalProperties: true
PlannerPlan:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerPlan1'
ChatMessage1:
title: chatMessage
type: object
properties:
attachments:
type: array
description: "References to attached objects like files, tabs, meetings\
\ etc."
items:
$ref: '#/components/schemas/ChatMessageAttachment'
body:
$ref: '#/components/schemas/ItemBody'
channelIdentity:
$ref: '#/components/schemas/ChannelIdentity'
chatId:
type: string
description: "If the message was sent in a chat, represents the identity\
\ of the chat."
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 of when the chat message was created.
format: date-time
nullable: true
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: "Read only. Timestamp at which the chat message was deleted,\
\ or null if not deleted."
format: date-time
nullable: true
etag:
type: string
description: Read-only. Version number of the chat message.
nullable: true
eventDetail:
$ref: '#/components/schemas/EventMessageDetail'
from:
$ref: '#/components/schemas/ChatMessageFromIdentitySet'
importance:
$ref: '#/components/schemas/ChatMessageImportance'
lastEditedDateTime:
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: Read only. Timestamp when edits to the chat message were made.
Triggers an 'Edited' flag in the Teams UI. If no edits are made the value
is null.
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: "Read only. Timestamp when the chat message is created (initial\
\ setting) or modified, including when a reaction is added or removed."
format: date-time
nullable: true
locale:
type: string
description: Locale of the chat message set by the client. Always set to
en-us.
mentions:
type: array
description: "List of entities mentioned in the chat message. Supported\
\ entities are: user, bot, team, channel, chat, and tag."
items:
$ref: '#/components/schemas/ChatMessageMention'
messageHistory:
type: array
description: "List of activity history of a message item, including modification\
\ time and actions, such as reactionAdded, reactionRemoved, or reaction\
\ changes, on the message."
items:
$ref: '#/components/schemas/ChatMessageHistoryItem'
messageType:
$ref: '#/components/schemas/ChatMessageType'
policyViolation:
$ref: '#/components/schemas/ChatMessagePolicyViolation'
reactions:
type: array
description: "Reactions for this chat message (for example, Like)."
items:
$ref: '#/components/schemas/ChatMessageReaction'
replyToId:
type: string
description: "Read-only. ID of the parent chat message or root chat message\
\ of the thread. (Only applies to chat messages in channels, not chats.)"
nullable: true
subject:
type: string
description: "The subject of the chat message, in plaintext."
nullable: true
summary:
type: string
description: "Summary text of the chat message that could be used for push\
\ notifications and summary views or fall back views. Only applies to\
\ channel chat messages, not chat messages in a chat."
nullable: true
webUrl:
type: string
description: Read-only. Link to the message in Microsoft Teams.
nullable: true
hostedContents:
type: array
description: "Content in a message hosted by Microsoft Teams - for example,\
\ images or code snippets."
items:
$ref: '#/components/schemas/ChatMessageHostedContent'
x-ms-navigationProperty: true
replies:
type: array
description: Replies for a specified message. Supports $expand for channel
messages.
items:
$ref: '#/components/schemas/ChatMessage'
x-ms-navigationProperty: true
additionalProperties: true
WorkbookChartAxis:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartAxis1'
OutlookCategory:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/OutlookCategory1'
TeamSummary:
title: teamSummary
type: object
properties:
guestsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of guests in a team.
format: int32
nullable: true
membersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of members in a team.
format: int32
nullable: true
ownersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of owners in a team.
format: int32
nullable: true
additionalProperties: true
WorkbookTable1:
title: workbookTable
type: object
properties:
highlightFirstColumn:
type: boolean
description: Indicates whether the first column contains special formatting.
highlightLastColumn:
type: boolean
description: Indicates whether the last column contains special formatting.
legacyId:
type: string
description: A legacy identifier used in older Excel clients. The value
of the identifier remains the same even when the table is renamed. This
property should be interpreted as an opaque string value and shouldn't
be parsed to any other type. Read-only.
nullable: true
name:
type: string
description: The name of the table.
nullable: true
showBandedColumns:
type: boolean
description: Indicates whether the columns show banded formatting in which
odd columns are highlighted differently from even ones to make reading
the table easier.
showBandedRows:
type: boolean
description: Indicates whether the rows show banded formatting in which
odd rows are highlighted differently from even ones to make reading the
table easier.
showFilterButton:
type: boolean
description: Indicates whether the filter buttons are visible at the top
of each column header. Setting this is only allowed if the table contains
a header row.
showHeaders:
type: boolean
description: Indicates whether the header row is visible or not. This value
can be set to show or remove the header row.
showTotals:
type: boolean
description: Indicates whether the total row is visible or not. This value
can be set to show or remove the total row.
style:
type: string
description: "A constant value that represents the Table style. Possible\
\ values are: TableStyleLight1 through TableStyleLight21, TableStyleMedium1\
\ through TableStyleMedium28, TableStyleStyleDark1 through TableStyleStyleDark11.\
\ A custom user-defined style present in the workbook can also be specified."
nullable: true
columns:
type: array
description: The list of all the columns in the table. Read-only.
items:
$ref: '#/components/schemas/WorkbookTableColumn'
x-ms-navigationProperty: true
rows:
type: array
description: The list of all the rows in the table. Read-only.
items:
$ref: '#/components/schemas/WorkbookTableRow'
x-ms-navigationProperty: true
sort:
$ref: '#/components/schemas/WorkbookTableSort'
worksheet:
$ref: '#/components/schemas/WorkbookWorksheet'
additionalProperties: true
WorkbookOperationStatus:
title: workbookOperationStatus
type: string
enum:
- notStarted
- running
- succeeded
- failed
Site:
allOf:
- $ref: '#/components/schemas/BaseItem'
- $ref: '#/components/schemas/Site1'
WorkbookSortField:
title: workbookSortField
type: object
properties:
ascending:
type: boolean
description: Represents whether the sorting is done in an ascending fashion.
color:
type: string
description: Represents the color that is the target of the condition if
the sorting is on font or cell color.
nullable: true
dataOption:
type: string
description: "Represents additional sorting options for this field. The\
\ possible values are: Normal, TextAsNumber."
icon:
$ref: '#/components/schemas/WorkbookIcon'
key:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Represents the column (or row, depending on the sort orientation)\
\ that the condition is on. Represented as an offset from the first column\
\ (or row)."
format: int32
sortOn:
type: string
description: "Represents the type of sorting of this condition. The possible\
\ values are: Value, CellColor, FontColor, Icon."
additionalProperties: true
KeyValue:
title: keyValue
type: object
properties:
key:
type: string
description: Key for the key-value pair.
nullable: true
value:
type: string
description: Value for the key-value pair.
nullable: true
additionalProperties: true
FieldValueSet:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/FieldValueSet1'
PageLayoutType:
title: pageLayoutType
type: string
enum:
- microsoftReserved
- article
- home
- unknownFutureValue
FreeBusyStatus:
title: freeBusyStatus
type: string
enum:
- unknown
- free
- tentative
- busy
- oof
- workingElsewhere
TermStoreRelationType:
title: relationType
type: string
enum:
- pin
- reuse
- unknownFutureValue
ResourceSpecificPermissionGrant1:
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
OnenoteOperation:
allOf:
- $ref: '#/components/schemas/Operation'
- $ref: '#/components/schemas/OnenoteOperation1'
LocationUniqueIdType:
title: locationUniqueIdType
type: string
enum:
- unknown
- locationStore
- directory
- private
- bing
ListItemVersion1:
title: listItemVersion
type: object
properties:
fields:
$ref: '#/components/schemas/FieldValueSet'
additionalProperties: true
ActivityHistoryItem:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ActivityHistoryItem1'
TimeOffReason:
allOf:
- $ref: '#/components/schemas/ChangeTrackedEntity'
- $ref: '#/components/schemas/TimeOffReason1'
WorkbookChartAxisTitleFormat1:
title: workbookChartAxisTitleFormat
type: object
properties:
font:
$ref: '#/components/schemas/WorkbookChartFont'
additionalProperties: true
UserTeamwork:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UserTeamwork1'
TimeOffRequest:
allOf:
- $ref: '#/components/schemas/ScheduleChangeRequest'
- $ref: '#/components/schemas/TimeOffRequest1'
WorkbookChartSeries1:
title: workbookChartSeries
type: object
properties:
name:
type: string
description: The name of a series in a chart.
nullable: true
format:
$ref: '#/components/schemas/WorkbookChartSeriesFormat'
points:
type: array
description: A collection of all points in the series. Read-only.
items:
$ref: '#/components/schemas/WorkbookChartPoint'
x-ms-navigationProperty: true
additionalProperties: true
PublicInnerError:
title: publicInnerError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
details:
type: array
description: A collection of error details.
items:
$ref: '#/components/schemas/PublicErrorDetail'
message:
type: string
description: The error message.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties: true
ColumnDefinition:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ColumnDefinition1'
WorkbookTable:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookTable1'
ThumbnailSet:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ThumbnailSet1'
OnenotePage1:
title: onenotePage
type: object
properties:
content:
type: string
description: The page's HTML content.
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for the page's HTML content. Read-only.
nullable: true
createdByAppId:
type: string
description: The unique identifier of the application that created the page.
Read-only.
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 date and time when the page was last modified. The timestamp\
\ represents date and time information using ISO 8601 format and is always\
\ in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.\
\ Read-only."
format: date-time
nullable: true
level:
maximum: 2147483647
minimum: -2147483648
type: number
description: The indentation level of the page. Read-only.
format: int32
nullable: true
links:
$ref: '#/components/schemas/PageLinks'
order:
maximum: 2147483647
minimum: -2147483648
type: number
description: The order of the page within its parent section. Read-only.
format: int32
nullable: true
title:
type: string
description: The title of the page.
nullable: true
userTags:
type: array
items:
type: string
nullable: true
parentNotebook:
$ref: '#/components/schemas/Notebook'
parentSection:
$ref: '#/components/schemas/OnenoteSection'
additionalProperties: true
Sensitivity:
title: sensitivity
type: string
enum:
- normal
- personal
- private
- confidential
Authentication:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Authentication1'
WebsiteType:
title: websiteType
type: string
enum:
- other
- home
- work
- blog
- profile
TemporaryAccessPassAuthenticationMethod1:
title: temporaryAccessPassAuthenticationMethod
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 when the Temporary Access Pass was created.
format: date-time
nullable: true
isUsable:
type: boolean
description: The state of the authentication method that indicates whether
it's currently usable by the user.
nullable: true
isUsableOnce:
type: boolean
description: "Determines whether the pass is limited to a one-time use.\
\ If true, the pass can be used once; if false, the pass can be used multiple\
\ times within the Temporary Access Pass lifetime."
nullable: true
lifetimeInMinutes:
maximum: 2147483647
minimum: -2147483648
type: number
description: The lifetime of the Temporary Access Pass in minutes starting
at startDateTime. Must be between 10 and 43200 inclusive (equivalent to
30 days).
format: int32
nullable: true
methodUsabilityReason:
type: string
description: "Details about the usability state (isUsable). Reasons can\
\ include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed."
nullable: true
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 date and time when the Temporary Access Pass becomes available
to use and when isUsable is true is enforced.
format: date-time
nullable: true
temporaryAccessPass:
type: string
description: The Temporary Access Pass used to authenticate. Returned only
on creation of a new temporaryAccessPassAuthenticationMethod object; Hidden
in subsequent read operations and returned as null with GET.
nullable: true
additionalProperties: true
WorkbookChartAxis1:
title: workbookChartAxis
type: object
properties:
majorUnit:
$ref: '#/components/schemas/Json'
maximum:
$ref: '#/components/schemas/Json'
minimum:
$ref: '#/components/schemas/Json'
minorUnit:
$ref: '#/components/schemas/Json'
format:
$ref: '#/components/schemas/WorkbookChartAxisFormat'
majorGridlines:
$ref: '#/components/schemas/WorkbookChartGridlines'
minorGridlines:
$ref: '#/components/schemas/WorkbookChartGridlines'
title:
$ref: '#/components/schemas/WorkbookChartAxisTitle'
additionalProperties: true
LinkedResource1:
title: linkedResource
type: object
properties:
applicationName:
type: string
description: The app name of the source that sends the linkedResource.
nullable: true
displayName:
type: string
description: The title of the linkedResource.
nullable: true
externalId:
type: string
description: ID of the object that is associated with this task on the third-party/partner
system.
nullable: true
webUrl:
type: string
description: Deep link to the linkedResource.
nullable: true
additionalProperties: true
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
Authentication1:
title: authentication
type: object
properties:
emailMethods:
type: array
description: The email address registered to a user for authentication.
items:
$ref: '#/components/schemas/EmailAuthenticationMethod'
x-ms-navigationProperty: true
fido2Methods:
type: array
description: Represents the FIDO2 security keys registered to a user for
authentication.
items:
$ref: '#/components/schemas/Fido2AuthenticationMethod'
x-ms-navigationProperty: true
methods:
type: array
description: Represents all authentication methods registered to a user.
items:
$ref: '#/components/schemas/AuthenticationMethod'
x-ms-navigationProperty: true
microsoftAuthenticatorMethods:
type: array
description: The details of the Microsoft Authenticator app registered to
a user for authentication.
items:
$ref: '#/components/schemas/MicrosoftAuthenticatorAuthenticationMethod'
x-ms-navigationProperty: true
operations:
type: array
description: "Represents the status of a long-running operation, such as\
\ a password reset operation."
items:
$ref: '#/components/schemas/LongRunningOperation'
x-ms-navigationProperty: true
passwordMethods:
type: array
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."
items:
$ref: '#/components/schemas/PasswordAuthenticationMethod'
x-ms-navigationProperty: true
phoneMethods:
type: array
description: The phone numbers registered to a user for authentication.
items:
$ref: '#/components/schemas/PhoneAuthenticationMethod'
x-ms-navigationProperty: true
platformCredentialMethods:
type: array
description: Represents a platform credential instance registered to a user
on Mac OS.
items:
$ref: '#/components/schemas/PlatformCredentialAuthenticationMethod'
x-ms-navigationProperty: true
softwareOathMethods:
type: array
description: The software OATH time-based one-time password (TOTP) applications
registered to a user for authentication.
items:
$ref: '#/components/schemas/SoftwareOathAuthenticationMethod'
x-ms-navigationProperty: true
temporaryAccessPassMethods:
type: array
description: Represents a Temporary Access Pass registered to a user for
authentication through time-limited passcodes.
items:
$ref: '#/components/schemas/TemporaryAccessPassAuthenticationMethod'
x-ms-navigationProperty: true
windowsHelloForBusinessMethods:
type: array
description: Represents the Windows Hello for Business authentication method
registered to a user for authentication.
items:
$ref: '#/components/schemas/WindowsHelloForBusinessAuthenticationMethod'
x-ms-navigationProperty: true
additionalProperties: true
LobbyBypassSettings:
title: lobbyBypassSettings
type: object
properties:
isDialInBypassEnabled:
type: boolean
description: Specifies whether or not to always let dial-in callers bypass
the lobby. Optional.
nullable: true
scope:
$ref: '#/components/schemas/LobbyBypassScope'
additionalProperties: true
Shift1:
title: shift
type: object
properties:
draftShift:
$ref: '#/components/schemas/ShiftItem'
isStagedForDeletion:
type: boolean
description: "The shift is marked for deletion, a process that is finalized\
\ when the schedule is shared."
nullable: true
schedulingGroupId:
type: string
description: ID of the scheduling group the shift is part of. Required.
nullable: true
sharedShift:
$ref: '#/components/schemas/ShiftItem'
userId:
type: string
description: ID of the user assigned to the shift. Required.
nullable: true
additionalProperties: true
TimeOffItem1:
title: timeOffItem
type: object
properties:
timeOffReasonId:
type: string
description: ID of the timeOffReason for this timeOffItem. Required.
nullable: true
additionalProperties: true
StorageQuotaBreakdown1:
title: storageQuotaBreakdown
type: object
properties:
displayName:
type: string
nullable: true
manageWebUrl:
type: string
nullable: true
used:
type: number
format: int64
nullable: true
additionalProperties: true
EventMessageDetail:
title: eventMessageDetail
type: object
additionalProperties: true
SettingSource:
title: settingSource
type: object
properties:
displayName:
type: string
description: Not yet documented
nullable: true
id:
type: string
description: Not yet documented
nullable: true
sourceType:
$ref: '#/components/schemas/SettingSourceType'
additionalProperties: true
DateTimeTimeZone:
title: dateTimeTimeZone
type: object
properties:
dateTime:
type: string
description: "A single point of time in a combined date and time representation\
\ ({date}T{time}; for example, 2017-08-29T04:00:00.0000000)."
timeZone:
type: string
description: "Represents a time zone, for example, 'Pacific Standard Time'.\
\ See below for more possible values."
nullable: true
additionalProperties: true
DefaultColumnValue:
title: defaultColumnValue
type: object
properties:
formula:
type: string
description: The formula used to compute the default value for the column.
nullable: true
value:
type: string
description: The direct value to use as the default value for the column.
nullable: true
additionalProperties: true
DisplayNameLocalization:
title: displayNameLocalization
type: object
properties:
displayName:
type: string
description: "If present, the value of this field contains the displayName\
\ string that has been set for the language present in the languageTag\
\ field."
nullable: true
languageTag:
type: string
description: Provides the language culture-code and friendly name of the
language that the displayName field has been provided in.
nullable: true
additionalProperties: true
WorkbookChartAxisTitle:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartAxisTitle1'
PlannerProgressTaskBoardTaskFormat1:
title: plannerProgressTaskBoardTaskFormat
type: object
properties:
orderHint:
type: string
description: "Hint value used to order the task on the progress view of\
\ the task board. For details about the supported format, see Using order\
\ hints in Planner."
nullable: true
additionalProperties: true
PrintFinishing:
title: printFinishing
type: string
enum:
- none
- staple
- punch
- cover
- bind
- saddleStitch
- stitchEdge
- stapleTopLeft
- stapleBottomLeft
- stapleTopRight
- stapleBottomRight
- stitchLeftEdge
- stitchTopEdge
- stitchRightEdge
- stitchBottomEdge
- stapleDualLeft
- stapleDualTop
- stapleDualRight
- stapleDualBottom
- unknownFutureValue
- stapleTripleLeft
- stapleTripleTop
- stapleTripleRight
- stapleTripleBottom
- bindLeft
- bindTop
- bindRight
- bindBottom
- foldAccordion
- foldDoubleGate
- foldGate
- foldHalf
- foldHalfZ
- foldLeftGate
- foldLetter
- foldParallel
- foldPoster
- foldRightGate
- foldZ
- foldEngineeringZ
- punchTopLeft
- punchBottomLeft
- punchTopRight
- punchBottomRight
- punchDualLeft
- punchDualTop
- punchDualRight
- punchDualBottom
- punchTripleLeft
- punchTripleTop
- punchTripleRight
- punchTripleBottom
- punchQuadLeft
- punchQuadTop
- punchQuadRight
- punchQuadBottom
- fold
- trim
- bale
- bookletMaker
- coat
- laminate
- trimAfterPages
- trimAfterDocuments
- trimAfterCopies
- trimAfterJob
ManagedAppRegistration:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ManagedAppRegistration1'
OutOfOfficeSettings:
title: outOfOfficeSettings
type: object
properties:
isOutOfOffice:
type: boolean
description: "If true, either of the following is met:The current time falls\
\ within the out-of-office window configured in Outlook or Teams.An event\
\ marked as 'Show as Out of Office' appears on the user's calendar.Otherwise,\
\ false."
nullable: true
message:
type: string
description: The out-of-office message configured by the user in the Outlook
client (Automatic replies) or the Teams client (Schedule out of office).
nullable: true
additionalProperties: true
Device:
allOf:
- $ref: '#/components/schemas/DirectoryObject'
- $ref: '#/components/schemas/Device1'
Channel:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Channel1'
TeamsTabConfiguration:
title: teamsTabConfiguration
type: object
properties:
contentUrl:
type: string
description: Url used for rendering tab contents in Teams. Required.
nullable: true
entityId:
type: string
description: Identifier for the entity hosted by the tab provider.
nullable: true
removeUrl:
type: string
description: Url called by Teams client when a Tab is removed using the
Teams Client.
nullable: true
websiteUrl:
type: string
description: Url for showing tab contents outside of Teams.
nullable: true
additionalProperties: true
ChoiceColumn:
title: choiceColumn
type: object
properties:
allowTextEntry:
type: boolean
description: "If true, allows custom values that aren't in the configured\
\ choices."
nullable: true
choices:
type: array
description: The list of values available for this column.
items:
type: string
nullable: true
displayAs:
type: string
description: "How the choices are to be presented in the UX. Must be one\
\ of checkBoxes, dropDownMenu, or radioButtons"
nullable: true
additionalProperties: true
PhysicalAddress:
title: physicalAddress
type: object
properties:
city:
type: string
description: The city.
nullable: true
countryOrRegion:
type: string
description: "The country or region. It's a free-format string value, for\
\ example, 'United States'."
nullable: true
postalCode:
type: string
description: The postal code.
nullable: true
state:
type: string
description: The state.
nullable: true
street:
type: string
description: The street.
nullable: true
additionalProperties: true
CalculatedColumn:
title: calculatedColumn
type: object
properties:
format:
type: string
description: "For dateTime output types, the format of the value. Possible\
\ values are: dateOnly or dateTime."
nullable: true
formula:
type: string
description: The formula used to compute the value for this column.
nullable: true
outputType:
type: string
description: "The output type used to format values in this column. Possible\
\ values are: boolean, currency, dateTime, number, or text."
nullable: true
additionalProperties: true
ColumnTypes:
title: columnTypes
type: string
enum:
- note
- text
- choice
- multichoice
- number
- currency
- dateTime
- lookup
- boolean
- user
- url
- calculated
- location
- geolocation
- term
- multiterm
- thumbnail
- approvalStatus
- unknownFutureValue
AuthorizationInfo:
title: authorizationInfo
type: object
properties:
certificateUserIds:
type: array
items:
type: string
nullable: true
additionalProperties: true
WorkbookOperation1:
title: workbookOperation
type: object
properties:
error:
$ref: '#/components/schemas/WorkbookOperationError'
resourceLocation:
type: string
description: The resource URI for the result.
nullable: true
status:
$ref: '#/components/schemas/WorkbookOperationStatus'
additionalProperties: true
PhoneType:
title: phoneType
type: string
enum:
- home
- business
- mobile
- other
- assistant
- homeFax
- businessFax
- otherFax
- pager
- radio
ChatMessageInfo1:
title: chatMessageInfo
type: object
properties:
body:
$ref: '#/components/schemas/ItemBody'
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 time object representing the time at which message was
created.
format: date-time
nullable: true
eventDetail:
$ref: '#/components/schemas/EventMessageDetail'
from:
$ref: '#/components/schemas/ChatMessageFromIdentitySet'
isDeleted:
type: boolean
description: "If set to true, the original message has been deleted."
nullable: true
messageType:
$ref: '#/components/schemas/ChatMessageType'
additionalProperties: true
CloudClipboardItemPayload:
title: cloudClipboardItemPayload
type: object
properties:
content:
type: string
description: The formatName version of the value of a cloud clipboard encoded
in base64.
formatName:
type: string
description: For a list of possible values see formatName values.
additionalProperties: true
CallRecording1:
title: callRecording
type: object
properties:
callId:
type: string
description: The unique identifier for the call that is related to this
recording. Read-only.
nullable: true
content:
type: string
description: The content of the recording. Read-only.
format: base64url
nullable: true
contentCorrelationId:
type: string
description: The unique identifier that links the transcript with its corresponding
recording. Read-only.
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 at which the recording was created. 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
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: "Date and time at which the recording ends. 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
meetingId:
type: string
description: The unique identifier of the onlineMeeting related to this
recording. Read-only.
nullable: true
meetingOrganizer:
$ref: '#/components/schemas/IdentitySet'
recordingContentUrl:
type: string
description: The URL that can be used to access the content of the recording.
Read-only.
nullable: true
additionalProperties: true
TodoTask1:
title: todoTask
type: object
properties:
body:
$ref: '#/components/schemas/ItemBody'
bodyLastModifiedDateTime:
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 task body was last modified. By\
\ default, it is in UTC. You can provide a custom time zone in the request\
\ header. The property value uses ISO 8601 format and is always in UTC\
\ time. For example, midnight UTC on Jan 1, 2020 would look like this:\
\ '2020-01-01T00:00:00Z'."
format: date-time
categories:
type: array
description: The categories associated with the task. Each category corresponds
to the displayName property of an outlookCategory that the user has defined.
items:
type: string
nullable: true
completedDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
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 when the task was created. By default, it\
\ is in UTC. You can provide a custom time zone in the request header.\
\ The property value uses ISO 8601 format. For example, midnight UTC on\
\ Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'."
format: date-time
dueDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
hasAttachments:
type: boolean
description: Indicates whether the task has attachments.
nullable: true
importance:
$ref: '#/components/schemas/Importance'
isReminderOn:
type: boolean
description: Set to true if an alert is set to remind the user of the task.
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 date and time when the task was last modified. By default,\
\ it is in UTC. You can provide a custom time zone in the request header.\
\ The property value uses ISO 8601 format and is always in UTC time. For\
\ example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'."
format: date-time
recurrence:
$ref: '#/components/schemas/PatternedRecurrence'
reminderDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
startDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
status:
$ref: '#/components/schemas/TaskStatus'
title:
type: string
description: A brief description of the task.
nullable: true
attachments:
type: array
description: A collection of file attachments for the task.
items:
$ref: '#/components/schemas/AttachmentBase'
x-ms-navigationProperty: true
attachmentSessions:
type: array
items:
$ref: '#/components/schemas/AttachmentSession'
x-ms-navigationProperty: true
checklistItems:
type: array
description: A collection of checklistItems linked to a task.
items:
$ref: '#/components/schemas/ChecklistItem'
x-ms-navigationProperty: true
extensions:
type: array
description: The collection of open extensions defined for the task. Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
linkedResources:
type: array
description: A collection of resources linked to the task.
items:
$ref: '#/components/schemas/LinkedResource'
x-ms-navigationProperty: true
additionalProperties: true
PrintConnector:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PrintConnector1'
PrinterBase1:
title: printerBase
type: object
properties:
capabilities:
$ref: '#/components/schemas/PrinterCapabilities'
defaults:
$ref: '#/components/schemas/PrinterDefaults'
displayName:
type: string
description: The name of the printer/printerShare.
isAcceptingJobs:
type: boolean
description: Specifies whether the printer/printerShare is currently accepting
new print jobs.
nullable: true
location:
$ref: '#/components/schemas/PrinterLocation'
manufacturer:
type: string
description: The manufacturer of the printer/printerShare.
nullable: true
model:
type: string
description: The model name of the printer/printerShare.
nullable: true
status:
$ref: '#/components/schemas/PrinterStatus'
jobs:
type: array
description: The list of jobs that are queued for printing by the printer/printerShare.
items:
$ref: '#/components/schemas/PrintJob'
x-ms-navigationProperty: true
additionalProperties: true
Message:
allOf:
- $ref: '#/components/schemas/OutlookItem'
- $ref: '#/components/schemas/Message1'
MicrosoftAuthenticatorAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/MicrosoftAuthenticatorAuthenticationMethod1'
WindowsSetting1:
title: windowsSetting
type: object
properties:
payloadType:
type: string
description: The type of setting payloads contained in the instances navigation
property.
nullable: true
settingType:
$ref: '#/components/schemas/WindowsSettingType'
windowsDeviceId:
type: string
description: A unique identifier for the device the setting might belong
to if it is of the settingType backup.
nullable: true
instances:
type: array
description: A collection of setting values for a given windowsSetting.
items:
$ref: '#/components/schemas/WindowsSettingInstance'
x-ms-navigationProperty: true
additionalProperties: true
AuthenticationMethodPlatform:
title: authenticationMethodPlatform
type: string
enum:
- unknown
- windows
- macOS
- iOS
- android
- linux
- unknownFutureValue
ProfilePhoto:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ProfilePhoto1'
ContentApprovalStatusColumn:
title: contentApprovalStatusColumn
type: object
additionalProperties: true
PrintJobStatus:
title: printJobStatus
type: object
properties:
description:
type: string
description: A human-readable description of the print job's current processing
state. Read-only.
details:
type: array
description: Additional details for print job state. Valid values are described
in the following table. Read-only.
items:
$ref: '#/components/schemas/PrintJobStateDetail'
isAcquiredByPrinter:
type: boolean
description: True if the job was acknowledged by a printer; false otherwise.
Read-only.
state:
$ref: '#/components/schemas/PrintJobProcessingState'
additionalProperties: true
ChatMessageReactionIdentitySet:
allOf:
- $ref: '#/components/schemas/IdentitySet'
- $ref: '#/components/schemas/ChatMessageReactionIdentitySet1'
WindowsSettingType:
title: windowsSettingType
type: string
enum:
- roaming
- backup
- unknownFutureValue
Bundle:
title: bundle
type: object
properties:
album:
$ref: '#/components/schemas/Album'
childCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of children contained immediately within this container.
format: int32
nullable: true
additionalProperties: true
PlannerChecklistItems:
title: plannerChecklistItems
type: object
additionalProperties: true
CourseStatus:
title: courseStatus
type: string
enum:
- notStarted
- inProgress
- completed
- unknownFutureValue
SecurityBehaviorDuringRetentionPeriod:
title: behaviorDuringRetentionPeriod
type: string
enum:
- doNotRetain
- retain
- retainAsRecord
- retainAsRegulatoryRecord
- unknownFutureValue
WorkbookNamedItem:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookNamedItem1'
CalendarPermission:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/CalendarPermission1'
TeamsTab1:
title: teamsTab
type: object
properties:
configuration:
$ref: '#/components/schemas/TeamsTabConfiguration'
displayName:
type: string
description: Name of the tab.
nullable: true
webUrl:
type: string
description: Deep link URL of the tab instance. Read-only.
nullable: true
teamsApp:
$ref: '#/components/schemas/TeamsApp'
additionalProperties: true
OperatingSystemSpecifications:
title: operatingSystemSpecifications
type: object
properties:
operatingSystemPlatform:
type: string
description: "The platform of the operating system (for example, 'Windows')."
operatingSystemVersion:
type: string
description: The version string of the operating system.
additionalProperties: true
ItemActivityStat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ItemActivityStat1'
PrinterBase:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PrinterBase1'
Entity:
title: entity
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
additionalProperties: true
SiteArchivalDetails:
title: siteArchivalDetails
type: object
properties:
archiveStatus:
$ref: '#/components/schemas/SiteArchiveStatus'
additionalProperties: true
ListItemVersionCollectionResponse:
title: Collection of listItemVersion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/ListItemVersion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
Store:
title: store
type: object
properties:
defaultLanguageTag:
type: string
description: Default language of the term store.
languageTags:
type: array
description: List of languages for the term store.
items:
type: string
groups:
type: array
description: Collection of all groups available in the term store.
items:
$ref: '#/components/schemas/TermStoreGroup'
x-ms-navigationProperty: true
sets:
type: array
description: Collection of all sets available in the term store. This relationship
can only be used to load a specific term set.
items:
$ref: '#/components/schemas/TermStoreSet'
x-ms-navigationProperty: true
additionalProperties: true
ItemActivity1:
title: itemActivity
type: object
properties:
access:
$ref: '#/components/schemas/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/IdentitySet'
driveItem:
$ref: '#/components/schemas/DriveItem'
additionalProperties: true
TimeOffReasonIconType:
title: timeOffReasonIconType
type: string
enum:
- none
- car
- calendar
- running
- plane
- firstAid
- doctor
- notWorking
- clock
- juryDuty
- globe
- cup
- phone
- weather
- umbrella
- piggyBank
- dog
- cake
- trafficCone
- pin
- sunny
- unknownFutureValue
Attachment1:
title: attachment
type: object
properties:
contentType:
type: string
description: The MIME type.
nullable: true
isInline:
type: boolean
description: "true if the attachment is an inline attachment; otherwise,\
\ false."
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 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
name:
type: string
description: The attachment's file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: number
description: The length of the attachment in bytes.
format: int32
additionalProperties: true
AuthenticationMethodKeyStrength:
title: authenticationMethodKeyStrength
type: string
enum:
- normal
- weak
- unknown
AudioConferencing:
title: audioConferencing
type: object
properties:
conferenceId:
type: string
description: The conference id of the online meeting.
nullable: true
dialinUrl:
type: string
description: A URL to the externally-accessible web page that contains dial-in
information.
nullable: true
tollFreeNumber:
type: string
description: The toll-free number that connects to the Audio Conference
Provider.
nullable: true
tollFreeNumbers:
type: array
description: List of toll-free numbers that are displayed in the meeting
invite.
items:
type: string
nullable: true
tollNumber:
type: string
description: The toll number that connects to the Audio Conference Provider.
nullable: true
tollNumbers:
type: array
description: List of toll numbers that are displayed in the meeting invite.
items:
type: string
nullable: true
additionalProperties: true
TermStoreStore:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Store'
WorkbookChartDataLabels1:
title: workbookChartDataLabels
type: object
properties:
position:
type: string
description: "DataLabelPosition value that represents the position of the\
\ data label. The possible values are: None, Center, InsideEnd, InsideBase,\
\ OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout."
nullable: true
separator:
type: string
description: String that represents the separator used for the data labels
on a chart.
nullable: true
showBubbleSize:
type: boolean
description: Boolean value that represents whether the data label bubble
size is visible.
nullable: true
showCategoryName:
type: boolean
description: Boolean value that represents whether the data label category
name is visible.
nullable: true
showLegendKey:
type: boolean
description: Boolean value that represents whether the data label legend
key is visible.
nullable: true
showPercentage:
type: boolean
description: Boolean value that represents whether the data label percentage
is visible.
nullable: true
showSeriesName:
type: boolean
description: Boolean value that represents whether the data label series
name is visible.
nullable: true
showValue:
type: boolean
description: Boolean value that represents whether the data label value
is visible.
nullable: true
format:
$ref: '#/components/schemas/WorkbookChartDataLabelFormat'
additionalProperties: true
ListItem1:
title: listItem
type: object
properties:
contentType:
$ref: '#/components/schemas/ContentTypeInfo'
sharepointIds:
$ref: '#/components/schemas/SharepointIds'
analytics:
$ref: '#/components/schemas/ItemAnalytics'
documentSetVersions:
type: array
description: Version information for a document set version created by a
user.
items:
$ref: '#/components/schemas/DocumentSetVersion'
x-ms-navigationProperty: true
driveItem:
$ref: '#/components/schemas/DriveItem'
fields:
$ref: '#/components/schemas/FieldValueSet'
versions:
type: array
description: The list of previous versions of the list item.
items:
$ref: '#/components/schemas/ListItemVersion'
x-ms-navigationProperty: true
additionalProperties: true
ManagedAppFlaggedReason:
title: managedAppFlaggedReason
type: string
description: The reason for which a user has been flagged
enum:
- none
- rootedDevice
x-ms-enum:
name: managedAppFlaggedReason
modelAsString: false
values:
- value: none
description: No issue.
name: none
- value: rootedDevice
description: The app registration is running on a rooted/unlocked device.
name: rootedDevice
SelectionLikelihoodInfo:
title: selectionLikelihoodInfo
type: string
enum:
- notSpecified
- high
WorkbookChartAxisTitle1:
title: workbookChartAxisTitle
type: object
properties:
text:
type: string
description: Represents the axis title.
nullable: true
visible:
type: boolean
description: A Boolean that specifies the visibility of an axis title.
format:
$ref: '#/components/schemas/WorkbookChartAxisTitleFormat'
additionalProperties: true
WindowsMalwareCategory:
title: windowsMalwareCategory
type: string
description: Malware category id
enum:
- invalid
- adware
- spyware
- passwordStealer
- trojanDownloader
- worm
- backdoor
- remoteAccessTrojan
- trojan
- emailFlooder
- keylogger
- dialer
- monitoringSoftware
- browserModifier
- cookie
- browserPlugin
- aolExploit
- nuker
- securityDisabler
- jokeProgram
- hostileActiveXControl
- softwareBundler
- stealthNotifier
- settingsModifier
- toolBar
- remoteControlSoftware
- trojanFtp
- potentialUnwantedSoftware
- icqExploit
- trojanTelnet
- exploit
- filesharingProgram
- malwareCreationTool
- remote_Control_Software
- tool
- trojanDenialOfService
- trojanDropper
- trojanMassMailer
- trojanMonitoringSoftware
- trojanProxyServer
- virus
- known
- unknown
- spp
- behavior
- vulnerability
- policy
- enterpriseUnwantedSoftware
- ransom
- hipsRule
x-ms-enum:
name: windowsMalwareCategory
modelAsString: false
values:
- value: invalid
description: Invalid
name: invalid
- value: adware
description: Adware
name: adware
- value: spyware
description: Spyware
name: spyware
- value: passwordStealer
description: Password stealer
name: passwordStealer
- value: trojanDownloader
description: Trojan downloader
name: trojanDownloader
- value: worm
description: Worm
name: worm
- value: backdoor
description: Backdoor
name: backdoor
- value: remoteAccessTrojan
description: Remote access Trojan
name: remoteAccessTrojan
- value: trojan
description: Trojan
name: trojan
- value: emailFlooder
description: Email flooder
name: emailFlooder
- value: keylogger
description: Keylogger
name: keylogger
- value: dialer
description: Dialer
name: dialer
- value: monitoringSoftware
description: Monitoring software
name: monitoringSoftware
- value: browserModifier
description: Browser modifier
name: browserModifier
- value: cookie
description: Cookie
name: cookie
- value: browserPlugin
description: Browser plugin
name: browserPlugin
- value: aolExploit
description: AOL exploit
name: aolExploit
- value: nuker
description: Nuker
name: nuker
- value: securityDisabler
description: Security disabler
name: securityDisabler
- value: jokeProgram
description: Joke program
name: jokeProgram
- value: hostileActiveXControl
description: Hostile ActiveX control
name: hostileActiveXControl
- value: softwareBundler
description: Software bundler
name: softwareBundler
- value: stealthNotifier
description: Stealth modifier
name: stealthNotifier
- value: settingsModifier
description: Settings modifier
name: settingsModifier
- value: toolBar
description: Toolbar
name: toolBar
- value: remoteControlSoftware
description: Remote control software
name: remoteControlSoftware
- value: trojanFtp
description: Trojan FTP
name: trojanFtp
- value: potentialUnwantedSoftware
description: Potential unwanted software
name: potentialUnwantedSoftware
- value: icqExploit
description: ICQ exploit
name: icqExploit
- value: trojanTelnet
description: Trojan telnet
name: trojanTelnet
- value: exploit
description: Exploit
name: exploit
- value: filesharingProgram
description: File sharing program
name: filesharingProgram
- value: malwareCreationTool
description: Malware creation tool
name: malwareCreationTool
- value: remote_Control_Software
description: Remote control software
name: remote_Control_Software
- value: tool
description: Tool
name: tool
- value: trojanDenialOfService
description: Trojan denial of service
name: trojanDenialOfService
- value: trojanDropper
description: Trojan dropper
name: trojanDropper
- value: trojanMassMailer
description: Trojan mass mailer
name: trojanMassMailer
- value: trojanMonitoringSoftware
description: Trojan monitoring software
name: trojanMonitoringSoftware
- value: trojanProxyServer
description: Trojan proxy server
name: trojanProxyServer
- value: virus
description: Virus
name: virus
- value: known
description: Known
name: known
- value: unknown
description: Unknown
name: unknown
- value: spp
description: SPP
name: spp
- value: behavior
description: Behavior
name: behavior
- value: vulnerability
description: Vulnerability
name: vulnerability
- value: policy
description: Policy
name: policy
- value: enterpriseUnwantedSoftware
description: Enterprise Unwanted Software
name: enterpriseUnwantedSoftware
- value: ransom
description: Ransom
name: ransom
- value: hipsRule
description: HIPS Rule
name: hipsRule
UserInsightsSettings1:
title: userInsightsSettings
type: object
properties:
isEnabled:
type: boolean
description: True if the user's itemInsights and meeting hours insights
are enabled; false if the user's itemInsights and meeting hours insights
are disabled. The default value is true. Optional.
additionalProperties: true
PrintScaling:
title: printScaling
type: string
enum:
- auto
- shrinkToFit
- fill
- fit
- none
- unknownFutureValue
SectionGroup1:
title: sectionGroup
type: object
properties:
sectionGroupsUrl:
type: string
description: "The URL for the sectionGroups navigation property, which returns\
\ all the section groups in the section group. Read-only."
nullable: true
sectionsUrl:
type: string
description: "The URL for the sections navigation property, which returns\
\ all the sections in the section group. Read-only."
nullable: true
parentNotebook:
$ref: '#/components/schemas/Notebook'
parentSectionGroup:
$ref: '#/components/schemas/SectionGroup'
sectionGroups:
type: array
description: The section groups in the section. Read-only. Nullable.
items:
$ref: '#/components/schemas/SectionGroup'
x-ms-navigationProperty: true
sections:
type: array
description: The sections in the section group. Read-only. Nullable.
items:
$ref: '#/components/schemas/OnenoteSection'
x-ms-navigationProperty: true
additionalProperties: true
TimeCard1:
title: timeCard
type: object
properties:
breaks:
type: array
description: The list of breaks associated with the timeCard.
items:
$ref: '#/components/schemas/TimeCardBreak'
clockInEvent:
$ref: '#/components/schemas/TimeCardEvent'
clockOutEvent:
$ref: '#/components/schemas/TimeCardEvent'
confirmedBy:
$ref: '#/components/schemas/ConfirmedBy'
notes:
$ref: '#/components/schemas/ItemBody'
originalEntry:
$ref: '#/components/schemas/TimeCardEntry'
state:
$ref: '#/components/schemas/TimeCardState'
userId:
type: string
description: User ID to which the timeCard belongs.
nullable: true
additionalProperties: true
ListItemCollectionResponse:
title: Collection of listItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/ListItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
Todo:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Todo1'
Set:
title: set
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: Date and time of set creation. Read-only.
format: date-time
nullable: true
description:
type: string
description: Description that gives details on the term usage.
nullable: true
localizedNames:
type: array
description: Name of the set for each languageTag.
items:
$ref: '#/components/schemas/TermStoreLocalizedName'
properties:
type: array
description: Custom properties for the set.
items:
$ref: '#/components/schemas/KeyValue'
children:
type: array
description: "Children terms of set in term [store]."
items:
$ref: '#/components/schemas/TermStoreTerm'
x-ms-navigationProperty: true
parentGroup:
$ref: '#/components/schemas/TermStoreGroup'
relations:
type: array
description: Indicates which terms have been pinned or reused directly under
the set.
items:
$ref: '#/components/schemas/TermStoreRelation'
x-ms-navigationProperty: true
terms:
type: array
description: All the terms under the set.
items:
$ref: '#/components/schemas/TermStoreTerm'
x-ms-navigationProperty: true
additionalProperties: true
PlannerUser:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerUser1'
RetentionLabelSettings:
title: retentionLabelSettings
type: object
properties:
behaviorDuringRetentionPeriod:
$ref: '#/components/schemas/SecurityBehaviorDuringRetentionPeriod'
isContentUpdateAllowed:
type: boolean
description: Specifies whether updates to document content are allowed.
Read-only.
nullable: true
isDeleteAllowed:
type: boolean
description: Specifies whether the document deletion is allowed. Read-only.
nullable: true
isLabelUpdateAllowed:
type: boolean
description: Specifies whether you're allowed to change the retention label
on the document. Read-only.
nullable: true
isMetadataUpdateAllowed:
type: boolean
description: "Specifies whether updates to the item metadata (for example,\
\ the Title field) are blocked. Read-only."
nullable: true
isRecordLocked:
type: boolean
description: Specifies whether the item is locked. Read-write.
nullable: true
additionalProperties: true
RemoteItem:
title: remoteItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/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/File'
fileSystemInfo:
$ref: '#/components/schemas/FileSystemInfo'
folder:
$ref: '#/components/schemas/Folder'
id:
type: string
description: Unique identifier for the remote item in its drive. Read-only.
nullable: true
image:
$ref: '#/components/schemas/Image'
lastModifiedBy:
$ref: '#/components/schemas/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/Package'
parentReference:
$ref: '#/components/schemas/ItemReference'
shared:
$ref: '#/components/schemas/Shared'
sharepointIds:
$ref: '#/components/schemas/SharepointIds'
size:
type: number
description: Size of the remote item. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/SpecialFolder'
video:
$ref: '#/components/schemas/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
Website:
title: website
type: object
properties:
address:
type: string
description: The URL of the website.
nullable: true
displayName:
type: string
description: The display name of the web site.
nullable: true
type:
$ref: '#/components/schemas/WebsiteType'
additionalProperties: true
WorkbookTableSort:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookTableSort1'
Device1:
title: device
type: object
properties:
accountEnabled:
type: boolean
description: "true if the account is enabled; otherwise, false. Required.\
\ Default is true. Supports $filter (eq, ne, not, in). Only callers with\
\ at least the Cloud Device Administrator role can set this property."
nullable: true
alternativeSecurityIds:
type: array
description: "For internal use only. Not nullable. Supports $filter (eq,\
\ not, ge, le)."
items:
$ref: '#/components/schemas/AlternativeSecurityId'
approximateLastSignInDateTime:
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. Read-only. Supports $filter\
\ (eq, ne, not, ge, le, and eq on null values) and $orderby."
format: date-time
nullable: true
complianceExpirationDateTime:
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 when the device is no longer deemed compliant.\
\ 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
deviceCategory:
type: string
description: User-defined property set by Intune to automatically add devices
to groups and simplify managing devices.
nullable: true
deviceId:
type: string
description: "Unique identifier set by Azure Device Registration Service\
\ at the time of registration. This alternate key can be used to reference\
\ the device object. Supports $filter (eq, ne, not, startsWith)."
nullable: true
deviceMetadata:
type: string
description: For internal use only. Set to null.
nullable: true
deviceOwnership:
type: string
description: "Ownership of the device. Intune sets this property. Possible\
\ values are: unknown, company, personal."
nullable: true
deviceVersion:
maximum: 2147483647
minimum: -2147483648
type: number
description: For internal use only.
format: int32
nullable: true
displayName:
type: string
description: "The display name for the device. Maximum length is 256 characters.\
\ Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and\
\ eq on null values), $search, and $orderby."
nullable: true
enrollmentProfileName:
type: string
description: "Enrollment profile applied to the device. For example, Apple\
\ Device Enrollment Profile, Device enrollment - Corporate device identifiers,\
\ or Windows Autopilot profile name. This property is set by Intune."
nullable: true
enrollmentType:
type: string
description: "Enrollment type of the device. Intune sets this property.\
\ Possible values are: unknown, userEnrollment, deviceEnrollmentManager,\
\ appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless,\
\ windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement,\
\ windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.\
\ NOTE: This property might return other values apart from those listed."
nullable: true
isCompliant:
type: boolean
description: "true if the device complies with Mobile Device Management\
\ (MDM) policies; otherwise, false. Read-only. This can only be updated\
\ by Intune for any device OS type or by an approved MDM app for Windows\
\ OS devices. Supports $filter (eq, ne, not)."
nullable: true
isManaged:
type: boolean
description: "true if the device is managed by a Mobile Device Management\
\ (MDM) app; otherwise, false. This can only be updated by Intune for\
\ any device OS type or by an approved MDM app for Windows OS devices.\
\ Supports $filter (eq, ne, not)."
nullable: true
isManagementRestricted:
type: boolean
description: "Indicates whether the device 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 device that's 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
isRooted:
type: boolean
description: true if the device is rooted or jail-broken. This property
can only be updated by Intune.
nullable: true
managementType:
type: string
description: "The management channel of the device. This property is set\
\ by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient,\
\ configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas,\
\ unknown, jamf, googleCloudDevicePolicyController."
nullable: true
manufacturer:
type: string
description: Manufacturer of the device. Read-only.
nullable: true
mdmAppId:
type: string
description: "Application identifier used to register device into MDM. Read-only.\
\ Supports $filter (eq, ne, not, startsWith)."
nullable: true
model:
type: string
description: Model of the device. Read-only.
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: "The last time at which the object was synced with the on-premises\
\ directory. 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. Supports $filter (eq,\
\ ne, not, ge, le, in)."
format: date-time
nullable: true
onPremisesSecurityIdentifier:
type: string
description: The on-premises security identifier (SID) for the user who
was synchronized from on-premises to the cloud. Read-only. Returned only
on $select. Supports $filter (eq).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: "true if this object is synced from an on-premises directory;\
\ false if this object was originally synced from an on-premises directory\
\ but is no longer synced; null if this object has never been synced from\
\ an on-premises directory (default). Read-only. Supports $filter (eq,\
\ ne, not, in, and eq on null values)."
nullable: true
operatingSystem:
type: string
description: "The type of operating system on the device. Required. Supports\
\ $filter (eq, ne, not, ge, le, startsWith, and eq on null values)."
nullable: true
operatingSystemVersion:
type: string
description: "The version of the operating system on the device. Required.\
\ Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values)."
nullable: true
physicalIds:
type: array
description: "For internal use only. Not nullable. Supports $filter (eq,\
\ not, ge, le, startsWith,/$count eq 0, /$count ne 0)."
items:
type: string
profileType:
type: string
description: "The profile type of the device. Possible values: RegisteredDevice\
\ (default), SecureVM, Printer, Shared, IoT."
nullable: true
registrationDateTime:
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 when the device was registered. 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
systemLabels:
type: array
description: "List of labels applied to the device by the system. Supports\
\ $filter (/$count eq 0, /$count ne 0)."
items:
type: string
trustType:
type: string
description: "Type of trust for the joined device. Read-only. Possible values:\
\ Workplace (indicates bring your own personal devices), AzureAd (Cloud-only\
\ joined devices), ServerAd (on-premises domain joined devices joined\
\ to Microsoft Entra ID). For more information, see Introduction to device\
\ management in Microsoft Entra ID. Supports $filter (eq, ne, not, in)."
nullable: true
extensions:
type: array
description: The collection of open extensions defined for the device. Read-only.
Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
memberOf:
type: array
description: Groups and administrative units that this device is a member
of. Read-only. Nullable. Supports $expand.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
registeredOwners:
type: array
description: The user that cloud joined the device or registered their personal
device. The registered owner is set at the time of registration. Read-only.
Nullable. Supports $expand.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
registeredUsers:
type: array
description: "Collection of registered users of the device. For cloud joined\
\ devices and registered personal devices, registered users are set to\
\ the same value as registered owners at the time of registration. Read-only.\
\ Nullable. Supports $expand."
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
description: Groups and administrative units that the device is a member
of. This operation is transitive. Supports $expand.
items:
$ref: '#/components/schemas/DirectoryObject'
x-ms-navigationProperty: true
additionalProperties: true
WorkbookTableColumn:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookTableColumn1'
MeetingChatMode:
title: meetingChatMode
type: string
enum:
- enabled
- disabled
- limited
- unknownFutureValue
NotebookLinks:
title: notebookLinks
type: object
properties:
oneNoteClientUrl:
$ref: '#/components/schemas/ExternalLink'
oneNoteWebUrl:
$ref: '#/components/schemas/ExternalLink'
additionalProperties: true
LongRunningOperationStatus:
title: longRunningOperationStatus
type: string
enum:
- notStarted
- running
- succeeded
- failed
- unknownFutureValue
DirectoryObject1:
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
Todo1:
title: todo
type: object
properties:
lists:
type: array
description: The task lists in the users mailbox.
items:
$ref: '#/components/schemas/TodoTaskList'
x-ms-navigationProperty: true
additionalProperties: true
WorkbookChartGridlines1:
title: workbookChartGridlines
type: object
properties:
visible:
type: boolean
description: Indicates whether the axis gridlines are visible.
format:
$ref: '#/components/schemas/WorkbookChartGridlinesFormat'
additionalProperties: true
WorkbookChartPointFormat1:
title: workbookChartPointFormat
type: object
properties:
fill:
$ref: '#/components/schemas/WorkbookChartFill'
additionalProperties: true
Chat1:
title: chat
type: object
properties:
chatType:
$ref: '#/components/schemas/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/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/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
description: A collection of all the apps in the chat. Nullable.
items:
$ref: '#/components/schemas/TeamsAppInstallation'
x-ms-navigationProperty: true
lastMessagePreview:
$ref: '#/components/schemas/ChatMessageInfo'
members:
type: array
description: A collection of all the members in the chat. Nullable.
items:
$ref: '#/components/schemas/ConversationMember'
x-ms-navigationProperty: true
messages:
type: array
description: A collection of all the messages in the chat. Nullable.
items:
$ref: '#/components/schemas/ChatMessage'
x-ms-navigationProperty: true
permissionGrants:
type: array
description: A collection of permissions granted to apps for the chat.
items:
$ref: '#/components/schemas/ResourceSpecificPermissionGrant'
x-ms-navigationProperty: true
pinnedMessages:
type: array
description: A collection of all the pinned messages in the chat. Nullable.
items:
$ref: '#/components/schemas/PinnedChatMessageInfo'
x-ms-navigationProperty: true
tabs:
type: array
description: A collection of all the tabs in the chat. Nullable.
items:
$ref: '#/components/schemas/TeamsTab'
x-ms-navigationProperty: true
additionalProperties: true
PersonOrGroupColumn:
title: personOrGroupColumn
type: object
properties:
allowMultipleSelection:
type: boolean
description: Indicates whether multiple values can be selected from the
source.
nullable: true
chooseFromType:
type: string
description: "Whether to allow selection of people only, or people and groups.\
\ Must be one of peopleAndGroups or peopleOnly."
nullable: true
displayAs:
type: string
description: How to display the information about the person or group chosen.
See below.
nullable: true
additionalProperties: true
RichLongRunningOperation:
allOf:
- $ref: '#/components/schemas/LongRunningOperation'
- $ref: '#/components/schemas/RichLongRunningOperation1'
ItemAnalytics1:
title: itemAnalytics
type: object
properties:
allTime:
$ref: '#/components/schemas/ItemActivityStat'
itemActivityStats:
type: array
items:
$ref: '#/components/schemas/ItemActivityStat'
x-ms-navigationProperty: true
lastSevenDays:
$ref: '#/components/schemas/ItemActivityStat'
additionalProperties: true
OnenoteOperationError:
title: onenoteOperationError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
message:
type: string
description: The error message.
nullable: true
additionalProperties: true
TeamworkBot:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamworkBot1'
TimeCardEvent:
title: timeCardEvent
type: object
properties:
dateTime:
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 the entry is recorded.
format: date-time
isAtApprovedLocation:
type: boolean
description: Indicates whether this action happens at an approved location.
nullable: true
notes:
$ref: '#/components/schemas/ItemBody'
additionalProperties: true
PrintConnector1:
title: printConnector
type: object
properties:
appVersion:
type: string
description: The connector's version.
displayName:
type: string
description: The name of the connector.
fullyQualifiedDomainName:
type: string
description: The connector machine's hostname.
location:
$ref: '#/components/schemas/PrinterLocation'
operatingSystem:
type: string
description: The connector machine's operating system version.
registeredDateTime:
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 DateTimeOffset when the connector was registered.
format: date-time
additionalProperties: true
OperationError:
title: operationError
type: object
properties:
code:
type: string
description: Operation error code.
nullable: true
message:
type: string
description: Operation error message.
nullable: true
additionalProperties: true
AttendeeBase:
allOf:
- $ref: '#/components/schemas/Recipient'
- $ref: '#/components/schemas/AttendeeBase1'
ChatMessageActions:
title: chatMessageActions
type: string
enum:
- reactionAdded
- reactionRemoved
- actionUndefined
- unknownFutureValue
x-ms-enum-flags:
isFlags: true
DriveItemIdMicrosoftGraphCreateUploadSessionBody:
type: object
properties:
item:
$ref: '#/components/schemas/DriveItemUploadableProperties'
additionalProperties: true
UnifiedStorageQuota:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UnifiedStorageQuota1'
ChatMessageReactionIdentitySet1:
title: chatMessageReactionIdentitySet
type: object
additionalProperties: true
SiteArchiveStatus:
title: siteArchiveStatus
type: string
enum:
- recentlyArchived
- fullyArchived
- reactivating
- unknownFutureValue
SectionLinks:
title: sectionLinks
type: object
properties:
oneNoteClientUrl:
$ref: '#/components/schemas/ExternalLink'
oneNoteWebUrl:
$ref: '#/components/schemas/ExternalLink'
additionalProperties: true
UserSolutionRoot:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UserSolutionRoot1'
MediaSourceContentCategory:
title: mediaSourceContentCategory
type: string
enum:
- meeting
- liveStream
- presentation
- screenRecording
- story
- profile
- chat
- note
- comment
- unknownFutureValue
PrinterStatus:
title: printerStatus
type: object
properties:
description:
type: string
description: A human-readable description of the printer's current processing
state. Read-only.
nullable: true
details:
type: array
description: The list of details describing why the printer is in the current
state. Valid values are described in the following table. Read-only.
items:
$ref: '#/components/schemas/PrinterProcessingStateDetail'
state:
$ref: '#/components/schemas/PrinterProcessingState'
additionalProperties: true
InferenceClassification1:
title: inferenceClassification
type: object
properties:
overrides:
type: array
description: "A set of overrides for a user to always classify messages\
\ from specific senders in certain ways: focused, or other. Read-only.\
\ Nullable."
items:
$ref: '#/components/schemas/InferenceClassificationOverride'
x-ms-navigationProperty: true
additionalProperties: true
Fido2AuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/Fido2AuthenticationMethod1'
PresenceStatusMessage:
title: presenceStatusMessage
type: object
properties:
expiryDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
message:
$ref: '#/components/schemas/ItemBody'
publishedDateTime:
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 in which the status message was published.Read-only.publishedDateTime
isn't available when you request the presence of another user.
format: date-time
nullable: true
additionalProperties: true
UserStorage1:
title: userStorage
type: object
properties:
quota:
$ref: '#/components/schemas/UnifiedStorageQuota'
additionalProperties: true
WorkbookIcon:
title: workbookIcon
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: number
description: The index of the icon in the given set.
format: int32
set:
type: string
description: "The set that the icon is part of. The possible values are:\
\ Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1,\
\ ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows,\
\ FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows,\
\ FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles,\
\ FiveBoxes."
additionalProperties: true
DocumentSetVersion:
allOf:
- $ref: '#/components/schemas/ListItemVersion'
- $ref: '#/components/schemas/DocumentSetVersion1'
ChangeTrackedEntity:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ChangeTrackedEntity1'
DriveItemIdMicrosoftGraphAssignSensitivityLabelBody:
type: object
properties:
sensitivityLabelId:
type: string
nullable: true
assignmentMethod:
$ref: '#/components/schemas/SensitivityLabelAssignmentMethod'
justificationText:
type: string
nullable: true
additionalProperties: true
TeamworkTagMember:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamworkTagMember1'
Subscription1:
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
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
Attachment:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Attachment1'
WorkbookWorksheetProtectionOptions:
title: workbookWorksheetProtectionOptions
type: object
properties:
allowAutoFilter:
type: boolean
description: Represents the worksheet protection option of allowing using
auto filter feature.
allowDeleteColumns:
type: boolean
description: Represents the worksheet protection option of allowing deleting
columns.
allowDeleteRows:
type: boolean
description: Represents the worksheet protection option of allowing deleting
rows.
allowFormatCells:
type: boolean
description: Represents the worksheet protection option of allowing formatting
cells.
allowFormatColumns:
type: boolean
description: Represents the worksheet protection option of allowing formatting
columns.
allowFormatRows:
type: boolean
description: Represents the worksheet protection option of allowing formatting
rows.
allowInsertColumns:
type: boolean
description: Represents the worksheet protection option of allowing inserting
columns.
allowInsertHyperlinks:
type: boolean
description: Represents the worksheet protection option of allowing inserting
hyperlinks.
allowInsertRows:
type: boolean
description: Represents the worksheet protection option of allowing inserting
rows.
allowPivotTables:
type: boolean
description: Represents the worksheet protection option of allowing using
pivot table feature.
allowSort:
type: boolean
description: Represents the worksheet protection option of allowing using
sort feature.
additionalProperties: true
BaseItemVersion:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/BaseItemVersion1'
ChatMessageAttachment:
title: chatMessageAttachment
type: object
properties:
content:
type: string
description: "The content of the attachment. If the attachment is a rich\
\ card, set the property to the rich card object. This property and contentUrl\
\ are mutually exclusive."
nullable: true
contentType:
type: string
description: "The media type of the content attachment. The possible values\
\ are: reference: The attachment is a link to another file. Populate the\
\ contentURL with the link to the object.forwardedMessageReference: The\
\ attachment is a reference to a forwarded message. Populate the content\
\ with the original message context.Any contentType that is supported\
\ by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet:\
\ A code snippet. application/vnd.microsoft.card.announcement: An announcement\
\ header."
nullable: true
contentUrl:
type: string
description: The URL for the content of the attachment.
nullable: true
id:
type: string
description: Read-only. The unique ID of the attachment.
nullable: true
name:
type: string
description: The name of the attachment.
nullable: true
teamsAppId:
type: string
description: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified
app.
nullable: true
thumbnailUrl:
type: string
description: "The URL to a thumbnail image that the channel can use if it\
\ supports using an alternative, smaller form of content or contentUrl.\
\ For example, if you set contentType to application/word and set contentUrl\
\ to the location of the Word document, you might include a thumbnail\
\ image that represents the document. The channel could display the thumbnail\
\ image instead of the document. When the user selects the image, the\
\ channel would open the document."
nullable: true
additionalProperties: true
AttestationLevel:
title: attestationLevel
type: string
enum:
- attested
- notAttested
- unknownFutureValue
List:
allOf:
- $ref: '#/components/schemas/BaseItem'
- $ref: '#/components/schemas/List1'
AssociatedTeamInfo1:
title: associatedTeamInfo
type: object
additionalProperties: true
BaseItem:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/BaseItem1'
WorkbookComment1:
title: workbookComment
type: object
properties:
content:
type: string
description: The content of the comment.
nullable: true
contentType:
type: string
description: The content type of the comment.
replies:
type: array
description: The list of replies to the comment. Read-only. Nullable.
items:
$ref: '#/components/schemas/WorkbookCommentReply'
x-ms-navigationProperty: true
additionalProperties: true
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/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/FileSystemInfo'
mediaSource:
$ref: '#/components/schemas/MediaSource'
name:
type: string
description: The name of the item (filename and extension). Read-write.
nullable: true
additionalProperties: true
AuthenticationMethodSignInState:
title: authenticationMethodSignInState
type: string
enum:
- notSupported
- notAllowedByPolicy
- notEnabled
- phoneNumberNotUnique
- ready
- notConfigured
- unknownFutureValue
UserSettings:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UserSettings1'
BroadcastMeetingCaptionSettings:
title: broadcastMeetingCaptionSettings
type: object
properties:
isCaptionEnabled:
type: boolean
description: Indicates whether captions are enabled for this Teams live
event.
nullable: true
spokenLanguage:
type: string
description: The spoken language.
nullable: true
translationLanguages:
type: array
description: The translation languages (choose up to 6).
items:
type: string
nullable: true
additionalProperties: true
WindowsProtectionState:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WindowsProtectionState1'
ResponseType:
title: responseType
type: string
enum:
- none
- organizer
- tentativelyAccepted
- accepted
- declined
- notResponded
DeviceHealthAttestationState:
title: deviceHealthAttestationState
type: object
properties:
attestationIdentityKey:
type: string
description: "TWhen an Attestation Identity Key (AIK) is present on a device,\
\ it indicates that the device has an endorsement key (EK) certificate."
nullable: true
bitLockerStatus:
type: string
description: On or Off of BitLocker Drive Encryption
nullable: true
bootAppSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootDebugging:
type: string
description: "When bootDebugging is enabled, the device is used in development\
\ and testing"
nullable: true
bootManagerSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootManagerVersion:
type: string
description: The version of the Boot Manager
nullable: true
bootRevisionListInfo:
type: string
description: The Boot Revision List that was loaded during initial boot
on the attested device
nullable: true
codeIntegrity:
type: string
description: "When code integrity is enabled, code execution is restricted\
\ to integrity verified code"
nullable: true
codeIntegrityCheckVersion:
type: string
description: The version of the Boot Manager
nullable: true
codeIntegrityPolicy:
type: string
description: The Code Integrity policy that is controlling the security
of the boot environment
nullable: true
contentNamespaceUrl:
type: string
description: The DHA report version. (Namespace version)
nullable: true
contentVersion:
type: string
description: The HealthAttestation state schema version
nullable: true
dataExcutionPolicy:
type: string
description: DEP Policy defines a set of hardware and software technologies
that perform additional checks on memory
nullable: true
deviceHealthAttestationStatus:
type: string
description: The DHA report version. (Namespace version)
nullable: true
earlyLaunchAntiMalwareDriverProtection:
type: string
description: ELAM provides protection for the computers in your network
when they start up
nullable: true
healthAttestationSupportedStatus:
type: string
description: This attribute indicates if DHA is supported for the device
nullable: true
healthStatusMismatchInfo:
type: string
description: This attribute appears if DHA-Service detects an integrity
issue
nullable: true
issuedDateTime:
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 was evaluated or issued to MDM
format: date-time
lastUpdateDateTime:
type: string
description: The Timestamp of the last update.
nullable: true
operatingSystemKernelDebugging:
type: string
description: "When operatingSystemKernelDebugging is enabled, the device\
\ is used in development and testing"
nullable: true
operatingSystemRevListInfo:
type: string
description: The Operating System Revision List that was loaded during initial
boot on the attested device
nullable: true
pcr0:
type: string
description: "The measurement that is captured in PCR[0]"
nullable: true
pcrHashAlgorithm:
type: string
description: Informational attribute that identifies the HASH algorithm
that was used by TPM
nullable: true
resetCount:
type: number
description: The number of times a PC device has hibernated or resumed
format: int64
restartCount:
type: number
description: The number of times a PC device has rebooted
format: int64
safeMode:
type: string
description: Safe mode is a troubleshooting option for Windows that starts
your computer in a limited state
nullable: true
secureBoot:
type: string
description: "When Secure Boot is enabled, the core components must have\
\ the correct cryptographic signatures"
nullable: true
secureBootConfigurationPolicyFingerPrint:
type: string
description: Fingerprint of the Custom Secure Boot Configuration Policy
nullable: true
testSigning:
type: string
description: "When test signing is allowed, the device does not enforce\
\ signature validation during boot"
nullable: true
tpmVersion:
type: string
description: The security version number of the Boot Application
nullable: true
virtualSecureMode:
type: string
description: VSM is a container that protects high value assets from a compromised
kernel
nullable: true
windowsPE:
type: string
description: Operating system running with limited services that is used
to prepare a computer for Windows
nullable: true
additionalProperties: true
LicenseProcessingState:
title: licenseProcessingState
type: object
properties:
state:
type: string
nullable: true
additionalProperties: true
TermStoreTerm:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Term'
WorkbookChartAxes:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartAxes1'
LongRunningOperation1:
title: longRunningOperation
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 start time of the operation. 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
lastActionDateTime:
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 of the last action in the operation. 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
resourceLocation:
type: string
description: URI of the resource that the operation is performed on.
nullable: true
status:
$ref: '#/components/schemas/LongRunningOperationStatus'
statusDetail:
type: string
description: Details about the status of the operation.
nullable: true
additionalProperties: true
description: The status of a long-running operation
GeolocationColumn:
title: geolocationColumn
type: object
additionalProperties: true
PlannerBucketTaskBoardTaskFormat1:
title: plannerBucketTaskBoardTaskFormat
type: object
properties:
orderHint:
type: string
description: "Hint used to order tasks in the bucket view of the task board.\
\ For details about the supported format, see Using order hints in Planner."
nullable: true
additionalProperties: true
OAuth2PermissionGrant:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/OAuth2PermissionGrant1'
CalendarRoleType:
title: calendarRoleType
type: string
enum:
- none
- freeBusyRead
- limitedRead
- read
- write
- delegateWithoutPrivateEventAccess
- delegateWithPrivateEventAccess
- custom
InferenceClassificationType:
title: inferenceClassificationType
type: string
enum:
- focused
- other
Relation:
title: relation
type: object
properties:
relationship:
$ref: '#/components/schemas/TermStoreRelationType'
fromTerm:
$ref: '#/components/schemas/TermStoreTerm'
set:
$ref: '#/components/schemas/TermStoreSet'
toTerm:
$ref: '#/components/schemas/TermStoreTerm'
additionalProperties: true
Conversation1:
title: conversation
type: object
properties:
hasAttachments:
type: boolean
description: "Indicates whether any of the posts within this Conversation\
\ has at least one attachment. Supports $filter (eq, ne) and $search."
lastDeliveredDateTime:
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
preview:
type: string
description: "A short summary from the body of the latest post in this conversation.\
\ Supports $filter (eq, ne, le, ge)."
topic:
type: string
description: "The topic of the conversation. This property can be set when\
\ the conversation is created, but it cannot be updated."
uniqueSenders:
type: array
description: All the users that sent a message to this Conversation.
items:
type: string
threads:
type: array
description: A collection of all the conversation threads in the conversation.
A navigation property. Read-only. Nullable.
items:
$ref: '#/components/schemas/ConversationThread'
x-ms-navigationProperty: true
additionalProperties: true
WindowsMalwareExecutionState:
title: windowsMalwareExecutionState
type: string
description: Malware execution status
enum:
- unknown
- blocked
- allowed
- running
- notRunning
x-ms-enum:
name: windowsMalwareExecutionState
modelAsString: false
values:
- value: unknown
description: Unknown
name: unknown
- value: blocked
description: Blocked
name: blocked
- value: allowed
description: Allowed
name: allowed
- value: running
description: Running
name: running
- value: notRunning
description: Not running
name: notRunning
OnlineMeetingInfo:
title: onlineMeetingInfo
type: object
properties:
conferenceId:
type: string
description: The ID of the conference.
nullable: true
joinUrl:
type: string
description: The external link that launches the online meeting. This is
a URL that clients launch into a browser and will redirect the user to
join the meeting.
nullable: true
phones:
type: array
description: All of the phone numbers associated with this conference.
items:
$ref: '#/components/schemas/Phone'
quickDial:
type: string
description: The preformatted quick dial for this call.
nullable: true
tollFreeNumbers:
type: array
description: The toll free numbers that can be used to join the conference.
items:
type: string
nullable: true
tollNumber:
type: string
description: The toll number that can be used to join the conference.
nullable: true
additionalProperties: true
ChatMessagePolicyViolationPolicyTip:
title: chatMessagePolicyViolationPolicyTip
type: object
properties:
complianceUrl:
type: string
description: "The URL a user can visit to read about the data loss prevention\
\ policies for the organization. (ie, policies about what users shouldn't\
\ say in chats)"
nullable: true
generalText:
type: string
description: Explanatory text shown to the sender of the message.
nullable: true
matchedConditionDescriptions:
type: array
description: "The list of improper data in the message that was detected\
\ by the data loss prevention app. Each DLP app defines its own conditions,\
\ examples include 'Credit Card Number' and 'Social Security Number'."
items:
type: string
nullable: true
additionalProperties: true
ResourceReference:
title: resourceReference
type: object
properties:
id:
type: string
description: The item's unique identifier.
nullable: true
type:
type: string
description: "A string value that can be used to classify the item, such\
\ as 'driveItem'"
nullable: true
webUrl:
type: string
description: A URL leading to the referenced item.
nullable: true
additionalProperties: true
Operation1:
title: operation
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 start time of the operation.
format: date-time
nullable: true
lastActionDateTime:
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 of the last action of the operation.
format: date-time
nullable: true
status:
$ref: '#/components/schemas/OperationStatus'
additionalProperties: true
PlannerPlanDetails:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerPlanDetails1'
CloudClipboardItem:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/CloudClipboardItem1'
PinnedChatMessageInfo1:
title: pinnedChatMessageInfo
type: object
properties:
message:
$ref: '#/components/schemas/ChatMessage'
additionalProperties: true
MeetingLiveShareOptions:
title: meetingLiveShareOptions
type: string
enum:
- enabled
- disabled
- unknownFutureValue
Post:
allOf:
- $ref: '#/components/schemas/OutlookItem'
- $ref: '#/components/schemas/Post1'
RecurrencePattern:
title: recurrencePattern
type: object
properties:
dayOfMonth:
maximum: 2147483647
minimum: -2147483648
type: number
description: The day of the month on which the event occurs. Required if
type is absoluteMonthly or absoluteYearly.
format: int32
daysOfWeek:
type: array
description: "A collection of the days of the week on which the event occurs.\
\ The possible values are: sunday, monday, tuesday, wednesday, thursday,\
\ friday, saturday. If type is relativeMonthly or relativeYearly, and\
\ daysOfWeek specifies more than one day, the event falls on the first\
\ day that satisfies the pattern. Required if type is weekly, relativeMonthly,\
\ or relativeYearly."
items:
$ref: '#/components/schemas/DayOfWeek'
firstDayOfWeek:
$ref: '#/components/schemas/DayOfWeek'
index:
$ref: '#/components/schemas/WeekIndex'
interval:
maximum: 2147483647
minimum: -2147483648
type: number
description: "The number of units between occurrences, where units can be\
\ in days, weeks, months, or years, depending on the type. Required."
format: int32
month:
maximum: 2147483647
minimum: -2147483648
type: number
description: The month in which the event occurs. This is a number from
1 to 12.
format: int32
type:
$ref: '#/components/schemas/RecurrencePatternType'
additionalProperties: true
MicrosoftAuthenticatorAuthenticationMethod1:
title: microsoftAuthenticatorAuthenticationMethod
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 that this app was registered. This property
is null if the device isn't registered for passwordless Phone Sign-In.
format: date-time
nullable: true
deviceTag:
type: string
description: Tags containing app metadata.
nullable: true
displayName:
type: string
description: The name of the device on which this app is registered.
nullable: true
phoneAppVersion:
type: string
description: Numerical version of this instance of the Authenticator app.
nullable: true
device:
$ref: '#/components/schemas/Device'
additionalProperties: true
WorkbookTableSort1:
title: workbookTableSort
type: object
properties:
fields:
type: array
description: The list of the current conditions last used to sort the table.
Read-only.
items:
$ref: '#/components/schemas/WorkbookSortField'
matchCase:
type: boolean
description: Indicates whether the casing impacted the last sort of the
table. Read-only.
method:
type: string
description: "The Chinese character ordering method last used to sort the\
\ table. The possible values are: PinYin, StrokeCount. Read-only."
additionalProperties: true
Attendee:
allOf:
- $ref: '#/components/schemas/AttendeeBase'
- $ref: '#/components/schemas/Attendee1'
WorkbookTableColumn1:
title: workbookTableColumn
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: number
description: The index of the column within the columns collection of the
table. Zero-indexed. Read-only.
format: int32
name:
type: string
description: The name of the table column.
nullable: true
values:
$ref: '#/components/schemas/Json'
filter:
$ref: '#/components/schemas/WorkbookFilter'
additionalProperties: true
WorkbookOperationError:
title: workbookOperationError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
innerError:
$ref: '#/components/schemas/WorkbookOperationError'
message:
type: string
description: The error message.
nullable: true
additionalProperties: true
Schedule:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Schedule1'
WorkbookChartAreaFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartAreaFormat1'
TermStoreSet:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Set'
DriveItemCollectionResponse:
title: CollectionOfDriveItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/DriveItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
WorkbookComment:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookComment1'
PlannerUser1:
title: plannerUser
type: object
properties:
plans:
type: array
description: Read-only. Nullable. Returns the plannerTasks assigned to the
user.
items:
$ref: '#/components/schemas/PlannerPlan'
x-ms-navigationProperty: true
tasks:
type: array
description: Read-only. Nullable. Returns the plannerPlans shared with the
user.
items:
$ref: '#/components/schemas/PlannerTask'
x-ms-navigationProperty: true
additionalProperties: true
Extension1:
title: extension
type: object
additionalProperties: true
UserStorage:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UserStorage1'
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
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
ManagedDevice1:
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/ComplianceState'
configurationManagerClientEnabledFeatures:
$ref: '#/components/schemas/ConfigurationManagerClientEnabledFeatures'
deviceActionResults:
type: array
description: List of ComplexType deviceActionResult objects. This property
is read-only.
readOnly: true
items:
$ref: '#/components/schemas/DeviceActionResult'
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/DeviceEnrollmentType'
deviceHealthAttestationState:
$ref: '#/components/schemas/DeviceHealthAttestationState'
deviceName:
type: string
description: Name of the device. This property is read-only.
nullable: true
readOnly: true
deviceRegistrationState:
$ref: '#/components/schemas/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/DeviceManagementExchangeAccessState'
exchangeAccessStateReason:
$ref: '#/components/schemas/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/ManagedDeviceOwnerType'
managementAgent:
$ref: '#/components/schemas/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/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/DeviceCategory'
deviceCompliancePolicyStates:
type: array
description: Device compliance policy states for this device.
items:
$ref: '#/components/schemas/DeviceCompliancePolicyState'
x-ms-navigationProperty: true
deviceConfigurationStates:
type: array
description: Device configuration states for this device.
items:
$ref: '#/components/schemas/DeviceConfigurationState'
x-ms-navigationProperty: true
logCollectionRequests:
type: array
description: List of log collection requests
items:
$ref: '#/components/schemas/DeviceLogCollectionResponse'
x-ms-navigationProperty: true
users:
type: array
description: The primary users associated with the managed device.
items:
$ref: '#/components/schemas/User'
x-ms-navigationProperty: true
windowsProtectionState:
$ref: '#/components/schemas/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'"
EmployeeExperienceUser:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/EmployeeExperienceUser1'
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
TeamworkTagMember1:
title: teamworkTagMember
type: object
properties:
displayName:
type: string
description: The member's display name.
nullable: true
tenantId:
type: string
description: The ID of the tenant that the tag member is a part of.
nullable: true
userId:
type: string
description: The user ID of the member.
nullable: true
additionalProperties: true
BaseItemVersion1:
title: baseItemVersion
type: object
properties:
lastModifiedBy:
$ref: '#/components/schemas/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 version was last modified. Read-only.
format: date-time
nullable: true
publication:
$ref: '#/components/schemas/PublicationFacet'
additionalProperties: true
WorkbookChartFill:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartFill1'
ColumnDefinition1:
title: columnDefinition
type: object
properties:
boolean:
$ref: '#/components/schemas/BooleanColumn'
calculated:
$ref: '#/components/schemas/CalculatedColumn'
choice:
$ref: '#/components/schemas/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/ContentApprovalStatusColumn'
currency:
$ref: '#/components/schemas/CurrencyColumn'
dateTime:
$ref: '#/components/schemas/DateTimeColumn'
defaultValue:
$ref: '#/components/schemas/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/GeolocationColumn'
hidden:
type: boolean
description: Specifies whether the column is displayed in the user interface.
nullable: true
hyperlinkOrPicture:
$ref: '#/components/schemas/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/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/NumberColumn'
personOrGroup:
$ref: '#/components/schemas/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/ContentTypeInfo'
term:
$ref: '#/components/schemas/TermColumn'
text:
$ref: '#/components/schemas/TextColumn'
thumbnail:
$ref: '#/components/schemas/ThumbnailColumn'
type:
$ref: '#/components/schemas/ColumnTypes'
validation:
$ref: '#/components/schemas/ColumnValidation'
sourceColumn:
$ref: '#/components/schemas/ColumnDefinition'
additionalProperties: true
Root:
title: root
type: object
additionalProperties: true
FolderView:
title: folderView
type: object
properties:
sortBy:
type: string
description: The method by which the folder should be sorted.
nullable: true
sortOrder:
type: string
description: "If true, indicates that items should be sorted in descending\
\ order. Otherwise, items should be sorted ascending."
nullable: true
viewType:
type: string
description: The type of view that should be used to represent the folder.
nullable: true
additionalProperties: true
WorkbookChartPoint:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartPoint1'
AttachmentBase1:
title: attachmentBase
type: object
properties:
contentType:
type: string
description: The MIME type.
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 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
name:
type: string
description: The display name of the attachment. This doesn't need to be
the actual file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: number
description: The length of the attachment in bytes.
format: int32
additionalProperties: true
TimeOff1:
title: timeOff
type: object
properties:
draftTimeOff:
$ref: '#/components/schemas/TimeOffItem'
isStagedForDeletion:
type: boolean
description: "The timeOff is marked for deletion, a process that is finalized\
\ when the schedule is shared."
nullable: true
sharedTimeOff:
$ref: '#/components/schemas/TimeOffItem'
userId:
type: string
description: ID of the user assigned to the timeOff. Required.
nullable: true
additionalProperties: true
EmailAddress:
title: emailAddress
type: object
properties:
address:
type: string
description: The email address of the person or entity.
nullable: true
name:
type: string
description: The display name of the person or entity.
nullable: true
additionalProperties: true
ShiftAvailability:
title: shiftAvailability
type: object
properties:
recurrence:
$ref: '#/components/schemas/PatternedRecurrence'
timeSlots:
type: array
description: The time slot(s) preferred by the user.
items:
$ref: '#/components/schemas/TimeRange'
timeZone:
type: string
description: Specifies the time zone for the indicated time.
nullable: true
additionalProperties: true
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
WindowsMalwareSeverity:
title: windowsMalwareSeverity
type: string
description: Malware severity
enum:
- unknown
- low
- moderate
- high
- severe
x-ms-enum:
name: windowsMalwareSeverity
modelAsString: false
values:
- value: unknown
description: Unknown
name: unknown
- value: low
description: Low
name: low
- value: moderate
description: Moderate
name: moderate
- value: high
description: High
name: high
- value: severe
description: Severe
name: severe
ManagedAppPolicy:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ManagedAppPolicy1'
OfficeGraphInsights:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/OfficeGraphInsights1'
AttachmentBase:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/AttachmentBase1'
ScheduleChangeState:
title: scheduleChangeState
type: string
enum:
- pending
- approved
- declined
- unknownFutureValue
PrintQuality:
title: printQuality
type: string
enum:
- low
- medium
- high
- unknownFutureValue
WorkbookChartDataLabels:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartDataLabels1'
Conversation:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Conversation1'
UserActivity:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UserActivity1'
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/FolderView'
additionalProperties: true
Workbook1:
title: workbook
type: object
properties:
application:
$ref: '#/components/schemas/WorkbookApplication'
comments:
type: array
description: Represents a collection of comments in a workbook.
items:
$ref: '#/components/schemas/WorkbookComment'
x-ms-navigationProperty: true
functions:
$ref: '#/components/schemas/WorkbookFunctions'
names:
type: array
description: Represents a collection of workbooks scoped named items (named
ranges and constants). Read-only.
items:
$ref: '#/components/schemas/WorkbookNamedItem'
x-ms-navigationProperty: true
operations:
type: array
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."
items:
$ref: '#/components/schemas/WorkbookOperation'
x-ms-navigationProperty: true
tables:
type: array
description: Represents a collection of tables associated with the workbook.
Read-only.
items:
$ref: '#/components/schemas/WorkbookTable'
x-ms-navigationProperty: true
worksheets:
type: array
description: Represents a collection of worksheets associated with the workbook.
Read-only.
items:
$ref: '#/components/schemas/WorkbookWorksheet'
x-ms-navigationProperty: true
additionalProperties: true
WorkingTimeSchedule:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkingTimeSchedule1'
OutlookUser:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/OutlookUser1'
TeamsAsyncOperation:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamsAsyncOperation1'
PageLinks:
title: pageLinks
type: object
properties:
oneNoteClientUrl:
$ref: '#/components/schemas/ExternalLink'
oneNoteWebUrl:
$ref: '#/components/schemas/ExternalLink'
additionalProperties: true
MessageRule1:
title: messageRule
type: object
properties:
actions:
$ref: '#/components/schemas/MessageRuleActions'
conditions:
$ref: '#/components/schemas/MessageRulePredicates'
displayName:
type: string
description: The display name of the rule.
nullable: true
exceptions:
$ref: '#/components/schemas/MessageRulePredicates'
hasError:
type: boolean
description: Indicates whether the rule is in an error condition. Read-only.
nullable: true
isEnabled:
type: boolean
description: Indicates whether the rule is enabled to be applied to messages.
nullable: true
isReadOnly:
type: boolean
description: Indicates if the rule is read-only and cannot be modified or
deleted by the rules REST API.
nullable: true
sequence:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Indicates the order in which the rule is executed, among other\
\ rules."
format: int32
nullable: true
additionalProperties: true
Message1:
title: message
type: object
properties:
bccRecipients:
type: array
description: "The Bcc: recipients for the message."
items:
$ref: '#/components/schemas/Recipient'
body:
$ref: '#/components/schemas/ItemBody'
bodyPreview:
type: string
description: The first 255 characters of the message body. It is in text
format.
nullable: true
ccRecipients:
type: array
description: "The Cc: recipients for the message."
items:
$ref: '#/components/schemas/Recipient'
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/FollowupFlag'
from:
$ref: '#/components/schemas/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/Importance'
inferenceClassification:
$ref: '#/components/schemas/InferenceClassificationType'
internetMessageHeaders:
type: array
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.
items:
$ref: '#/components/schemas/InternetMessageHeader'
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
description: The email addresses to use when replying.
items:
$ref: '#/components/schemas/Recipient'
sender:
$ref: '#/components/schemas/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
description: "The To: recipients for the message."
items:
$ref: '#/components/schemas/Recipient'
uniqueBody:
$ref: '#/components/schemas/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
description: The fileAttachment and itemAttachment attachments for the message.
items:
$ref: '#/components/schemas/Attachment'
x-ms-navigationProperty: true
extensions:
type: array
description: The collection of open extensions defined for the message.
Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
description: The collection of multi-value extended properties defined for
the message. Nullable.
items:
$ref: '#/components/schemas/MultiValueLegacyExtendedProperty'
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
description: The collection of single-value extended properties defined
for the message. Nullable.
items:
$ref: '#/components/schemas/SingleValueLegacyExtendedProperty'
x-ms-navigationProperty: true
additionalProperties: true
WorkbookChartSeries:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartSeries1'
LobbyBypassScope:
title: lobbyBypassScope
type: string
enum:
- organizer
- organization
- organizationAndFederated
- everyone
- unknownFutureValue
- invited
- organizationExcludingGuests
Site1:
title: site
type: object
properties:
displayName:
type: string
description: The full title for the site. Read-only.
nullable: true
error:
$ref: '#/components/schemas/PublicError'
isPersonalSite:
type: boolean
description: Identifies whether the site is personal or not. Read-only.
nullable: true
root:
$ref: '#/components/schemas/Root'
sharepointIds:
$ref: '#/components/schemas/SharepointIds'
siteCollection:
$ref: '#/components/schemas/SiteCollection'
analytics:
$ref: '#/components/schemas/ItemAnalytics'
columns:
type: array
description: The collection of column definitions reusable across lists
under this site.
items:
$ref: '#/components/schemas/ColumnDefinition'
x-ms-navigationProperty: true
contentTypes:
type: array
description: The collection of content types defined for this site.
items:
$ref: '#/components/schemas/ContentType'
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/Drive'
drives:
type: array
description: The collection of drives (document libraries) under this site.
items:
$ref: '#/components/schemas/Drive'
x-ms-navigationProperty: true
externalColumns:
type: array
items:
$ref: '#/components/schemas/ColumnDefinition'
x-ms-navigationProperty: true
items:
type: array
description: Used to address any item contained in this site. This collection
can't be enumerated.
items:
$ref: '#/components/schemas/BaseItem'
x-ms-navigationProperty: true
lists:
type: array
description: The collection of lists under this site.
items:
$ref: '#/components/schemas/List'
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/Onenote'
operations:
type: array
description: The collection of long-running operations on the site.
items:
$ref: '#/components/schemas/RichLongRunningOperation'
x-ms-navigationProperty: true
pages:
type: array
description: The collection of pages in the baseSitePages list in this site.
items:
$ref: '#/components/schemas/BaseSitePage'
x-ms-navigationProperty: true
permissions:
type: array
description: The permissions associated with the site. Nullable.
items:
$ref: '#/components/schemas/Permission'
x-ms-navigationProperty: true
sites:
type: array
description: The collection of the sub-sites under this site.
items:
$ref: '#/components/schemas/Site'
x-ms-navigationProperty: true
termStore:
$ref: '#/components/schemas/TermStoreStore'
termStores:
type: array
description: The collection of termStores under this site.
items:
$ref: '#/components/schemas/TermStoreStore'
x-ms-navigationProperty: true
additionalProperties: true
ChatMessageReaction:
title: chatMessageReaction
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 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
displayName:
type: string
description: The name of the reaction.
nullable: true
reactionContentUrl:
type: string
description: The hosted content URL for the custom reaction type.
nullable: true
reactionType:
type: string
description: "The reaction type. Supported values include Unicode characters,\
\ custom, and some backward-compatible reaction types, such as like, angry,\
\ sad, laugh, heart, and surprised."
user:
$ref: '#/components/schemas/ChatMessageReactionIdentitySet'
additionalProperties: true
SharingDetail:
title: sharingDetail
type: object
properties:
sharedBy:
$ref: '#/components/schemas/InsightIdentity'
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 date and time the file was last shared. The timestamp\
\ represents date and time information using ISO 8601 format and is always\
\ in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.\
\ Read-only."
format: date-time
nullable: true
sharingReference:
$ref: '#/components/schemas/ResourceReference'
sharingSubject:
type: string
description: The subject with which the document was shared.
nullable: true
sharingType:
type: string
description: "Determines the way the document was shared. Can be by a 1Link1,\
\ 1Attachment1, 1Group1, 1Site1."
nullable: true
additionalProperties: true
TaskStatus:
title: taskStatus
type: string
enum:
- notStarted
- inProgress
- completed
- waitingOnOthers
- deferred
DriveItemIdMicrosoftGraphCreateLinkBody:
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/DriveRecipient'
retainInheritedPermissions:
type: boolean
nullable: true
default: false
sendNotification:
type: boolean
nullable: true
default: false
additionalProperties: true
DeviceMetadata:
title: deviceMetadata
type: object
properties:
deviceType:
type: string
description: "Optional. The general type of the device (for example, 'Managed',\
\ 'Unmanaged')."
nullable: true
ipAddress:
type: string
description: The Internet Protocol (IP) address of the device.
nullable: true
operatingSystemSpecifications:
$ref: '#/components/schemas/OperatingSystemSpecifications'
additionalProperties: true
TodoTaskList:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TodoTaskList1'
DriveItemIdMicrosoftGraphCheckinBody:
type: object
properties:
checkInAs:
type: string
nullable: true
comment:
type: string
nullable: true
additionalProperties: true
SectionGroup:
allOf:
- $ref: '#/components/schemas/OnenoteEntityHierarchyModel'
- $ref: '#/components/schemas/SectionGroup1'
Schedule1:
title: schedule
type: object
properties:
enabled:
type: boolean
description: Indicates whether the schedule is enabled for the team. Required.
nullable: true
isActivitiesIncludedWhenCopyingShiftsEnabled:
type: boolean
description: Indicates whether copied shifts include activities from the
original shift.
nullable: true
offerShiftRequestsEnabled:
type: boolean
description: Indicates whether offer shift requests are enabled for the
schedule.
nullable: true
openShiftsEnabled:
type: boolean
description: Indicates whether open shifts are enabled for the schedule.
nullable: true
provisionStatus:
$ref: '#/components/schemas/OperationStatus'
provisionStatusCode:
type: string
description: Additional information about why schedule provisioning failed.
nullable: true
readOnly: true
startDayOfWeek:
$ref: '#/components/schemas/DayOfWeek'
swapShiftsRequestsEnabled:
type: boolean
description: Indicates whether swap shifts requests are enabled for the
schedule.
nullable: true
timeClockEnabled:
type: boolean
description: Indicates whether time clock is enabled for the schedule.
nullable: true
timeClockSettings:
$ref: '#/components/schemas/TimeClockSettings'
timeOffRequestsEnabled:
type: boolean
description: Indicates whether time off requests are enabled for the schedule.
nullable: true
timeZone:
type: string
description: Indicates the time zone of the schedule team using tz database
format. Required.
nullable: true
workforceIntegrationIds:
type: array
description: The IDs for the workforce integrations associated with this
schedule.
items:
type: string
nullable: true
dayNotes:
type: array
description: The day notes in the schedule.
items:
$ref: '#/components/schemas/DayNote'
x-ms-navigationProperty: true
offerShiftRequests:
type: array
description: The offer requests for shifts in the schedule.
items:
$ref: '#/components/schemas/OfferShiftRequest'
x-ms-navigationProperty: true
openShiftChangeRequests:
type: array
description: The open shift requests in the schedule.
items:
$ref: '#/components/schemas/OpenShiftChangeRequest'
x-ms-navigationProperty: true
openShifts:
type: array
description: The set of open shifts in a scheduling group in the schedule.
items:
$ref: '#/components/schemas/OpenShift'
x-ms-navigationProperty: true
schedulingGroups:
type: array
description: The logical grouping of users in the schedule (usually by role).
items:
$ref: '#/components/schemas/SchedulingGroup'
x-ms-navigationProperty: true
shifts:
type: array
description: The shifts in the schedule.
items:
$ref: '#/components/schemas/Shift'
x-ms-navigationProperty: true
swapShiftsChangeRequests:
type: array
description: The swap requests for shifts in the schedule.
items:
$ref: '#/components/schemas/SwapShiftsChangeRequest'
x-ms-navigationProperty: true
timeCards:
type: array
description: The time cards in the schedule.
items:
$ref: '#/components/schemas/TimeCard'
x-ms-navigationProperty: true
timeOffReasons:
type: array
description: The set of reasons for a time off in the schedule.
items:
$ref: '#/components/schemas/TimeOffReason'
x-ms-navigationProperty: true
timeOffRequests:
type: array
description: The time off requests in the schedule.
items:
$ref: '#/components/schemas/TimeOffRequest'
x-ms-navigationProperty: true
timesOff:
type: array
description: The instances of times off in the schedule.
items:
$ref: '#/components/schemas/TimeOff'
x-ms-navigationProperty: true
additionalProperties: true
Album:
title: album
type: object
properties:
coverImageItemId:
type: string
description: Unique identifier of the driveItem that is the cover of the
album.
nullable: true
additionalProperties: true
SchedulingGroup1:
title: schedulingGroup
type: object
properties:
code:
type: string
description: "The code for the schedulingGroup to represent an external\
\ identifier. This field must be unique within the team in Microsoft Teams\
\ and uses an alphanumeric format, with a maximum of 100 characters."
nullable: true
displayName:
type: string
description: The display name for the schedulingGroup. Required.
nullable: true
isActive:
type: boolean
description: Indicates whether the schedulingGroup can be used when creating
new entities or updating existing ones. Required.
nullable: true
readOnly: true
userIds:
type: array
description: The list of user IDs that are a member of the schedulingGroup.
Required.
items:
type: string
nullable: true
additionalProperties: true
Person1:
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/PersonType'
phones:
type: array
description: The person's phone numbers.
items:
$ref: '#/components/schemas/Phone'
postalAddresses:
type: array
description: The person's addresses.
items:
$ref: '#/components/schemas/Location'
profession:
type: string
description: The person's profession.
nullable: true
scoredEmailAddresses:
type: array
description: The person's email addresses.
items:
$ref: '#/components/schemas/ScoredEmailAddress'
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
description: The person's websites.
items:
$ref: '#/components/schemas/Website'
yomiCompany:
type: string
description: The phonetic Japanese name of the person's company.
nullable: true
additionalProperties: true
TodoTask:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TodoTask1'
WorkbookChartDataLabelFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartDataLabelFormat1'
OnlineMeetingProviderType:
title: onlineMeetingProviderType
type: string
enum:
- unknown
- skypeForBusiness
- skypeForConsumer
- teamsForBusiness
OnenoteResource:
allOf:
- $ref: '#/components/schemas/OnenoteEntityBaseModel'
- $ref: '#/components/schemas/OnenoteResource1'
ComplianceState:
title: complianceState
type: string
description: Compliance state
enum:
- unknown
- compliant
- noncompliant
- conflict
- error
- inGracePeriod
- configManager
x-ms-enum:
name: complianceState
modelAsString: false
values:
- value: unknown
description: Unknown.
name: unknown
- value: compliant
description: Compliant.
name: compliant
- value: noncompliant
description: Device is non-compliant and is blocked from corporate resources.
name: noncompliant
- value: conflict
description: Conflict with other rules.
name: conflict
- value: error
description: Error.
name: error
- value: inGracePeriod
description: Device is non-compliant but still has access to corporate resources
name: inGracePeriod
- value: configManager
description: Managed by Config Manager
name: configManager
AttendanceRecord:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/AttendanceRecord1'
Team1:
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/TeamFunSettings'
guestSettings:
$ref: '#/components/schemas/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/TeamMemberSettings'
messagingSettings:
$ref: '#/components/schemas/TeamMessagingSettings'
specialization:
$ref: '#/components/schemas/TeamSpecialization'
summary:
$ref: '#/components/schemas/TeamSummary'
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
visibility:
$ref: '#/components/schemas/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
description: List of channels either hosted in or shared with the team (incoming
channels).
items:
$ref: '#/components/schemas/Channel'
x-ms-navigationProperty: true
channels:
type: array
description: The collection of channels and messages associated with the
team.
items:
$ref: '#/components/schemas/Channel'
x-ms-navigationProperty: true
group:
$ref: '#/components/schemas/Group'
incomingChannels:
type: array
description: List of channels shared with the team.
items:
$ref: '#/components/schemas/Channel'
x-ms-navigationProperty: true
installedApps:
type: array
description: The apps installed in this team.
items:
$ref: '#/components/schemas/TeamsAppInstallation'
x-ms-navigationProperty: true
members:
type: array
description: Members and owners of the team.
items:
$ref: '#/components/schemas/ConversationMember'
x-ms-navigationProperty: true
operations:
type: array
description: The async operations that ran or are running on this team.
items:
$ref: '#/components/schemas/TeamsAsyncOperation'
x-ms-navigationProperty: true
permissionGrants:
type: array
description: A collection of permissions granted to apps to access the team.
items:
$ref: '#/components/schemas/ResourceSpecificPermissionGrant'
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/ProfilePhoto'
primaryChannel:
$ref: '#/components/schemas/Channel'
schedule:
$ref: '#/components/schemas/Schedule'
tags:
type: array
description: The tags associated with the team.
items:
$ref: '#/components/schemas/TeamworkTag'
x-ms-navigationProperty: true
template:
$ref: '#/components/schemas/TeamsTemplate'
additionalProperties: true
WorkbookChartAxisFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartAxisFormat1'
SharePointIdentity1:
title: sharePointIdentity
type: object
properties:
loginName:
type: string
description: The sign in name of the SharePoint identity.
nullable: true
additionalProperties: true
ListItemVersion:
allOf:
- $ref: '#/components/schemas/BaseItemVersion'
- $ref: '#/components/schemas/ListItemVersion1'
PrintEvent:
title: printEvent
type: string
enum:
- jobStarted
- unknownFutureValue
WorkbookChartFont1:
title: workbookChartFont
type: object
properties:
bold:
type: boolean
description: Indicates whether the fond is bold.
nullable: true
color:
type: string
description: "The HTML color code representation of the text color. For\
\ example #FF0000 represents Red."
nullable: true
italic:
type: boolean
description: Indicates whether the fond is italic.
nullable: true
name:
type: string
description: The font name. For example 'Calibri'.
nullable: true
size:
type: number
description: "The size of the font. For example, 11."
format: double
nullable: true
underline:
type: string
description: "The type of underlining applied to the font. The possible\
\ values are: None, Single."
nullable: true
additionalProperties: true
GroupSetting:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/GroupSetting1'
BooleanColumn:
title: booleanColumn
type: object
additionalProperties: true
ChannelMembershipType:
title: channelMembershipType
type: string
enum:
- standard
- private
- unknownFutureValue
- shared
ChatRestrictions:
title: chatRestrictions
type: object
properties:
allowTextOnly:
type: boolean
description: Indicates whether only text is allowed in the meeting chat.
Optional.
nullable: true
additionalProperties: true
CallRecording:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/CallRecording1'
ItemPreviewInfo:
title: itemPreviewInfo
type: object
properties:
getUrl:
type: string
nullable: true
postParameters:
type: string
nullable: true
postUrl:
type: string
nullable: true
additionalProperties: true
ResponseStatus:
title: responseStatus
type: object
properties:
response:
$ref: '#/components/schemas/ResponseType'
time:
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 response was returned. It 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
additionalProperties: true
SwapShiftsChangeRequest:
allOf:
- $ref: '#/components/schemas/OfferShiftRequest'
- $ref: '#/components/schemas/SwapShiftsChangeRequest1'
OnlineMeetingPresenters:
title: onlineMeetingPresenters
type: string
enum:
- everyone
- organization
- roleIsPresenter
- organizer
- unknownFutureValue
DeviceCompliancePolicyState:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/DeviceCompliancePolicyState1'
TeamsAppInstallation1:
title: teamsAppInstallation
type: object
properties:
consentedPermissionSet:
$ref: '#/components/schemas/TeamsAppPermissionSet'
teamsApp:
$ref: '#/components/schemas/TeamsApp'
teamsAppDefinition:
$ref: '#/components/schemas/TeamsAppDefinition'
additionalProperties: true
WindowsHelloForBusinessAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/WindowsHelloForBusinessAuthenticationMethod1'
WorkbookWorksheet1:
title: workbookWorksheet
type: object
properties:
name:
type: string
description: The display name of the worksheet.
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: number
description: The zero-based position of the worksheet within the workbook.
format: int32
visibility:
type: string
description: "The visibility of the worksheet. The possible values are:\
\ Visible, Hidden, VeryHidden."
charts:
type: array
description: The list of charts that are part of the worksheet. Read-only.
items:
$ref: '#/components/schemas/WorkbookChart'
x-ms-navigationProperty: true
names:
type: array
description: The list of names that are associated with the worksheet. Read-only.
items:
$ref: '#/components/schemas/WorkbookNamedItem'
x-ms-navigationProperty: true
pivotTables:
type: array
description: The list of piot tables that are part of the worksheet.
items:
$ref: '#/components/schemas/WorkbookPivotTable'
x-ms-navigationProperty: true
protection:
$ref: '#/components/schemas/WorkbookWorksheetProtection'
tables:
type: array
description: The list of tables that are part of the worksheet. Read-only.
items:
$ref: '#/components/schemas/WorkbookTable'
x-ms-navigationProperty: true
additionalProperties: true
ContactFolder1:
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
description: The collection of child folders in the folder. Navigation property.
Read-only. Nullable.
items:
$ref: '#/components/schemas/ContactFolder'
x-ms-navigationProperty: true
contacts:
type: array
description: The contacts in the folder. Navigation property. Read-only.
Nullable.
items:
$ref: '#/components/schemas/Contact'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
description: The collection of multi-value extended properties defined for
the contactFolder. Read-only. Nullable.
items:
$ref: '#/components/schemas/MultiValueLegacyExtendedProperty'
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
description: The collection of single-value extended properties defined
for the contactFolder. Read-only. Nullable.
items:
$ref: '#/components/schemas/SingleValueLegacyExtendedProperty'
x-ms-navigationProperty: true
additionalProperties: true
ChatInfo:
title: chatInfo
type: object
properties:
messageId:
type: string
description: The unique identifier of a message in a Microsoft Teams channel.
nullable: true
replyChainMessageId:
type: string
description: The ID of the reply message.
nullable: true
threadId:
type: string
description: The unique identifier for a thread in Microsoft Teams.
nullable: true
additionalProperties: true
DeviceManagementExchangeAccessState:
title: deviceManagementExchangeAccessState
type: string
description: Device Exchange Access State
enum:
- none
- unknown
- allowed
- blocked
- quarantined
x-ms-enum:
name: deviceManagementExchangeAccessState
modelAsString: false
values:
- value: none
description: No access state discovered from Exchange
name: none
- value: unknown
description: Device access state to Exchange is unknown
name: unknown
- value: allowed
description: Device has access to Exchange
name: allowed
- value: blocked
description: Device is Blocked in Exchange
name: blocked
- value: quarantined
description: Device is Quarantined in Exchange
name: quarantined
GiphyRatingType:
title: giphyRatingType
type: string
enum:
- strict
- moderate
- unknownFutureValue
SingleValueLegacyExtendedProperty1:
title: singleValueLegacyExtendedProperty
type: object
properties:
value:
type: string
description: A property value.
nullable: true
additionalProperties: true
SizeRange:
title: sizeRange
type: object
properties:
maximumSize:
maximum: 2147483647
minimum: -2147483648
type: number
description: The maximum size (in kilobytes) that an incoming message must
have in order for a condition or exception to apply.
format: int32
nullable: true
minimumSize:
maximum: 2147483647
minimum: -2147483648
type: number
description: The minimum size (in kilobytes) that an incoming message must
have in order for a condition or exception to apply.
format: int32
nullable: true
additionalProperties: true
ItemInsights1:
title: itemInsights
type: object
additionalProperties: true
WorkbookChartGridlines:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartGridlines1'
MobileAppIdentifier:
title: mobileAppIdentifier
type: object
additionalProperties: true
description: The identifier for a mobile app
DocumentSetVersion1:
title: documentSetVersion
type: object
properties:
comment:
type: string
description: Comment about the captured version.
nullable: true
createdBy:
$ref: '#/components/schemas/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
description: Items within the document set that are captured as part of
this version.
items:
$ref: '#/components/schemas/DocumentSetVersionItem'
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
WorkbookNamedItem1:
title: workbookNamedItem
type: object
properties:
comment:
type: string
description: The comment associated with this name.
nullable: true
name:
type: string
description: The name of the object. Read-only.
nullable: true
scope:
type: string
description: Indicates whether the name is scoped to the workbook or to
a specific worksheet. Read-only.
type:
type: string
description: "The type of reference is associated with the name. Possible\
\ values are: String, Integer, Double, Boolean, Range. Read-only."
nullable: true
value:
$ref: '#/components/schemas/Json'
visible:
type: boolean
description: Indicates whether the object is visible.
worksheet:
$ref: '#/components/schemas/WorkbookWorksheet'
additionalProperties: true
TeamsTemplate:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamsTemplate1'
WatermarkProtectionValues:
title: watermarkProtectionValues
type: object
properties:
isEnabledForContentSharing:
type: boolean
description: Indicates whether to apply a watermark to any shared content.
nullable: true
isEnabledForVideo:
type: boolean
description: Indicates whether to apply a watermark to everyone's video
feed.
nullable: true
additionalProperties: true
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
PlannerProgressTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerProgressTaskBoardTaskFormat1'
AttendeeType:
title: attendeeType
type: string
enum:
- required
- optional
- resource
RecurrencePatternType:
title: recurrencePatternType
type: string
enum:
- daily
- weekly
- absoluteMonthly
- relativeMonthly
- absoluteYearly
- relativeYearly
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
WindowsDeviceMalwareState:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WindowsDeviceMalwareState1'
OpenShiftItem:
allOf:
- $ref: '#/components/schemas/ShiftItem'
- $ref: '#/components/schemas/OpenShiftItem1'
DelegateMeetingMessageDeliveryOptions:
title: delegateMeetingMessageDeliveryOptions
type: string
enum:
- sendToDelegateAndInformationToPrincipal
- sendToDelegateAndPrincipal
- sendToDelegateOnly
ODataErrorsODataError:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/ODataErrorsMainError'
additionalProperties: true
PlannerPlanContainer:
title: plannerPlanContainer
type: object
properties:
containerId:
type: string
description: The identifier of the resource that contains the plan. Optional.
nullable: true
type:
$ref: '#/components/schemas/PlannerContainerType'
url:
type: string
description: The full canonical URL of the container. Optional.
nullable: true
additionalProperties: true
ChatMessageHistoryItem:
title: chatMessageHistoryItem
type: object
properties:
actions:
$ref: '#/components/schemas/ChatMessageActions'
modifiedDateTime:
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 message was modified.
format: date-time
reaction:
$ref: '#/components/schemas/ChatMessageReaction'
additionalProperties: true
Thumbnail:
title: thumbnail
type: object
properties:
content:
type: string
description: The content stream for the thumbnail.
format: base64url
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: "The height of the thumbnail, in pixels."
format: int32
nullable: true
sourceItemId:
type: string
description: The unique identifier of the item that provided the thumbnail.
This is only available when a folder thumbnail is requested.
nullable: true
url:
type: string
description: The URL used to fetch the thumbnail content.
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: "The width of the thumbnail, in pixels."
format: int32
nullable: true
additionalProperties: true
BaseSitePage:
allOf:
- $ref: '#/components/schemas/BaseItem'
- $ref: '#/components/schemas/BaseSitePage1'
OnlineMeetingBase1:
title: onlineMeetingBase
type: object
properties:
allowAttendeeToEnableCamera:
type: boolean
description: Indicates whether attendees can turn on their camera.
nullable: true
allowAttendeeToEnableMic:
type: boolean
description: Indicates whether attendees can turn on their microphone.
nullable: true
allowBreakoutRooms:
type: boolean
description: Indicates whether breakout rooms are enabled for the meeting.
nullable: true
allowedLobbyAdmitters:
$ref: '#/components/schemas/AllowedLobbyAdmitterRoles'
allowedPresenters:
$ref: '#/components/schemas/OnlineMeetingPresenters'
allowLiveShare:
$ref: '#/components/schemas/MeetingLiveShareOptions'
allowMeetingChat:
$ref: '#/components/schemas/MeetingChatMode'
allowParticipantsToChangeName:
type: boolean
description: Specifies if participants are allowed to rename themselves
in an instance of the meeting.
nullable: true
allowPowerPointSharing:
type: boolean
description: Indicates whether PowerPoint live is enabled for the meeting.
nullable: true
allowRecording:
type: boolean
description: Indicates whether recording is enabled for the meeting.
nullable: true
allowTeamworkReactions:
type: boolean
description: Indicates if Teams reactions are enabled for the meeting.
nullable: true
allowTranscription:
type: boolean
description: Indicates whether transcription is enabled for the meeting.
nullable: true
allowWhiteboard:
type: boolean
description: Indicates whether whiteboard is enabled for the meeting.
nullable: true
audioConferencing:
$ref: '#/components/schemas/AudioConferencing'
chatInfo:
$ref: '#/components/schemas/ChatInfo'
chatRestrictions:
$ref: '#/components/schemas/ChatRestrictions'
isEndToEndEncryptionEnabled:
type: boolean
nullable: true
isEntryExitAnnounced:
type: boolean
description: Indicates whether to announce when callers join or leave.
nullable: true
joinInformation:
$ref: '#/components/schemas/ItemBody'
joinMeetingIdSettings:
$ref: '#/components/schemas/JoinMeetingIdSettings'
joinWebUrl:
type: string
description: The join URL of the online meeting. Read-only.
nullable: true
lobbyBypassSettings:
$ref: '#/components/schemas/LobbyBypassSettings'
recordAutomatically:
type: boolean
description: Indicates whether to record the meeting automatically.
nullable: true
shareMeetingChatHistoryDefault:
$ref: '#/components/schemas/MeetingChatHistoryDefaultMode'
subject:
type: string
description: The subject of the online meeting.
nullable: true
videoTeleconferenceId:
type: string
description: The video teleconferencing ID. Read-only.
nullable: true
watermarkProtection:
$ref: '#/components/schemas/WatermarkProtectionValues'
attendanceReports:
type: array
description: The attendance reports of an online meeting. Read-only.
items:
$ref: '#/components/schemas/MeetingAttendanceReport'
x-ms-navigationProperty: true
additionalProperties: true
SingleValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/SingleValueLegacyExtendedProperty1'
DeviceActionResult:
title: deviceActionResult
type: object
properties:
actionName:
type: string
description: Action name
nullable: true
actionState:
$ref: '#/components/schemas/ActionState'
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: Time the action state was last updated
format: date-time
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: Time the action was initiated
format: date-time
additionalProperties: true
description: Device action result
TimeZoneBase:
title: timeZoneBase
type: object
properties:
name:
type: string
description: "The name of a time zone. It can be a standard time zone name\
\ such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for\
\ a custom time zone."
nullable: true
additionalProperties: true
Permission:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Permission1'
ChatMessageHostedContent1:
title: chatMessageHostedContent
type: object
additionalProperties: true
ExtractSensitivityLabelsResult:
title: extractSensitivityLabelsResult
type: object
properties:
labels:
type: array
description: List of sensitivity labels assigned to a file.
items:
$ref: '#/components/schemas/SensitivityLabelAssignment'
additionalProperties: true
RichLongRunningOperationCollectionResponse:
title: Collection of richLongRunningOperation
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/RichLongRunningOperation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
SystemFacet:
title: systemFacet
type: object
additionalProperties: true
WorkbookFilterCriteria:
title: workbookFilterCriteria
type: object
properties:
color:
type: string
description: The color applied to the cell.
nullable: true
criterion1:
type: string
description: A custom criterion.
nullable: true
criterion2:
type: string
description: A custom criterion.
nullable: true
dynamicCriteria:
type: string
description: A dynamic formula specified in a custom filter.
filterOn:
type: string
description: Indicates whether a filter is applied to a column.
icon:
$ref: '#/components/schemas/WorkbookIcon'
operator:
type: string
description: "An operator in a cell; for example, =, >, <, <=, or <>."
values:
$ref: '#/components/schemas/Json'
additionalProperties: true
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
Hashes:
title: hashes
type: object
properties:
crc32Hash:
type: string
description: The CRC32 value of the file (if available). Read-only.
nullable: true
quickXorHash:
type: string
description: A proprietary hash of the file that can be used to determine
if the contents of the file change (if available). Read-only.
nullable: true
sha1Hash:
type: string
description: SHA1 hash for the contents of the file (if available). Read-only.
nullable: true
sha256Hash:
type: string
description: This property isn't supported. Don't use.
nullable: true
additionalProperties: true
Contact1:
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/PhysicalAddress'
businessHomePage:
type: string
description: The business home page of the contact.
nullable: true
businessPhones:
type: array
description: The contact's business phone numbers.
items:
type: string
nullable: true
children:
type: array
description: The names of the contact's children.
items:
type: string
nullable: true
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
description: The contact's email addresses.
items:
$ref: '#/components/schemas/EmailAddress'
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/PhysicalAddress'
homePhones:
type: array
description: The contact's home phone numbers.
items:
type: string
nullable: true
imAddresses:
type: array
description: The contact's instant messaging (IM) addresses.
items:
type: string
nullable: true
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/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
description: The collection of open extensions defined for the contact.
Read-only. Nullable.
items:
$ref: '#/components/schemas/Extension'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
description: The collection of multi-value extended properties defined for
the contact. Read-only. Nullable.
items:
$ref: '#/components/schemas/MultiValueLegacyExtendedProperty'
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/ProfilePhoto'
singleValueExtendedProperties:
type: array
description: The collection of single-value extended properties defined
for the contact. Read-only. Nullable.
items:
$ref: '#/components/schemas/SingleValueLegacyExtendedProperty'
x-ms-navigationProperty: true
additionalProperties: true
ShiftItem:
allOf:
- $ref: '#/components/schemas/ScheduleEntity'
- $ref: '#/components/schemas/ShiftItem1'
ChatMessageMentionedIdentitySet:
allOf:
- $ref: '#/components/schemas/IdentitySet'
- $ref: '#/components/schemas/ChatMessageMentionedIdentitySet1'
UserProtectionScopeContainer:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/UserProtectionScopeContainer1'
WorkbookFilter:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookFilter1'
UnifiedStorageQuota1:
title: unifiedStorageQuota
type: object
properties:
deleted:
type: number
format: int64
nullable: true
manageWebUrl:
type: string
nullable: true
remaining:
type: number
format: int64
nullable: true
state:
type: string
nullable: true
total:
type: number
format: int64
nullable: true
used:
type: number
format: int64
nullable: true
services:
type: array
items:
$ref: '#/components/schemas/ServiceStorageQuotaBreakdown'
x-ms-navigationProperty: true
additionalProperties: true
ODataErrorsErrorDetails:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
nullable: true
additionalProperties: true
WindowsMalwareThreatState:
title: windowsMalwareThreatState
type: string
description: Malware threat status
enum:
- active
- actionFailed
- manualStepsRequired
- fullScanRequired
- rebootRequired
- remediatedWithNonCriticalFailures
- quarantined
- removed
- cleaned
- allowed
- noStatusCleared
x-ms-enum:
name: windowsMalwareThreatState
modelAsString: false
values:
- value: active
description: Active
name: active
- value: actionFailed
description: Action failed
name: actionFailed
- value: manualStepsRequired
description: Manual steps required
name: manualStepsRequired
- value: fullScanRequired
description: Full scan required
name: fullScanRequired
- value: rebootRequired
description: Reboot required
name: rebootRequired
- value: remediatedWithNonCriticalFailures
description: 'Remediated with non critical failures '
name: remediatedWithNonCriticalFailures
- value: quarantined
description: Quarantined
name: quarantined
- value: removed
description: Removed
name: removed
- value: cleaned
description: Cleaned
name: cleaned
- value: allowed
description: Allowed
name: allowed
- value: noStatusCleared
description: No status cleared
name: noStatusCleared
WorkbookChart:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChart1'
UsedInsight1:
title: usedInsight
type: object
properties:
lastUsed:
$ref: '#/components/schemas/UsageDetails'
resourceReference:
$ref: '#/components/schemas/ResourceReference'
resourceVisualization:
$ref: '#/components/schemas/ResourceVisualization'
resource:
$ref: '#/components/schemas/Entity'
additionalProperties: true
ChecklistItem:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ChecklistItem1'
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
Team:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Team1'
ManagedDevice:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ManagedDevice1'
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
UserIdentity1:
title: userIdentity
type: object
properties:
ipAddress:
type: string
description: Indicates the client IP address associated with the user performing
the activity (audit log only).
nullable: true
userPrincipalName:
type: string
description: The userPrincipalName attribute of the user.
nullable: true
additionalProperties: true
AgreementAcceptance:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/AgreementAcceptance1'
DayNote1:
title: dayNote
type: object
properties:
dayNoteDate:
pattern: "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$"
type: string
description: The date of the day note.
format: date
nullable: true
draftDayNote:
$ref: '#/components/schemas/ItemBody'
sharedDayNote:
$ref: '#/components/schemas/ItemBody'
additionalProperties: true
ChatMessageImportance:
title: chatMessageImportance
type: string
enum:
- normal
- high
- urgent
- unknownFutureValue
TimeOffReason1:
title: timeOffReason
type: object
properties:
code:
type: string
description: "The code of the timeOffReason to represent an external identifier.\
\ This field must be unique within the team in Microsoft Teams and uses\
\ an alphanumeric format, with a maximum of 100 characters."
nullable: true
displayName:
type: string
description: The name of the timeOffReason. Required.
nullable: true
iconType:
$ref: '#/components/schemas/TimeOffReasonIconType'
isActive:
type: boolean
description: Indicates whether the timeOffReason can be used when creating
new entities or updating existing ones. Required.
nullable: true
additionalProperties: true
Calendar:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Calendar1'
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
PrinterLocation:
title: printerLocation
type: object
properties:
altitudeInMeters:
maximum: 2147483647
minimum: -2147483648
type: number
description: "The altitude, in meters, that the printer is located at."
format: int32
nullable: true
building:
type: string
description: The building that the printer is located in.
nullable: true
city:
type: string
description: The city that the printer is located in.
nullable: true
countryOrRegion:
type: string
description: The country or region that the printer is located in.
nullable: true
floor:
type: string
description: The floor that the printer is located on. Only numerical values
are supported right now.
nullable: true
floorDescription:
type: string
description: The description of the floor that the printer is located on.
nullable: true
latitude:
type: number
description: The latitude that the printer is located at.
format: double
nullable: true
longitude:
type: number
description: The longitude that the printer is located at.
format: double
nullable: true
organization:
type: array
description: The organizational hierarchy that the printer belongs to. The
elements should be in hierarchical order.
items:
type: string
nullable: true
postalCode:
type: string
description: The postal code that the printer is located in.
nullable: true
roomDescription:
type: string
description: The description of the room that the printer is located in.
nullable: true
roomName:
type: string
description: The room that the printer is located in. Only numerical values
are supported right now.
nullable: true
site:
type: string
description: The site that the printer is located in.
nullable: true
stateOrProvince:
type: string
description: The state or province that the printer is located in.
nullable: true
streetAddress:
type: string
description: The street address where the printer is located.
nullable: true
subdivision:
type: array
description: The subdivision that the printer is located in. The elements
should be in hierarchical order.
items:
type: string
nullable: true
subunit:
type: array
items:
type: string
nullable: true
additionalProperties: true
TeamsTab:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamsTab1'
WorkingHours:
title: workingHours
type: object
properties:
daysOfWeek:
type: array
description: The days of the week on which the user works.
items:
$ref: '#/components/schemas/DayOfWeek'
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/TimeZoneBase'
additionalProperties: true
DriveItem:
allOf:
- $ref: '#/components/schemas/BaseItem'
- $ref: '#/components/schemas/DriveItem1'
ItemAnalytics:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ItemAnalytics1'
Event:
allOf:
- $ref: '#/components/schemas/OutlookItem'
- $ref: '#/components/schemas/Event1'
EmailAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/EmailAuthenticationMethod1'
WorkbookPivotTable:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookPivotTable1'
PrinterProcessingStateDetail:
title: printerProcessingStateDetail
type: string
enum:
- paused
- mediaJam
- mediaNeeded
- mediaLow
- mediaEmpty
- coverOpen
- interlockOpen
- outputTrayMissing
- outputAreaFull
- markerSupplyLow
- markerSupplyEmpty
- inputTrayMissing
- outputAreaAlmostFull
- markerWasteAlmostFull
- markerWasteFull
- fuserOverTemp
- fuserUnderTemp
- other
- none
- movingToPaused
- shutdown
- connectingToDevice
- timedOut
- stopping
- stoppedPartially
- tonerLow
- tonerEmpty
- spoolAreaFull
- doorOpen
- opticalPhotoConductorNearEndOfLife
- opticalPhotoConductorLifeOver
- developerLow
- developerEmpty
- interpreterResourceUnavailable
- unknownFutureValue
- alertRemovalOfBinaryChangeEntry
- banderAdded
- banderAlmostEmpty
- banderAlmostFull
- banderAtLimit
- banderClosed
- banderConfigurationChange
- banderCoverClosed
- banderCoverOpen
- banderEmpty
- banderFull
- banderInterlockClosed
- banderInterlockOpen
- banderJam
- banderLifeAlmostOver
- banderLifeOver
- banderMemoryExhausted
- banderMissing
- banderMotorFailure
- banderNearLimit
- banderOffline
- banderOpened
- banderOverTemperature
- banderPowerSaver
- banderRecoverableFailure
- banderRecoverableStorage
- banderRemoved
- banderResourceAdded
- banderResourceRemoved
- banderThermistorFailure
- banderTimingFailure
- banderTurnedOff
- banderTurnedOn
- banderUnderTemperature
- banderUnrecoverableFailure
- banderUnrecoverableStorageError
- banderWarmingUp
- binderAdded
- binderAlmostEmpty
- binderAlmostFull
- binderAtLimit
- binderClosed
- binderConfigurationChange
- binderCoverClosed
- binderCoverOpen
- binderEmpty
- binderFull
- binderInterlockClosed
- binderInterlockOpen
- binderJam
- binderLifeAlmostOver
- binderLifeOver
- binderMemoryExhausted
- binderMissing
- binderMotorFailure
- binderNearLimit
- binderOffline
- binderOpened
- binderOverTemperature
- binderPowerSaver
- binderRecoverableFailure
- binderRecoverableStorage
- binderRemoved
- binderResourceAdded
- binderResourceRemoved
- binderThermistorFailure
- binderTimingFailure
- binderTurnedOff
- binderTurnedOn
- binderUnderTemperature
- binderUnrecoverableFailure
- binderUnrecoverableStorageError
- binderWarmingUp
- cameraFailure
- chamberCooling
- chamberFailure
- chamberHeating
- chamberTemperatureHigh
- chamberTemperatureLow
- cleanerLifeAlmostOver
- cleanerLifeOver
- configurationChange
- deactivated
- deleted
- dieCutterAdded
- dieCutterAlmostEmpty
- dieCutterAlmostFull
- dieCutterAtLimit
- dieCutterClosed
- dieCutterConfigurationChange
- dieCutterCoverClosed
- dieCutterCoverOpen
- dieCutterEmpty
- dieCutterFull
- dieCutterInterlockClosed
- dieCutterInterlockOpen
- dieCutterJam
- dieCutterLifeAlmostOver
- dieCutterLifeOver
- dieCutterMemoryExhausted
- dieCutterMissing
- dieCutterMotorFailure
- dieCutterNearLimit
- dieCutterOffline
- dieCutterOpened
- dieCutterOverTemperature
- dieCutterPowerSaver
- dieCutterRecoverableFailure
- dieCutterRecoverableStorage
- dieCutterRemoved
- dieCutterResourceAdded
- dieCutterResourceRemoved
- dieCutterThermistorFailure
- dieCutterTimingFailure
- dieCutterTurnedOff
- dieCutterTurnedOn
- dieCutterUnderTemperature
- dieCutterUnrecoverableFailure
- dieCutterUnrecoverableStorageError
- dieCutterWarmingUp
- extruderCooling
- extruderFailure
- extruderHeating
- extruderJam
- extruderTemperatureHigh
- extruderTemperatureLow
- fanFailure
- faxModemLifeAlmostOver
- faxModemLifeOver
- faxModemMissing
- faxModemTurnedOff
- faxModemTurnedOn
- folderAdded
- folderAlmostEmpty
- folderAlmostFull
- folderAtLimit
- folderClosed
- folderConfigurationChange
- folderCoverClosed
- folderCoverOpen
- folderEmpty
- folderFull
- folderInterlockClosed
- folderInterlockOpen
- folderJam
- folderLifeAlmostOver
- folderLifeOver
- folderMemoryExhausted
- folderMissing
- folderMotorFailure
- folderNearLimit
- folderOffline
- folderOpened
- folderOverTemperature
- folderPowerSaver
- folderRecoverableFailure
- folderRecoverableStorage
- folderRemoved
- folderResourceAdded
- folderResourceRemoved
- folderThermistorFailure
- folderTimingFailure
- folderTurnedOff
- folderTurnedOn
- folderUnderTemperature
- folderUnrecoverableFailure
- folderUnrecoverableStorageError
- folderWarmingUp
- hibernate
- holdNewJobs
- identifyPrinterRequested
- imprinterAdded
- imprinterAlmostEmpty
- imprinterAlmostFull
- imprinterAtLimit
- imprinterClosed
- imprinterConfigurationChange
- imprinterCoverClosed
- imprinterCoverOpen
- imprinterEmpty
- imprinterFull
- imprinterInterlockClosed
- imprinterInterlockOpen
- imprinterJam
- imprinterLifeAlmostOver
- imprinterLifeOver
- imprinterMemoryExhausted
- imprinterMissing
- imprinterMotorFailure
- imprinterNearLimit
- imprinterOffline
- imprinterOpened
- imprinterOverTemperature
- imprinterPowerSaver
- imprinterRecoverableFailure
- imprinterRecoverableStorage
- imprinterRemoved
- imprinterResourceAdded
- imprinterResourceRemoved
- imprinterThermistorFailure
- imprinterTimingFailure
- imprinterTurnedOff
- imprinterTurnedOn
- imprinterUnderTemperature
- imprinterUnrecoverableFailure
- imprinterUnrecoverableStorageError
- imprinterWarmingUp
- inputCannotFeedSizeSelected
- inputManualInputRequest
- inputMediaColorChange
- inputMediaFormPartsChange
- inputMediaSizeChange
- inputMediaTrayFailure
- inputMediaTrayFeedError
- inputMediaTrayJam
- inputMediaTypeChange
- inputMediaWeightChange
- inputPickRollerFailure
- inputPickRollerLifeOver
- inputPickRollerLifeWarn
- inputPickRollerMissing
- inputTrayElevationFailure
- inputTrayPositionFailure
- inserterAdded
- inserterAlmostEmpty
- inserterAlmostFull
- inserterAtLimit
- inserterClosed
- inserterConfigurationChange
- inserterCoverClosed
- inserterCoverOpen
- inserterEmpty
- inserterFull
- inserterInterlockClosed
- inserterInterlockOpen
- inserterJam
- inserterLifeAlmostOver
- inserterLifeOver
- inserterMemoryExhausted
- inserterMissing
- inserterMotorFailure
- inserterNearLimit
- inserterOffline
- inserterOpened
- inserterOverTemperature
- inserterPowerSaver
- inserterRecoverableFailure
- inserterRecoverableStorage
- inserterRemoved
- inserterResourceAdded
- inserterResourceRemoved
- inserterThermistorFailure
- inserterTimingFailure
- inserterTurnedOff
- inserterTurnedOn
- inserterUnderTemperature
- inserterUnrecoverableFailure
- inserterUnrecoverableStorageError
- inserterWarmingUp
- interlockClosed
- interpreterCartridgeAdded
- interpreterCartridgeDeleted
- interpreterComplexPageEncountered
- interpreterMemoryDecrease
- interpreterMemoryIncrease
- interpreterResourceAdded
- interpreterResourceDeleted
- lampAtEol
- lampFailure
- lampNearEol
- laserAtEol
- laserFailure
- laserNearEol
- makeEnvelopeAdded
- makeEnvelopeAlmostEmpty
- makeEnvelopeAlmostFull
- makeEnvelopeAtLimit
- makeEnvelopeClosed
- makeEnvelopeConfigurationChange
- makeEnvelopeCoverClosed
- makeEnvelopeCoverOpen
- makeEnvelopeEmpty
- makeEnvelopeFull
- makeEnvelopeInterlockClosed
- makeEnvelopeInterlockOpen
- makeEnvelopeJam
- makeEnvelopeLifeAlmostOver
- makeEnvelopeLifeOver
- makeEnvelopeMemoryExhausted
- makeEnvelopeMissing
- makeEnvelopeMotorFailure
- makeEnvelopeNearLimit
- makeEnvelopeOffline
- makeEnvelopeOpened
- makeEnvelopeOverTemperature
- makeEnvelopePowerSaver
- makeEnvelopeRecoverableFailure
- makeEnvelopeRecoverableStorage
- makeEnvelopeRemoved
- makeEnvelopeResourceAdded
- makeEnvelopeResourceRemoved
- makeEnvelopeThermistorFailure
- makeEnvelopeTimingFailure
- makeEnvelopeTurnedOff
- makeEnvelopeTurnedOn
- makeEnvelopeUnderTemperature
- makeEnvelopeUnrecoverableFailure
- makeEnvelopeUnrecoverableStorageError
- makeEnvelopeWarmingUp
- markerAdjustingPrintQuality
- markerCleanerMissing
- markerDeveloperAlmostEmpty
- markerDeveloperEmpty
- markerDeveloperMissing
- markerFuserMissing
- markerFuserThermistorFailure
- markerFuserTimingFailure
- markerInkAlmostEmpty
- markerInkEmpty
- markerInkMissing
- markerOpcMissing
- markerPrintRibbonAlmostEmpty
- markerPrintRibbonEmpty
- markerPrintRibbonMissing
- markerSupplyAlmostEmpty
- markerSupplyMissing
- markerTonerCartridgeMissing
- markerTonerMissing
- markerWasteInkReceptacleAlmostFull
- markerWasteInkReceptacleFull
- markerWasteInkReceptacleMissing
- markerWasteMissing
- markerWasteTonerReceptacleAlmostFull
- markerWasteTonerReceptacleFull
- markerWasteTonerReceptacleMissing
- materialEmpty
- materialLow
- materialNeeded
- mediaDrying
- mediaPathCannotDuplexMediaSelected
- mediaPathFailure
- mediaPathInputEmpty
- mediaPathInputFeedError
- mediaPathInputJam
- mediaPathInputRequest
- mediaPathJam
- mediaPathMediaTrayAlmostFull
- mediaPathMediaTrayFull
- mediaPathMediaTrayMissing
- mediaPathOutputFeedError
- mediaPathOutputFull
- mediaPathOutputJam
- mediaPathPickRollerFailure
- mediaPathPickRollerLifeOver
- mediaPathPickRollerLifeWarn
- mediaPathPickRollerMissing
- motorFailure
- outputMailboxSelectFailure
- outputMediaTrayFailure
- outputMediaTrayFeedError
- outputMediaTrayJam
- perforaterAdded
- perforaterAlmostEmpty
- perforaterAlmostFull
- perforaterAtLimit
- perforaterClosed
- perforaterConfigurationChange
- perforaterCoverClosed
- perforaterCoverOpen
- perforaterEmpty
- perforaterFull
- perforaterInterlockClosed
- perforaterInterlockOpen
- perforaterJam
- perforaterLifeAlmostOver
- perforaterLifeOver
- perforaterMemoryExhausted
- perforaterMissing
- perforaterMotorFailure
- perforaterNearLimit
- perforaterOffline
- perforaterOpened
- perforaterOverTemperature
- perforaterPowerSaver
- perforaterRecoverableFailure
- perforaterRecoverableStorage
- perforaterRemoved
- perforaterResourceAdded
- perforaterResourceRemoved
- perforaterThermistorFailure
- perforaterTimingFailure
- perforaterTurnedOff
- perforaterTurnedOn
- perforaterUnderTemperature
- perforaterUnrecoverableFailure
- perforaterUnrecoverableStorageError
- perforaterWarmingUp
- platformCooling
- platformFailure
- platformHeating
- platformTemperatureHigh
- platformTemperatureLow
- powerDown
- powerUp
- printerManualReset
- printerNmsReset
- printerReadyToPrint
- puncherAdded
- puncherAlmostEmpty
- puncherAlmostFull
- puncherAtLimit
- puncherClosed
- puncherConfigurationChange
- puncherCoverClosed
- puncherCoverOpen
- puncherEmpty
- puncherFull
- puncherInterlockClosed
- puncherInterlockOpen
- puncherJam
- puncherLifeAlmostOver
- puncherLifeOver
- puncherMemoryExhausted
- puncherMissing
- puncherMotorFailure
- puncherNearLimit
- puncherOffline
- puncherOpened
- puncherOverTemperature
- puncherPowerSaver
- puncherRecoverableFailure
- puncherRecoverableStorage
- puncherRemoved
- puncherResourceAdded
- puncherResourceRemoved
- puncherThermistorFailure
- puncherTimingFailure
- puncherTurnedOff
- puncherTurnedOn
- puncherUnderTemperature
- puncherUnrecoverableFailure
- puncherUnrecoverableStorageError
- puncherWarmingUp
- resuming
- scanMediaPathFailure
- scanMediaPathInputEmpty
- scanMediaPathInputFeedError
- scanMediaPathInputJam
- scanMediaPathInputRequest
- scanMediaPathJam
- scanMediaPathOutputFeedError
- scanMediaPathOutputFull
- scanMediaPathOutputJam
- scanMediaPathPickRollerFailure
- scanMediaPathPickRollerLifeOver
- scanMediaPathPickRollerLifeWarn
- scanMediaPathPickRollerMissing
- scanMediaPathTrayAlmostFull
- scanMediaPathTrayFull
- scanMediaPathTrayMissing
- scannerLightFailure
- scannerLightLifeAlmostOver
- scannerLightLifeOver
- scannerLightMissing
- scannerSensorFailure
- scannerSensorLifeAlmostOver
- scannerSensorLifeOver
- scannerSensorMissing
- separationCutterAdded
- separationCutterAlmostEmpty
- separationCutterAlmostFull
- separationCutterAtLimit
- separationCutterClosed
- separationCutterConfigurationChange
- separationCutterCoverClosed
- separationCutterCoverOpen
- separationCutterEmpty
- separationCutterFull
- separationCutterInterlockClosed
- separationCutterInterlockOpen
- separationCutterJam
- separationCutterLifeAlmostOver
- separationCutterLifeOver
- separationCutterMemoryExhausted
- separationCutterMissing
- separationCutterMotorFailure
- separationCutterNearLimit
- separationCutterOffline
- separationCutterOpened
- separationCutterOverTemperature
- separationCutterPowerSaver
- separationCutterRecoverableFailure
- separationCutterRecoverableStorage
- separationCutterRemoved
- separationCutterResourceAdded
- separationCutterResourceRemoved
- separationCutterThermistorFailure
- separationCutterTimingFailure
- separationCutterTurnedOff
- separationCutterTurnedOn
- separationCutterUnderTemperature
- separationCutterUnrecoverableFailure
- separationCutterUnrecoverableStorageError
- separationCutterWarmingUp
- sheetRotatorAdded
- sheetRotatorAlmostEmpty
- sheetRotatorAlmostFull
- sheetRotatorAtLimit
- sheetRotatorClosed
- sheetRotatorConfigurationChange
- sheetRotatorCoverClosed
- sheetRotatorCoverOpen
- sheetRotatorEmpty
- sheetRotatorFull
- sheetRotatorInterlockClosed
- sheetRotatorInterlockOpen
- sheetRotatorJam
- sheetRotatorLifeAlmostOver
- sheetRotatorLifeOver
- sheetRotatorMemoryExhausted
- sheetRotatorMissing
- sheetRotatorMotorFailure
- sheetRotatorNearLimit
- sheetRotatorOffline
- sheetRotatorOpened
- sheetRotatorOverTemperature
- sheetRotatorPowerSaver
- sheetRotatorRecoverableFailure
- sheetRotatorRecoverableStorage
- sheetRotatorRemoved
- sheetRotatorResourceAdded
- sheetRotatorResourceRemoved
- sheetRotatorThermistorFailure
- sheetRotatorTimingFailure
- sheetRotatorTurnedOff
- sheetRotatorTurnedOn
- sheetRotatorUnderTemperature
- sheetRotatorUnrecoverableFailure
- sheetRotatorUnrecoverableStorageError
- sheetRotatorWarmingUp
- slitterAdded
- slitterAlmostEmpty
- slitterAlmostFull
- slitterAtLimit
- slitterClosed
- slitterConfigurationChange
- slitterCoverClosed
- slitterCoverOpen
- slitterEmpty
- slitterFull
- slitterInterlockClosed
- slitterInterlockOpen
- slitterJam
- slitterLifeAlmostOver
- slitterLifeOver
- slitterMemoryExhausted
- slitterMissing
- slitterMotorFailure
- slitterNearLimit
- slitterOffline
- slitterOpened
- slitterOverTemperature
- slitterPowerSaver
- slitterRecoverableFailure
- slitterRecoverableStorage
- slitterRemoved
- slitterResourceAdded
- slitterResourceRemoved
- slitterThermistorFailure
- slitterTimingFailure
- slitterTurnedOff
- slitterTurnedOn
- slitterUnderTemperature
- slitterUnrecoverableFailure
- slitterUnrecoverableStorageError
- slitterWarmingUp
- stackerAdded
- stackerAlmostEmpty
- stackerAlmostFull
- stackerAtLimit
- stackerClosed
- stackerConfigurationChange
- stackerCoverClosed
- stackerCoverOpen
- stackerEmpty
- stackerFull
- stackerInterlockClosed
- stackerInterlockOpen
- stackerJam
- stackerLifeAlmostOver
- stackerLifeOver
- stackerMemoryExhausted
- stackerMissing
- stackerMotorFailure
- stackerNearLimit
- stackerOffline
- stackerOpened
- stackerOverTemperature
- stackerPowerSaver
- stackerRecoverableFailure
- stackerRecoverableStorage
- stackerRemoved
- stackerResourceAdded
- stackerResourceRemoved
- stackerThermistorFailure
- stackerTimingFailure
- stackerTurnedOff
- stackerTurnedOn
- stackerUnderTemperature
- stackerUnrecoverableFailure
- stackerUnrecoverableStorageError
- stackerWarmingUp
- standby
- staplerAdded
- staplerAlmostEmpty
- staplerAlmostFull
- staplerAtLimit
- staplerClosed
- staplerConfigurationChange
- staplerCoverClosed
- staplerCoverOpen
- staplerEmpty
- staplerFull
- staplerInterlockClosed
- staplerInterlockOpen
- staplerJam
- staplerLifeAlmostOver
- staplerLifeOver
- staplerMemoryExhausted
- staplerMissing
- staplerMotorFailure
- staplerNearLimit
- staplerOffline
- staplerOpened
- staplerOverTemperature
- staplerPowerSaver
- staplerRecoverableFailure
- staplerRecoverableStorage
- staplerRemoved
- staplerResourceAdded
- staplerResourceRemoved
- staplerThermistorFailure
- staplerTimingFailure
- staplerTurnedOff
- staplerTurnedOn
- staplerUnderTemperature
- staplerUnrecoverableFailure
- staplerUnrecoverableStorageError
- staplerWarmingUp
- stitcherAdded
- stitcherAlmostEmpty
- stitcherAlmostFull
- stitcherAtLimit
- stitcherClosed
- stitcherConfigurationChange
- stitcherCoverClosed
- stitcherCoverOpen
- stitcherEmpty
- stitcherFull
- stitcherInterlockClosed
- stitcherInterlockOpen
- stitcherJam
- stitcherLifeAlmostOver
- stitcherLifeOver
- stitcherMemoryExhausted
- stitcherMissing
- stitcherMotorFailure
- stitcherNearLimit
- stitcherOffline
- stitcherOpened
- stitcherOverTemperature
- stitcherPowerSaver
- stitcherRecoverableFailure
- stitcherRecoverableStorage
- stitcherRemoved
- stitcherResourceAdded
- stitcherResourceRemoved
- stitcherThermistorFailure
- stitcherTimingFailure
- stitcherTurnedOff
- stitcherTurnedOn
- stitcherUnderTemperature
- stitcherUnrecoverableFailure
- stitcherUnrecoverableStorageError
- stitcherWarmingUp
- subunitAdded
- subunitAlmostEmpty
- subunitAlmostFull
- subunitAtLimit
- subunitClosed
- subunitCoolingDown
- subunitEmpty
- subunitFull
- subunitLifeAlmostOver
- subunitLifeOver
- subunitMemoryExhausted
- subunitMissing
- subunitMotorFailure
- subunitNearLimit
- subunitOffline
- subunitOpened
- subunitOverTemperature
- subunitPowerSaver
- subunitRecoverableFailure
- subunitRecoverableStorage
- subunitRemoved
- subunitResourceAdded
- subunitResourceRemoved
- subunitThermistorFailure
- subunitTimingFailure
- subunitTurnedOff
- subunitTurnedOn
- subunitUnderTemperature
- subunitUnrecoverableFailure
- subunitUnrecoverableStorage
- subunitWarmingUp
- suspend
- testing
- trimmerAdded
- trimmerAlmostEmpty
- trimmerAlmostFull
- trimmerAtLimit
- trimmerClosed
- trimmerConfigurationChange
- trimmerCoverClosed
- trimmerCoverOpen
- trimmerEmpty
- trimmerFull
- trimmerInterlockClosed
- trimmerInterlockOpen
- trimmerJam
- trimmerLifeAlmostOver
- trimmerLifeOver
- trimmerMemoryExhausted
- trimmerMissing
- trimmerMotorFailure
- trimmerNearLimit
- trimmerOffline
- trimmerOpened
- trimmerOverTemperature
- trimmerPowerSaver
- trimmerRecoverableFailure
- trimmerRecoverableStorage
- trimmerRemoved
- trimmerResourceAdded
- trimmerResourceRemoved
- trimmerThermistorFailure
- trimmerTimingFailure
- trimmerTurnedOff
- trimmerTurnedOn
- trimmerUnderTemperature
- trimmerUnrecoverableFailure
- trimmerUnrecoverableStorageError
- trimmerWarmingUp
- unknown
- wrapperAdded
- wrapperAlmostEmpty
- wrapperAlmostFull
- wrapperAtLimit
- wrapperClosed
- wrapperConfigurationChange
- wrapperCoverClosed
- wrapperCoverOpen
- wrapperEmpty
- wrapperFull
- wrapperInterlockClosed
- wrapperInterlockOpen
- wrapperJam
- wrapperLifeAlmostOver
- wrapperLifeOver
- wrapperMemoryExhausted
- wrapperMissing
- wrapperMotorFailure
- wrapperNearLimit
- wrapperOffline
- wrapperOpened
- wrapperOverTemperature
- wrapperPowerSaver
- wrapperRecoverableFailure
- wrapperRecoverableStorage
- wrapperRemoved
- wrapperResourceAdded
- wrapperResourceRemoved
- wrapperThermistorFailure
- wrapperTimingFailure
- wrapperTurnedOff
- wrapperTurnedOn
- wrapperUnderTemperature
- wrapperUnrecoverableFailure
- wrapperUnrecoverableStorageError
- wrapperWarmingUp
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
AttendeeBase1:
title: attendeeBase
type: object
properties:
type:
$ref: '#/components/schemas/AttendeeType'
additionalProperties: true
PlannerTask:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerTask1'
Drive1:
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/IdentitySet'
quota:
$ref: '#/components/schemas/Quota'
sharePointIds:
$ref: '#/components/schemas/SharepointIds'
system:
$ref: '#/components/schemas/SystemFacet'
bundles:
type: array
description: Collection of bundles (albums and multi-select-shared sets
of items). Only in personal OneDrive.
items:
$ref: '#/components/schemas/DriveItem'
x-ms-navigationProperty: true
following:
type: array
description: The list of items the user is following. Only in OneDrive for
Business.
items:
$ref: '#/components/schemas/DriveItem'
x-ms-navigationProperty: true
items:
type: array
description: All items contained in the drive. Read-only. Nullable.
items:
$ref: '#/components/schemas/DriveItem'
x-ms-navigationProperty: true
list:
$ref: '#/components/schemas/List'
root:
$ref: '#/components/schemas/DriveItem'
special:
type: array
description: Collection of common folders available in OneDrive. Read-only.
Nullable.
items:
$ref: '#/components/schemas/DriveItem'
x-ms-navigationProperty: true
additionalProperties: true
OnlineMeetingBase:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/OnlineMeetingBase1'
OpenShiftChangeRequest:
allOf:
- $ref: '#/components/schemas/ScheduleChangeRequest'
- $ref: '#/components/schemas/OpenShiftChangeRequest1'
DriveCollectionResponse:
title: Collection of drive
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Drive'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
FollowupFlag:
title: followupFlag
type: object
properties:
completedDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
dueDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
flagStatus:
$ref: '#/components/schemas/FollowupFlagStatus'
startDateTime:
$ref: '#/components/schemas/DateTimeTimeZone'
additionalProperties: true
TimeSlot:
title: timeSlot
type: object
properties:
end:
$ref: '#/components/schemas/DateTimeTimeZone'
start:
$ref: '#/components/schemas/DateTimeTimeZone'
additionalProperties: true
OnenoteSection1:
title: onenoteSection
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default section. Read-only.
nullable: true
links:
$ref: '#/components/schemas/SectionLinks'
pagesUrl:
type: string
description: The pages endpoint where you can get details for all the pages
in the section. Read-only.
nullable: true
pages:
type: array
description: The collection of pages in the section. Read-only. Nullable.
items:
$ref: '#/components/schemas/OnenotePage'
x-ms-navigationProperty: true
parentNotebook:
$ref: '#/components/schemas/Notebook'
parentSectionGroup:
$ref: '#/components/schemas/SectionGroup'
additionalProperties: true
Channel1:
title: channel
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: Read only. Timestamp at which the channel was created.
format: date-time
nullable: true
description:
type: string
description: Optional textual description for the channel.
nullable: true
displayName:
type: string
description: Channel name as it will appear to the user in Microsoft Teams.
The maximum length is 50 characters.
email:
type: string
description: The email address for sending messages to the channel. Read-only.
nullable: true
isArchived:
type: boolean
description: Indicates whether the channel is archived. Read-only.
nullable: true
isFavoriteByDefault:
type: boolean
description: "Indicates whether the channel should be marked as recommended\
\ for all members of the team to show in their channel list. Note: All\
\ recommended channels automatically show in the channels list for education\
\ and frontline worker users. The property can only be set programmatically\
\ via the Create team method. The default value is false."
nullable: true
membershipType:
$ref: '#/components/schemas/ChannelMembershipType'
summary:
$ref: '#/components/schemas/ChannelSummary'
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
webUrl:
type: string
description: "A hyperlink that will go to the channel in Microsoft Teams.\
\ This is the URL that you get when you right-click a channel in Microsoft\
\ Teams and select Get link to channel. This URL should be treated as\
\ an opaque blob, and not parsed. Read-only."
nullable: true
allMembers:
type: array
description: "A collection of membership records associated with the channel,\
\ including both direct and indirect members of shared channels."
items:
$ref: '#/components/schemas/ConversationMember'
x-ms-navigationProperty: true
filesFolder:
$ref: '#/components/schemas/DriveItem'
members:
type: array
description: A collection of membership records associated with the channel.
items:
$ref: '#/components/schemas/ConversationMember'
x-ms-navigationProperty: true
messages:
type: array
description: A collection of all the messages in the channel. A navigation
property. Nullable.
items:
$ref: '#/components/schemas/ChatMessage'
x-ms-navigationProperty: true
sharedWithTeams:
type: array
description: A collection of teams with which a channel is shared.
items:
$ref: '#/components/schemas/SharedWithChannelTeamInfo'
x-ms-navigationProperty: true
tabs:
type: array
description: A collection of all the tabs in the channel. A navigation property.
items:
$ref: '#/components/schemas/TeamsTab'
x-ms-navigationProperty: true
additionalProperties: true
DocumentSetVersionCollectionResponse:
title: Collection of documentSetVersion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/DocumentSetVersion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
ChatMessageMentionedIdentitySet1:
title: chatMessageMentionedIdentitySet
type: object
properties:
conversation:
$ref: '#/components/schemas/TeamworkConversationIdentity'
additionalProperties: true
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
WorkbookChartSeriesFormat:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/WorkbookChartSeriesFormat1'
OutlookUser1:
title: outlookUser
type: object
properties:
masterCategories:
type: array
description: A list of categories defined for the user.
items:
$ref: '#/components/schemas/OutlookCategory'
x-ms-navigationProperty: true
additionalProperties: true
PlannerGroup:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/PlannerGroup1'
PlannerTask1:
title: plannerTask
type: object
properties:
activeChecklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Number of checklist items with value set to false, representing\
\ incomplete items."
format: int32
nullable: true
appliedCategories:
$ref: '#/components/schemas/PlannerAppliedCategories'
assigneePriority:
type: string
description: Hint used to order items of this type in a list view. The format
is defined as outlined here.
nullable: true
assignments:
$ref: '#/components/schemas/PlannerAssignments'
bucketId:
type: string
description: Bucket ID to which the task belongs. The bucket needs to be
in the plan that the task is in. It's 28 characters long and case-sensitive.
Format validation is done on the service.
nullable: true
checklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of checklist items that are present on the task.
format: int32
nullable: true
completedBy:
$ref: '#/components/schemas/IdentitySet'
completedDateTime:
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: "Read-only. Date and time at which the 'percentComplete' of\
\ the task is set to '100'. 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
conversationThreadId:
type: string
description: Thread ID of the conversation on the task. This is the ID of
the conversation thread object created in the group.
nullable: true
createdBy:
$ref: '#/components/schemas/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: "Read-only. Date and time at which the task is 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"
format: date-time
nullable: true
dueDateTime:
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 task is due. 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
hasDescription:
type: boolean
description: Read-only. Value is true if the details object of the task
has a nonempty description and false otherwise.
nullable: true
orderHint:
type: string
description: Hint used to order items of this type in a list view. The format
is defined as outlined here.
nullable: true
percentComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Percentage of task completion. When set to 100, the task is\
\ considered completed."
format: int32
nullable: true
planId:
type: string
description: Plan ID to which the task belongs.
nullable: true
previewType:
$ref: '#/components/schemas/PlannerPreviewType'
priority:
maximum: 2147483647
minimum: -2147483648
type: number
description: "Priority of the task. The valid range of values is between\
\ 0 and 10, with the increasing value being lower priority (0 has the\
\ highest priority and 10 has the lowest priority). Currently, Planner\
\ interprets values 0 and 1 as 'urgent', 2, 3 and 4 as 'important', 5,\
\ 6, and 7 as 'medium', and 8, 9, and 10 as 'low'. Additionally, Planner\
\ sets the value 1 for 'urgent', 3 for 'important', 5 for 'medium', and\
\ 9 for 'low'."
format: int32
nullable: true
referenceCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of external references that exist on the task.
format: int32
nullable: true
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: "Date and time at which the task starts. 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
title:
type: string
description: Title of the task.
assignedToTaskBoardFormat:
$ref: '#/components/schemas/PlannerAssignedToTaskBoardTaskFormat'
bucketTaskBoardFormat:
$ref: '#/components/schemas/PlannerBucketTaskBoardTaskFormat'
details:
$ref: '#/components/schemas/PlannerTaskDetails'
progressTaskBoardFormat:
$ref: '#/components/schemas/PlannerProgressTaskBoardTaskFormat'
additionalProperties: true
OnenoteEntitySchemaObjectModel1:
title: onenoteEntitySchemaObjectModel
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 when the page was created. The timestamp\
\ represents date and time information using ISO 8601 format and is always\
\ in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.\
\ Read-only."
format: date-time
nullable: true
additionalProperties: true
ChannelIdentity:
title: channelIdentity
type: object
properties:
channelId:
type: string
description: The identity of the channel in which the message was posted.
nullable: true
teamId:
type: string
description: The identity of the team in which the message was posted.
nullable: true
additionalProperties: true
DataSecurityAndGovernance:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/DataSecurityAndGovernance1'
EmployeeExperienceUser1:
title: employeeExperienceUser
type: object
properties:
learningCourseActivities:
type: array
items:
$ref: '#/components/schemas/LearningCourseActivity'
x-ms-navigationProperty: true
additionalProperties: true
ColumnLinkCollectionResponse:
title: Collection of columnLink
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/ColumnLink'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
ConversationThread:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/ConversationThread1'
TimeRange:
title: timeRange
type: object
properties:
endTime:
pattern: "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$"
type: string
description: End time for the time range.
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: Start time for the time range.
format: time
nullable: true
additionalProperties: true
PermissionCollectionResponse:
title: CollectionOfPermission
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Permission'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
MultiValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/MultiValueLegacyExtendedProperty1'
AlternativeSecurityId:
title: alternativeSecurityId
type: object
properties:
identityProvider:
type: string
description: For internal use only.
nullable: true
key:
type: string
description: For internal use only.
format: base64url
nullable: true
type:
maximum: 2147483647
minimum: -2147483648
type: number
description: For internal use only.
format: int32
nullable: true
additionalProperties: true
ThumbnailSetCollectionResponse:
title: Collection of thumbnailSet
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/ThumbnailSet'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
PrintJobStateDetail:
title: printJobStateDetail
type: string
enum:
- uploadPending
- transforming
- completedSuccessfully
- completedWithWarnings
- completedWithErrors
- releaseWait
- interpreting
- unknownFutureValue
AppRoleAssignment1:
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
WorkbookChartLegend1:
title: workbookChartLegend
type: object
properties:
overlay:
type: boolean
description: Indicates whether the chart legend should overlap with the
main body of the chart.
nullable: true
position:
type: string
description: "Represents the position of the legend on the chart. The possible\
\ values are: Top, Bottom, Left, Right, Corner, Custom."
nullable: true
visible:
type: boolean
description: Indicates whether the chart legend is visible.
format:
$ref: '#/components/schemas/WorkbookChartLegendFormat'
additionalProperties: true
SensitivityLabelAssignmentMethod:
title: sensitivityLabelAssignmentMethod
type: string
enum:
- standard
- privileged
- auto
- unknownFutureValue
PrintTask1:
title: printTask
type: object
properties:
parentUrl:
type: string
description: "The URL for the print entity that triggered this task. For\
\ example, https://graph.microsoft.com/v1.0/print/printers/{printerId}/jobs/{jobId}.\
\ Read-only."
status:
$ref: '#/components/schemas/PrintTaskStatus'
definition:
$ref: '#/components/schemas/PrintTaskDefinition'
trigger:
$ref: '#/components/schemas/PrintTaskTrigger'
additionalProperties: true
ChatMessagePolicyViolationVerdictDetailsTypes:
title: chatMessagePolicyViolationVerdictDetailsTypes
type: string
enum:
- none
- allowFalsePositiveOverride
- allowOverrideWithoutJustification
- allowOverrideWithJustification
x-ms-enum-flags:
isFlags: true
WorkbookChartGridlinesFormat1:
title: workbookChartGridlinesFormat
type: object
properties:
line:
$ref: '#/components/schemas/WorkbookChartLineFormat'
additionalProperties: true
TemporaryAccessPassAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/AuthenticationMethod'
- $ref: '#/components/schemas/TemporaryAccessPassAuthenticationMethod1'
CollectionOfPermission:
title: CollectionOfPermission
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Permission'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
TeamworkUserIdentityType:
title: teamworkUserIdentityType
type: string
enum:
- aadUser
- onPremiseAadUser
- anonymousGuest
- federatedUser
- personalMicrosoftAccountUser
- skypeUser
- phoneUser
- unknownFutureValue
- emailUser
OpenShift:
allOf:
- $ref: '#/components/schemas/ChangeTrackedEntity'
- $ref: '#/components/schemas/OpenShift1'
Presence:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Presence1'
TeamworkHostedContent:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/TeamworkHostedContent1'
MessageRulePredicates:
title: messageRulePredicates
type: object
properties:
bodyContains:
type: array
description: Represents the strings that should appear in the body of an
incoming message in order for the condition or exception to apply.
items:
type: string
nullable: true
bodyOrSubjectContains:
type: array
description: Represents the strings that should appear in the body or subject
of an incoming message in order for the condition or exception to apply.
items:
type: string
nullable: true
categories:
type: array
description: Represents the categories that an incoming message should be
labeled with in order for the condition or exception to apply.
items:
type: string
nullable: true
fromAddresses:
type: array
description: Represents the specific sender email addresses of an incoming
message in order for the condition or exception to apply.
items:
$ref: '#/components/schemas/Recipient'
hasAttachments:
type: boolean
description: Indicates whether an incoming message must have attachments
in order for the condition or exception to apply.
nullable: true
headerContains:
type: array
description: Represents the strings that appear in the headers of an incoming
message in order for the condition or exception to apply.
items:
type: string
nullable: true
importance:
$ref: '#/components/schemas/Importance'
isApprovalRequest:
type: boolean
description: Indicates whether an incoming message must be an approval request
in order for the condition or exception to apply.
nullable: true
isAutomaticForward:
type: boolean
description: Indicates whether an incoming message must be automatically
forwarded in order for the condition or exception to apply.
nullable: true
isAutomaticReply:
type: boolean
description: Indicates whether an incoming message must be an auto reply
in order for the condition or exception to apply.
nullable: true
isEncrypted:
type: boolean
description: Indicates whether an incoming message must be encrypted in
order for the condition or exception to apply.
nullable: true
isMeetingRequest:
type: boolean
description: Indicates whether an incoming message must be a meeting request
in order for the condition or exception to apply.
nullable: true
isMeetingResponse:
type: boolean
description: Indicates whether an incoming message must be a meeting response
in order for the condition or exception to apply.
nullable: true
isNonDeliveryReport:
type: boolean
description: Indicates whether an incoming message must be a non-delivery
report in order for the condition or exception to apply.
nullable: true
isPermissionControlled:
type: boolean
description: Indicates whether an incoming message must be permission controlled
(RMS-protected) in order for the condition or exception to apply.
nullable: true
isReadReceipt:
type: boolean
description: Indicates whether an incoming message must be a read receipt
in order for the condition or exception to apply.
nullable: true
isSigned:
type: boolean
description: Indicates whether an incoming message must be S/MIME-signed
in order for the condition or exception to apply.
nullable: true
isVoicemail:
type: boolean
description: Indicates whether an incoming message must be a voice mail
in order for the condition or exception to apply.
nullable: true
messageActionFlag:
$ref: '#/components/schemas/MessageActionFlag'
notSentToMe:
type: boolean
description: Indicates whether the owner of the mailbox must not be a recipient
of an incoming message in order for the condition or exception to apply.
nullable: true
recipientContains:
type: array
description: Represents the strings that appear in either the toRecipients
or ccRecipients properties of an incoming message in order for the condition
or exception to apply.
items:
type: string
nullable: true
senderContains:
type: array
description: Represents the strings that appear in the from property of
an incoming message in order for the condition or exception to apply.
items:
type: string
nullable: true
sensitivity:
$ref: '#/components/schemas/Sensitivity'
sentCcMe:
type: boolean
description: Indicates whether the owner of the mailbox must be in the ccRecipients
property of an incoming message in order for the condition or exception
to apply.
nullable: true
sentOnlyToMe:
type: boolean
description: Indicates whether the owner of the mailbox must be the only
recipient in an incoming message in order for the condition or exception
to apply.
nullable: true
sentToAddresses:
type: array
description: Represents the email addresses that an incoming message must
have been sent to in order for the condition or exception to apply.
items:
$ref: '#/components/schemas/Recipient'
sentToMe:
type: boolean
description: Indicates whether the owner of the mailbox must be in the toRecipients
property of an incoming message in order for the condition or exception
to apply.
nullable: true
sentToOrCcMe:
type: boolean
description: Indicates whether the owner of the mailbox must be in either
a toRecipients or ccRecipients property of an incoming message in order
for the condition or exception to apply.
nullable: true
subjectContains:
type: array
description: Represents the strings that appear in the subject of an incoming
message in order for the condition or exception to apply.
items:
type: string
nullable: true
withinSizeRange:
$ref: '#/components/schemas/SizeRange'
additionalProperties: true
SubscriptionCollectionResponse:
title: Collection of subscription
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/Subscription'
'@odata.nextLink':
type: string
nullable: true
additionalProperties: true
TeamsAsyncOperationStatus:
title: teamsAsyncOperationStatus
type: string
enum:
- invalid
- notStarted
- inProgress
- succeeded
- failed
- unknownFutureValue
SwapShiftsChangeRequest1:
title: swapShiftsChangeRequest
type: object
properties:
recipientShiftId:
type: string
description: The recipient's Shift ID
nullable: true
additionalProperties: true
ContentBase:
title: contentBase
type: object
additionalProperties: true
ContentActivity1:
title: contentActivity
type: object
properties:
contentMetadata:
$ref: '#/components/schemas/ProcessContentRequest'
scopeIdentifier:
type: string
description: The scope identified from computed protection scopes.
nullable: true
userId:
type: string
description: ID of the user.
nullable: true
additionalProperties: true
InternetMessageHeader:
title: internetMessageHeader
type: object
properties:
name:
type: string
description: Represents the key in a key-value pair.
nullable: true
value:
type: string
description: The value in a key-value pair.
nullable: true
additionalProperties: true
Extension:
allOf:
- $ref: '#/components/schemas/Entity'
- $ref: '#/components/schemas/Extension1'
SharingLink:
title: sharingLink
type: object
properties:
application:
$ref: '#/components/schemas/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