openapi: 3.1.0
info:
title: Microsoft Graph Users
description: Needs a description.
paths:
/copilot/users:
description: >-
Provides operations to manage the users property of the
microsoft.graph.copilotRoot entity.
get:
tags:
- copilot.aiUser
summary: Microsoft Graph Get users from copilot
operationId: copilot.ListUsers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.aiUserCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- copilot.aiUser
summary: Microsoft Graph Create new navigation property to users for copilot
operationId: copilot.CreateUsers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiUser'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/copilot/users/{aiUser-id}:
description: >-
Provides operations to manage the users property of the
microsoft.graph.copilotRoot entity.
get:
tags:
- copilot.aiUser
summary: Microsoft Graph Get users from copilot
operationId: copilot.GetUsers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- copilot.aiUser
summary: Microsoft Graph Update the navigation property users in copilot
operationId: copilot.UpdateUsers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiUser'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- copilot.aiUser
summary: Microsoft Graph Delete navigation property users for copilot
operationId: copilot.DeleteUsers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: aiUser-id
in: path
description: The unique identifier of aiUser
required: true
schema:
type: string
x-ms-docs-key-type: aiUser
/copilot/users/{aiUser-id}/interactionHistory:
description: >-
Provides operations to manage the interactionHistory property of the
microsoft.graph.aiUser entity.
get:
tags:
- copilot.aiUser
summary: Microsoft Graph Get interactionHistory from copilot
operationId: copilot.users.GetInteractionHistory
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiInteractionHistory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- copilot.aiUser
summary: Microsoft Graph Update the navigation property interactionHistory in copilot
operationId: copilot.users.UpdateInteractionHistory
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiInteractionHistory'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiInteractionHistory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- copilot.aiUser
summary: Microsoft Graph Delete navigation property interactionHistory for copilot
operationId: copilot.users.DeleteInteractionHistory
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: aiUser-id
in: path
description: The unique identifier of aiUser
required: true
schema:
type: string
x-ms-docs-key-type: aiUser
/copilot/users/{aiUser-id}/interactionHistory/getAllEnterpriseInteractions():
description: Provides operations to call the getAllEnterpriseInteractions method.
get:
tags:
- copilot.aiUser
summary: Microsoft Graph Invoke function getAllEnterpriseInteractions
operationId: copilot.users.aiUser.interactionHistory.getAllEnterpriseInteractions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of aiInteraction
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.aiInteraction'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: aiUser-id
in: path
description: The unique identifier of aiUser
required: true
schema:
type: string
x-ms-docs-key-type: aiUser
x-ms-docs-grouped-path:
- /copilot/interactionHistory/getAllEnterpriseInteractions()
/copilot/users/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- copilot.aiUser
summary: Microsoft Graph Get the number of the resource
operationId: copilot.users.GetCount-2ed5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/deviceManagement/managedDevices/{managedDevice-id}/users:
description: >-
Provides operations to manage the users property of the
microsoft.graph.managedDevice entity.
get:
tags:
- deviceManagement.managedDevice
summary: Microsoft Graph Get users from deviceManagement
description: The primary users associated with the managed device.
operationId: deviceManagement.managedDevices.ListUsers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.userCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/education/schools/{educationSchool-id}/users:
description: >-
Provides operations to manage the users property of the
microsoft.graph.educationSchool entity.
get:
tags:
- education.educationSchool
summary: Microsoft Graph List users of an educationSchool
description: Get the educationUser resources associated with an educationSchool.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationschool-list-users?view=graph-rest-1.0
operationId: education.schools.ListUsers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationUserCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: educationSchool-id
in: path
description: The unique identifier of educationSchool
required: true
schema:
type: string
x-ms-docs-key-type: educationSchool
/education/schools/{educationSchool-id}/users/{educationUser-id}/$ref:
description: Provides operations to manage the collection of educationRoot entities.
delete:
tags:
- education.educationSchool
summary: Microsoft Graph Remove educationUser from an educationSchool
description: Delete a user from a school.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationschool-delete-users?view=graph-rest-1.0
operationId: education.schools.users.DeleteRefEducationUser
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationSchool-id
in: path
description: The unique identifier of educationSchool
required: true
schema:
type: string
x-ms-docs-key-type: educationSchool
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/schools/{educationSchool-id}/users/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationSchool
summary: Microsoft Graph Get the number of the resource
operationId: education.schools.users.GetCount-e5a6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationSchool-id
in: path
description: The unique identifier of educationSchool
required: true
schema:
type: string
x-ms-docs-key-type: educationSchool
/education/schools/{educationSchool-id}/users/$ref:
description: Provides operations to manage the collection of educationRoot entities.
get:
tags:
- education.educationSchool
summary: Microsoft Graph List users of an educationSchool
description: Get the educationUser resources associated with an educationSchool.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationschool-list-users?view=graph-rest-1.0
operationId: education.schools.ListRefUsers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationSchool
summary: Microsoft Graph Add educationUser to an educationSchool
description: Add a user to a school.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationschool-post-users?view=graph-rest-1.0
operationId: education.schools.CreateRefUsers
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationSchool
summary: Microsoft Graph Remove educationUser from an educationSchool
description: Delete a user from a school.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationschool-delete-users?view=graph-rest-1.0
operationId: education.schools.DeleteRefUsers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationSchool-id
in: path
description: The unique identifier of educationSchool
required: true
schema:
type: string
x-ms-docs-key-type: educationSchool
/education/users:
description: >-
Provides operations to manage the users property of the
microsoft.graph.educationRoot entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph List educationUsers
description: Get a list of the educationUser objects and their properties.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-list?view=graph-rest-1.0
operationId: education.ListUsers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationUserCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create educationUser
description: Create a new educationUser object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-post?view=graph-rest-1.0
operationId: education.CreateUsers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationUser'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/education/users/{educationUser-id}:
description: >-
Provides operations to manage the users property of the
microsoft.graph.educationRoot entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get educationUser
description: Read the properties and relationships of an educationUser object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-get?view=graph-rest-1.0
operationId: education.GetUsers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update educationUser
description: Update the properties of an educationUser object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-update?view=graph-rest-1.0
operationId: education.UpdateUsers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationUser'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete educationUser
description: Delete a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-delete?view=graph-rest-1.0
operationId: education.DeleteUsers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/assignments:
description: >-
Provides operations to manage the assignments property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph List assignments of a user
description: >-
Returns a list of educationAssignment assigned to a educationUser for
all classes. Only teachers, students, and applications with application
permissions can perform this operation. This method allows a caller to
find all the assignments belonging to a student or a teacher in a single
call rather than having to request assignments from each class. The
assignment list contains what is needed to get the detailed information
for the assignment from within the class namespace. Use the methods
defined for the assignment for all other operations.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-list-assignments?view=graph-rest-1.0
operationId: education.users.ListAssignments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationAssignmentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to assignments for education
operationId: education.users.CreateAssignments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
x-ms-docs-grouped-path:
- /education/me/assignments
/education/users/{educationUser-id}/assignments/{educationAssignment-id}:
description: >-
Provides operations to manage the assignments property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get assignments from education
description: Assignments belonging to the user.
operationId: education.users.GetAssignments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property assignments in education
operationId: education.users.UpdateAssignments
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property assignments for education
operationId: education.users.DeleteAssignments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- /education/me/assignments/{educationAssignment-id}
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/categories:
description: >-
Provides operations to manage the categories property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get categories from education
description: >-
When set, enables users to easily find assignments of a given type.
Read-only. Nullable.
operationId: education.users.assignments.ListCategories
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationCategoryCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to categories for education
operationId: education.users.assignments.CreateCategories
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationCategory'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationCategory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/categories
- /education/me/assignments/{educationAssignment-id}/categories
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/categories/{educationCategory-id}/$ref:
description: Provides operations to manage the collection of educationRoot entities.
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete ref of navigation property categories for education
operationId: education.users.assignments.categories.DeleteRefEducationCategory
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationCategory-id
in: path
description: The unique identifier of educationCategory
required: true
schema:
type: string
x-ms-docs-key-type: educationCategory
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/categories/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.categories.GetCount-0551
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/categories/$ref:
description: Provides operations to manage the collection of educationRoot entities.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get ref of categories from education
description: >-
When set, enables users to easily find assignments of a given type.
Read-only. Nullable.
operationId: education.users.assignments.ListRefCategories
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property ref to categories for education
operationId: education.users.assignments.CreateRefCategories
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete ref of navigation property categories for education
operationId: education.users.assignments.DeleteRefCategories
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/categories/delta():
description: Provides operations to call the delta method.
get:
tags:
- education.educationUser
summary: Microsoft Graph Invoke function delta
description: >-
Get a list of newly created or updated educationCategory objects without
having to perform a full read of the collection.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationcategory-delta?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.categories.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of educationCategory
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationCategory
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- /education/classes/{educationClass-id}/assignmentCategories/delta()
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/categories/delta()
- /education/classes/{educationClass-id}/assignments/delta()
- /education/classes/delta()
- /education/me/assignments/{educationAssignment-id}/categories/delta()
- /education/me/assignments/delta()
- /education/schools/delta()
- /education/users/{educationUser-id}/assignments/delta()
- /education/users/delta()
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/gradingCategory:
description: >-
Provides operations to manage the gradingCategory property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get gradingCategory from education
description: >-
When set, enables users to weight assignments differently when computing
a class average grade.
operationId: education.users.assignments.GetGradingCategory
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationGradingCategory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/gradingCategory
- /education/me/assignments/{educationAssignment-id}/gradingCategory
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/gradingScheme:
description: >-
Provides operations to manage the gradingScheme property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get gradingScheme from education
description: >-
When set, enables users to configure custom string grades based on the
percentage of total points earned on this assignment.
operationId: education.users.assignments.GetGradingScheme
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationGradingScheme'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/gradingScheme
- /education/me/assignments/{educationAssignment-id}/gradingScheme
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/activate:
description: Provides operations to call the activate method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action activate
description: >-
Activate an inactive educationAssignment to signal that the assignment
has further action items for teachers or students. This action can only
be performed by a teacher on currently inactive assignments.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationassignment-activate?view=graph-rest-1.0
operationId: education.users.educationUser.assignments.educationAssignment.activate
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationAssignment'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/activate
- /education/me/assignments/{educationAssignment-id}/activate
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/deactivate:
description: Provides operations to call the deactivate method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action deactivate
description: >-
Mark an assigned educationAssignment as inactive to signal that the
assignment has no further action items for teachers and students. This
action can only be performed by a teacher on assigned assignments.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationassignment-deactivate?view=graph-rest-1.0
operationId: education.users.educationUser.assignments.educationAssignment.deactivate
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationAssignment'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/deactivate
- /education/me/assignments/{educationAssignment-id}/deactivate
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/publish:
description: Provides operations to call the publish method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action publish
description: >-
Publish an education assignment. Change the status of an
educationAssignment from its original draft status to the published
status. You can change the status from draft to scheduled if the
assignment is scheduled for a future date. Only a teacher in the class
can make this call. When an assignment is in draft status, students will
not see the assignment, nor will there be any submission objects.
Calling this API creates educationSubmission objects and displays the
assignment in each student's list. The status of the assignment goes
back to draft if there is any backend failure during publish process. To
update the properties of a published assignment, see update an
assignment.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationassignment-publish?view=graph-rest-1.0
operationId: education.users.educationUser.assignments.educationAssignment.publish
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationAssignment'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/publish
- >-
/education/classes/{educationClass-id}/modules/{educationModule-id}/publish
- /education/me/assignments/{educationAssignment-id}/publish
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/setUpFeedbackResourcesFolder:
description: Provides operations to call the setUpFeedbackResourcesFolder method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action setUpFeedbackResourcesFolder
description: >-
Create a SharePoint folder to upload feedback files for a given
educationSubmission. Only teachers can perform this operation. The
teacher determines the resources to upload in the feedback resources
folder of a submission.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationassignment-setupfeedbackresourcesfolder?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.setUpFeedbackResourcesFolder
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationAssignment'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/setUpFeedbackResourcesFolder
- >-
/education/me/assignments/{educationAssignment-id}/setUpFeedbackResourcesFolder
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/setUpResourcesFolder:
description: Provides operations to call the setUpResourcesFolder method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action setUpResourcesFolder
description: >-
Create a SharePoint folder to upload files for a given
educationAssignment. Only teachers can perform this operation. The
teacher determines the resources to upload in the assignment's folder.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationassignment-setupresourcesfolder?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.setUpResourcesFolder
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationAssignment'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/setUpResourcesFolder
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/setUpResourcesFolder
- >-
/education/classes/{educationClass-id}/modules/{educationModule-id}/setUpResourcesFolder
- /education/me/assignments/{educationAssignment-id}/setUpResourcesFolder
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/setUpResourcesFolder
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/setUpResourcesFolder
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/resources:
description: >-
Provides operations to manage the resources property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get resources from education
description: >-
Learning objects that are associated with this assignment. Only teachers
can modify this list. Nullable.
operationId: education.users.assignments.ListResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationAssignmentResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to resources for education
operationId: education.users.assignments.CreateResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignmentResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/resources
- /education/me/assignments/{educationAssignment-id}/resources
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}:
description: >-
Provides operations to manage the resources property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get resources from education
description: >-
Learning objects that are associated with this assignment. Only teachers
can modify this list. Nullable.
operationId: education.users.assignments.GetResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property resources in education
operationId: education.users.assignments.UpdateResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignmentResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property resources for education
operationId: education.users.assignments.DeleteResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationAssignmentResource-id
in: path
description: The unique identifier of educationAssignmentResource
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignmentResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}
- >-
/education/me/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}/dependentResources
: description: >-
Provides operations to manage the dependentResources property of the
microsoft.graph.educationAssignmentResource entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get dependentResources from education
description: >-
A collection of assignment resources that depend on the parent
educationAssignmentResource.
operationId: education.users.assignments.resources.ListDependentResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationAssignmentResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to dependentResources for education
operationId: education.users.assignments.resources.CreateDependentResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignmentResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationAssignmentResource-id
in: path
description: The unique identifier of educationAssignmentResource
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignmentResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}/dependentResources
- >-
/education/me/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}/dependentResources
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}/dependentResources/{educationAssignmentResource-id1}
: description: >-
Provides operations to manage the dependentResources property of the
microsoft.graph.educationAssignmentResource entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get dependentResources from education
description: >-
A collection of assignment resources that depend on the parent
educationAssignmentResource.
operationId: education.users.assignments.resources.GetDependentResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property dependentResources in education
operationId: education.users.assignments.resources.UpdateDependentResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationAssignmentResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property dependentResources for education
operationId: education.users.assignments.resources.DeleteDependentResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationAssignmentResource-id
in: path
description: The unique identifier of educationAssignmentResource
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignmentResource
- name: educationAssignmentResource-id1
in: path
description: The unique identifier of educationAssignmentResource
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignmentResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}/dependentResources/{educationAssignmentResource-id1}
- >-
/education/me/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}/dependentResources/{educationAssignmentResource-id1}
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/resources/{educationAssignmentResource-id}/dependentResources/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.resources.dependentResources.GetCount-e1ee
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationAssignmentResource-id
in: path
description: The unique identifier of educationAssignmentResource
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignmentResource
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/resources/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.resources.GetCount-69da
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/rubric:
description: >-
Provides operations to manage the rubric property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get rubric from education
description: When set, the grading rubric attached to this assignment.
operationId: education.users.assignments.GetRubric
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property rubric in education
operationId: education.users.assignments.UpdateRubric
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property rubric for education
operationId: education.users.assignments.DeleteRubric
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/rubric
- /education/me/assignments/{educationAssignment-id}/rubric
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/rubric/$ref:
description: Provides operations to manage the collection of educationRoot entities.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get ref of rubric from education
description: When set, the grading rubric attached to this assignment.
operationId: education.users.assignments.GetRefRubric
responses:
2XX:
description: Retrieved navigation property link
content:
application/json:
schema:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- education.educationUser
summary: Microsoft Graph Update the ref of navigation property rubric in education
operationId: education.users.assignments.UpdateRefRubric
requestBody:
$ref: '#/components/requestBodies/refPutBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete ref of navigation property rubric for education
operationId: education.users.assignments.DeleteRefRubric
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions:
description: >-
Provides operations to manage the submissions property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get submissions from education
description: >-
Once published, there's a submission object for each student
representing their work and grade. Read-only. Nullable.
operationId: education.users.assignments.ListSubmissions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationSubmissionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to submissions for education
operationId: education.users.assignments.CreateSubmissions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions
- /education/me/assignments/{educationAssignment-id}/submissions
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}:
description: >-
Provides operations to manage the submissions property of the
microsoft.graph.educationAssignment entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get submissions from education
description: >-
Once published, there's a submission object for each student
representing their work and grade. Read-only. Nullable.
operationId: education.users.assignments.GetSubmissions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property submissions in education
operationId: education.users.assignments.UpdateSubmissions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property submissions for education
operationId: education.users.assignments.DeleteSubmissions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/excuse:
description: Provides operations to call the excuse method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action excuse
description: >-
Excuse a submission. Excused submissions aren't included in average
grade calculations. Grading rubrics and feedback are deleted. Only
teachers can perform this action. If the Prefer:
include-unknown-enum-members request header is provided, the excused
submission shows the excused status. Otherwise, the submission status
retains the returned status. For more information about how to use this
header, see the Examples section.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationsubmission-excuse?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.submissions.educationSubmission.excuse
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationSubmission'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/excuse
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/excuse
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/reassign:
description: Provides operations to call the reassign method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action reassign
description: >-
Reassign the submission to the student with feedback for review. Only
teachers can perform this action. Include the Prefer:
include-unknown-enum-members header when you call this method;
otherwise, a reassigned submission is treated as a returned submission.
This means that the reassigned status is mapped to the returned status,
and reassignedDateTime and reassignedBy properties are mapped to
returnedDateTime and returnedBy respectively. If the header Prefer:
include-unknown-enum-members is provided, a reassigned submission
retains the reassigned status. For details, see the examples section.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationsubmission-reassign?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.submissions.educationSubmission.reassign
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationSubmission'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/reassign
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/reassign
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/return:
description: Provides operations to call the return method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action return
description: >-
Make the grade and feedback associated with this submission available to
the student. This action changes the status of the submission from
'submitted' to 'returned' and indicates that feedback is provided or
grading is done. This action can only be done by the teacher.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationsubmission-return?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.submissions.educationSubmission.return
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationSubmission'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/return
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/return
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/setUpResourcesFolder
: description: Provides operations to call the setUpResourcesFolder method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action setUpResourcesFolder
description: >-
Trigger the creation of the SharePoint resource folder where all
file-based resources (Word, Excel, and so on) should be uploaded for a
given submission. Only teachers and students can perform this operation.
Note that files must be located in this folder in order to be added as
resources. Only a student in the class can determine what files to
upload in a given submission-level resource folder.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationsubmission-setupresourcesfolder?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.submissions.educationSubmission.setUpResourcesFolder
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationSubmission'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/setUpResourcesFolder
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/setUpResourcesFolder
- >-
/education/classes/{educationClass-id}/modules/{educationModule-id}/setUpResourcesFolder
- /education/me/assignments/{educationAssignment-id}/setUpResourcesFolder
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/setUpResourcesFolder
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/setUpResourcesFolder
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submit:
description: Provides operations to call the submit method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action submit
description: >-
Indicate that a student is done with the work and is ready to hand in
the assignment. Only teachers, students, and applications with
application permissions can perform this operation. This method changes
the status of the submission from working to submitted. During the
submit process, all the resources are copied to the submittedResources
bucket. The teacher will be looking at the submitted resources list for
grading. A teacher can also submit a student's assignment on their
behalf.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationsubmission-submit?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.submissions.educationSubmission.submit
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationSubmission'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submit
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submit
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/unsubmit:
description: Provides operations to call the unsubmit method.
post:
tags:
- education.educationUser
summary: Microsoft Graph Invoke action unsubmit
description: >-
Indicate that a student wants to work on the submission of the
assignment after it was turned in. Only teachers, students, and
applications with application permissions can perform this operation.
This method changes the status of the submission from submitted to
working. During the submit process, all the resources are copied from
submittedResources to workingResources. The teacher will be looking at
the working resources list for grading. A teacher can also unsubmit a
student's assignment on their behalf.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationsubmission-unsubmit?view=graph-rest-1.0
operationId: >-
education.users.educationUser.assignments.educationAssignment.submissions.educationSubmission.unsubmit
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationSubmission'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/unsubmit
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/unsubmit
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/outcomes:
description: >-
Provides operations to manage the outcomes property of the
microsoft.graph.educationSubmission entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get outcomes from education
operationId: education.users.assignments.submissions.ListOutcomes
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationOutcomeCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to outcomes for education
operationId: education.users.assignments.submissions.CreateOutcomes
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationOutcome'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationOutcome'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/outcomes
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/outcomes
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/outcomes/{educationOutcome-id}
: description: >-
Provides operations to manage the outcomes property of the
microsoft.graph.educationSubmission entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get outcomes from education
operationId: education.users.assignments.submissions.GetOutcomes
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationOutcome'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property outcomes in education
operationId: education.users.assignments.submissions.UpdateOutcomes
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationOutcome'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationOutcome'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property outcomes for education
operationId: education.users.assignments.submissions.DeleteOutcomes
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationOutcome-id
in: path
description: The unique identifier of educationOutcome
required: true
schema:
type: string
x-ms-docs-key-type: educationOutcome
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/outcomes/{educationOutcome-id}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/outcomes/{educationOutcome-id}
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/outcomes/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.submissions.outcomes.GetCount-c6c3
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources:
description: >-
Provides operations to manage the resources property of the
microsoft.graph.educationSubmission entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get resources from education
operationId: education.users.assignments.submissions.ListResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationSubmissionResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to resources for education
operationId: education.users.assignments.submissions.CreateResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}
: description: >-
Provides operations to manage the resources property of the
microsoft.graph.educationSubmission entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get resources from education
operationId: education.users.assignments.submissions.GetResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property resources in education
operationId: education.users.assignments.submissions.UpdateResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property resources for education
operationId: education.users.assignments.submissions.DeleteResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources
: description: >-
Provides operations to manage the dependentResources property of the
microsoft.graph.educationSubmissionResource entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get dependentResources from education
description: >-
A collection of submission resources that depend on the parent
educationSubmissionResource.
operationId: education.users.assignments.submissions.resources.ListDependentResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationSubmissionResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to dependentResources for education
operationId: >-
education.users.assignments.submissions.resources.CreateDependentResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
: description: >-
Provides operations to manage the dependentResources property of the
microsoft.graph.educationSubmissionResource entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get dependentResources from education
description: >-
A collection of submission resources that depend on the parent
educationSubmissionResource.
operationId: education.users.assignments.submissions.resources.GetDependentResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property dependentResources in education
operationId: >-
education.users.assignments.submissions.resources.UpdateDependentResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property dependentResources for education
operationId: >-
education.users.assignments.submissions.resources.DeleteDependentResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
- name: educationSubmissionResource-id1
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: >-
education.users.assignments.submissions.resources.dependentResources.GetCount-ebf2
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.submissions.resources.GetCount-cb98
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources
: description: >-
Provides operations to manage the submittedResources property of the
microsoft.graph.educationSubmission entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get submittedResources from education
operationId: education.users.assignments.submissions.ListSubmittedResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationSubmissionResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to submittedResources for education
operationId: education.users.assignments.submissions.CreateSubmittedResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}
: description: >-
Provides operations to manage the submittedResources property of the
microsoft.graph.educationSubmission entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get submittedResources from education
operationId: education.users.assignments.submissions.GetSubmittedResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property submittedResources in education
operationId: education.users.assignments.submissions.UpdateSubmittedResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property submittedResources for education
operationId: education.users.assignments.submissions.DeleteSubmittedResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources
: description: >-
Provides operations to manage the dependentResources property of the
microsoft.graph.educationSubmissionResource entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get dependentResources from education
description: >-
A collection of submission resources that depend on the parent
educationSubmissionResource.
operationId: >-
education.users.assignments.submissions.submittedResources.ListDependentResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationSubmissionResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to dependentResources for education
operationId: >-
education.users.assignments.submissions.submittedResources.CreateDependentResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
: description: >-
Provides operations to manage the dependentResources property of the
microsoft.graph.educationSubmissionResource entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get dependentResources from education
description: >-
A collection of submission resources that depend on the parent
educationSubmissionResource.
operationId: >-
education.users.assignments.submissions.submittedResources.GetDependentResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property dependentResources in education
operationId: >-
education.users.assignments.submissions.submittedResources.UpdateDependentResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSubmissionResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property dependentResources for education
operationId: >-
education.users.assignments.submissions.submittedResources.DeleteDependentResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
- name: educationSubmissionResource-id1
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
x-ms-docs-grouped-path:
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/me/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/resources/{educationSubmissionResource-id}/dependentResources/{educationSubmissionResource-id1}
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/{educationSubmissionResource-id}/dependentResources/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: >-
education.users.assignments.submissions.submittedResources.dependentResources.GetCount-ce4e
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
- name: educationSubmissionResource-id
in: path
description: The unique identifier of educationSubmissionResource
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmissionResource
? /education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/{educationSubmission-id}/submittedResources/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.submissions.submittedResources.GetCount-6158
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
- name: educationSubmission-id
in: path
description: The unique identifier of educationSubmission
required: true
schema:
type: string
x-ms-docs-key-type: educationSubmission
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/submissions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.submissions.GetCount-fe47
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationAssignment-id
in: path
description: The unique identifier of educationAssignment
required: true
schema:
type: string
x-ms-docs-key-type: educationAssignment
/education/users/{educationUser-id}/assignments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.assignments.GetCount-d390
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/assignments/delta():
description: Provides operations to call the delta method.
get:
tags:
- education.educationUser
summary: Microsoft Graph Invoke function delta
description: >-
Get a list of newly-created or updated assignments without reading the
whole collection. A teacher or an application running with application
permissions can see all assignment objects for the class. Students can
only see assignments that are assigned to them.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationassignment-delta?view=graph-rest-1.0
operationId: education.users.educationUser.assignments.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of educationAssignment
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignment
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
x-ms-docs-grouped-path:
- /education/classes/{educationClass-id}/assignmentCategories/delta()
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/categories/delta()
- /education/classes/{educationClass-id}/assignments/delta()
- /education/classes/delta()
- /education/me/assignments/{educationAssignment-id}/categories/delta()
- /education/me/assignments/delta()
- /education/schools/delta()
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/categories/delta()
- /education/users/delta()
/education/users/{educationUser-id}/classes:
description: >-
Provides operations to manage the classes property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get classes from education
description: Classes to which the user belongs. Nullable.
operationId: education.users.ListClasses
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationClassCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
x-ms-docs-grouped-path:
- /education/me/classes
/education/users/{educationUser-id}/classes/{educationClass-id}:
description: >-
Provides operations to manage the classes property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get classes from education
description: Classes to which the user belongs. Nullable.
operationId: education.users.GetClasses
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationClass'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationClass-id
in: path
description: The unique identifier of educationClass
required: true
schema:
type: string
x-ms-docs-key-type: educationClass
x-ms-docs-grouped-path:
- /education/me/classes/{educationClass-id}
/education/users/{educationUser-id}/classes/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.classes.GetCount-4517
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/rubrics:
description: >-
Provides operations to manage the rubrics property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get rubrics from education
description: When set, the grading rubric attached to the assignment.
operationId: education.users.ListRubrics
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationRubricCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- education.educationUser
summary: Microsoft Graph Create new navigation property to rubrics for education
operationId: education.users.CreateRubrics
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
x-ms-docs-grouped-path:
- /education/me/rubrics
/education/users/{educationUser-id}/rubrics/{educationRubric-id}:
description: >-
Provides operations to manage the rubrics property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get rubrics from education
description: When set, the grading rubric attached to the assignment.
operationId: education.users.GetRubrics
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update the navigation property rubrics in education
operationId: education.users.UpdateRubrics
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- education.educationUser
summary: Microsoft Graph Delete navigation property rubrics for education
operationId: education.users.DeleteRubrics
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationRubric-id
in: path
description: The unique identifier of educationRubric
required: true
schema:
type: string
x-ms-docs-key-type: educationRubric
x-ms-docs-grouped-path:
- /education/me/rubrics/{educationRubric-id}
/education/users/{educationUser-id}/rubrics/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.rubrics.GetCount-7e40
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/schools:
description: >-
Provides operations to manage the schools property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get schools from education
description: Schools to which the user belongs. Nullable.
operationId: education.users.ListSchools
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationSchoolCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
x-ms-docs-grouped-path:
- /education/me/schools
/education/users/{educationUser-id}/schools/{educationSchool-id}:
description: >-
Provides operations to manage the schools property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get schools from education
description: Schools to which the user belongs. Nullable.
operationId: education.users.GetSchools
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationSchool'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationSchool-id
in: path
description: The unique identifier of educationSchool
required: true
schema:
type: string
x-ms-docs-key-type: educationSchool
x-ms-docs-grouped-path:
- /education/me/schools/{educationSchool-id}
/education/users/{educationUser-id}/schools/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.schools.GetCount-a99c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/taughtClasses:
description: >-
Provides operations to manage the taughtClasses property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph List taughtClasses
description: Get the educationClass resources owned by an educationUser.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-list-taughtclasses?view=graph-rest-1.0
operationId: education.users.ListTaughtClasses
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.educationClassCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
x-ms-docs-grouped-path:
- /education/me/taughtClasses
/education/users/{educationUser-id}/taughtClasses/{educationClass-id}:
description: >-
Provides operations to manage the taughtClasses property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get taughtClasses from education
description: Classes for which the user is a teacher.
operationId: education.users.GetTaughtClasses
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.educationClass'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
- name: educationClass-id
in: path
description: The unique identifier of educationClass
required: true
schema:
type: string
x-ms-docs-key-type: educationClass
x-ms-docs-grouped-path:
- /education/me/taughtClasses/{educationClass-id}
/education/users/{educationUser-id}/taughtClasses/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.taughtClasses.GetCount-788d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/user:
description: >-
Provides operations to manage the user property of the
microsoft.graph.educationUser entity.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get user from education
description: The directory user that corresponds to this user.
operationId: education.users.GetUser
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
x-ms-docs-grouped-path:
- /education/me/user
/education/users/{educationUser-id}/user/mailboxSettings:
get:
tags:
- education.educationUser
summary: Microsoft Graph Get mailboxSettings property value
description: >-
Settings for the primary mailbox of the signed-in user. You can get or
update settings for sending automatic replies to incoming messages,
locale, and time zone. Returned only on $select.
operationId: education.users.user.GetMailboxSettings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
patch:
tags:
- education.educationUser
summary: Microsoft Graph Update property mailboxSettings value.
operationId: education.users.user.UpdateMailboxSettings
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/user/serviceProvisioningErrors:
get:
tags:
- education.educationUser
summary: Microsoft Graph Get serviceProvisioningErrors property value
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).
operationId: education.users.user.ListServiceProvisioningErrors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/{educationUser-id}/user/serviceProvisioningErrors/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.user.ServiceProvisioningErrors.GetCount-9dc6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: educationUser-id
in: path
description: The unique identifier of educationUser
required: true
schema:
type: string
x-ms-docs-key-type: educationUser
/education/users/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- education.educationUser
summary: Microsoft Graph Get the number of the resource
operationId: education.users.GetCount-6be9
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/education/users/delta():
description: Provides operations to call the delta method.
get:
tags:
- education.educationUser
summary: Microsoft Graph Invoke function delta
description: >-
Get newly created or updated educationUser without having to perform a
full read of the entire collection. See Use delta query for details.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/educationuser-delta?view=graph-rest-1.0
operationId: education.users.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of educationUser
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-grouped-path:
- /education/classes/{educationClass-id}/assignmentCategories/delta()
- >-
/education/classes/{educationClass-id}/assignments/{educationAssignment-id}/categories/delta()
- /education/classes/{educationClass-id}/assignments/delta()
- /education/classes/delta()
- /education/me/assignments/{educationAssignment-id}/categories/delta()
- /education/me/assignments/delta()
- /education/schools/delta()
- >-
/education/users/{educationUser-id}/assignments/{educationAssignment-id}/categories/delta()
- /education/users/{educationUser-id}/assignments/delta()
/me/managedDevices/{managedDevice-id}/users:
description: >-
Provides operations to manage the users property of the
microsoft.graph.managedDevice entity.
get:
tags:
- me.managedDevice
summary: Microsoft Graph Get users from me
description: The primary users associated with the managed device.
operationId: me.managedDevices.ListUsers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.userCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/reports/authenticationMethods/usersRegisteredByFeature():
description: Provides operations to call the usersRegisteredByFeature method.
get:
tags:
- reports.authenticationMethodsRoot
summary: Microsoft Graph Invoke function usersRegisteredByFeature
description: >-
Get the number of users capable of multi-factor authentication,
self-service password reset, and passwordless authentication.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/authenticationmethodsroot-usersregisteredbyfeature?view=graph-rest-1.0
operationId: reports.authenticationMethods.usersRegisteredByFeature-07f2
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userRegistrationFeatureSummary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- >-
/reports/authenticationMethods/usersRegisteredByFeature(includedUserTypes='{includedUserTypes}',includedUserRoles='{includedUserRoles}')
? /reports/authenticationMethods/usersRegisteredByFeature(includedUserTypes='{includedUserTypes}',includedUserRoles='{includedUserRoles}')
: description: Provides operations to call the usersRegisteredByFeature method.
get:
tags:
- reports.authenticationMethodsRoot
summary: Microsoft Graph Invoke function usersRegisteredByFeature
operationId: reports.authenticationMethods.usersRegisteredByFeature-b345
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userRegistrationFeatureSummary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: includedUserTypes
in: path
description: 'Usage: includedUserTypes=''{includedUserTypes}'''
required: true
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.includedUserTypes'
- type: object
nullable: true
- name: includedUserRoles
in: path
description: 'Usage: includedUserRoles=''{includedUserRoles}'''
required: true
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.includedUserRoles'
- type: object
nullable: true
x-ms-docs-grouped-path:
- /reports/authenticationMethods/usersRegisteredByFeature()
/reports/authenticationMethods/usersRegisteredByMethod():
description: Provides operations to call the usersRegisteredByMethod method.
get:
tags:
- reports.authenticationMethodsRoot
summary: Microsoft Graph Invoke function usersRegisteredByMethod
description: Get the number of users registered for each authentication method.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/authenticationmethodsroot-usersregisteredbymethod?view=graph-rest-1.0
operationId: reports.authenticationMethods.usersRegisteredByMethod-d25d
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userRegistrationMethodSummary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-docs-grouped-path:
- >-
/reports/authenticationMethods/usersRegisteredByMethod(includedUserTypes='{includedUserTypes}',includedUserRoles='{includedUserRoles}')
? /reports/authenticationMethods/usersRegisteredByMethod(includedUserTypes='{includedUserTypes}',includedUserRoles='{includedUserRoles}')
: description: Provides operations to call the usersRegisteredByMethod method.
get:
tags:
- reports.authenticationMethodsRoot
summary: Microsoft Graph Invoke function usersRegisteredByMethod
operationId: reports.authenticationMethods.usersRegisteredByMethod-fb94
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userRegistrationMethodSummary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: includedUserTypes
in: path
description: 'Usage: includedUserTypes=''{includedUserTypes}'''
required: true
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.includedUserTypes'
- type: object
nullable: true
- name: includedUserRoles
in: path
description: 'Usage: includedUserRoles=''{includedUserRoles}'''
required: true
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.includedUserRoles'
- type: object
nullable: true
x-ms-docs-grouped-path:
- /reports/authenticationMethods/usersRegisteredByMethod()
/users:
description: Provides operations to manage the collection of user entities.
get:
tags:
- Users.user
summary: Microsoft Graph List users
description: Retrieve a list of user objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-list?view=graph-rest-1.0
operationId: users.user.ListUser
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.userCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.user
summary: Microsoft Graph Create User
description: "Create a new user.\r\nThe request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-post-users?view=graph-rest-1.0
operationId: users.user.CreateUser
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/users/{user-id}:
description: Provides operations to manage the collection of user entities.
get:
tags:
- Users.user
summary: Microsoft Graph Get a user
description: >-
Retrieve the properties and relationships of user object. This operation
returns by default only a subset of the more commonly used properties
for each user. These default properties are noted in the Properties
section. To get properties that are not returned by default, do a GET
operation for the user and specify the properties in a $select OData
query option. Because the user resource supports extensions, you can
also use the GET operation to get custom properties and extension data
in a user instance. Customers through Microsoft Entra ID for customers
can also use this API operation to retrieve their details.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-get?view=graph-rest-1.0
operationId: users.user.GetUser
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.user
summary: Microsoft Graph Update user
description: Update the properties of a user object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-update?view=graph-rest-1.0
operationId: users.user.UpdateUser
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.user
summary: Microsoft Graph Delete a user
description: >-
Delete a user object. When deleted, user resources, including their
mailbox and license assignments, are moved to a temporary container and
if the user is restored within 30 days, these objects are restored to
them. The user is also restored to any groups they were a member of.
After 30 days and if not restored, the user object is permanently
deleted and their assigned resources freed. To manage the deleted user
object, see deletedItems.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-delete?view=graph-rest-1.0
operationId: users.user.DeleteUser
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/activities:
description: >-
Provides operations to manage the activities property of the
microsoft.graph.user entity.
get:
tags:
- users.userActivity
summary: Microsoft Graph Get activities from users
description: The user's activities across devices. Read-only. Nullable.
operationId: users.ListActivities
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.userActivityCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userActivity
summary: Microsoft Graph Create new navigation property to activities for users
operationId: users.CreateActivities
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userActivity'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/activities/{userActivity-id}:
description: >-
Provides operations to manage the activities property of the
microsoft.graph.user entity.
get:
tags:
- users.userActivity
summary: Microsoft Graph Get activities from users
description: The user's activities across devices. Read-only. Nullable.
operationId: users.GetActivities
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userActivity
summary: Microsoft Graph Update the navigation property activities in users
operationId: users.UpdateActivities
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userActivity'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userActivity
summary: Microsoft Graph Delete navigation property activities for users
operationId: users.DeleteActivities
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userActivity-id
in: path
description: The unique identifier of userActivity
required: true
schema:
type: string
x-ms-docs-key-type: userActivity
/users/{user-id}/activities/{userActivity-id}/historyItems:
description: >-
Provides operations to manage the historyItems property of the
microsoft.graph.userActivity entity.
get:
tags:
- users.userActivity
summary: Microsoft Graph Get historyItems from users
description: >-
Optional. NavigationProperty/Containment; navigation property to the
activity's historyItems.
operationId: users.activities.ListHistoryItems
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.activityHistoryItemCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userActivity
summary: Microsoft Graph Create new navigation property to historyItems for users
operationId: users.activities.CreateHistoryItems
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userActivity-id
in: path
description: The unique identifier of userActivity
required: true
schema:
type: string
x-ms-docs-key-type: userActivity
/users/{user-id}/activities/{userActivity-id}/historyItems/{activityHistoryItem-id}:
description: >-
Provides operations to manage the historyItems property of the
microsoft.graph.userActivity entity.
get:
tags:
- users.userActivity
summary: Microsoft Graph Get historyItems from users
description: >-
Optional. NavigationProperty/Containment; navigation property to the
activity's historyItems.
operationId: users.activities.GetHistoryItems
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userActivity
summary: Microsoft Graph Update the navigation property historyItems in users
operationId: users.activities.UpdateHistoryItems
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userActivity
summary: Microsoft Graph Delete navigation property historyItems for users
operationId: users.activities.DeleteHistoryItems
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userActivity-id
in: path
description: The unique identifier of userActivity
required: true
schema:
type: string
x-ms-docs-key-type: userActivity
- name: activityHistoryItem-id
in: path
description: The unique identifier of activityHistoryItem
required: true
schema:
type: string
x-ms-docs-key-type: activityHistoryItem
/users/{user-id}/activities/{userActivity-id}/historyItems/{activityHistoryItem-id}/activity:
description: >-
Provides operations to manage the activity property of the
microsoft.graph.activityHistoryItem entity.
get:
tags:
- users.userActivity
summary: Microsoft Graph Get activity from users
description: >-
Optional. NavigationProperty/Containment; navigation property to the
associated activity.
operationId: users.activities.historyItems.GetActivity
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userActivity-id
in: path
description: The unique identifier of userActivity
required: true
schema:
type: string
x-ms-docs-key-type: userActivity
- name: activityHistoryItem-id
in: path
description: The unique identifier of activityHistoryItem
required: true
schema:
type: string
x-ms-docs-key-type: activityHistoryItem
/users/{user-id}/activities/{userActivity-id}/historyItems/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userActivity
summary: Microsoft Graph Get the number of the resource
operationId: users.activities.historyItems.GetCount-625e
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userActivity-id
in: path
description: The unique identifier of userActivity
required: true
schema:
type: string
x-ms-docs-key-type: userActivity
/users/{user-id}/activities/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userActivity
summary: Microsoft Graph Get the number of the resource
operationId: users.activities.GetCount-39cc
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/activities/recent():
description: Provides operations to call the recent method.
get:
tags:
- users.userActivity
summary: Microsoft Graph Invoke function recent
description: >-
Get recent activities for a given user. This OData function has some
default behaviors included to make it operate like a 'most recently
used' API. The service queries for the most recent activityHistoryItems,
and then pull those related activities. Activities are sorted according
to the most recent lastModified on the activityHistoryItem. This means
that activities without activityHistoryItems won't be included in the
response. The UserActivity.ReadWrite.CreatedByApp permission will also
apply extra filtering to the response, so that only activities created
by your application are returned. This server-side filtering might
result in empty pages if the user is active and other applications have
created more recent activities. To get your application's activities,
use the nextLink property to paginate.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/projectrome-get-recent-activities?view=graph-rest-1.0
operationId: users.user.activities.recent
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of userActivity
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/agreementAcceptances:
description: >-
Provides operations to manage the agreementAcceptances property of the
microsoft.graph.user entity.
get:
tags:
- users.agreementAcceptance
summary: Microsoft Graph Get agreementAcceptances from users
description: The user's terms of use acceptance statuses. Read-only. Nullable.
operationId: users.ListAgreementAcceptances
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.agreementAcceptanceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/agreementAcceptances/{agreementAcceptance-id}:
description: >-
Provides operations to manage the agreementAcceptances property of the
microsoft.graph.user entity.
get:
tags:
- users.agreementAcceptance
summary: Microsoft Graph Get agreementAcceptances from users
description: The user's terms of use acceptance statuses. Read-only. Nullable.
operationId: users.GetAgreementAcceptances
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
/users/{user-id}/agreementAcceptances/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.agreementAcceptance
summary: Microsoft Graph Get the number of the resource
operationId: users.agreementAcceptances.GetCount-b659
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/appRoleAssignments:
description: >-
Provides operations to manage the appRoleAssignments property of the
microsoft.graph.user entity.
get:
tags:
- users.appRoleAssignment
summary: Microsoft Graph List appRoleAssignments granted to a user
description: >-
Retrieve the list of appRoleAssignments that are currently granted to a
user. This operation also returns app role assignments granted to groups
that the user is a direct member of.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-approleassignments?view=graph-rest-1.0
operationId: users.ListAppRoleAssignments
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.appRoleAssignmentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.appRoleAssignment
summary: Microsoft Graph Grant an appRoleAssignment to a user
description: >-
Assign an app role to a user, creating an appRoleAssignment object. To
grant an app role assignment to a user, you need three identifiers:
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-post-approleassignments?view=graph-rest-1.0
operationId: users.CreateAppRoleAssignments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}:
description: >-
Provides operations to manage the appRoleAssignments property of the
microsoft.graph.user entity.
get:
tags:
- users.appRoleAssignment
summary: Microsoft Graph Get appRoleAssignments from users
description: >-
Represents the app roles a user is granted for an application. Supports
$expand.
operationId: users.GetAppRoleAssignments
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.appRoleAssignment
summary: Microsoft Graph Update the navigation property appRoleAssignments in users
operationId: users.UpdateAppRoleAssignments
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.appRoleAssignment
summary: Microsoft Graph Delete appRoleAssignment
description: Delete an appRoleAssignment that has been granted to a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-delete-approleassignments?view=graph-rest-1.0
operationId: users.DeleteAppRoleAssignments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
/users/{user-id}/appRoleAssignments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.appRoleAssignment
summary: Microsoft Graph Get the number of the resource
operationId: users.appRoleAssignments.GetCount-d180
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication:
description: >-
Provides operations to manage the authentication property of the
microsoft.graph.user entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get authentication from users
description: The authentication methods that are supported for the user.
operationId: users.GetAuthentication
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authentication'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.authentication
summary: Microsoft Graph Update the navigation property authentication in users
operationId: users.UpdateAuthentication
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authentication'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authentication'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete navigation property authentication for users
operationId: users.DeleteAuthentication
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/emailMethods:
description: >-
Provides operations to manage the emailMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get emailMethods from users
description: The email address registered to a user for authentication.
operationId: users.authentication.ListEmailMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.emailAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.authentication
summary: Microsoft Graph Create emailMethod
description: >-
Set a user's emailAuthenticationMethod object. Email authentication is a
self-service password reset method. A user may only have one email
authentication method. Self-service operations aren't supported.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/authentication-post-emailmethods?view=graph-rest-1.0
operationId: users.authentication.CreateEmailMethods
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/emailMethods/{emailAuthenticationMethod-id}:
description: >-
Provides operations to manage the emailMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get emailMethods from users
description: The email address registered to a user for authentication.
operationId: users.authentication.GetEmailMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.authentication
summary: Microsoft Graph Update emailAuthenticationMethod
description: >-
Update a user's email address represented by an
emailAuthenticationMethod object. Self-service operations aren't
supported.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/emailauthenticationmethod-update?view=graph-rest-1.0
operationId: users.authentication.UpdateEmailMethods
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete emailAuthenticationMethod
description: Deletes a user's emailAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/emailauthenticationmethod-delete?view=graph-rest-1.0
operationId: users.authentication.DeleteEmailMethods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: emailAuthenticationMethod-id
in: path
description: The unique identifier of emailAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: emailAuthenticationMethod
/users/{user-id}/authentication/emailMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.emailMethods.GetCount-6f5c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/fido2Methods:
description: >-
Provides operations to manage the fido2Methods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get fido2Methods from users
description: >-
Represents the FIDO2 security keys registered to a user for
authentication.
operationId: users.authentication.ListFido2Methods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.fido2AuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/fido2Methods/{fido2AuthenticationMethod-id}:
description: >-
Provides operations to manage the fido2Methods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get fido2Methods from users
description: >-
Represents the FIDO2 security keys registered to a user for
authentication.
operationId: users.authentication.GetFido2Methods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete fido2AuthenticationMethod
description: Deletes a user's FIDO2 security key authentication method object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/fido2authenticationmethod-delete?view=graph-rest-1.0
operationId: users.authentication.DeleteFido2Methods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: fido2AuthenticationMethod-id
in: path
description: The unique identifier of fido2AuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: fido2AuthenticationMethod
/users/{user-id}/authentication/fido2Methods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.fido2Methods.GetCount-9673
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/methods:
description: >-
Provides operations to manage the methods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get methods from users
description: Represents all authentication methods registered to a user.
operationId: users.authentication.ListMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.authenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.authentication
summary: Microsoft Graph Create new navigation property to methods for users
operationId: users.authentication.CreateMethods
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/methods/{authenticationMethod-id}:
description: >-
Provides operations to manage the methods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get methods from users
description: Represents all authentication methods registered to a user.
operationId: users.authentication.GetMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.authentication
summary: Microsoft Graph Update the navigation property methods in users
operationId: users.authentication.UpdateMethods
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: authenticationMethod-id
in: path
description: The unique identifier of authenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: authenticationMethod
/users/{user-id}/authentication/methods/{authenticationMethod-id}/resetPassword:
description: Provides operations to call the resetPassword method.
post:
tags:
- Users.authentication
summary: Microsoft Graph Invoke action resetPassword
description: >-
Reset a user's password, represented by a password authentication method
object. This can only be done by an administrator with appropriate
permissions and can't be performed on a user's own account. To reset a
user's password in Azure AD B2C, use the Update user API operation and
update the passwordProfile > forceChangePasswordNextSignIn object. This
flow writes the new password to Microsoft Entra ID and pushes it to
on-premises Active Directory if configured using password writeback. The
admin can either provide a new password or have the system generate one.
The user is prompted to change their password on their next sign in.
This reset is a long-running operation and returns a Location header
with a link where the caller can periodically check for the status of
the reset operation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/authenticationmethod-resetpassword?view=graph-rest-1.0
operationId: users.user.authentication.methods.authenticationMethod.resetPassword
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
newPassword:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.passwordResetResponse'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: authenticationMethod-id
in: path
description: The unique identifier of authenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: authenticationMethod
/users/{user-id}/authentication/methods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.methods.GetCount-0da1
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/microsoftAuthenticatorMethods:
description: >-
Provides operations to manage the microsoftAuthenticatorMethods property
of the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph List microsoftAuthenticatorAuthenticationMethods
description: >-
Get a list of the microsoftAuthenticatorAuthenticationMethod objects and
their properties.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/microsoftauthenticatorauthenticationmethod-list?view=graph-rest-1.0
operationId: users.authentication.ListMicrosoftAuthenticatorMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.microsoftAuthenticatorAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/microsoftAuthenticatorMethods/{microsoftAuthenticatorAuthenticationMethod-id}:
description: >-
Provides operations to manage the microsoftAuthenticatorMethods property
of the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get microsoftAuthenticatorAuthenticationMethod
description: >-
Read the properties and relationships of a
microsoftAuthenticatorAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/microsoftauthenticatorauthenticationmethod-get?view=graph-rest-1.0
operationId: users.authentication.GetMicrosoftAuthenticatorMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete microsoftAuthenticatorAuthenticationMethod
description: Delete a microsoftAuthenticatorAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/microsoftauthenticatorauthenticationmethod-delete?view=graph-rest-1.0
operationId: users.authentication.DeleteMicrosoftAuthenticatorMethods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: microsoftAuthenticatorAuthenticationMethod-id
in: path
description: The unique identifier of microsoftAuthenticatorAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: microsoftAuthenticatorAuthenticationMethod
/users/{user-id}/authentication/microsoftAuthenticatorMethods/{microsoftAuthenticatorAuthenticationMethod-id}/device:
description: >-
Provides operations to manage the device property of the
microsoft.graph.microsoftAuthenticatorAuthenticationMethod entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get device from users
description: >-
The registered device on which Microsoft Authenticator resides. This
property is null if the device isn't registered for passwordless Phone
Sign-In.
operationId: users.authentication.microsoftAuthenticatorMethods.GetDevice
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: microsoftAuthenticatorAuthenticationMethod-id
in: path
description: The unique identifier of microsoftAuthenticatorAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: microsoftAuthenticatorAuthenticationMethod
/users/{user-id}/authentication/microsoftAuthenticatorMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.microsoftAuthenticatorMethods.GetCount-af8c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/operations:
description: >-
Provides operations to manage the operations property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get longRunningOperation
description: >-
Read the properties and relationships of a longRunningOperation object.
This API allows you to retrieve the details and status of the following
long-running Microsoft Graph API operations. The possible states of the
long-running operation are notStarted, running, succeeded, failed,
unknownFutureValue where succeeded and failed are terminal states.
operationId: users.authentication.ListOperations
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.longRunningOperationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.authentication
summary: Microsoft Graph Create new navigation property to operations for users
operationId: users.authentication.CreateOperations
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/operations/{longRunningOperation-id}:
description: >-
Provides operations to manage the operations property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get longRunningOperation
description: >-
Read the properties and relationships of a longRunningOperation object.
This API allows you to retrieve the details and status of the following
long-running Microsoft Graph API operations. The possible states of the
long-running operation are notStarted, running, succeeded, failed,
unknownFutureValue where succeeded and failed are terminal states.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/longrunningoperation-get?view=graph-rest-1.0
operationId: users.authentication.GetOperations
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.authentication
summary: Microsoft Graph Update the navigation property operations in users
operationId: users.authentication.UpdateOperations
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete navigation property operations for users
operationId: users.authentication.DeleteOperations
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: longRunningOperation-id
in: path
description: The unique identifier of longRunningOperation
required: true
schema:
type: string
x-ms-docs-key-type: longRunningOperation
/users/{user-id}/authentication/operations/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.operations.GetCount-40a4
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/passwordMethods:
description: >-
Provides operations to manage the passwordMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get passwordMethods from users
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.
operationId: users.authentication.ListPasswordMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.passwordAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.authentication
summary: Microsoft Graph Create new navigation property to passwordMethods for users
operationId: users.authentication.CreatePasswordMethods
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.passwordAuthenticationMethod
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.passwordAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/passwordMethods/{passwordAuthenticationMethod-id}:
description: >-
Provides operations to manage the passwordMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get passwordMethods from users
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.
operationId: users.authentication.GetPasswordMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.passwordAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: passwordAuthenticationMethod-id
in: path
description: The unique identifier of passwordAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: passwordAuthenticationMethod
/users/{user-id}/authentication/passwordMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.passwordMethods.GetCount-ec55
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/phoneMethods:
description: >-
Provides operations to manage the phoneMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get phoneMethods from users
description: The phone numbers registered to a user for authentication.
operationId: users.authentication.ListPhoneMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.phoneAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.authentication
summary: Microsoft Graph Create phoneMethod
description: >-
Add a new phone authentication method for a user. A user may only have
one phone of each type, captured in the phoneType property. This means,
for example, adding a mobile phone to a user with a pre-existing mobile
phone fails. Additionally, a user must always have a mobile phone before
adding an alternateMobile phone. Adding a phone number makes it
available for use in both Azure multi-factor authentication (MFA) and
self-service password reset (SSPR), if enabled. Additionally, if a user
is enabled by policy to use SMS sign-in and a mobile number is added,
the system attempts to register the number for use in that system.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/authentication-post-phonemethods?view=graph-rest-1.0
operationId: users.authentication.CreatePhoneMethods
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/phoneMethods/{phoneAuthenticationMethod-id}:
description: >-
Provides operations to manage the phoneMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get phoneMethods from users
description: The phone numbers registered to a user for authentication.
operationId: users.authentication.GetPhoneMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.authentication
summary: Microsoft Graph Update phoneAuthenticationMethod
description: >-
Update a user's phone number associated with a phone authentication
method object. You can't change a phone's type. To change a phone's
type, add a new number of the desired type and then delete the object
with the original type. If a user is enabled by policy to use SMS to
sign in and the mobile number is changed, the system will attempt to
register the number for use in that system. Self-service operations
aren't supported.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/phoneauthenticationmethod-update?view=graph-rest-1.0
operationId: users.authentication.UpdatePhoneMethods
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete navigation property phoneMethods for users
operationId: users.authentication.DeletePhoneMethods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
/users/{user-id}/authentication/phoneMethods/{phoneAuthenticationMethod-id}/disableSmsSignIn:
description: Provides operations to call the disableSmsSignIn method.
post:
tags:
- Users.authentication
summary: Microsoft Graph Invoke action disableSmsSignIn
description: >-
Disable SMS sign-in for an existing mobile phone number registered to a
user. The number will no longer be available for SMS sign-in, which can
prevent your user from signing in.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/phoneauthenticationmethod-disablesmssignin?view=graph-rest-1.0
operationId: >-
users.user.authentication.phoneMethods.phoneAuthenticationMethod.disableSmsSignIn
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
/users/{user-id}/authentication/phoneMethods/{phoneAuthenticationMethod-id}/enableSmsSignIn:
description: Provides operations to call the enableSmsSignIn method.
post:
tags:
- Users.authentication
summary: Microsoft Graph Invoke action enableSmsSignIn
description: >-
Enable SMS sign-in for an existing mobile phone number registered to a
user. To be successfully enabled:
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/phoneauthenticationmethod-enablesmssignin?view=graph-rest-1.0
operationId: >-
users.user.authentication.phoneMethods.phoneAuthenticationMethod.enableSmsSignIn
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
/users/{user-id}/authentication/phoneMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.phoneMethods.GetCount-2ea0
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/platformCredentialMethods:
description: >-
Provides operations to manage the platformCredentialMethods property of
the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get platformCredentialMethods from users
description: >-
Represents a platform credential instance registered to a user on Mac
OS.
operationId: users.authentication.ListPlatformCredentialMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.platformCredentialAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/platformCredentialMethods/{platformCredentialAuthenticationMethod-id}:
description: >-
Provides operations to manage the platformCredentialMethods property of
the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get platformCredentialMethods from users
description: >-
Represents a platform credential instance registered to a user on Mac
OS.
operationId: users.authentication.GetPlatformCredentialMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete platformCredentialAuthenticationMethod
description: Delete a platformCredentialAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/platformcredentialauthenticationmethod-delete?view=graph-rest-1.0
operationId: users.authentication.DeletePlatformCredentialMethods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: platformCredentialAuthenticationMethod-id
in: path
description: The unique identifier of platformCredentialAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: platformCredentialAuthenticationMethod
/users/{user-id}/authentication/platformCredentialMethods/{platformCredentialAuthenticationMethod-id}/device:
description: >-
Provides operations to manage the device property of the
microsoft.graph.platformCredentialAuthenticationMethod entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get device from users
description: >-
The registered device on which this Platform Credential resides.
Supports $expand. When you get a user's Platform Credential registration
information, this property is returned only on a single GET and when you
specify ?$expand. For example, GET
/users/admin@contoso.com/authentication/platformCredentialAuthenticationMethod/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.
operationId: users.authentication.platformCredentialMethods.GetDevice
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: platformCredentialAuthenticationMethod-id
in: path
description: The unique identifier of platformCredentialAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: platformCredentialAuthenticationMethod
/users/{user-id}/authentication/platformCredentialMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.platformCredentialMethods.GetCount-66e6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/softwareOathMethods:
description: >-
Provides operations to manage the softwareOathMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get softwareOathMethods from users
description: >-
The software OATH time-based one-time password (TOTP) applications
registered to a user for authentication.
operationId: users.authentication.ListSoftwareOathMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.softwareOathAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/softwareOathMethods/{softwareOathAuthenticationMethod-id}:
description: >-
Provides operations to manage the softwareOathMethods property of the
microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get softwareOathMethods from users
description: >-
The software OATH time-based one-time password (TOTP) applications
registered to a user for authentication.
operationId: users.authentication.GetSoftwareOathMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete softwareOathAuthenticationMethod
description: Delete a user's Software OATH token authentication method object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/softwareoathauthenticationmethod-delete?view=graph-rest-1.0
operationId: users.authentication.DeleteSoftwareOathMethods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: softwareOathAuthenticationMethod-id
in: path
description: The unique identifier of softwareOathAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: softwareOathAuthenticationMethod
/users/{user-id}/authentication/softwareOathMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.softwareOathMethods.GetCount-0ccd
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/temporaryAccessPassMethods:
description: >-
Provides operations to manage the temporaryAccessPassMethods property of
the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph List temporaryAccessPassMethods
description: >-
Retrieve a list of a user's temporaryAccessPassAuthenticationMethod
objects and their properties. This API will only return a single object
in the collection as a user can have only one Temporary Access Pass
method.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/authentication-list-temporaryaccesspassmethods?view=graph-rest-1.0
operationId: users.authentication.ListTemporaryAccessPassMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.temporaryAccessPassAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.authentication
summary: Microsoft Graph Create temporaryAccessPassMethod
description: >-
Create a new temporaryAccessPassAuthenticationMethod object on a user. A
user can only have one Temporary Access Pass that's usable within its
specified lifetime. If the user requires a new Temporary Access Pass
while the current Temporary Access Pass is valid, the admin can create a
new Temporary Access Pass for the user, the previous Temporary Access
Pass will be deleted, and a new Temporary Access Pass will be created.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/authentication-post-temporaryaccesspassmethods?view=graph-rest-1.0
operationId: users.authentication.CreateTemporaryAccessPassMethods
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/temporaryAccessPassMethods/{temporaryAccessPassAuthenticationMethod-id}:
description: >-
Provides operations to manage the temporaryAccessPassMethods property of
the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get temporaryAccessPassAuthenticationMethod
description: Retrieve a user's single temporaryAccessPassAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/temporaryaccesspassauthenticationmethod-get?view=graph-rest-1.0
operationId: users.authentication.GetTemporaryAccessPassMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete temporaryAccessPassAuthenticationMethod
description: Delete a users's temporaryAccessPassAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/temporaryaccesspassauthenticationmethod-delete?view=graph-rest-1.0
operationId: users.authentication.DeleteTemporaryAccessPassMethods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: temporaryAccessPassAuthenticationMethod-id
in: path
description: The unique identifier of temporaryAccessPassAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: temporaryAccessPassAuthenticationMethod
/users/{user-id}/authentication/temporaryAccessPassMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.temporaryAccessPassMethods.GetCount-3b4c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/windowsHelloForBusinessMethods:
description: >-
Provides operations to manage the windowsHelloForBusinessMethods property
of the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph List windowsHelloForBusinessAuthenticationMethods
description: >-
Get a list of the windowsHelloForBusinessAuthenticationMethod objects
and their properties.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/windowshelloforbusinessauthenticationmethod-list?view=graph-rest-1.0
operationId: users.authentication.ListWindowsHelloForBusinessMethods
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.windowsHelloForBusinessAuthenticationMethodCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/authentication/windowsHelloForBusinessMethods/{windowsHelloForBusinessAuthenticationMethod-id}:
description: >-
Provides operations to manage the windowsHelloForBusinessMethods property
of the microsoft.graph.authentication entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get windowsHelloForBusinessAuthenticationMethod
description: >-
Read the properties and relationships of a
windowsHelloForBusinessAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/windowshelloforbusinessauthenticationmethod-get?view=graph-rest-1.0
operationId: users.authentication.GetWindowsHelloForBusinessMethods
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.authentication
summary: Microsoft Graph Delete windowsHelloForBusinessAuthenticationMethod
description: Deletes a windowsHelloForBusinessAuthenticationMethod object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/windowshelloforbusinessauthenticationmethod-delete?view=graph-rest-1.0
operationId: users.authentication.DeleteWindowsHelloForBusinessMethods
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: windowsHelloForBusinessAuthenticationMethod-id
in: path
description: The unique identifier of windowsHelloForBusinessAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: windowsHelloForBusinessAuthenticationMethod
/users/{user-id}/authentication/windowsHelloForBusinessMethods/{windowsHelloForBusinessAuthenticationMethod-id}/device:
description: >-
Provides operations to manage the device property of the
microsoft.graph.windowsHelloForBusinessAuthenticationMethod entity.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get device from users
description: >-
The registered device on which this Windows Hello for Business key
resides. Supports $expand. When you get a user's Windows Hello for
Business registration information, this property is returned only on a
single GET and when you specify ?$expand. For example, GET
/users/admin@contoso.com/authentication/windowsHelloForBusinessMethods/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.
operationId: users.authentication.windowsHelloForBusinessMethods.GetDevice
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: windowsHelloForBusinessAuthenticationMethod-id
in: path
description: The unique identifier of windowsHelloForBusinessAuthenticationMethod
required: true
schema:
type: string
x-ms-docs-key-type: windowsHelloForBusinessAuthenticationMethod
/users/{user-id}/authentication/windowsHelloForBusinessMethods/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.authentication
summary: Microsoft Graph Get the number of the resource
operationId: users.authentication.windowsHelloForBusinessMethods.GetCount-0479
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendar:
description: >-
Provides operations to manage the calendar property of the
microsoft.graph.user entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendar from users
description: The user's primary calendar. Read-only.
operationId: users.GetCalendar
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update the navigation property calendar in users
operationId: users.UpdateCalendar
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendar/calendarPermissions:
description: >-
Provides operations to manage the calendarPermissions property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph List calendarPermissions
description: >-
Get a collection of calendarPermission resources that describe the
identity and roles of users with whom the specified calendar has been
shared or delegated. Here, the calendar can be a user calendar or group
calendar.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendar-list-calendarpermissions?view=graph-rest-1.0
operationId: users.calendar.ListCalendarPermissions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.calendarPermissionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to calendarPermissions for users
operationId: users.calendar.CreateCalendarPermissions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions
- /users/{user-id}/calendars/{calendar-id}/calendarPermissions
/users/{user-id}/calendar/calendarPermissions/{calendarPermission-id}:
description: >-
Provides operations to manage the calendarPermissions property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendarPermission
description: >-
Get the specified permissions object of a user or group calendar that
has been shared.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendarpermission-get?view=graph-rest-1.0
operationId: users.calendar.GetCalendarPermissions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update calendarPermission
description: >-
Update the permissions assigned to an existing share recipient or
delegate, through the corresponding calendarPermission object for
a calendar.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendarpermission-update?view=graph-rest-1.0
operationId: users.calendar.UpdateCalendarPermissions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete calendarPermission
description: Delete calendarPermission.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendarpermission-delete?view=graph-rest-1.0
operationId: users.calendar.DeleteCalendarPermissions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
schema:
type: string
x-ms-docs-key-type: calendarPermission
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}
- >-
/users/{user-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}
/users/{user-id}/calendar/calendarPermissions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendar.calendarPermissions.GetCount-b877
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendar/calendarView:
description: >-
Provides operations to manage the calendarView property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendarView from users
description: The calendar view for the calendar. Navigation property. Read-only.
operationId: users.calendar.ListCalendarView
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView
- /users/{user-id}/calendars/{calendar-id}/calendarView
/users/{user-id}/calendar/calendarView/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendar.calendarView.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendar/events:
description: >-
Provides operations to manage the events property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: users.calendar.ListEvents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to events for users
operationId: users.calendar.CreateEvents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events
- /users/{user-id}/calendars/{calendar-id}/events
/users/{user-id}/calendar/events/{event-id}:
description: >-
Provides operations to manage the events property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: users.calendar.GetEvents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update the navigation property events in users
operationId: users.calendar.UpdateEvents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property events for users
operationId: users.calendar.DeleteEvents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}
/users/{user-id}/calendar/events/{event-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.calendar.events.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.calendar.events.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments
- /users/{user-id}/events/{event-id}/attachments
/users/{user-id}/calendar/events/{event-id}/attachments/{attachment-id}:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.calendar.events.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.calendar.events.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
schema:
type: string
x-ms-docs-key-type: attachment
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}
- /users/{user-id}/events/{event-id}/attachments/{attachment-id}
/users/{user-id}/calendar/events/{event-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendar.events.attachments.GetCount-114f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession:
description: Provides operations to call the createUploadSession method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session that allows an app to iteratively upload ranges
of a file, so as to attach the file to the specified Outlook item. The
item can be a message or event. Use this approach to attach a file if
the file size is between 3 MB and 150 MB. To attach a file that's
smaller than 3 MB, do a POST operation on the attachments navigation
property of the Outlook item; see how to do this for a message or for an
event. As part of the response, this action returns an upload URL that
you can use in subsequent sequential PUT queries. Request headers for
each PUT operation let you specify the exact range of bytes to be
uploaded. This allows transfer to be resumed, in case the network
connection is dropped during upload. The following are the steps to
attach a file to an Outlook item using an upload session: See attach
large files to Outlook messages or events for an example.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: users.user.calendar.events.event.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- /users/{user-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession
- /users/{user-id}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession
/users/{user-id}/calendar/events/{event-id}/calendar:
description: >-
Provides operations to manage the calendar property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: users.calendar.events.GetCalendar
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/calendar
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/calendar
- /users/{user-id}/events/{event-id}/calendar
/users/{user-id}/calendar/events/{event-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.calendar.events.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.calendar.events.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions
- /users/{user-id}/events/{event-id}/extensions
/users/{user-id}/calendar/events/{event-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.calendar.events.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.calendar.events.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.calendar.events.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}
- /users/{user-id}/events/{event-id}/extensions/{extension-id}
/users/{user-id}/calendar/events/{event-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendar.events.extensions.GetCount-15ec
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/calendar/events/{event-id}/instances:
description: >-
Provides operations to manage the instances property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get instances from users
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.
operationId: users.calendar.events.ListInstances
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances
- /users/{user-id}/events/{event-id}/instances
/users/{user-id}/calendar/events/{event-id}/instances/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendar.events.event.instances.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendar/events/{event-id}/accept:
description: Provides operations to call the accept method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: users.user.calendar.events.event.accept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/accept
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/accept
- /users/{user-id}/events/{event-id}/accept
/users/{user-id}/calendar/events/{event-id}/cancel:
description: Provides operations to call the cancel method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: users.user.calendar.events.event.cancel
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/cancel
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/cancel
- /users/{user-id}/events/{event-id}/cancel
/users/{user-id}/calendar/events/{event-id}/decline:
description: Provides operations to call the decline method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action decline
description: >-
Decline invitation to the specified event in a user calendar. If the
event allows proposals for new times, on declining the event, an invitee
can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: users.user.calendar.events.event.decline
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/decline
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/decline
- /users/{user-id}/events/{event-id}/decline
/users/{user-id}/calendar/events/{event-id}/dismissReminder:
description: Provides operations to call the dismissReminder method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action dismissReminder
description: >-
Dismiss a reminder that has been triggered for an event in a user
calendar.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: users.user.calendar.events.event.dismissReminder
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder
- /users/{user-id}/events/{event-id}/dismissReminder
/users/{user-id}/calendar/events/{event-id}/forward:
description: Provides operations to call the forward method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: users.user.calendar.events.event.forward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/events/{event-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/forward
- /users/{user-id}/messages/{message-id}/forward
/users/{user-id}/calendar/events/{event-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.calendar.events.event.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/calendar/events/{event-id}/snoozeReminder:
description: Provides operations to call the snoozeReminder method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: users.user.calendar.events.event.snoozeReminder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder
- /users/{user-id}/events/{event-id}/snoozeReminder
/users/{user-id}/calendar/events/{event-id}/tentativelyAccept:
description: Provides operations to call the tentativelyAccept method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action tentativelyAccept
description: >-
Tentatively accept the specified event in a user calendar. If the event
allows proposals for new times, on responding tentative to the event, an
invitee can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: users.user.calendar.events.event.tentativelyAccept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept
- /users/{user-id}/events/{event-id}/tentativelyAccept
/users/{user-id}/calendar/events/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendar.events.GetCount-1a22
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendar/events/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendar.events.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendar/allowedCalendarSharingRoles(User='{User}'):
description: Provides operations to call the allowedCalendarSharingRoles method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function allowedCalendarSharingRoles
operationId: users.user.calendar.allowedCalendarSharingRoles
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.calendarRoleType
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: User
in: path
description: 'Usage: User=''{User}'''
required: true
schema:
type: string
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/allowedCalendarSharingRoles(User='{User}')
- >-
/users/{user-id}/calendars/{calendar-id}/allowedCalendarSharingRoles(User='{User}')
/users/{user-id}/calendar/getSchedule:
description: Provides operations to call the getSchedule method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action getSchedule
description: >-
Get the free/busy availability information for a collection of users,
distributions lists, or resources (rooms or equipment) for a specified
time period.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendar-getschedule?view=graph-rest-1.0
operationId: users.user.calendar.getSchedule
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Schedules:
type: array
items:
type: string
nullable: true
EndTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
StartTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
AvailabilityViewInterval:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.scheduleInformation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/getSchedule
- /users/{user-id}/calendars/{calendar-id}/getSchedule
/users/{user-id}/calendar/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action permanentDelete
description: >-
Permanently delete a calendar folder and the events that it contains and
remove them from the mailbox. For more information about item retention,
see Configure deleted item retention and recoverable items quotas.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendar-permanentdelete?view=graph-rest-1.0
operationId: users.user.calendar.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/calendarGroups:
description: >-
Provides operations to manage the calendarGroups property of the
microsoft.graph.user entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendarGroups from users
description: The user's calendar groups. Read-only. Nullable.
operationId: users.ListCalendarGroups
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.calendarGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Create new navigation property to calendarGroups for users
operationId: users.CreateCalendarGroups
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendarGroups/{calendarGroup-id}:
description: >-
Provides operations to manage the calendarGroups property of the
microsoft.graph.user entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendarGroups from users
description: The user's calendar groups. Read-only. Nullable.
operationId: users.GetCalendarGroups
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Microsoft Graph Update the navigation property calendarGroups in users
operationId: users.UpdateCalendarGroups
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Microsoft Graph Delete navigation property calendarGroups for users
operationId: users.DeleteCalendarGroups
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars:
description: >-
Provides operations to manage the calendars property of the
microsoft.graph.calendarGroup entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendars from users
description: >-
The calendars in the calendar group. Navigation property. Read-only.
Nullable.
operationId: users.calendarGroups.ListCalendars
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.calendarCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Create new navigation property to calendars for users
operationId: users.calendarGroups.CreateCalendars
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}:
description: >-
Provides operations to manage the calendars property of the
microsoft.graph.calendarGroup entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendars from users
description: >-
The calendars in the calendar group. Navigation property. Read-only.
Nullable.
operationId: users.calendarGroups.GetCalendars
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Microsoft Graph Update the navigation property calendars in users
operationId: users.calendarGroups.UpdateCalendars
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Microsoft Graph Delete navigation property calendars for users
operationId: users.calendarGroups.DeleteCalendars
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions:
description: >-
Provides operations to manage the calendarPermissions property of the
microsoft.graph.calendar entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: users.calendarGroups.calendars.ListCalendarPermissions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.calendarPermissionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Create new navigation property to calendarPermissions for users
operationId: users.calendarGroups.calendars.CreateCalendarPermissions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarPermissions
- /users/{user-id}/calendars/{calendar-id}/calendarPermissions
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}:
description: >-
Provides operations to manage the calendarPermissions property of the
microsoft.graph.calendar entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: users.calendarGroups.calendars.GetCalendarPermissions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Microsoft Graph Update the navigation property calendarPermissions in users
operationId: users.calendarGroups.calendars.UpdateCalendarPermissions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Microsoft Graph Delete navigation property calendarPermissions for users
operationId: users.calendarGroups.calendars.DeleteCalendarPermissions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
schema:
type: string
x-ms-docs-key-type: calendarPermission
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarPermissions/{calendarPermission-id}
- >-
/users/{user-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get the number of the resource
operationId: users.calendarGroups.calendars.calendarPermissions.GetCount-98a8
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView:
description: >-
Provides operations to manage the calendarView property of the
microsoft.graph.calendar entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendarView from users
description: The calendar view for the calendar. Navigation property. Read-only.
operationId: users.calendarGroups.calendars.ListCalendarView
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView
- /users/{user-id}/calendars/{calendar-id}/calendarView
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.calendarView.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events:
description: >-
Provides operations to manage the events property of the
microsoft.graph.calendar entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: users.calendarGroups.calendars.ListEvents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Create new navigation property to events for users
operationId: users.calendarGroups.calendars.CreateEvents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events
- /users/{user-id}/calendars/{calendar-id}/events
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}:
description: >-
Provides operations to manage the events property of the
microsoft.graph.calendar entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: users.calendarGroups.calendars.GetEvents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Microsoft Graph Update the navigation property events in users
operationId: users.calendarGroups.calendars.UpdateEvents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Microsoft Graph Delete navigation property events for users
operationId: users.calendarGroups.calendars.DeleteEvents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.calendarGroups.calendars.events.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.calendarGroups.calendars.events.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/attachments
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments
- /users/{user-id}/events/{event-id}/attachments
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.calendarGroups.calendars.events.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.calendarGroups.calendars.events.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
schema:
type: string
x-ms-docs-key-type: attachment
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/attachments/{attachment-id}
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}
- /users/{user-id}/events/{event-id}/attachments/{attachment-id}
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get the number of the resource
operationId: users.calendarGroups.calendars.events.attachments.GetCount-e742
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
? /users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
: description: Provides operations to call the createUploadSession method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session that allows an app to iteratively upload ranges
of a file, so as to attach the file to the specified Outlook item. The
item can be a message or event. Use this approach to attach a file if
the file size is between 3 MB and 150 MB. To attach a file that's
smaller than 3 MB, do a POST operation on the attachments navigation
property of the Outlook item; see how to do this for a message or for an
event. As part of the response, this action returns an upload URL that
you can use in subsequent sequential PUT queries. Request headers for
each PUT operation let you specify the exact range of bytes to be
uploaded. This allows transfer to be resumed, in case the network
connection is dropped during upload. The following are the steps to
attach a file to an Outlook item using an upload session: See attach
large files to Outlook messages or events for an example.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- /users/{user-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession
- /users/{user-id}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/calendar:
description: >-
Provides operations to manage the calendar property of the
microsoft.graph.event entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: users.calendarGroups.calendars.events.GetCalendar
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/calendar
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/calendar
- /users/{user-id}/events/{event-id}/calendar
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.calendarGroups.calendars.events.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.calendarGroups.calendars.events.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/extensions
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions
- /users/{user-id}/events/{event-id}/extensions
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.calendarGroups.calendars.events.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.calendarGroup
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.calendarGroups.calendars.events.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.calendarGroup
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.calendarGroups.calendars.events.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/extensions/{extension-id}
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}
- /users/{user-id}/events/{event-id}/extensions/{extension-id}
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get the number of the resource
operationId: users.calendarGroups.calendars.events.extensions.GetCount-4cca
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances:
description: >-
Provides operations to manage the instances property of the
microsoft.graph.event entity.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get instances from users
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.
operationId: users.calendarGroups.calendars.events.ListInstances
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/instances
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances
- /users/{user-id}/events/{event-id}/instances
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.instances.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/accept:
description: Provides operations to call the accept method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.accept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/accept
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/accept
- /users/{user-id}/events/{event-id}/accept
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/cancel:
description: Provides operations to call the cancel method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.cancel
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/cancel
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/cancel
- /users/{user-id}/events/{event-id}/cancel
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/decline:
description: Provides operations to call the decline method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action decline
description: >-
Decline invitation to the specified event in a user calendar. If the
event allows proposals for new times, on declining the event, an invitee
can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.decline
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/decline
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/decline
- /users/{user-id}/events/{event-id}/decline
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder:
description: Provides operations to call the dismissReminder method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action dismissReminder
description: >-
Dismiss a reminder that has been triggered for an event in a user
calendar.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.dismissReminder
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/dismissReminder
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder
- /users/{user-id}/events/{event-id}/dismissReminder
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward:
description: Provides operations to call the forward method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.forward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/forward
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/events/{event-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/forward
- /users/{user-id}/messages/{message-id}/forward
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action permanentDelete
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder:
description: Provides operations to call the snoozeReminder method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.snoozeReminder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/snoozeReminder
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder
- /users/{user-id}/events/{event-id}/snoozeReminder
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept:
description: Provides operations to call the tentativelyAccept method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action tentativelyAccept
description: >-
Tentatively accept the specified event in a user calendar. If the event
allows proposals for new times, on responding tentative to the event, an
invitee can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.events.event.tentativelyAccept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/tentativelyAccept
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept
- /users/{user-id}/events/{event-id}/tentativelyAccept
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get the number of the resource
operationId: users.calendarGroups.calendars.events.GetCount-f3ad
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendarGroups.calendarGroup.calendars.calendar.events.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/allowedCalendarSharingRoles(User='{User}'):
description: Provides operations to call the allowedCalendarSharingRoles method.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke function allowedCalendarSharingRoles
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.allowedCalendarSharingRoles
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.calendarRoleType
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: User
in: path
description: 'Usage: User=''{User}'''
required: true
schema:
type: string
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/allowedCalendarSharingRoles(User='{User}')
- >-
/users/{user-id}/calendars/{calendar-id}/allowedCalendarSharingRoles(User='{User}')
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/getSchedule:
description: Provides operations to call the getSchedule method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action getSchedule
description: >-
Get the free/busy availability information for a collection of users,
distributions lists, or resources (rooms or equipment) for a specified
time period.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendar-getschedule?view=graph-rest-1.0
operationId: users.user.calendarGroups.calendarGroup.calendars.calendar.getSchedule
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Schedules:
type: array
items:
type: string
nullable: true
EndTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
StartTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
AvailabilityViewInterval:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.scheduleInformation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/getSchedule
- /users/{user-id}/calendars/{calendar-id}/getSchedule
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.calendarGroup
summary: Microsoft Graph Invoke action permanentDelete
description: >-
Permanently delete a calendar folder and the events that it contains and
remove them from the mailbox. For more information about item retention,
see Configure deleted item retention and recoverable items quotas.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendar-permanentdelete?view=graph-rest-1.0
operationId: >-
users.user.calendarGroups.calendarGroup.calendars.calendar.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get the number of the resource
operationId: users.calendarGroups.calendars.GetCount-8e45
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendarGroup-id
in: path
description: The unique identifier of calendarGroup
required: true
schema:
type: string
x-ms-docs-key-type: calendarGroup
/users/{user-id}/calendarGroups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.calendarGroup
summary: Microsoft Graph Get the number of the resource
operationId: users.calendarGroups.GetCount-ee80
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendars:
description: >-
Provides operations to manage the calendars property of the
microsoft.graph.user entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendars from users
description: The user's calendars. Read-only. Nullable.
operationId: users.ListCalendars
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.calendarCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to calendars for users
operationId: users.CreateCalendars
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendars/{calendar-id}:
description: >-
Provides operations to manage the calendars property of the
microsoft.graph.user entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendars from users
description: The user's calendars. Read-only. Nullable.
operationId: users.GetCalendars
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update the navigation property calendars in users
operationId: users.UpdateCalendars
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property calendars for users
operationId: users.DeleteCalendars
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
/users/{user-id}/calendars/{calendar-id}/calendarPermissions:
description: >-
Provides operations to manage the calendarPermissions property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: users.calendars.ListCalendarPermissions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.calendarPermissionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to calendarPermissions for users
operationId: users.calendars.CreateCalendarPermissions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarPermissions
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions
/users/{user-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}:
description: >-
Provides operations to manage the calendarPermissions property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendarPermissions from users
description: The permissions of the users with whom the calendar is shared.
operationId: users.calendars.GetCalendarPermissions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update the navigation property calendarPermissions in users
operationId: users.calendars.UpdateCalendarPermissions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property calendarPermissions for users
operationId: users.calendars.DeleteCalendarPermissions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: calendarPermission-id
in: path
description: The unique identifier of calendarPermission
required: true
schema:
type: string
x-ms-docs-key-type: calendarPermission
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarPermissions/{calendarPermission-id}
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarPermissions/{calendarPermission-id}
/users/{user-id}/calendars/{calendar-id}/calendarPermissions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendars.calendarPermissions.GetCount-a224
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
/users/{user-id}/calendars/{calendar-id}/calendarView:
description: >-
Provides operations to manage the calendarView property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendarView from users
description: The calendar view for the calendar. Navigation property. Read-only.
operationId: users.calendars.ListCalendarView
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView
/users/{user-id}/calendars/{calendar-id}/calendarView/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendars.calendar.calendarView.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendars/{calendar-id}/events:
description: >-
Provides operations to manage the events property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: users.calendars.ListEvents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to events for users
operationId: users.calendars.CreateEvents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events
/users/{user-id}/calendars/{calendar-id}/events/{event-id}:
description: >-
Provides operations to manage the events property of the
microsoft.graph.calendar entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get events from users
description: The events in the calendar. Navigation property. Read-only.
operationId: users.calendars.GetEvents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update the navigation property events in users
operationId: users.calendars.UpdateEvents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property events for users
operationId: users.calendars.DeleteEvents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.calendars.events.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.calendars.events.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/attachments
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments
- /users/{user-id}/events/{event-id}/attachments
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.calendars.events.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.calendars.events.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
schema:
type: string
x-ms-docs-key-type: attachment
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/attachments/{attachment-id}
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}
- /users/{user-id}/events/{event-id}/attachments/{attachment-id}
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendars.events.attachments.GetCount-8147
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession:
description: Provides operations to call the createUploadSession method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session that allows an app to iteratively upload ranges
of a file, so as to attach the file to the specified Outlook item. The
item can be a message or event. Use this approach to attach a file if
the file size is between 3 MB and 150 MB. To attach a file that's
smaller than 3 MB, do a POST operation on the attachments navigation
property of the Outlook item; see how to do this for a message or for an
event. As part of the response, this action returns an upload URL that
you can use in subsequent sequential PUT queries. Request headers for
each PUT operation let you specify the exact range of bytes to be
uploaded. This allows transfer to be resumed, in case the network
connection is dropped during upload. The following are the steps to
attach a file to an Outlook item using an upload session: See attach
large files to Outlook messages or events for an example.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: >-
users.user.calendars.calendar.events.event.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- /users/{user-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession
- /users/{user-id}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/calendar:
description: >-
Provides operations to manage the calendar property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: users.calendars.events.GetCalendar
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/calendar
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/calendar
- /users/{user-id}/events/{event-id}/calendar
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.calendars.events.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.calendar
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.calendars.events.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/extensions
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions
- /users/{user-id}/events/{event-id}/extensions
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.calendars.events.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.calendar
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.calendars.events.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.calendar
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.calendars.events.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/extensions/{extension-id}
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}
- /users/{user-id}/events/{event-id}/extensions/{extension-id}
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendars.events.extensions.GetCount-b44d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances:
description: >-
Provides operations to manage the instances property of the
microsoft.graph.event entity.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get instances from users
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.
operationId: users.calendars.events.ListInstances
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/instances
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances
- /users/{user-id}/events/{event-id}/instances
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.instances.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/accept:
description: Provides operations to call the accept method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.accept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/accept
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/accept
- /users/{user-id}/events/{event-id}/accept
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/cancel:
description: Provides operations to call the cancel method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.cancel
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/cancel
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/cancel
- /users/{user-id}/events/{event-id}/cancel
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/decline:
description: Provides operations to call the decline method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action decline
description: >-
Decline invitation to the specified event in a user calendar. If the
event allows proposals for new times, on declining the event, an invitee
can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.decline
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/decline
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/decline
- /users/{user-id}/events/{event-id}/decline
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder:
description: Provides operations to call the dismissReminder method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action dismissReminder
description: >-
Dismiss a reminder that has been triggered for an event in a user
calendar.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.dismissReminder
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/dismissReminder
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder
- /users/{user-id}/events/{event-id}/dismissReminder
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/forward:
description: Provides operations to call the forward method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.forward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/forward
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/events/{event-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/forward
- /users/{user-id}/messages/{message-id}/forward
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.calendars.calendar.events.event.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder:
description: Provides operations to call the snoozeReminder method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.snoozeReminder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/snoozeReminder
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder
- /users/{user-id}/events/{event-id}/snoozeReminder
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept:
description: Provides operations to call the tentativelyAccept method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action tentativelyAccept
description: >-
Tentatively accept the specified event in a user calendar. If the event
allows proposals for new times, on responding tentative to the event, an
invitee can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.event.tentativelyAccept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/tentativelyAccept
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept
- /users/{user-id}/events/{event-id}/tentativelyAccept
/users/{user-id}/calendars/{calendar-id}/events/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendars.events.GetCount-efc7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
/users/{user-id}/calendars/{calendar-id}/events/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendars.calendar.events.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/calendars/{calendar-id}/allowedCalendarSharingRoles(User='{User}'):
description: Provides operations to call the allowedCalendarSharingRoles method.
get:
tags:
- Users.calendar
summary: Microsoft Graph Invoke function allowedCalendarSharingRoles
operationId: users.user.calendars.calendar.allowedCalendarSharingRoles
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.calendarRoleType
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
- name: User
in: path
description: 'Usage: User=''{User}'''
required: true
schema:
type: string
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/allowedCalendarSharingRoles(User='{User}')
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/allowedCalendarSharingRoles(User='{User}')
/users/{user-id}/calendars/{calendar-id}/getSchedule:
description: Provides operations to call the getSchedule method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action getSchedule
description: >-
Get the free/busy availability information for a collection of users,
distributions lists, or resources (rooms or equipment) for a specified
time period.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendar-getschedule?view=graph-rest-1.0
operationId: users.user.calendars.calendar.getSchedule
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Schedules:
type: array
items:
type: string
nullable: true
EndTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
StartTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
AvailabilityViewInterval:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.scheduleInformation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/getSchedule
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/getSchedule
/users/{user-id}/calendars/{calendar-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- Users.calendar
summary: Microsoft Graph Invoke action permanentDelete
description: >-
Permanently delete a calendar folder and the events that it contains and
remove them from the mailbox. For more information about item retention,
see Configure deleted item retention and recoverable items quotas.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calendar-permanentdelete?view=graph-rest-1.0
operationId: users.user.calendars.calendar.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: calendar-id
in: path
description: The unique identifier of calendar
required: true
schema:
type: string
x-ms-docs-key-type: calendar
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/calendars/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.calendar
summary: Microsoft Graph Get the number of the resource
operationId: users.calendars.GetCount-a1b5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendarView:
description: >-
Provides operations to manage the calendarView property of the
microsoft.graph.user entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get calendarView from users
description: The calendar view for the calendar. Read-only. Nullable.
operationId: users.ListCalendarView
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/calendarView/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.event
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.calendarView.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/chats:
description: >-
Provides operations to manage the chats property of the
microsoft.graph.user entity.
get:
tags:
- Users.chat
summary: Microsoft Graph List chats
description: >-
Retrieve the list of chats that the user is part of. This method
supports federation. When a user ID is provided, the calling application
must belong to the same tenant that the user belongs to.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/chat-list?view=graph-rest-1.0
operationId: users.ListChats
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.chatCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to chats for users
operationId: users.CreateChats
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chat'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/chats/{chat-id}:
description: >-
Provides operations to manage the chats property of the
microsoft.graph.user entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get chat
description: >-
Retrieve a single chat (without its messages). This method supports
federation. To access a chat, at least one chat member must belong to
the tenant the request initiated from.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/chat-get?view=graph-rest-1.0
operationId: users.GetChats
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property chats in users
operationId: users.UpdateChats
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chat'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property chats for users
operationId: users.DeleteChats
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/installedApps:
description: >-
Provides operations to manage the installedApps property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get installedApps from users
description: A collection of all the apps in the chat. Nullable.
operationId: users.chats.ListInstalledApps
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.teamsAppInstallationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to installedApps for users
operationId: users.chats.CreateInstalledApps
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}:
description: >-
Provides operations to manage the installedApps property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get installedApps from users
description: A collection of all the apps in the chat. Nullable.
operationId: users.chats.GetInstalledApps
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property installedApps in users
operationId: users.chats.UpdateInstalledApps
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property installedApps for users
operationId: users.chats.DeleteInstalledApps
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/upgrade:
description: Provides operations to call the upgrade method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action upgrade
description: Upgrade an app installation within a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-teamsappinstallation-upgrade?view=graph-rest-1.0
operationId: users.user.chats.chat.installedApps.teamsAppInstallation.upgrade
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
consentedPermissionSet:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamsAppPermissionSet
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/upgrade
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get teamsApp from users
description: The app that is installed.
operationId: users.chats.installedApps.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/teamsApp
- >-
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}/teamsApp
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition:
description: >-
Provides operations to manage the teamsAppDefinition property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get teamsAppDefinition from users
description: The details of this version of the app.
operationId: users.chats.installedApps.GetTeamsAppDefinition
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition
- >-
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}/teamsAppDefinition
/users/{user-id}/chats/{chat-id}/installedApps/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.installedApps.GetCount-0d67
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/lastMessagePreview:
description: >-
Provides operations to manage the lastMessagePreview property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get lastMessagePreview from users
description: >-
Preview of the last message sent in the chat. Null if no messages were
sent in the chat. Currently, only the list chats operation supports this
property.
operationId: users.chats.GetLastMessagePreview
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property lastMessagePreview in users
operationId: users.chats.UpdateLastMessagePreview
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property lastMessagePreview for users
operationId: users.chats.DeleteLastMessagePreview
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get members from users
description: A collection of all the members in the chat. Nullable.
operationId: users.chats.ListMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to members for users
operationId: users.chats.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/members/{conversationMember-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get members from users
description: A collection of all the members in the chat. Nullable.
operationId: users.chats.GetMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property members in users
operationId: users.chats.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property members for users
operationId: users.chats.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
/users/{user-id}/chats/{chat-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.members.GetCount-b25d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/members/add:
description: Provides operations to call the add method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action add
description: >-
Add multiple members in a single request to a team. The response
provides details about which memberships could and couldn't be created.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmembers-add?view=graph-rest-1.0
operationId: users.user.chats.chat.members.add
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
x-ms-docs-grouped-path:
- /users/{user-id}/followedSites/add
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/add
/users/{user-id}/chats/{chat-id}/members/remove:
description: Provides operations to call the remove method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action remove
description: >-
Remove multiple members from a team in a single request. The response
provides details about which memberships could and couldn't be removed.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmember-remove?view=graph-rest-1.0
operationId: users.user.chats.chat.members.remove
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
x-ms-docs-grouped-path:
- /users/{user-id}/followedSites/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/remove
/users/{user-id}/chats/{chat-id}/messages:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get messages from users
description: A collection of all the messages in the chat. Nullable.
operationId: users.chats.ListMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.chatMessageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to messages for users
operationId: users.chats.CreateMessages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get messages from users
description: A collection of all the messages in the chat. Nullable.
operationId: users.chats.GetMessages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property messages in users
operationId: users.chats.UpdateMessages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property messages for users
operationId: users.chats.DeleteMessages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents:
description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.chats.messages.ListHostedContents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.chatMessageHostedContentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to hostedContents for users
operationId: users.chats.messages.CreateHostedContents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}:
description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.chats.messages.GetHostedContents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property hostedContents in users
operationId: users.chats.messages.UpdateHostedContents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property hostedContents for users
operationId: users.chats.messages.DeleteHostedContents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get media content for the navigation property hostedContents from users
description: The unique identifier for an entity. Read-only.
operationId: users.chats.messages.GetHostedContentsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.chat
summary: Microsoft Graph Update media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.chats.messages.UpdateHostedContentsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.chats.messages.DeleteHostedContentsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.messages.hostedContents.GetCount-e922
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/setReaction:
description: Provides operations to call the setReaction method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action setReaction
operationId: users.user.chats.chat.messages.chatMessage.setReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/softDelete:
description: Provides operations to call the softDelete method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action softDelete
description: >-
Delete a single chatMessage or a chat message reply in a channel or a
chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-softdelete?view=graph-rest-1.0
operationId: users.user.chats.chat.messages.chatMessage.softDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete:
description: Provides operations to call the undoSoftDelete method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action undoSoftDelete
description: >-
Undo soft deletion of a single chatMessage or a chat message reply in a
channel or a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-undosoftdelete?view=graph-rest-1.0
operationId: users.user.chats.chat.messages.chatMessage.undoSoftDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction:
description: Provides operations to call the unsetReaction method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action unsetReaction
operationId: users.user.chats.chat.messages.chatMessage.unsetReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies:
description: >-
Provides operations to manage the replies property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get replies from users
description: Replies for a specified message. Supports $expand for channel messages.
operationId: users.chats.messages.ListReplies
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.chatMessageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to replies for users
operationId: users.chats.messages.CreateReplies
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}:
description: >-
Provides operations to manage the replies property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get replies from users
description: Replies for a specified message. Supports $expand for channel messages.
operationId: users.chats.messages.GetReplies
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property replies in users
operationId: users.chats.messages.UpdateReplies
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property replies for users
operationId: users.chats.messages.DeleteReplies
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents:
description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.chats.messages.replies.ListHostedContents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.chatMessageHostedContentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to hostedContents for users
operationId: users.chats.messages.replies.CreateHostedContents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
? /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
: description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.chats.messages.replies.GetHostedContents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property hostedContents in users
operationId: users.chats.messages.replies.UpdateHostedContents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property hostedContents for users
operationId: users.chats.messages.replies.DeleteHostedContents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
? /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}/$value
: description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get media content for the navigation property hostedContents from users
description: The unique identifier for an entity. Read-only.
operationId: users.chats.messages.replies.GetHostedContentsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.chat
summary: Microsoft Graph Update media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.chats.messages.replies.UpdateHostedContentsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.chats.messages.replies.DeleteHostedContentsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.messages.replies.hostedContents.GetCount-34f5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction:
description: Provides operations to call the setReaction method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action setReaction
operationId: >-
users.user.chats.chat.messages.chatMessage.replies.chatMessage.setReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete:
description: Provides operations to call the softDelete method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action softDelete
description: >-
Delete a single chatMessage or a chat message reply in a channel or a
chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-softdelete?view=graph-rest-1.0
operationId: >-
users.user.chats.chat.messages.chatMessage.replies.chatMessage.softDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete:
description: Provides operations to call the undoSoftDelete method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action undoSoftDelete
description: >-
Undo soft deletion of a single chatMessage or a chat message reply in a
channel or a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-undosoftdelete?view=graph-rest-1.0
operationId: >-
users.user.chats.chat.messages.chatMessage.replies.chatMessage.undoSoftDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction:
description: Provides operations to call the unsetReaction method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action unsetReaction
operationId: >-
users.user.chats.chat.messages.chatMessage.replies.chatMessage.unsetReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.messages.replies.GetCount-cecc
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.chat
summary: Microsoft Graph Invoke function delta
description: >-
Get the list of messages from all chats in which a user is a
participant, including one-on-one chats, group chats, and meeting chats.
When you use delta query, you can get new or updated messages. To get
the replies for a message, use the list message replies or the get
message reply operations. A GET request with the delta function returns
one of the following: State tokens are opaque to the client. To proceed
with a round of change tracking, copy and apply the @odata.nextLink or
@odata.deltaLink URL returned from the last GET request to the next
delta function call. An @odata.deltaLink returned in a response
signifies that the current round of change tracking is complete. You can
save and use the @odata.deltaLink URL when you begin to retrieve more
changes (messages changed or posted after you acquire @odata.deltaLink).
For more information, see the delta query documentation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-delta?view=graph-rest-1.0
operationId: users.user.chats.chat.messages.chatMessage.replies.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/chats/{chat-id}/messages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.messages.GetCount-c95d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/messages/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.chat
summary: Microsoft Graph Invoke function delta
description: >-
Get the list of messages from all chats in which a user is a
participant, including one-on-one chats, group chats, and meeting chats.
When you use delta query, you can get new or updated messages. To get
the replies for a message, use the list message replies or the get
message reply operations. A GET request with the delta function returns
one of the following: State tokens are opaque to the client. To proceed
with a round of change tracking, copy and apply the @odata.nextLink or
@odata.deltaLink URL returned from the last GET request to the next
delta function call. An @odata.deltaLink returned in a response
signifies that the current round of change tracking is complete. You can
save and use the @odata.deltaLink URL when you begin to retrieve more
changes (messages changed or posted after you acquire @odata.deltaLink).
For more information, see the delta query documentation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-delta?view=graph-rest-1.0
operationId: users.user.chats.chat.messages.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/chats/{chat-id}/hideForUser:
description: Provides operations to call the hideForUser method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action hideForUser
description: Hide a chat for a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-hideforuser?view=graph-rest-1.0
operationId: users.user.chats.chat.hideForUser
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
user:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkUserIdentity
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/markChatReadForUser:
description: Provides operations to call the markChatReadForUser method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action markChatReadForUser
description: Mark a chat as read for a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-markchatreadforuser?view=graph-rest-1.0
operationId: users.user.chats.chat.markChatReadForUser
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
user:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkUserIdentity
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/markChatUnreadForUser:
description: Provides operations to call the markChatUnreadForUser method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action markChatUnreadForUser
description: Mark a chat as unread for a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-markchatunreadforuser?view=graph-rest-1.0
operationId: users.user.chats.chat.markChatUnreadForUser
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
user:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkUserIdentity
- type: object
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
format: date-time
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/removeAllAccessForUser:
description: Provides operations to call the removeAllAccessForUser method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action removeAllAccessForUser
description: Remove access to a chat for a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-removeallaccessforuser?view=graph-rest-1.0
operationId: users.user.chats.chat.removeAllAccessForUser
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
user:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkUserIdentity
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/sendActivityNotification:
description: Provides operations to call the sendActivityNotification method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action sendActivityNotification
description: >-
Send an activity feed notification in scope of a chat. For more
information about sending notifications and the requirements for doing
so, see sending Teams activity notifications.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-sendactivitynotification?view=graph-rest-1.0
operationId: users.user.chats.chat.sendActivityNotification
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
topic:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkActivityTopic
- type: object
nullable: true
activityType:
type: string
nullable: true
chainId:
type: number
format: int64
nullable: true
previewText:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
teamsAppId:
type: string
nullable: true
templateParameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValuePair'
recipient:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkNotificationRecipient
- type: object
nullable: true
iconId:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/sendActivityNotification
- /users/{user-id}/teamwork/sendActivityNotification
/users/{user-id}/chats/{chat-id}/unhideForUser:
description: Provides operations to call the unhideForUser method.
post:
tags:
- Users.chat
summary: Microsoft Graph Invoke action unhideForUser
description: Unhide a chat for a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-unhideforuser?view=graph-rest-1.0
operationId: users.user.chats.chat.unhideForUser
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
user:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkUserIdentity
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/permissionGrants:
description: >-
Provides operations to manage the permissionGrants property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get permissionGrants from users
description: A collection of permissions granted to apps for the chat.
operationId: users.chats.ListPermissionGrants
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.resourceSpecificPermissionGrantCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to permissionGrants for users
operationId: users.chats.CreatePermissionGrants
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/permissionGrants/{resourceSpecificPermissionGrant-id}:
description: >-
Provides operations to manage the permissionGrants property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get permissionGrants from users
description: A collection of permissions granted to apps for the chat.
operationId: users.chats.GetPermissionGrants
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property permissionGrants in users
operationId: users.chats.UpdatePermissionGrants
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property permissionGrants for users
operationId: users.chats.DeletePermissionGrants
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: resourceSpecificPermissionGrant-id
in: path
description: The unique identifier of resourceSpecificPermissionGrant
required: true
schema:
type: string
x-ms-docs-key-type: resourceSpecificPermissionGrant
/users/{user-id}/chats/{chat-id}/permissionGrants/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.permissionGrants.GetCount-8aa5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/pinnedMessages:
description: >-
Provides operations to manage the pinnedMessages property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get pinnedMessages from users
description: A collection of all the pinned messages in the chat. Nullable.
operationId: users.chats.ListPinnedMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.pinnedChatMessageInfoCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to pinnedMessages for users
operationId: users.chats.CreatePinnedMessages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/pinnedMessages/{pinnedChatMessageInfo-id}:
description: >-
Provides operations to manage the pinnedMessages property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get pinnedMessages from users
description: A collection of all the pinned messages in the chat. Nullable.
operationId: users.chats.GetPinnedMessages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property pinnedMessages in users
operationId: users.chats.UpdatePinnedMessages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property pinnedMessages for users
operationId: users.chats.DeletePinnedMessages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: pinnedChatMessageInfo-id
in: path
description: The unique identifier of pinnedChatMessageInfo
required: true
schema:
type: string
x-ms-docs-key-type: pinnedChatMessageInfo
/users/{user-id}/chats/{chat-id}/pinnedMessages/{pinnedChatMessageInfo-id}/message:
description: >-
Provides operations to manage the message property of the
microsoft.graph.pinnedChatMessageInfo entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get message from users
description: Represents details about the chat message that is pinned.
operationId: users.chats.pinnedMessages.GetMessage
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: pinnedChatMessageInfo-id
in: path
description: The unique identifier of pinnedChatMessageInfo
required: true
schema:
type: string
x-ms-docs-key-type: pinnedChatMessageInfo
/users/{user-id}/chats/{chat-id}/pinnedMessages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.pinnedMessages.GetCount-bc2d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/tabs:
description: >-
Provides operations to manage the tabs property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get tabs from users
description: A collection of all the tabs in the chat. Nullable.
operationId: users.chats.ListTabs
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.teamsTabCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.chat
summary: Microsoft Graph Create new navigation property to tabs for users
operationId: users.chats.CreateTabs
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/{chat-id}/tabs/{teamsTab-id}:
description: >-
Provides operations to manage the tabs property of the
microsoft.graph.chat entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get tabs from users
description: A collection of all the tabs in the chat. Nullable.
operationId: users.chats.GetTabs
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.chat
summary: Microsoft Graph Update the navigation property tabs in users
operationId: users.chats.UpdateTabs
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.chat
summary: Microsoft Graph Delete navigation property tabs for users
operationId: users.chats.DeleteTabs
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
/users/{user-id}/chats/{chat-id}/tabs/{teamsTab-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsTab entity.
get:
tags:
- Users.chat
summary: Microsoft Graph Get teamsApp from users
description: >-
The application that is linked to the tab. This can't be changed after
tab creation.
operationId: users.chats.tabs.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs/{teamsTab-id}/teamsApp
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs/{teamsTab-id}/teamsApp
/users/{user-id}/chats/{chat-id}/tabs/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.tabs.GetCount-bf26
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: chat-id
in: path
description: The unique identifier of chat
required: true
schema:
type: string
x-ms-docs-key-type: chat
/users/{user-id}/chats/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.chat
summary: Microsoft Graph Get the number of the resource
operationId: users.chats.GetCount-38c2
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/chats/getAllMessages():
description: Provides operations to call the getAllMessages method.
get:
tags:
- Users.chat
summary: Microsoft Graph Invoke function getAllMessages
description: >-
Get all messages from all chats in which a user is a participant,
including one-on-one chats, group chats, and meeting chats. To learn
more about how to use the Microsoft Teams export APIs to export content,
see Export content with the Microsoft Teams export APIs.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chats-getallmessages?view=graph-rest-1.0
operationId: users.user.chats.getAllMessages
parameters:
- name: model
in: query
description: The payment model for the API
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/getAllMessages()
- /users/{user-id}/joinedTeams/getAllMessages()
/users/{user-id}/chats/getAllRetainedMessages():
description: Provides operations to call the getAllRetainedMessages method.
get:
tags:
- Users.chat
summary: Microsoft Graph Invoke function getAllRetainedMessages
description: >-
Get all retained messages from all chats that a user is a participant
in, including one-on-one chats, group chats, and meeting chats. To learn
more about how to use the Microsoft Teams export APIs to export content,
see Export content with the Microsoft Teams export APIs.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-getallretainedmessages?view=graph-rest-1.0
operationId: users.user.chats.getAllRetainedMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/getAllRetainedMessages()
/users/{user-id}/cloudClipboard:
description: >-
Provides operations to manage the cloudClipboard property of the
microsoft.graph.user entity.
get:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Get cloudClipboard from users
operationId: users.GetCloudClipboard
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Update the navigation property cloudClipboard in users
operationId: users.UpdateCloudClipboard
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Delete navigation property cloudClipboard for users
operationId: users.DeleteCloudClipboard
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/cloudClipboard/items:
description: >-
Provides operations to manage the items property of the
microsoft.graph.cloudClipboardRoot entity.
get:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Get items from users
description: Represents a collection of Cloud Clipboard items.
operationId: users.cloudClipboard.ListItems
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.cloudClipboardItemCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Create new navigation property to items for users
operationId: users.cloudClipboard.CreateItems
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/cloudClipboard/items/{cloudClipboardItem-id}:
description: >-
Provides operations to manage the items property of the
microsoft.graph.cloudClipboardRoot entity.
get:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Get items from users
description: Represents a collection of Cloud Clipboard items.
operationId: users.cloudClipboard.GetItems
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Update the navigation property items in users
operationId: users.cloudClipboard.UpdateItems
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Delete navigation property items for users
operationId: users.cloudClipboard.DeleteItems
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudClipboardItem-id
in: path
description: The unique identifier of cloudClipboardItem
required: true
schema:
type: string
x-ms-docs-key-type: cloudClipboardItem
/users/{user-id}/cloudClipboard/items/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.cloudClipboardRoot
summary: Microsoft Graph Get the number of the resource
operationId: users.cloudClipboard.items.GetCount-1146
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/cloudPCs:
description: >-
Provides operations to manage the cloudPCs property of the
microsoft.graph.user entity.
get:
tags:
- users.cloudPC
summary: Microsoft Graph Get cloudPCs from users
description: The user's Cloud PCs. Read-only. Nullable.
operationId: users.ListCloudPCs
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.cloudPCCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.cloudPC
summary: Microsoft Graph Create new navigation property to cloudPCs for users
operationId: users.CreateCloudPCs
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/cloudPCs/{cloudPC-id}:
description: >-
Provides operations to manage the cloudPCs property of the
microsoft.graph.user entity.
get:
tags:
- users.cloudPC
summary: Microsoft Graph Get cloudPCs from users
description: The user's Cloud PCs. Read-only. Nullable.
operationId: users.GetCloudPCs
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.cloudPC
summary: Microsoft Graph Update the navigation property cloudPCs in users
operationId: users.UpdateCloudPCs
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.cloudPC
summary: Microsoft Graph Delete navigation property cloudPCs for users
operationId: users.DeleteCloudPCs
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudPC-id
in: path
description: The unique identifier of cloudPC
required: true
schema:
type: string
x-ms-docs-key-type: cloudPC
/users/{user-id}/cloudPCs/{cloudPC-id}/endGracePeriod:
description: Provides operations to call the endGracePeriod method.
post:
tags:
- users.cloudPC
summary: Microsoft Graph Invoke action endGracePeriod
description: >-
End the grace period for a specific cloudPC object. The grace period is
triggered when the Cloud PC license is removed or the provisioning
policy is unassigned. It allows users to access Cloud PCs for up to
seven days before deprovisioning occurs. Ending the grace period
immediately deprovisions the Cloud PC without waiting the seven days.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/cloudpc-endgraceperiod?view=graph-rest-1.0
operationId: users.user.cloudPCs.cloudPC.endGracePeriod
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudPC-id
in: path
description: The unique identifier of cloudPC
required: true
schema:
type: string
x-ms-docs-key-type: cloudPC
/users/{user-id}/cloudPCs/{cloudPC-id}/reboot:
description: Provides operations to call the reboot method.
post:
tags:
- users.cloudPC
summary: Microsoft Graph Invoke action reboot
description: Reboot a specific cloudPC object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/cloudpc-reboot?view=graph-rest-1.0
operationId: users.user.cloudPCs.cloudPC.reboot
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudPC-id
in: path
description: The unique identifier of cloudPC
required: true
schema:
type: string
x-ms-docs-key-type: cloudPC
/users/{user-id}/cloudPCs/{cloudPC-id}/rename:
description: Provides operations to call the rename method.
post:
tags:
- users.cloudPC
summary: Microsoft Graph Invoke action rename
description: >-
Rename a specific cloudPC object. Use this API to update the displayName
of a Cloud PC entity.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/cloudpc-rename?view=graph-rest-1.0
operationId: users.user.cloudPCs.cloudPC.rename
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
displayName:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudPC-id
in: path
description: The unique identifier of cloudPC
required: true
schema:
type: string
x-ms-docs-key-type: cloudPC
/users/{user-id}/cloudPCs/{cloudPC-id}/resize:
description: Provides operations to call the resize method.
post:
tags:
- users.cloudPC
summary: Microsoft Graph Invoke action resize
description: >-
Upgrade or downgrade an existing Cloud PC to a configuration with a new
virtual CPU (vCPU) and storage size.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/cloudpc-resize?view=graph-rest-1.0
operationId: users.user.cloudPCs.cloudPC.resize
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
targetServicePlanId:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudPC-id
in: path
description: The unique identifier of cloudPC
required: true
schema:
type: string
x-ms-docs-key-type: cloudPC
/users/{user-id}/cloudPCs/{cloudPC-id}/restore:
description: Provides operations to call the restore method.
post:
tags:
- users.cloudPC
summary: Microsoft Graph Invoke action restore
description: >-
Restore a specific cloudPC object to a previous state from a snapshot.
Use this API to trigger a remote action that restores a Cloud PC device
to a previous state.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/cloudpc-restore?view=graph-rest-1.0
operationId: users.user.cloudPCs.cloudPC.restore
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
cloudPcSnapshotId:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudPC-id
in: path
description: The unique identifier of cloudPC
required: true
schema:
type: string
x-ms-docs-key-type: cloudPC
x-ms-docs-grouped-path:
- /users/{user-id}/restore
/users/{user-id}/cloudPCs/{cloudPC-id}/troubleshoot:
description: Provides operations to call the troubleshoot method.
post:
tags:
- users.cloudPC
summary: Microsoft Graph Invoke action troubleshoot
description: >-
Troubleshoot a specific cloudPC object. Use this API to check the health
status of the Cloud PC and the session host.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/cloudpc-troubleshoot?view=graph-rest-1.0
operationId: users.user.cloudPCs.cloudPC.troubleshoot
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: cloudPC-id
in: path
description: The unique identifier of cloudPC
required: true
schema:
type: string
x-ms-docs-key-type: cloudPC
/users/{user-id}/cloudPCs/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.cloudPC
summary: Microsoft Graph Get the number of the resource
operationId: users.cloudPCs.GetCount-a4ef
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/contactFolders:
description: >-
Provides operations to manage the contactFolders property of the
microsoft.graph.user entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get contactFolders from users
description: The user's contacts folders. Read-only. Nullable.
operationId: users.ListContactFolders
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.contactFolderCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.contactFolder
summary: Microsoft Graph Create new navigation property to contactFolders for users
operationId: users.CreateContactFolders
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/contactFolders/{contactFolder-id}:
description: >-
Provides operations to manage the contactFolders property of the
microsoft.graph.user entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get contactFolders from users
description: The user's contacts folders. Read-only. Nullable.
operationId: users.GetContactFolders
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property contactFolders in users
operationId: users.UpdateContactFolders
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete navigation property contactFolders for users
operationId: users.DeleteContactFolders
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders:
description: >-
Provides operations to manage the childFolders property of the
microsoft.graph.contactFolder entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get childFolders from users
description: >-
The collection of child folders in the folder. Navigation property.
Read-only. Nullable.
operationId: users.contactFolders.ListChildFolders
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.contactFolderCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.contactFolder
summary: Microsoft Graph Create new navigation property to childFolders for users
operationId: users.contactFolders.CreateChildFolders
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}:
description: >-
Provides operations to manage the childFolders property of the
microsoft.graph.contactFolder entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get childFolders from users
description: >-
The collection of child folders in the folder. Navigation property.
Read-only. Nullable.
operationId: users.contactFolders.GetChildFolders
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property childFolders in users
operationId: users.contactFolders.UpdateChildFolders
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete navigation property childFolders for users
operationId: users.contactFolders.DeleteChildFolders
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts:
description: >-
Provides operations to manage the contacts property of the
microsoft.graph.contactFolder entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get contacts from users
description: The contacts in the folder. Navigation property. Read-only. Nullable.
operationId: users.contactFolders.childFolders.ListContacts
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.contactCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.contactFolder
summary: Microsoft Graph Create new navigation property to contacts for users
operationId: users.contactFolders.childFolders.CreateContacts
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
x-ms-docs-grouped-path:
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}:
description: >-
Provides operations to manage the contacts property of the
microsoft.graph.contactFolder entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get contacts from users
description: The contacts in the folder. Navigation property. Read-only. Nullable.
operationId: users.contactFolders.childFolders.GetContacts
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property contacts in users
operationId: users.contactFolders.childFolders.UpdateContacts
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete navigation property contacts for users
operationId: users.contactFolders.childFolders.DeleteContacts
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.contact entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the contact. Read-only.
Nullable.
operationId: users.contactFolders.childFolders.contacts.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.contactFolder
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.contactFolders.childFolders.contacts.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/extensions
- /users/{user-id}/contacts/{contact-id}/extensions
? /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/extensions/{extension-id}
: description: >-
Provides operations to manage the extensions property of the
microsoft.graph.contact entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the contact. Read-only.
Nullable.
operationId: users.contactFolders.childFolders.contacts.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.contactFolders.childFolders.contacts.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.contactFolders.childFolders.contacts.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/extensions/{extension-id}
- /users/{user-id}/contacts/{contact-id}/extensions/{extension-id}
? /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/extensions/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.contactFolders.childFolders.contacts.extensions.GetCount-5b30
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: >-
users.user.contactFolders.contactFolder.childFolders.contactFolder.contacts.contact.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/photo:
description: >-
Provides operations to manage the photo property of the
microsoft.graph.contact entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get photo from users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.childFolders.contacts.GetPhoto
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property photo in users
operationId: users.contactFolders.childFolders.contacts.UpdatePhoto
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/photo
- /users/{user-id}/contacts/{contact-id}/photo
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/photo/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get media content for the navigation property photo from users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.childFolders.contacts.GetPhotoContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.contactFolder
summary: Microsoft Graph Update media content for the navigation property photo in users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.childFolders.contacts.UpdatePhotoContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete media content for the navigation property photo in users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.childFolders.contacts.DeletePhotoContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.contactFolders.childFolders.contacts.GetCount-6cbe
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of contacts that have been added, deleted, or updated in a specified folder. A delta function call for contacts in a folder is similar to a GET request, except that by appropriately \r\napplying state tokens in one or more of these calls, \r\nyou can query for incremental changes in the contacts in \r\nthat folder. This allows you to maintain and synchronize a local store of a user's contacts without \r\nhaving to fetch the entire set of contacts from the server every time. "
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/contact-delta?view=graph-rest-1.0
operationId: >-
users.user.contactFolders.contactFolder.childFolders.contactFolder.contacts.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of contact
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: >-
users.user.contactFolders.contactFolder.childFolders.contactFolder.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contactFolder-id1
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.contactFolders.childFolders.GetCount-9149
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of contact folders that have been added, deleted, or removed from the user's mailbox. A delta function call for contact folders in a mailbox is similar to a GET request, except that by appropriately \r\napplying state tokens in one or more of these calls, \r\nyou can query for incremental changes in the contact folders. This allows you to maintain and synchronize \r\na local store of a user's contact folders without having to fetch all the contact folders of that mailbox from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/contactfolder-delta?view=graph-rest-1.0
operationId: users.user.contactFolders.contactFolder.childFolders.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of contactFolder
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/contactFolders/{contactFolder-id}/contacts:
description: >-
Provides operations to manage the contacts property of the
microsoft.graph.contactFolder entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get contacts from users
description: The contacts in the folder. Navigation property. Read-only. Nullable.
operationId: users.contactFolders.ListContacts
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.contactCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.contactFolder
summary: Microsoft Graph Create new navigation property to contacts for users
operationId: users.contactFolders.CreateContacts
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}:
description: >-
Provides operations to manage the contacts property of the
microsoft.graph.contactFolder entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get contacts from users
description: The contacts in the folder. Navigation property. Read-only. Nullable.
operationId: users.contactFolders.GetContacts
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property contacts in users
operationId: users.contactFolders.UpdateContacts
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete navigation property contacts for users
operationId: users.contactFolders.DeleteContacts
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.contact entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the contact. Read-only.
Nullable.
operationId: users.contactFolders.contacts.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.contactFolder
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.contactFolders.contacts.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/extensions
- /users/{user-id}/contacts/{contact-id}/extensions
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.contact entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the contact. Read-only.
Nullable.
operationId: users.contactFolders.contacts.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.contactFolders.contacts.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.contactFolders.contacts.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/extensions/{extension-id}
- /users/{user-id}/contacts/{contact-id}/extensions/{extension-id}
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.contactFolders.contacts.extensions.GetCount-8e14
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.contactFolders.contactFolder.contacts.contact.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/photo:
description: >-
Provides operations to manage the photo property of the
microsoft.graph.contact entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get photo from users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.contacts.GetPhoto
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.contactFolder
summary: Microsoft Graph Update the navigation property photo in users
operationId: users.contactFolders.contacts.UpdatePhoto
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/photo
- /users/{user-id}/contacts/{contact-id}/photo
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/photo/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get media content for the navigation property photo from users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.contacts.GetPhotoContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.contactFolder
summary: Microsoft Graph Update media content for the navigation property photo in users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.contacts.UpdatePhotoContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.contactFolder
summary: Microsoft Graph Delete media content for the navigation property photo in users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contactFolders.contacts.DeletePhotoContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.contactFolders.contacts.GetCount-5cc4
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of contacts that have been added, deleted, or updated in a specified folder. A delta function call for contacts in a folder is similar to a GET request, except that by appropriately \r\napplying state tokens in one or more of these calls, \r\nyou can query for incremental changes in the contacts in \r\nthat folder. This allows you to maintain and synchronize a local store of a user's contacts without \r\nhaving to fetch the entire set of contacts from the server every time. "
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/contact-delta?view=graph-rest-1.0
operationId: users.user.contactFolders.contactFolder.contacts.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of contact
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.contactFolders.contactFolder.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contactFolder-id
in: path
description: The unique identifier of contactFolder
required: true
schema:
type: string
x-ms-docs-key-type: contactFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/contactFolders/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.contactFolders.GetCount-72bb
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/contactFolders/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.contactFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of contact folders that have been added, deleted, or removed from the user's mailbox. A delta function call for contact folders in a mailbox is similar to a GET request, except that by appropriately \r\napplying state tokens in one or more of these calls, \r\nyou can query for incremental changes in the contact folders. This allows you to maintain and synchronize \r\na local store of a user's contact folders without having to fetch all the contact folders of that mailbox from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/contactfolder-delta?view=graph-rest-1.0
operationId: users.user.contactFolders.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of contactFolder
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/contacts:
description: >-
Provides operations to manage the contacts property of the
microsoft.graph.user entity.
get:
tags:
- Users.contact
summary: Microsoft Graph Get contacts from users
description: The user's contacts. Read-only. Nullable.
operationId: users.ListContacts
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.contactCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.contact
summary: Microsoft Graph Create new navigation property to contacts for users
operationId: users.CreateContacts
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/contacts/{contact-id}:
description: >-
Provides operations to manage the contacts property of the
microsoft.graph.user entity.
get:
tags:
- Users.contact
summary: Microsoft Graph Get contacts from users
description: The user's contacts. Read-only. Nullable.
operationId: users.GetContacts
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.contact
summary: Microsoft Graph Update the navigation property contacts in users
operationId: users.UpdateContacts
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.contact
summary: Microsoft Graph Delete navigation property contacts for users
operationId: users.DeleteContacts
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
/users/{user-id}/contacts/{contact-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.contact entity.
get:
tags:
- Users.contact
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the contact. Read-only.
Nullable.
operationId: users.contacts.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.contact
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.contacts.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/extensions
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/extensions
/users/{user-id}/contacts/{contact-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.contact entity.
get:
tags:
- Users.contact
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the contact. Read-only.
Nullable.
operationId: users.contacts.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.contact
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.contacts.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.contact
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.contacts.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/extensions/{extension-id}
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/extensions/{extension-id}
/users/{user-id}/contacts/{contact-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.contact
summary: Microsoft Graph Get the number of the resource
operationId: users.contacts.extensions.GetCount-e5d6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
/users/{user-id}/contacts/{contact-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- Users.contact
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.contacts.contact.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/contacts/{contact-id}/photo:
description: >-
Provides operations to manage the photo property of the
microsoft.graph.contact entity.
get:
tags:
- Users.contact
summary: Microsoft Graph Get photo from users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contacts.GetPhoto
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.contact
summary: Microsoft Graph Update the navigation property photo in users
operationId: users.contacts.UpdatePhoto
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
x-ms-docs-grouped-path:
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/photo
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/photo
/users/{user-id}/contacts/{contact-id}/photo/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.contact
summary: Microsoft Graph Get media content for the navigation property photo from users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contacts.GetPhotoContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.contact
summary: Microsoft Graph Update media content for the navigation property photo in users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contacts.UpdatePhotoContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.contact
summary: Microsoft Graph Delete media content for the navigation property photo in users
description: Optional contact picture. You can get or set a photo for a contact.
operationId: users.contacts.DeletePhotoContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contact-id
in: path
description: The unique identifier of contact
required: true
schema:
type: string
x-ms-docs-key-type: contact
/users/{user-id}/contacts/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.contact
summary: Microsoft Graph Get the number of the resource
operationId: users.contacts.GetCount-4943
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/contacts/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.contact
summary: Microsoft Graph Invoke function delta
description: "Get a set of contacts that have been added, deleted, or updated in a specified folder. A delta function call for contacts in a folder is similar to a GET request, except that by appropriately \r\napplying state tokens in one or more of these calls, \r\nyou can query for incremental changes in the contacts in \r\nthat folder. This allows you to maintain and synchronize a local store of a user's contacts without \r\nhaving to fetch the entire set of contacts from the server every time. "
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/contact-delta?view=graph-rest-1.0
operationId: users.user.contacts.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of contact
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/createdObjects:
description: >-
Provides operations to manage the createdObjects property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get createdObjects from users
description: Directory objects that the user created. Read-only. Nullable.
operationId: users.ListCreatedObjects
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/createdObjects/{directoryObject-id}:
description: >-
Provides operations to manage the createdObjects property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get createdObjects from users
description: Directory objects that the user created. Read-only. Nullable.
operationId: users.GetCreatedObjects
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/createdObjects/{directoryObject-id}/graph.servicePrincipal:
description: Casts the previous resource to servicePrincipal.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal
operationId: users.GetCreatedObjects.AsServicePrincipal
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/createdObjects/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.createdObjects.GetCount-c0ed
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/createdObjects/graph.servicePrincipal:
description: Casts the previous resource to servicePrincipal.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection
operationId: users.ListCreatedObjects.AsServicePrincipal
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.servicePrincipalCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/createdObjects/graph.servicePrincipal/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.CreatedObjects.GetCount.AsServicePrincipal-1751
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance:
description: >-
Provides operations to manage the dataSecurityAndGovernance property of
the microsoft.graph.user entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get dataSecurityAndGovernance from users
description: >-
The data security and governance settings for the user. Read-only.
Nullable.
operationId: users.GetDataSecurityAndGovernance
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userDataSecurityAndGovernance
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Update the navigation property dataSecurityAndGovernance in users
operationId: users.UpdateDataSecurityAndGovernance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userDataSecurityAndGovernance
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userDataSecurityAndGovernance
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Delete navigation property dataSecurityAndGovernance for users
operationId: users.DeleteDataSecurityAndGovernance
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/activities:
description: >-
Provides operations to manage the activities property of the
microsoft.graph.userDataSecurityAndGovernance entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get activities from users
description: >-
Container for activity logs (content processing and audit) related to
this user. ContainsTarget: true.
operationId: users.dataSecurityAndGovernance.GetActivities
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activitiesContainer'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Update the navigation property activities in users
operationId: users.dataSecurityAndGovernance.UpdateActivities
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activitiesContainer'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activitiesContainer'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Delete navigation property activities for users
operationId: users.dataSecurityAndGovernance.DeleteActivities
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/activities/contentActivities:
description: >-
Provides operations to manage the contentActivities property of the
microsoft.graph.activitiesContainer entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get contentActivities from users
description: Collection of activity logs related to content processing.
operationId: users.dataSecurityAndGovernance.activities.ListContentActivities
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.contentActivityCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Create new navigation property to contentActivities for users
operationId: users.dataSecurityAndGovernance.activities.CreateContentActivities
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/activities/contentActivities/{contentActivity-id}:
description: >-
Provides operations to manage the contentActivities property of the
microsoft.graph.activitiesContainer entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get contentActivities from users
description: Collection of activity logs related to content processing.
operationId: users.dataSecurityAndGovernance.activities.GetContentActivities
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Update the navigation property contentActivities in users
operationId: users.dataSecurityAndGovernance.activities.UpdateContentActivities
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Delete navigation property contentActivities for users
operationId: users.dataSecurityAndGovernance.activities.DeleteContentActivities
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: contentActivity-id
in: path
description: The unique identifier of contentActivity
required: true
schema:
type: string
x-ms-docs-key-type: contentActivity
/users/{user-id}/dataSecurityAndGovernance/activities/contentActivities/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get the number of the resource
operationId: >-
users.dataSecurityAndGovernance.activities.contentActivities.GetCount-a94c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/processContent:
description: Provides operations to call the processContent method.
post:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Invoke action processContent
description: >-
Process content against data protection policies in the context of the
current, or specified, user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userdatasecurityandgovernance-processcontent?view=graph-rest-1.0
operationId: users.user.dataSecurityAndGovernance.processContent
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
contentToProcess:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.processContentRequest
- type: object
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.processContentResponse
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/protectionScopes:
description: >-
Provides operations to manage the protectionScopes property of the
microsoft.graph.userDataSecurityAndGovernance entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get protectionScopes from users
operationId: users.dataSecurityAndGovernance.GetProtectionScopes
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userProtectionScopeContainer
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Update the navigation property protectionScopes in users
operationId: users.dataSecurityAndGovernance.UpdateProtectionScopes
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userProtectionScopeContainer
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userProtectionScopeContainer
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Delete navigation property protectionScopes for users
operationId: users.dataSecurityAndGovernance.DeleteProtectionScopes
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/protectionScopes/compute:
description: Provides operations to call the compute method.
post:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Invoke action compute
operationId: users.user.dataSecurityAndGovernance.protectionScopes.compute
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
activities:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userActivityTypes'
- type: object
nullable: true
locations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.policyLocation'
pivotOn:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.policyPivotProperty'
- type: object
nullable: true
deviceMetadata:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.deviceMetadata'
- type: object
nullable: true
integratedAppMetadata:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.integratedApplicationMetadata
- type: object
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.policyUserScope'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels:
description: >-
Provides operations to manage the sensitivityLabels property of the
microsoft.graph.dataSecurityAndGovernance entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get sensitivityLabels from users
operationId: users.dataSecurityAndGovernance.ListSensitivityLabels
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sensitivityLabelCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Create new navigation property to sensitivityLabels for users
operationId: users.dataSecurityAndGovernance.CreateSensitivityLabels
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}:
description: >-
Provides operations to manage the sensitivityLabels property of the
microsoft.graph.dataSecurityAndGovernance entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get sensitivityLabels from users
operationId: users.dataSecurityAndGovernance.GetSensitivityLabels
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Update the navigation property sensitivityLabels in users
operationId: users.dataSecurityAndGovernance.UpdateSensitivityLabels
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Delete navigation property sensitivityLabels for users
operationId: users.dataSecurityAndGovernance.DeleteSensitivityLabels
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/rights:
description: >-
Provides operations to manage the rights property of the
microsoft.graph.sensitivityLabel entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get rights from users
operationId: users.dataSecurityAndGovernance.sensitivityLabels.GetRights
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usageRightsIncluded'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
x-ms-docs-grouped-path:
- >-
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/{sensitivityLabel-id1}/rights
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels:
description: >-
Provides operations to manage the sublabels property of the
microsoft.graph.sensitivityLabel entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get sublabels from users
operationId: users.dataSecurityAndGovernance.sensitivityLabels.ListSublabels
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sensitivityLabelCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Create new navigation property to sublabels for users
operationId: users.dataSecurityAndGovernance.sensitivityLabels.CreateSublabels
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/{sensitivityLabel-id1}:
description: >-
Provides operations to manage the sublabels property of the
microsoft.graph.sensitivityLabel entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get sublabels from users
operationId: users.dataSecurityAndGovernance.sensitivityLabels.GetSublabels
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Update the navigation property sublabels in users
operationId: users.dataSecurityAndGovernance.sensitivityLabels.UpdateSublabels
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Delete navigation property sublabels for users
operationId: users.dataSecurityAndGovernance.sensitivityLabels.DeleteSublabels
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
- name: sensitivityLabel-id1
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/{sensitivityLabel-id1}/rights:
description: >-
Provides operations to manage the rights property of the
microsoft.graph.sensitivityLabel entity.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get rights from users
operationId: users.dataSecurityAndGovernance.sensitivityLabels.sublabels.GetRights
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usageRightsIncluded'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
- name: sensitivityLabel-id1
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
x-ms-docs-grouped-path:
- >-
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/rights
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get the number of the resource
operationId: >-
users.dataSecurityAndGovernance.sensitivityLabels.sublabels.GetCount-5943
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
? /users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/computeInheritance(labelIds={labelIds},locale='{locale}',contentFormats={contentFormats})
: description: Provides operations to call the computeInheritance method.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Invoke function computeInheritance
description: >-
Calculate the sensitivity label that should be inherited by an output
artifact, given a set of sensitivity labels from input or referenced
artifacts.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/sensitivitylabel-computeinheritance?view=graph-rest-1.0
operationId: >-
users.user.dataSecurityAndGovernance.sensitivityLabels.sensitivityLabel.sublabels.computeInheritance
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
- name: labelIds
in: path
description: 'Usage: labelIds={labelIds}'
required: true
content:
application/json:
schema:
type: array
items:
type: string
- name: locale
in: path
description: 'Usage: locale=''{locale}'''
required: true
schema:
type: string
nullable: true
- name: contentFormats
in: path
description: 'Usage: contentFormats={contentFormats}'
required: true
content:
application/json:
schema:
type: array
items:
type: string
x-ms-docs-grouped-path:
- >-
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/computeInheritance(labelIds={labelIds},locale='{locale}',contentFormats={contentFormats})
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/computeRightsAndInheritance:
description: Provides operations to call the computeRightsAndInheritance method.
post:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Invoke action computeRightsAndInheritance
description: >-
Computes the rights and inheritance for sensitivity labels based on the
input content and labels.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/sensitivitylabel-computerightsandinheritance?view=graph-rest-1.0
operationId: >-
users.user.dataSecurityAndGovernance.sensitivityLabels.sensitivityLabel.sublabels.computeRightsAndInheritance
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
delegatedUserEmail:
type: string
nullable: true
locale:
type: string
nullable: true
protectedContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.protectedContent'
supportedContentFormats:
type: array
items:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.computeRightsAndInheritanceResult
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sensitivityLabel-id
in: path
description: The unique identifier of sensitivityLabel
required: true
schema:
type: string
x-ms-docs-key-type: sensitivityLabel
x-ms-docs-grouped-path:
- >-
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/computeRightsAndInheritance
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Get the number of the resource
operationId: users.dataSecurityAndGovernance.sensitivityLabels.GetCount-8e86
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
? /users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/computeInheritance(labelIds={labelIds},locale='{locale}',contentFormats={contentFormats})
: description: Provides operations to call the computeInheritance method.
get:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Invoke function computeInheritance
description: >-
Calculate the sensitivity label that should be inherited by an output
artifact, given a set of sensitivity labels from input or referenced
artifacts.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/sensitivitylabel-computeinheritance?view=graph-rest-1.0
operationId: >-
users.user.dataSecurityAndGovernance.sensitivityLabels.computeInheritance
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: labelIds
in: path
description: 'Usage: labelIds={labelIds}'
required: true
content:
application/json:
schema:
type: array
items:
type: string
- name: locale
in: path
description: 'Usage: locale=''{locale}'''
required: true
schema:
type: string
nullable: true
- name: contentFormats
in: path
description: 'Usage: contentFormats={contentFormats}'
required: true
content:
application/json:
schema:
type: array
items:
type: string
x-ms-docs-grouped-path:
- >-
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/computeInheritance(labelIds={labelIds},locale='{locale}',contentFormats={contentFormats})
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/computeRightsAndInheritance:
description: Provides operations to call the computeRightsAndInheritance method.
post:
tags:
- users.userDataSecurityAndGovernance
summary: Microsoft Graph Invoke action computeRightsAndInheritance
description: >-
Computes the rights and inheritance for sensitivity labels based on the
input content and labels.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/sensitivitylabel-computerightsandinheritance?view=graph-rest-1.0
operationId: >-
users.user.dataSecurityAndGovernance.sensitivityLabels.computeRightsAndInheritance
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
delegatedUserEmail:
type: string
nullable: true
locale:
type: string
nullable: true
protectedContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.protectedContent'
supportedContentFormats:
type: array
items:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.computeRightsAndInheritanceResult
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- >-
/users/{user-id}/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabel-id}/sublabels/computeRightsAndInheritance
/users/{user-id}/deviceManagementTroubleshootingEvents:
description: >-
Provides operations to manage the deviceManagementTroubleshootingEvents
property of the microsoft.graph.user entity.
get:
tags:
- users.deviceManagementTroubleshootingEvent
summary: Microsoft Graph Get deviceManagementTroubleshootingEvents from users
description: The list of troubleshooting events for this user.
operationId: users.ListDeviceManagementTroubleshootingEvents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.deviceManagementTroubleshootingEventCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.deviceManagementTroubleshootingEvent
summary: >-
Microsoft Graph Create new navigation property to deviceManagementTroubleshootingEvents for users
operationId: users.CreateDeviceManagementTroubleshootingEvents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/deviceManagementTroubleshootingEvents/{deviceManagementTroubleshootingEvent-id}:
description: >-
Provides operations to manage the deviceManagementTroubleshootingEvents
property of the microsoft.graph.user entity.
get:
tags:
- users.deviceManagementTroubleshootingEvent
summary: Microsoft Graph Get deviceManagementTroubleshootingEvents from users
description: The list of troubleshooting events for this user.
operationId: users.GetDeviceManagementTroubleshootingEvents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.deviceManagementTroubleshootingEvent
summary: >-
Microsoft Graph Update the navigation property deviceManagementTroubleshootingEvents in users
operationId: users.UpdateDeviceManagementTroubleshootingEvents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.deviceManagementTroubleshootingEvent
summary: >-
Microsoft Graph Delete navigation property deviceManagementTroubleshootingEvents for users
operationId: users.DeleteDeviceManagementTroubleshootingEvents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: deviceManagementTroubleshootingEvent-id
in: path
description: The unique identifier of deviceManagementTroubleshootingEvent
required: true
schema:
type: string
x-ms-docs-key-type: deviceManagementTroubleshootingEvent
/users/{user-id}/deviceManagementTroubleshootingEvents/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.deviceManagementTroubleshootingEvent
summary: Microsoft Graph Get the number of the resource
operationId: users.deviceManagementTroubleshootingEvents.GetCount-3623
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/directReports:
description: >-
Provides operations to manage the directReports property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get directReports from users
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.
operationId: users.ListDirectReports
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/directReports/{directoryObject-id}:
description: >-
Provides operations to manage the directReports property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get directReports from users
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.
operationId: users.GetDirectReports
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/directReports/{directoryObject-id}/graph.orgContact:
description: Casts the previous resource to orgContact.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.orgContact
operationId: users.GetDirectReports.AsOrgContact
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.orgContact'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/directReports/{directoryObject-id}/graph.user:
description: Casts the previous resource to user.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.user
operationId: users.GetDirectReports.AsUser
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/directReports/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.directReports.GetCount-0678
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/directReports/graph.orgContact:
description: Casts the previous resource to orgContact.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.orgContact in the microsoft.graph.directoryObject collection
operationId: users.ListDirectReports.AsOrgContact
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.orgContactCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/directReports/graph.orgContact/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.DirectReports.GetCount.AsOrgContact-88c4
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/directReports/graph.user:
description: Casts the previous resource to user.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection
operationId: users.ListDirectReports.AsUser
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.userCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/directReports/graph.user/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.DirectReports.GetCount.AsUser-c9c7
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/drive:
description: >-
Provides operations to manage the drive property of the
microsoft.graph.user entity.
get:
tags:
- Users.drive
summary: Microsoft Graph Get drive from users
description: The user's OneDrive. Read-only.
operationId: users.GetDrive
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/drives:
description: >-
Provides operations to manage the drives property of the
microsoft.graph.user entity.
get:
tags:
- Users.drive
summary: Microsoft Graph Get drives from users
description: A collection of drives available for this user. Read-only.
operationId: users.ListDrives
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.driveCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/drives/{drive-id}:
description: >-
Provides operations to manage the drives property of the
microsoft.graph.user entity.
get:
tags:
- Users.drive
summary: Microsoft Graph Get drives from users
description: A collection of drives available for this user. Read-only.
operationId: users.GetDrives
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.drive'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: drive-id
in: path
description: The unique identifier of drive
required: true
schema:
type: string
x-ms-docs-key-type: drive
/users/{user-id}/drives/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.drive
summary: Microsoft Graph Get the number of the resource
operationId: users.drives.GetCount-7cd7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/employeeExperience:
description: >-
Provides operations to manage the employeeExperience property of the
microsoft.graph.user entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get employeeExperience from users
operationId: users.GetEmployeeExperience
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Update the navigation property employeeExperience in users
operationId: users.UpdateEmployeeExperience
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Delete navigation property employeeExperience for users
operationId: users.DeleteEmployeeExperience
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/employeeExperience/assignedRoles:
description: >-
Provides operations to manage the assignedRoles property of the
microsoft.graph.employeeExperienceUser entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph List assignedRoles
description: Get a list of all the roles assigned to a user in Viva Engage.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/employeeexperienceuser-list-assignedroles?view=graph-rest-1.0
operationId: users.employeeExperience.ListAssignedRoles
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.engagementRoleCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Create new navigation property to assignedRoles for users
operationId: users.employeeExperience.CreateAssignedRoles
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}:
description: >-
Provides operations to manage the assignedRoles property of the
microsoft.graph.employeeExperienceUser entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get assignedRoles from users
description: Represents the collection of Viva Engage roles assigned to a user.
operationId: users.employeeExperience.GetAssignedRoles
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Update the navigation property assignedRoles in users
operationId: users.employeeExperience.UpdateAssignedRoles
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Delete navigation property assignedRoles for users
operationId: users.employeeExperience.DeleteAssignedRoles
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
/users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.engagementRole entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get members from users
description: Users that have this role assigned.
operationId: users.employeeExperience.assignedRoles.ListMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.engagementRoleMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Create new navigation property to members for users
operationId: users.employeeExperience.assignedRoles.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
/users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}/members/{engagementRoleMember-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.engagementRole entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get members from users
description: Users that have this role assigned.
operationId: users.employeeExperience.assignedRoles.GetMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Update the navigation property members in users
operationId: users.employeeExperience.assignedRoles.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Delete navigation property members for users
operationId: users.employeeExperience.assignedRoles.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
- name: engagementRoleMember-id
in: path
description: The unique identifier of engagementRoleMember
required: true
schema:
type: string
x-ms-docs-key-type: engagementRoleMember
/users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}/members/{engagementRoleMember-id}/user:
description: >-
Provides operations to manage the user property of the
microsoft.graph.engagementRoleMember entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get user from users
description: The user who has this role assigned.
operationId: users.employeeExperience.assignedRoles.members.GetUser
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
- name: engagementRoleMember-id
in: path
description: The unique identifier of engagementRoleMember
required: true
schema:
type: string
x-ms-docs-key-type: engagementRoleMember
? /users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}/members/{engagementRoleMember-id}/user/mailboxSettings
: get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get mailboxSettings property value
description: >-
Settings for the primary mailbox of the signed-in user. You can get or
update settings for sending automatic replies to incoming messages,
locale, and time zone. Returned only on $select.
operationId: users.employeeExperience.assignedRoles.members.user.GetMailboxSettings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
patch:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Update property mailboxSettings value.
operationId: >-
users.employeeExperience.assignedRoles.members.user.UpdateMailboxSettings
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
- name: engagementRoleMember-id
in: path
description: The unique identifier of engagementRoleMember
required: true
schema:
type: string
x-ms-docs-key-type: engagementRoleMember
? /users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}/members/{engagementRoleMember-id}/user/serviceProvisioningErrors
: get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get serviceProvisioningErrors property value
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).
operationId: >-
users.employeeExperience.assignedRoles.members.user.ListServiceProvisioningErrors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
- name: engagementRoleMember-id
in: path
description: The unique identifier of engagementRoleMember
required: true
schema:
type: string
x-ms-docs-key-type: engagementRoleMember
? /users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}/members/{engagementRoleMember-id}/user/serviceProvisioningErrors/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get the number of the resource
operationId: >-
users.employeeExperience.assignedRoles.members.user.ServiceProvisioningErrors.GetCount-52a8
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
- name: engagementRoleMember-id
in: path
description: The unique identifier of engagementRoleMember
required: true
schema:
type: string
x-ms-docs-key-type: engagementRoleMember
/users/{user-id}/employeeExperience/assignedRoles/{engagementRole-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get the number of the resource
operationId: users.employeeExperience.assignedRoles.members.GetCount-cc8d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: engagementRole-id
in: path
description: The unique identifier of engagementRole
required: true
schema:
type: string
x-ms-docs-key-type: engagementRole
/users/{user-id}/employeeExperience/assignedRoles/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get the number of the resource
operationId: users.employeeExperience.assignedRoles.GetCount-6f8f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/employeeExperience/learningCourseActivities:
description: >-
Provides operations to manage the learningCourseActivities property of the
microsoft.graph.employeeExperienceUser entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph List learningCourseActivities
description: >-
Get a list of the learningCourseActivity objects (assigned or
self-initiated) for a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/learningcourseactivity-list?view=graph-rest-1.0
operationId: users.employeeExperience.ListLearningCourseActivities
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.learningCourseActivityCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/employeeExperience/learningCourseActivities/{learningCourseActivity-id}:
description: >-
Provides operations to manage the learningCourseActivities property of the
microsoft.graph.employeeExperienceUser entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get learningCourseActivity
description: >-
Get the specified learningCourseActivity object using either an ID or an
externalCourseActivityId of the learning provider, or a courseActivityId
of a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/learningcourseactivity-get?view=graph-rest-1.0
operationId: users.employeeExperience.GetLearningCourseActivities
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: learningCourseActivity-id
in: path
description: The unique identifier of learningCourseActivity
required: true
schema:
type: string
x-ms-docs-key-type: learningCourseActivity
x-ms-docs-grouped-path:
- >-
/users/{user-id}/employeeExperience/learningCourseActivities(externalcourseActivityId='{externalcourseActivityId}')
/users/{user-id}/employeeExperience/learningCourseActivities(externalcourseActivityId='{externalcourseActivityId}'):
description: >-
Provides operations to manage the learningCourseActivities property of the
microsoft.graph.employeeExperienceUser entity.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get learningCourseActivity
description: >-
Get the specified learningCourseActivity object using either an ID or an
externalCourseActivityId of the learning provider, or a courseActivityId
of a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/learningcourseactivity-get?view=graph-rest-1.0
operationId: >-
users.employeeExperience.learningCourseActivities.GetByExternalcourseActivityId
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: externalcourseActivityId
in: path
description: Alternate key of learningCourseActivity
required: true
schema:
type: string
nullable: true
x-ms-docs-grouped-path:
- >-
/users/{user-id}/employeeExperience/learningCourseActivities/{learningCourseActivity-id}
/users/{user-id}/employeeExperience/learningCourseActivities/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.employeeExperienceUser
summary: Microsoft Graph Get the number of the resource
operationId: users.employeeExperience.learningCourseActivities.GetCount-dbc7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/events:
description: >-
Provides operations to manage the events property of the
microsoft.graph.user entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get events from users
description: >-
The user's events. Default is to show Events under the Default Calendar.
Read-only. Nullable.
operationId: users.ListEvents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.event
summary: Microsoft Graph Create new navigation property to events for users
operationId: users.CreateEvents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/events/{event-id}:
description: >-
Provides operations to manage the events property of the
microsoft.graph.user entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get events from users
description: >-
The user's events. Default is to show Events under the Default Calendar.
Read-only. Nullable.
operationId: users.GetEvents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.event
summary: Microsoft Graph Update the navigation property events in users
operationId: users.UpdateEvents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.event
summary: Microsoft Graph Delete navigation property events for users
operationId: users.DeleteEvents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/events/{event-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.events.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.event
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.events.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/attachments
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments
/users/{user-id}/events/{event-id}/attachments/{attachment-id}:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.event entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get attachments from users
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation property.
Read-only. Nullable.
operationId: users.events.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.event
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.events.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
schema:
type: string
x-ms-docs-key-type: attachment
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/attachments/{attachment-id}
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/{attachment-id}
/users/{user-id}/events/{event-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.event
summary: Microsoft Graph Get the number of the resource
operationId: users.events.attachments.GetCount-711f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/events/{event-id}/attachments/createUploadSession:
description: Provides operations to call the createUploadSession method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session that allows an app to iteratively upload ranges
of a file, so as to attach the file to the specified Outlook item. The
item can be a message or event. Use this approach to attach a file if
the file size is between 3 MB and 150 MB. To attach a file that's
smaller than 3 MB, do a POST operation on the attachments navigation
property of the Outlook item; see how to do this for a message or for an
event. As part of the response, this action returns an upload URL that
you can use in subsequent sequential PUT queries. Request headers for
each PUT operation let you specify the exact range of bytes to be
uploaded. This allows transfer to be resumed, in case the network
connection is dropped during upload. The following are the steps to
attach a file to an Outlook item using an upload session: See attach
large files to Outlook messages or events for an example.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: users.user.events.event.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession
- /users/{user-id}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession
/users/{user-id}/events/{event-id}/calendar:
description: >-
Provides operations to manage the calendar property of the
microsoft.graph.event entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get calendar from users
description: The calendar that contains the event. Navigation property. Read-only.
operationId: users.events.GetCalendar
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendar'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/calendar
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/calendar
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/calendar
/users/{user-id}/events/{event-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.events.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.event
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.events.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/extensions
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions
/users/{user-id}/events/{event-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.event entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the event. Nullable.
operationId: users.events.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.event
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.events.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.event
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.events.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/extensions/{extension-id}
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/extensions/{extension-id}
/users/{user-id}/events/{event-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.event
summary: Microsoft Graph Get the number of the resource
operationId: users.events.extensions.GetCount-0041
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
/users/{user-id}/events/{event-id}/instances:
description: >-
Provides operations to manage the instances property of the
microsoft.graph.event entity.
get:
tags:
- Users.event
summary: Microsoft Graph Get instances from users
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.
operationId: users.events.ListInstances
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T19:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range, represented in ISO 8601
format. For example, 2019-11-08T20:00:00-08:00
required: true
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.eventCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/instances
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances
/users/{user-id}/events/{event-id}/instances/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.event
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.events.event.instances.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/events/{event-id}/accept:
description: Provides operations to call the accept method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action accept
description: Accept the specified event in a user calendar.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-accept?view=graph-rest-1.0
operationId: users.user.events.event.accept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/accept
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/accept
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/accept
/users/{user-id}/events/{event-id}/cancel:
description: Provides operations to call the cancel method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action cancel
description: "This action allows the organizer of a meeting to send a cancellation message and cancel the event. The action moves the event to the Deleted Items folder. The organizer can also cancel an occurrence of a recurring meeting \r\nby providing the occurrence event ID. An attendee calling this action gets an error (HTTP 400 Bad Request), with the following\r\nerror message: 'Your request can't be completed. You need to be an organizer to cancel a meeting.' This action differs from Delete in that Cancel is available to only the organizer, and lets\r\nthe organizer send a custom message to the attendees about the cancellation."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-cancel?view=graph-rest-1.0
operationId: users.user.events.event.cancel
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/cancel
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/cancel
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/cancel
/users/{user-id}/events/{event-id}/decline:
description: Provides operations to call the decline method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action decline
description: >-
Decline invitation to the specified event in a user calendar. If the
event allows proposals for new times, on declining the event, an invitee
can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-decline?view=graph-rest-1.0
operationId: users.user.events.event.decline
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/decline
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/decline
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/decline
/users/{user-id}/events/{event-id}/dismissReminder:
description: Provides operations to call the dismissReminder method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action dismissReminder
description: >-
Dismiss a reminder that has been triggered for an event in a user
calendar.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-dismissreminder?view=graph-rest-1.0
operationId: users.user.events.event.dismissReminder
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/dismissReminder
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/dismissReminder
/users/{user-id}/events/{event-id}/forward:
description: Provides operations to call the forward method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action forward
description: "This action allows the organizer or attendee of a meeting event to forward the\r\nmeeting request to a new recipient. If the meeting event is forwarded from an attendee's Microsoft 365 mailbox to another recipient, this action\r\nalso sends a message to notify the organizer of the forwarding, and adds the recipient to the organizer's\r\ncopy of the meeting event. This convenience is not available when forwarding from an Outlook.com account."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-forward?view=graph-rest-1.0
operationId: users.user.events.event.forward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/forward
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/forward
- /users/{user-id}/messages/{message-id}/forward
/users/{user-id}/events/{event-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.events.event.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/events/{event-id}/snoozeReminder:
description: Provides operations to call the snoozeReminder method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action snoozeReminder
description: Postpone a reminder for an event in a user calendar until a new time.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-snoozereminder?view=graph-rest-1.0
operationId: users.user.events.event.snoozeReminder
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
NewReminderTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/snoozeReminder
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/snoozeReminder
/users/{user-id}/events/{event-id}/tentativelyAccept:
description: Provides operations to call the tentativelyAccept method.
post:
tags:
- Users.event
summary: Microsoft Graph Invoke action tentativelyAccept
description: >-
Tentatively accept the specified event in a user calendar. If the event
allows proposals for new times, on responding tentative to the event, an
invitee can choose to suggest an alternative time by including the
proposedNewTime parameter. For more information on how to propose a
time, and how to receive and accept a new time proposal, see Propose new
meeting times.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/event-tentativelyaccept?view=graph-rest-1.0
operationId: users.user.events.event.tentativelyAccept
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ProposedNewTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeSlot'
- type: object
nullable: true
SendResponse:
type: boolean
default: false
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: event-id
in: path
description: The unique identifier of event
required: true
schema:
type: string
x-ms-docs-key-type: event
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/tentativelyAccept
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/tentativelyAccept
/users/{user-id}/events/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.event
summary: Microsoft Graph Get the number of the resource
operationId: users.events.GetCount-d443
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/events/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.event
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of event resources that have been added, deleted, or updated
in a calendarView (a range of events defined by start and end dates) of
the user's primary calendar. Typically, synchronizing events in a
calendarView in a local store entails a round of multiple delta function
calls. The initial call is a full synchronization, and every subsequent
delta call in the same round gets the incremental changes (additions,
deletions, or updates). This allows you to maintain and synchronize a
local store of events in the specified calendarView, without having to
fetch all the events of that calendar from the server every time.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/event-delta?view=graph-rest-1.0
operationId: users.user.events.delta
parameters:
- name: startDateTime
in: query
description: >-
The start date and time of the time range in the function,
represented in ISO 8601 format. For example,
2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- name: endDateTime
in: query
description: >-
The end date and time of the time range in the function, represented
in ISO 8601 format. For example, 2019-11-08T20:00:00-08:00
required: true
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of event
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.user entity.
get:
tags:
- Users.extension
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the user. Read-only.
Supports $expand. Nullable.
operationId: users.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.extension
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.user entity.
get:
tags:
- Users.extension
summary: Microsoft Graph Get extensions from users
description: >-
The collection of open extensions defined for the user. Read-only.
Supports $expand. Nullable.
operationId: users.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.extension
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.extension
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
/users/{user-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.extension
summary: Microsoft Graph Get the number of the resource
operationId: users.extensions.GetCount-4b1c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/followedSites:
description: >-
Provides operations to manage the followedSites property of the
microsoft.graph.user entity.
get:
tags:
- Users.site
summary: Microsoft Graph Get followedSites from users
operationId: users.ListFollowedSites
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.siteCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/followedSites/{site-id}:
description: >-
Provides operations to manage the followedSites property of the
microsoft.graph.user entity.
get:
tags:
- Users.site
summary: Microsoft Graph Get followedSites from users
operationId: users.GetFollowedSites
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.site'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
/users/{user-id}/followedSites/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.site
summary: Microsoft Graph Get the number of the resource
operationId: users.followedSites.GetCount-40c9
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/followedSites/add:
description: Provides operations to call the add method.
post:
tags:
- Users.site
summary: Microsoft Graph Invoke action add
description: Follow a user's site or multiple sites.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/site-follow?view=graph-rest-1.0
operationId: users.user.followedSites.add
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of site
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/add
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/add
/users/{user-id}/followedSites/remove:
description: Provides operations to call the remove method.
post:
tags:
- Users.site
summary: Microsoft Graph Invoke action remove
description: Unfollow a user's site or multiple sites.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/site-unfollow?view=graph-rest-1.0
operationId: users.user.followedSites.remove
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of site
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/remove
/users/{user-id}/inferenceClassification:
description: >-
Provides operations to manage the inferenceClassification property of the
microsoft.graph.user entity.
get:
tags:
- users.inferenceClassification
summary: Microsoft Graph Get inferenceClassification from users
description: >-
Relevance classification of the user's messages based on explicit
designations that override inferred relevance or importance.
operationId: users.GetInferenceClassification
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.inferenceClassification
summary: Microsoft Graph Update the navigation property inferenceClassification in users
operationId: users.UpdateInferenceClassification
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/inferenceClassification/overrides:
description: >-
Provides operations to manage the overrides property of the
microsoft.graph.inferenceClassification entity.
get:
tags:
- users.inferenceClassification
summary: Microsoft Graph Get overrides from users
description: >-
A set of overrides for a user to always classify messages from specific
senders in certain ways: focused, or other. Read-only. Nullable.
operationId: users.inferenceClassification.ListOverrides
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.inferenceClassificationOverrideCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.inferenceClassification
summary: Microsoft Graph Create new navigation property to overrides for users
operationId: users.inferenceClassification.CreateOverrides
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.inferenceClassificationOverride
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.inferenceClassificationOverride
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/inferenceClassification/overrides/{inferenceClassificationOverride-id}:
description: >-
Provides operations to manage the overrides property of the
microsoft.graph.inferenceClassification entity.
get:
tags:
- users.inferenceClassification
summary: Microsoft Graph Get overrides from users
description: >-
A set of overrides for a user to always classify messages from specific
senders in certain ways: focused, or other. Read-only. Nullable.
operationId: users.inferenceClassification.GetOverrides
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.inferenceClassificationOverride
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.inferenceClassification
summary: Microsoft Graph Update the navigation property overrides in users
operationId: users.inferenceClassification.UpdateOverrides
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.inferenceClassificationOverride
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.inferenceClassificationOverride
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.inferenceClassification
summary: Microsoft Graph Delete navigation property overrides for users
operationId: users.inferenceClassification.DeleteOverrides
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: inferenceClassificationOverride-id
in: path
description: The unique identifier of inferenceClassificationOverride
required: true
schema:
type: string
x-ms-docs-key-type: inferenceClassificationOverride
/users/{user-id}/inferenceClassification/overrides/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.inferenceClassification
summary: Microsoft Graph Get the number of the resource
operationId: users.inferenceClassification.overrides.GetCount-f355
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/insights:
description: >-
Provides operations to manage the insights property of the
microsoft.graph.user entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get insights from users
description: >-
Represents relationships between a user and items such as OneDrive for
work or school documents, calculated using advanced analytics and
machine learning techniques. Read-only. Nullable.
operationId: users.GetInsights
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.itemInsights'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.itemInsights
summary: Microsoft Graph Update the navigation property insights in users
operationId: users.UpdateInsights
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.itemInsights'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.itemInsights'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.itemInsights
summary: Microsoft Graph Delete navigation property insights for users
operationId: users.DeleteInsights
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/insights/shared:
description: >-
Provides operations to manage the shared property of the
microsoft.graph.officeGraphInsights entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get shared from users
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.
operationId: users.insights.ListShared
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sharedInsightCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.itemInsights
summary: Microsoft Graph Create new navigation property to shared for users
operationId: users.insights.CreateShared
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/insights/shared/{sharedInsight-id}:
description: >-
Provides operations to manage the shared property of the
microsoft.graph.officeGraphInsights entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get shared from users
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.
operationId: users.insights.GetShared
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.itemInsights
summary: Microsoft Graph Update the navigation property shared in users
operationId: users.insights.UpdateShared
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.itemInsights
summary: Microsoft Graph Delete navigation property shared for users
operationId: users.insights.DeleteShared
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sharedInsight-id
in: path
description: The unique identifier of sharedInsight
required: true
schema:
type: string
x-ms-docs-key-type: sharedInsight
/users/{user-id}/insights/shared/{sharedInsight-id}/lastSharedMethod:
description: >-
Provides operations to manage the lastSharedMethod property of the
microsoft.graph.sharedInsight entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get lastSharedMethod from users
operationId: users.insights.shared.GetLastSharedMethod
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sharedInsight-id
in: path
description: The unique identifier of sharedInsight
required: true
schema:
type: string
x-ms-docs-key-type: sharedInsight
/users/{user-id}/insights/shared/{sharedInsight-id}/resource:
description: >-
Provides operations to manage the resource property of the
microsoft.graph.sharedInsight entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get resource from users
description: >-
Used for navigating to the item that was shared. For file attachments,
the type is fileAttachment. For linked attachments, the type is
driveItem.
operationId: users.insights.shared.GetResource
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sharedInsight-id
in: path
description: The unique identifier of sharedInsight
required: true
schema:
type: string
x-ms-docs-key-type: sharedInsight
/users/{user-id}/insights/shared/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get the number of the resource
operationId: users.insights.shared.GetCount-bfe2
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/insights/trending:
description: >-
Provides operations to manage the trending property of the
microsoft.graph.officeGraphInsights entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get trending from users
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.
operationId: users.insights.ListTrending
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.trendingCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.itemInsights
summary: Microsoft Graph Create new navigation property to trending for users
operationId: users.insights.CreateTrending
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.trending'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.trending'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/insights/trending/{trending-id}:
description: >-
Provides operations to manage the trending property of the
microsoft.graph.officeGraphInsights entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get trending from users
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.
operationId: users.insights.GetTrending
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.trending'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.itemInsights
summary: Microsoft Graph Update the navigation property trending in users
operationId: users.insights.UpdateTrending
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.trending'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.trending'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.itemInsights
summary: Microsoft Graph Delete navigation property trending for users
operationId: users.insights.DeleteTrending
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: trending-id
in: path
description: The unique identifier of trending
required: true
schema:
type: string
x-ms-docs-key-type: trending
/users/{user-id}/insights/trending/{trending-id}/resource:
description: >-
Provides operations to manage the resource property of the
microsoft.graph.trending entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get resource from users
description: Used for navigating to the trending document.
operationId: users.insights.trending.GetResource
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: trending-id
in: path
description: The unique identifier of trending
required: true
schema:
type: string
x-ms-docs-key-type: trending
/users/{user-id}/insights/trending/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get the number of the resource
operationId: users.insights.trending.GetCount-9a67
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/insights/used:
description: >-
Provides operations to manage the used property of the
microsoft.graph.officeGraphInsights entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get used from users
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.
operationId: users.insights.ListUsed
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.usedInsightCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.itemInsights
summary: Microsoft Graph Create new navigation property to used for users
operationId: users.insights.CreateUsed
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/insights/used/{usedInsight-id}:
description: >-
Provides operations to manage the used property of the
microsoft.graph.officeGraphInsights entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get used from users
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.
operationId: users.insights.GetUsed
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.itemInsights
summary: Microsoft Graph Update the navigation property used in users
operationId: users.insights.UpdateUsed
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.itemInsights
summary: Microsoft Graph Delete navigation property used for users
operationId: users.insights.DeleteUsed
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: usedInsight-id
in: path
description: The unique identifier of usedInsight
required: true
schema:
type: string
x-ms-docs-key-type: usedInsight
/users/{user-id}/insights/used/{usedInsight-id}/resource:
description: >-
Provides operations to manage the resource property of the
microsoft.graph.usedInsight entity.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get resource from users
description: >-
Used for navigating to the item that was used. For file attachments, the
type is fileAttachment. For linked attachments, the type is driveItem.
operationId: users.insights.used.GetResource
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entity'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: usedInsight-id
in: path
description: The unique identifier of usedInsight
required: true
schema:
type: string
x-ms-docs-key-type: usedInsight
/users/{user-id}/insights/used/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.itemInsights
summary: Microsoft Graph Get the number of the resource
operationId: users.insights.used.GetCount-d5af
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/joinedTeams:
description: >-
Provides operations to manage the joinedTeams property of the
microsoft.graph.user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get joinedTeams from users
operationId: users.ListJoinedTeams
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.teamCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to joinedTeams for users
operationId: users.CreateJoinedTeams
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/joinedTeams/{team-id}:
description: >-
Provides operations to manage the joinedTeams property of the
microsoft.graph.user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get joinedTeams from users
operationId: users.GetJoinedTeams
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property joinedTeams in users
operationId: users.UpdateJoinedTeams
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property joinedTeams for users
operationId: users.DeleteJoinedTeams
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/allChannels:
description: >-
Provides operations to manage the allChannels property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allChannels from users
description: >-
List of channels either hosted in or shared with the team (incoming
channels).
operationId: users.joinedTeams.ListAllChannels
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.channelCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/allChannels/{channel-id}:
description: >-
Provides operations to manage the allChannels property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allChannels from users
description: >-
List of channels either hosted in or shared with the team (incoming
channels).
operationId: users.joinedTeams.GetAllChannels
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/allChannels/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.allChannels.GetCount-33d5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/channels:
description: >-
Provides operations to manage the channels property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get channels from users
description: The collection of channels and messages associated with the team.
operationId: users.joinedTeams.ListChannels
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.channelCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to channels for users
operationId: users.joinedTeams.CreateChannels
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}:
description: >-
Provides operations to manage the channels property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get channels from users
description: The collection of channels and messages associated with the team.
operationId: users.joinedTeams.GetChannels
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property channels in users
operationId: users.joinedTeams.UpdateChannels
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property channels for users
operationId: users.joinedTeams.DeleteChannels
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers:
description: >-
Provides operations to manage the allMembers property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allMembers from users
description: >-
A collection of membership records associated with the channel,
including both direct and indirect members of shared channels.
operationId: users.joinedTeams.channels.ListAllMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to allMembers for users
operationId: users.joinedTeams.channels.CreateAllMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/{conversationMember-id}:
description: >-
Provides operations to manage the allMembers property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allMembers from users
description: >-
A collection of membership records associated with the channel,
including both direct and indirect members of shared channels.
operationId: users.joinedTeams.channels.GetAllMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property allMembers in users
operationId: users.joinedTeams.channels.UpdateAllMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property allMembers for users
operationId: users.joinedTeams.channels.DeleteAllMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/{conversationMember-id}
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.allMembers.GetCount-12c2
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/add:
description: Provides operations to call the add method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action add
description: >-
Add multiple members in a single request to a team. The response
provides details about which memberships could and couldn't be created.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmembers-add?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.allMembers.add
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/add
- /users/{user-id}/followedSites/add
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/add
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/remove:
description: Provides operations to call the remove method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action remove
description: >-
Remove multiple members from a team in a single request. The response
provides details about which memberships could and couldn't be removed.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmember-remove?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.allMembers.remove
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/remove
- /users/{user-id}/followedSites/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/remove
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/filesFolder:
description: >-
Provides operations to manage the filesFolder property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get filesFolder from users
description: Metadata for the location where the channel's files are stored.
operationId: users.joinedTeams.channels.GetFilesFolder
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/filesFolder
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/filesFolder/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get content for the navigation property filesFolder from users
description: The content stream, if the item represents a file.
operationId: users.joinedTeams.channels.GetFilesFolderContent
parameters:
- name: $format
in: query
description: Format of the content
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.team
summary: Microsoft Graph Update content for the navigation property filesFolder in users
description: The content stream, if the item represents a file.
operationId: users.joinedTeams.channels.UpdateFilesFolderContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.team
summary: Microsoft Graph Delete content for the navigation property filesFolder in users
description: The content stream, if the item represents a file.
operationId: users.joinedTeams.channels.DeleteFilesFolderContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: A collection of membership records associated with the channel.
operationId: users.joinedTeams.channels.ListMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to members for users
operationId: users.joinedTeams.channels.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/{conversationMember-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: A collection of membership records associated with the channel.
operationId: users.joinedTeams.channels.GetMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property members in users
operationId: users.joinedTeams.channels.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property members for users
operationId: users.joinedTeams.channels.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/{conversationMember-id}
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.members.GetCount-ac8d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/add:
description: Provides operations to call the add method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action add
description: >-
Add multiple members in a single request to a team. The response
provides details about which memberships could and couldn't be created.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmembers-add?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.members.add
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/add
- /users/{user-id}/followedSites/add
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/add
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/remove:
description: Provides operations to call the remove method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action remove
description: >-
Remove multiple members from a team in a single request. The response
provides details about which memberships could and couldn't be removed.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmember-remove?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.members.remove
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/remove
- /users/{user-id}/followedSites/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/remove
- /users/{user-id}/joinedTeams/{team-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/remove
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get messages from users
description: >-
A collection of all the messages in the channel. A navigation property.
Nullable.
operationId: users.joinedTeams.channels.ListMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.chatMessageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to messages for users
operationId: users.joinedTeams.channels.CreateMessages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get messages from users
description: >-
A collection of all the messages in the channel. A navigation property.
Nullable.
operationId: users.joinedTeams.channels.GetMessages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property messages in users
operationId: users.joinedTeams.channels.UpdateMessages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property messages for users
operationId: users.joinedTeams.channels.DeleteMessages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents:
description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.channels.messages.ListHostedContents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.chatMessageHostedContentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to hostedContents for users
operationId: users.joinedTeams.channels.messages.CreateHostedContents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
: description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.channels.messages.GetHostedContents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property hostedContents in users
operationId: users.joinedTeams.channels.messages.UpdateHostedContents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property hostedContents for users
operationId: users.joinedTeams.channels.messages.DeleteHostedContents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}/$value
: description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get media content for the navigation property hostedContents from users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.channels.messages.GetHostedContentsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.team
summary: Microsoft Graph Update media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.channels.messages.UpdateHostedContentsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.team
summary: Microsoft Graph Delete media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.channels.messages.DeleteHostedContentsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.messages.hostedContents.GetCount-a414
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/setReaction:
description: Provides operations to call the setReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action setReaction
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.setReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/softDelete:
description: Provides operations to call the softDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action softDelete
description: >-
Delete a single chatMessage or a chat message reply in a channel or a
chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-softdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.softDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/undoSoftDelete:
description: Provides operations to call the undoSoftDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action undoSoftDelete
description: >-
Undo soft deletion of a single chatMessage or a chat message reply in a
channel or a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-undosoftdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.undoSoftDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/unsetReaction:
description: Provides operations to call the unsetReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action unsetReaction
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.unsetReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies:
description: >-
Provides operations to manage the replies property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get replies from users
description: Replies for a specified message. Supports $expand for channel messages.
operationId: users.joinedTeams.channels.messages.ListReplies
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.chatMessageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to replies for users
operationId: users.joinedTeams.channels.messages.CreateReplies
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}:
description: >-
Provides operations to manage the replies property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get replies from users
description: Replies for a specified message. Supports $expand for channel messages.
operationId: users.joinedTeams.channels.messages.GetReplies
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property replies in users
operationId: users.joinedTeams.channels.messages.UpdateReplies
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property replies for users
operationId: users.joinedTeams.channels.messages.DeleteReplies
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
: description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.channels.messages.replies.ListHostedContents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.chatMessageHostedContentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to hostedContents for users
operationId: users.joinedTeams.channels.messages.replies.CreateHostedContents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
: description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.channels.messages.replies.GetHostedContents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property hostedContents in users
operationId: users.joinedTeams.channels.messages.replies.UpdateHostedContents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property hostedContents for users
operationId: users.joinedTeams.channels.messages.replies.DeleteHostedContents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}/$value
: description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get media content for the navigation property hostedContents from users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.channels.messages.replies.GetHostedContentsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.team
summary: Microsoft Graph Update media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.channels.messages.replies.UpdateHostedContentsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.team
summary: Microsoft Graph Delete media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.channels.messages.replies.DeleteHostedContentsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.messages.replies.hostedContents.GetCount-9464
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
: description: Provides operations to call the setReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action setReaction
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.replies.chatMessage.setReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
: description: Provides operations to call the softDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action softDelete
description: >-
Delete a single chatMessage or a chat message reply in a channel or a
chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-softdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.replies.chatMessage.softDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
: description: Provides operations to call the undoSoftDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action undoSoftDelete
description: >-
Undo soft deletion of a single chatMessage or a chat message reply in a
channel or a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-undosoftdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.replies.chatMessage.undoSoftDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
: description: Provides operations to call the unsetReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action unsetReaction
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.replies.chatMessage.unsetReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.messages.replies.GetCount-3de6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function delta
description: >-
Get the list of messages from all chats in which a user is a
participant, including one-on-one chats, group chats, and meeting chats.
When you use delta query, you can get new or updated messages. To get
the replies for a message, use the list message replies or the get
message reply operations. A GET request with the delta function returns
one of the following: State tokens are opaque to the client. To proceed
with a round of change tracking, copy and apply the @odata.nextLink or
@odata.deltaLink URL returned from the last GET request to the next
delta function call. An @odata.deltaLink returned in a response
signifies that the current round of change tracking is complete. You can
save and use the @odata.deltaLink URL when you begin to retrieve more
changes (messages changed or posted after you acquire @odata.deltaLink).
For more information, see the delta query documentation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-delta?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.channels.channel.messages.chatMessage.replies.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.messages.GetCount-9955
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function delta
description: >-
Get the list of messages from all chats in which a user is a
participant, including one-on-one chats, group chats, and meeting chats.
When you use delta query, you can get new or updated messages. To get
the replies for a message, use the list message replies or the get
message reply operations. A GET request with the delta function returns
one of the following: State tokens are opaque to the client. To proceed
with a round of change tracking, copy and apply the @odata.nextLink or
@odata.deltaLink URL returned from the last GET request to the next
delta function call. An @odata.deltaLink returned in a response
signifies that the current round of change tracking is complete. You can
save and use the @odata.deltaLink URL when you begin to retrieve more
changes (messages changed or posted after you acquire @odata.deltaLink).
For more information, see the delta query documentation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-delta?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.messages.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/archive:
description: Provides operations to call the archive method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action archive
description: >-
Archive a channel in a team. When a channel is archived, users can't
send new messages or react to existing messages in the channel, edit the
channel settings, or make other changes to the channel. You can delete
an archived channel or add and remove members from it. If you archive a
team, its channels are also archived. Archiving is an asynchronous
operation; a channel is archived after the asynchronous archiving
operation completes successfully, which might occur after the response
returns. A channel without an owner or that belongs to a group that has
no owner, can't be archived. To restore a channel from its archived
state, use the channel: unarchive method. A channel can’t be archived or
unarchived if its team is archived.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-archive?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.archive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
shouldSetSpoSiteReadOnlyForMembers:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/archive
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/archive
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/completeMigration:
description: Provides operations to call the completeMigration method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action completeMigration
description: >-
Complete the message migration process by removing migration mode from a
channel in a team. Migration mode is a special state that prevents
certain operations, like sending messages and adding members, during the
data migration process. After a completeMigration request is made, you
can't import additional messages into the team. You can add members to
the team after the request returns a successful response.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-completemigration?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.completeMigration
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/completeMigration
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/completeMigration
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')
: description: Provides operations to call the doesUserHaveAccess method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function doesUserHaveAccess
description: Determine whether a user has access to a channel.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-doesuserhaveaccess?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.doesUserHaveAccess
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: boolean
default: false
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: userId
in: query
description: 'Usage: userId=''@userId'''
schema:
type: string
nullable: true
- name: tenantId
in: query
description: 'Usage: tenantId=''@tenantId'''
schema:
type: string
nullable: true
- name: userPrincipalName
in: query
description: 'Usage: userPrincipalName=''@userPrincipalName'''
schema:
type: string
nullable: true
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/provisionEmail:
description: Provides operations to call the provisionEmail method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action provisionEmail
description: >-
Provision an email address for a channel. Microsoft Teams doesn't
automatically provision an email address for a channel by default. To
have Teams provision an email address, you can call provisionEmail, or
through the Teams user interface, select Get email address, which
triggers Teams to generate an email address if it has not already
provisioned one. To remove the email address of a channel, use the
removeEmail method.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-provisionemail?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.provisionEmail
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.provisionChannelEmailResult
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/provisionEmail
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/removeEmail:
description: Provides operations to call the removeEmail method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action removeEmail
description: >-
Remove the email address of a channel. You can remove an email address
only if it was provisioned using the provisionEmail method or through
the Microsoft Teams client.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-removeemail?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.removeEmail
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/removeEmail
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/unarchive:
description: Provides operations to call the unarchive method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action unarchive
description: >-
Restore an archived channel. Unarchiving restores the ability for users
to send messages and edit the channel. Channels are archived via the
channel: archive method. Unarchiving is an asynchronous operation; a
channel is unarchived when the asynchronous unarchiving operation
completes successfully, which might occur after this method responds.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-unarchive?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.channel.unarchive
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/unarchive
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/unarchive
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams:
description: >-
Provides operations to manage the sharedWithTeams property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get sharedWithTeams from users
description: A collection of teams with which a channel is shared.
operationId: users.joinedTeams.channels.ListSharedWithTeams
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sharedWithChannelTeamInfoCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to sharedWithTeams for users
operationId: users.joinedTeams.channels.CreateSharedWithTeams
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}:
description: >-
Provides operations to manage the sharedWithTeams property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get sharedWithTeams from users
description: A collection of teams with which a channel is shared.
operationId: users.joinedTeams.channels.GetSharedWithTeams
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property sharedWithTeams in users
operationId: users.joinedTeams.channels.UpdateSharedWithTeams
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property sharedWithTeams for users
operationId: users.joinedTeams.channels.DeleteSharedWithTeams
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers:
description: >-
Provides operations to manage the allowedMembers property of the
microsoft.graph.sharedWithChannelTeamInfo entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allowedMembers from users
description: A collection of team members who have access to the shared channel.
operationId: users.joinedTeams.channels.sharedWithTeams.ListAllowedMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers/{conversationMember-id}
: description: >-
Provides operations to manage the allowedMembers property of the
microsoft.graph.sharedWithChannelTeamInfo entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allowedMembers from users
description: A collection of team members who have access to the shared channel.
operationId: users.joinedTeams.channels.sharedWithTeams.GetAllowedMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers/{conversationMember-id}
? /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.sharedWithTeams.allowedMembers.GetCount-8dec
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/team:
description: >-
Provides operations to manage the team property of the
microsoft.graph.teamInfo entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get team from users
operationId: users.joinedTeams.channels.sharedWithTeams.GetTeam
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/team
- /users/{user-id}/teamwork/associatedTeams/{associatedTeamInfo-id}/team
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.sharedWithTeams.GetCount-3df3
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs:
description: >-
Provides operations to manage the tabs property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get tabs from users
description: A collection of all the tabs in the channel. A navigation property.
operationId: users.joinedTeams.channels.ListTabs
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.teamsTabCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to tabs for users
operationId: users.joinedTeams.channels.CreateTabs
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs/{teamsTab-id}:
description: >-
Provides operations to manage the tabs property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get tabs from users
description: A collection of all the tabs in the channel. A navigation property.
operationId: users.joinedTeams.channels.GetTabs
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property tabs in users
operationId: users.joinedTeams.channels.UpdateTabs
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property tabs for users
operationId: users.joinedTeams.channels.DeleteTabs
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs/{teamsTab-id}
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs/{teamsTab-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsTab entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get teamsApp from users
description: >-
The application that is linked to the tab. This can't be changed after
tab creation.
operationId: users.joinedTeams.channels.tabs.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/tabs/{teamsTab-id}/teamsApp
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs/{teamsTab-id}/teamsApp
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.tabs.GetCount-6808
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/channels/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.channels.GetCount-e058
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/channels/getAllMessages():
description: Provides operations to call the getAllMessages method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function getAllMessages
description: >-
Retrieve messages across all channels in a team, including text, audio,
and video conversations. To learn more about how to use the Microsoft
Teams export APIs to export content, see Export content with the
Microsoft Teams export APIs.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-getallmessages?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.getAllMessages
parameters:
- name: model
in: query
description: The payment model for the API
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/getAllMessages()
- /users/{user-id}/joinedTeams/getAllMessages()
/users/{user-id}/joinedTeams/{team-id}/channels/getAllRetainedMessages():
description: Provides operations to call the getAllRetainedMessages method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function getAllRetainedMessages
description: >-
Get all retained messages across all channels in a team. To learn more
about how to use the Microsoft Teams export APIs to export content, see
Export content with the Microsoft Teams export APIs.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-getallretainedmessages?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.channels.getAllRetainedMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/getAllRetainedMessages()
/users/{user-id}/joinedTeams/{team-id}/group:
description: >-
Provides operations to manage the group property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get group from users
operationId: users.joinedTeams.GetGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/group/serviceProvisioningErrors:
get:
tags:
- Users.team
summary: Microsoft Graph Get serviceProvisioningErrors property value
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).
operationId: users.joinedTeams.group.ListServiceProvisioningErrors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/group/serviceProvisioningErrors/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.group.ServiceProvisioningErrors.GetCount-989c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/incomingChannels:
description: >-
Provides operations to manage the incomingChannels property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get incomingChannels from users
description: List of channels shared with the team.
operationId: users.joinedTeams.ListIncomingChannels
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.channelCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/incomingChannels/{channel-id}:
description: >-
Provides operations to manage the incomingChannels property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get incomingChannels from users
description: List of channels shared with the team.
operationId: users.joinedTeams.GetIncomingChannels
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: channel-id
in: path
description: The unique identifier of channel
required: true
schema:
type: string
x-ms-docs-key-type: channel
/users/{user-id}/joinedTeams/{team-id}/incomingChannels/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.incomingChannels.GetCount-bf05
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/installedApps:
description: >-
Provides operations to manage the installedApps property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get installedApps from users
description: The apps installed in this team.
operationId: users.joinedTeams.ListInstalledApps
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.teamsAppInstallationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to installedApps for users
operationId: users.joinedTeams.CreateInstalledApps
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}:
description: >-
Provides operations to manage the installedApps property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get installedApps from users
description: The apps installed in this team.
operationId: users.joinedTeams.GetInstalledApps
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property installedApps in users
operationId: users.joinedTeams.UpdateInstalledApps
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property installedApps for users
operationId: users.joinedTeams.DeleteInstalledApps
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/upgrade:
description: Provides operations to call the upgrade method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action upgrade
description: Upgrade an app installation within a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chat-teamsappinstallation-upgrade?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.installedApps.teamsAppInstallation.upgrade
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
consentedPermissionSet:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamsAppPermissionSet
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/upgrade
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get teamsApp from users
description: The app that is installed.
operationId: users.joinedTeams.installedApps.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsApp
- >-
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}/teamsApp
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition:
description: >-
Provides operations to manage the teamsAppDefinition property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get teamsAppDefinition from users
description: The details of this version of the app.
operationId: users.joinedTeams.installedApps.GetTeamsAppDefinition
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamsAppInstallation-id
in: path
description: The unique identifier of teamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition
- >-
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}/teamsAppDefinition
/users/{user-id}/joinedTeams/{team-id}/installedApps/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.installedApps.GetCount-1148
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: Members and owners of the team.
operationId: users.joinedTeams.ListMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to members for users
operationId: users.joinedTeams.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/members/{conversationMember-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: Members and owners of the team.
operationId: users.joinedTeams.GetMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property members in users
operationId: users.joinedTeams.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property members for users
operationId: users.joinedTeams.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
/users/{user-id}/joinedTeams/{team-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.members.GetCount-5648
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/members/add:
description: Provides operations to call the add method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action add
description: >-
Add multiple members in a single request to a team. The response
provides details about which memberships could and couldn't be created.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmembers-add?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.members.add
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/add
- /users/{user-id}/followedSites/add
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/add
/users/{user-id}/joinedTeams/{team-id}/members/remove:
description: Provides operations to call the remove method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action remove
description: >-
Remove multiple members from a team in a single request. The response
provides details about which memberships could and couldn't be removed.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmember-remove?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.members.remove
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/remove
- /users/{user-id}/followedSites/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/remove
/users/{user-id}/joinedTeams/{team-id}/archive:
description: Provides operations to call the archive method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action archive
description: "Archive the specified team. \r\nWhen a team is archived, users can no longer make most changes to the team. For example, users can no longer: send or like messages on any channel in the team; edit the team's name or description; nor edit other settings. However, membership changes to the team are still allowed. Archiving is an async operation. A team is archived once the async operation completes successfully, which might occur subsequent to a response from this API. To archive a team, the team and group must have an owner. To restore a team from its archived state, use the API to unarchive."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/team-archive?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.archive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
shouldSetSpoSiteReadOnlyForMembers:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/archive
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/archive
/users/{user-id}/joinedTeams/{team-id}/clone:
description: Provides operations to call the clone method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action clone
description: "Create a copy of a team. This operation also creates a copy of the corresponding group.\r\nYou can specify which parts of the team to clone: When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen. \r\nIf the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured. Cloning is a long-running operation. After the POST clone returns, you need to GET the operation returned by the Location: header to see if it's running, succeeded, or failed. You should continue to GET until the status isn't running. The recommended delay between GETs is 5 seconds."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/team-clone?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.clone
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
displayName:
type: string
nullable: true
description:
type: string
nullable: true
mailNickname:
type: string
nullable: true
classification:
type: string
nullable: true
visibility:
$ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
partsToClone:
$ref: '#/components/schemas/microsoft.graph.clonableTeamParts'
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/completeMigration:
description: Provides operations to call the completeMigration method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action completeMigration
description: >-
Complete the message migration process by removing migration mode from a
team. Migration mode is a special state where certain operations are
barred, like message POST and membership operations during the data
migration process. After a completeMigration request is made, you can't
import additional messages into the team. You can add members to the
team after the request returns a successful response.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/team-completemigration?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.completeMigration
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/completeMigration
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/completeMigration
/users/{user-id}/joinedTeams/{team-id}/sendActivityNotification:
description: Provides operations to call the sendActivityNotification method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action sendActivityNotification
description: "Send an activity feed notification in the scope of a team. For more information about sending notifications and the requirements for doing so, see\r\nsending Teams activity notifications."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/team-sendactivitynotification?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.sendActivityNotification
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
topic:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkActivityTopic
- type: object
nullable: true
activityType:
type: string
nullable: true
chainId:
type: number
format: int64
nullable: true
previewText:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
teamsAppId:
type: string
nullable: true
templateParameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValuePair'
recipient:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkNotificationRecipient
- type: object
nullable: true
iconId:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/sendActivityNotification
- /users/{user-id}/teamwork/sendActivityNotification
/users/{user-id}/joinedTeams/{team-id}/unarchive:
description: Provides operations to call the unarchive method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action unarchive
description: >-
Restore an archived team. This API restores users' ability to send
messages and edit the team, abiding by tenant and team settings. A Team
is archived using the archive API. Unarchiving is an async operation. A
team is unarchived once the async operation completes successfully,
which might occur subsequent to a response from this API.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/team-unarchive?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.unarchive
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/unarchive
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/unarchive
/users/{user-id}/joinedTeams/{team-id}/operations:
description: >-
Provides operations to manage the operations property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get operations from users
description: The async operations that ran or are running on this team.
operationId: users.joinedTeams.ListOperations
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.teamsAsyncOperationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to operations for users
operationId: users.joinedTeams.CreateOperations
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/operations/{teamsAsyncOperation-id}:
description: >-
Provides operations to manage the operations property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get operations from users
description: The async operations that ran or are running on this team.
operationId: users.joinedTeams.GetOperations
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property operations in users
operationId: users.joinedTeams.UpdateOperations
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property operations for users
operationId: users.joinedTeams.DeleteOperations
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamsAsyncOperation-id
in: path
description: The unique identifier of teamsAsyncOperation
required: true
schema:
type: string
x-ms-docs-key-type: teamsAsyncOperation
/users/{user-id}/joinedTeams/{team-id}/operations/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.operations.GetCount-5268
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/permissionGrants:
description: >-
Provides operations to manage the permissionGrants property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get permissionGrants from users
description: A collection of permissions granted to apps to access the team.
operationId: users.joinedTeams.ListPermissionGrants
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.resourceSpecificPermissionGrantCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to permissionGrants for users
operationId: users.joinedTeams.CreatePermissionGrants
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/permissionGrants/{resourceSpecificPermissionGrant-id}:
description: >-
Provides operations to manage the permissionGrants property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get permissionGrants from users
description: A collection of permissions granted to apps to access the team.
operationId: users.joinedTeams.GetPermissionGrants
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property permissionGrants in users
operationId: users.joinedTeams.UpdatePermissionGrants
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property permissionGrants for users
operationId: users.joinedTeams.DeletePermissionGrants
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: resourceSpecificPermissionGrant-id
in: path
description: The unique identifier of resourceSpecificPermissionGrant
required: true
schema:
type: string
x-ms-docs-key-type: resourceSpecificPermissionGrant
/users/{user-id}/joinedTeams/{team-id}/permissionGrants/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.permissionGrants.GetCount-70b8
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/photo:
description: >-
Provides operations to manage the photo property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get photo from users
description: The profile photo for the team.
operationId: users.joinedTeams.GetPhoto
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property photo in users
operationId: users.joinedTeams.UpdatePhoto
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/photo/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get media content for the navigation property photo from users
description: The profile photo for the team.
operationId: users.joinedTeams.GetPhotoContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.team
summary: Microsoft Graph Update media content for the navigation property photo in users
description: The profile photo for the team.
operationId: users.joinedTeams.UpdatePhotoContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.team
summary: Microsoft Graph Delete media content for the navigation property photo in users
description: The profile photo for the team.
operationId: users.joinedTeams.DeletePhotoContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel:
description: >-
Provides operations to manage the primaryChannel property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get primaryChannel from users
description: The general channel for the team.
operationId: users.joinedTeams.GetPrimaryChannel
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property primaryChannel in users
operationId: users.joinedTeams.UpdatePrimaryChannel
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channel'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property primaryChannel for users
operationId: users.joinedTeams.DeletePrimaryChannel
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers:
description: >-
Provides operations to manage the allMembers property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allMembers from users
description: >-
A collection of membership records associated with the channel,
including both direct and indirect members of shared channels.
operationId: users.joinedTeams.primaryChannel.ListAllMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to allMembers for users
operationId: users.joinedTeams.primaryChannel.CreateAllMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/{conversationMember-id}:
description: >-
Provides operations to manage the allMembers property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allMembers from users
description: >-
A collection of membership records associated with the channel,
including both direct and indirect members of shared channels.
operationId: users.joinedTeams.primaryChannel.GetAllMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property allMembers in users
operationId: users.joinedTeams.primaryChannel.UpdateAllMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property allMembers for users
operationId: users.joinedTeams.primaryChannel.DeleteAllMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/{conversationMember-id}
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.primaryChannel.allMembers.GetCount-6630
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/add:
description: Provides operations to call the add method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action add
description: >-
Add multiple members in a single request to a team. The response
provides details about which memberships could and couldn't be created.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmembers-add?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.allMembers.add
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/add
- /users/{user-id}/followedSites/add
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/add
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/remove:
description: Provides operations to call the remove method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action remove
description: >-
Remove multiple members from a team in a single request. The response
provides details about which memberships could and couldn't be removed.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmember-remove?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.allMembers.remove
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/remove
- /users/{user-id}/followedSites/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/remove
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/filesFolder:
description: >-
Provides operations to manage the filesFolder property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get filesFolder from users
description: Metadata for the location where the channel's files are stored.
operationId: users.joinedTeams.primaryChannel.GetFilesFolder
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/filesFolder
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/filesFolder/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get content for the navigation property filesFolder from users
description: The content stream, if the item represents a file.
operationId: users.joinedTeams.primaryChannel.GetFilesFolderContent
parameters:
- name: $format
in: query
description: Format of the content
schema:
type: string
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.team
summary: Microsoft Graph Update content for the navigation property filesFolder in users
description: The content stream, if the item represents a file.
operationId: users.joinedTeams.primaryChannel.UpdateFilesFolderContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.team
summary: Microsoft Graph Delete content for the navigation property filesFolder in users
description: The content stream, if the item represents a file.
operationId: users.joinedTeams.primaryChannel.DeleteFilesFolderContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: A collection of membership records associated with the channel.
operationId: users.joinedTeams.primaryChannel.ListMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to members for users
operationId: users.joinedTeams.primaryChannel.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/{conversationMember-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: A collection of membership records associated with the channel.
operationId: users.joinedTeams.primaryChannel.GetMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property members in users
operationId: users.joinedTeams.primaryChannel.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property members for users
operationId: users.joinedTeams.primaryChannel.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/{conversationMember-id}
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.primaryChannel.members.GetCount-719e
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/add:
description: Provides operations to call the add method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action add
description: >-
Add multiple members in a single request to a team. The response
provides details about which memberships could and couldn't be created.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmembers-add?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.members.add
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/add
- /users/{user-id}/followedSites/add
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/add
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/members/add
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/add
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/members/remove:
description: Provides operations to call the remove method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action remove
description: >-
Remove multiple members from a team in a single request. The response
provides details about which memberships could and couldn't be removed.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/conversationmember-remove?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.members.remove
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.actionResultPart
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/members/remove
- /users/{user-id}/followedSites/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/allMembers/remove
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/members/remove
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/allMembers/remove
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get messages from users
description: >-
A collection of all the messages in the channel. A navigation property.
Nullable.
operationId: users.joinedTeams.primaryChannel.ListMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.chatMessageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to messages for users
operationId: users.joinedTeams.primaryChannel.CreateMessages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get messages from users
description: >-
A collection of all the messages in the channel. A navigation property.
Nullable.
operationId: users.joinedTeams.primaryChannel.GetMessages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property messages in users
operationId: users.joinedTeams.primaryChannel.UpdateMessages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property messages for users
operationId: users.joinedTeams.primaryChannel.DeleteMessages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents:
description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.primaryChannel.messages.ListHostedContents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.chatMessageHostedContentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to hostedContents for users
operationId: users.joinedTeams.primaryChannel.messages.CreateHostedContents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
? /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
: description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.primaryChannel.messages.GetHostedContents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property hostedContents in users
operationId: users.joinedTeams.primaryChannel.messages.UpdateHostedContents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property hostedContents for users
operationId: users.joinedTeams.primaryChannel.messages.DeleteHostedContents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
? /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}/$value
: description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get media content for the navigation property hostedContents from users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.primaryChannel.messages.GetHostedContentsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.team
summary: Microsoft Graph Update media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.primaryChannel.messages.UpdateHostedContentsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.team
summary: Microsoft Graph Delete media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: users.joinedTeams.primaryChannel.messages.DeleteHostedContentsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.primaryChannel.messages.hostedContents.GetCount-98f7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/setReaction:
description: Provides operations to call the setReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action setReaction
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.setReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/softDelete:
description: Provides operations to call the softDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action softDelete
description: >-
Delete a single chatMessage or a chat message reply in a channel or a
chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-softdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.softDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/undoSoftDelete:
description: Provides operations to call the undoSoftDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action undoSoftDelete
description: >-
Undo soft deletion of a single chatMessage or a chat message reply in a
channel or a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-undosoftdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.undoSoftDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/unsetReaction:
description: Provides operations to call the unsetReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action unsetReaction
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.unsetReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies:
description: >-
Provides operations to manage the replies property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get replies from users
description: Replies for a specified message. Supports $expand for channel messages.
operationId: users.joinedTeams.primaryChannel.messages.ListReplies
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.chatMessageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to replies for users
operationId: users.joinedTeams.primaryChannel.messages.CreateReplies
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}:
description: >-
Provides operations to manage the replies property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get replies from users
description: Replies for a specified message. Supports $expand for channel messages.
operationId: users.joinedTeams.primaryChannel.messages.GetReplies
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property replies in users
operationId: users.joinedTeams.primaryChannel.messages.UpdateReplies
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property replies for users
operationId: users.joinedTeams.primaryChannel.messages.DeleteReplies
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents:
description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.primaryChannel.messages.replies.ListHostedContents
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.chatMessageHostedContentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to hostedContents for users
operationId: users.joinedTeams.primaryChannel.messages.replies.CreateHostedContents
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents
? /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
: description: >-
Provides operations to manage the hostedContents property of the
microsoft.graph.chatMessage entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get hostedContents from users
description: >-
Content in a message hosted by Microsoft Teams - for example, images or
code snippets.
operationId: users.joinedTeams.primaryChannel.messages.replies.GetHostedContents
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property hostedContents in users
operationId: users.joinedTeams.primaryChannel.messages.replies.UpdateHostedContents
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property hostedContents for users
operationId: users.joinedTeams.primaryChannel.messages.replies.DeleteHostedContents
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}
? /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}/$value
: description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get media content for the navigation property hostedContents from users
description: The unique identifier for an entity. Read-only.
operationId: >-
users.joinedTeams.primaryChannel.messages.replies.GetHostedContentsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.team
summary: Microsoft Graph Update media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: >-
users.joinedTeams.primaryChannel.messages.replies.UpdateHostedContentsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.team
summary: Microsoft Graph Delete media content for the navigation property hostedContents in users
description: The unique identifier for an entity. Read-only.
operationId: >-
users.joinedTeams.primaryChannel.messages.replies.DeleteHostedContentsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessageHostedContent-id
in: path
description: The unique identifier of chatMessageHostedContent
required: true
schema:
type: string
x-ms-docs-key-type: chatMessageHostedContent
? /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/$count
: description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: >-
users.joinedTeams.primaryChannel.messages.replies.hostedContents.GetCount-f576
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction:
description: Provides operations to call the setReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action setReaction
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.replies.chatMessage.setReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/setReaction
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete:
description: Provides operations to call the softDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action softDelete
description: >-
Delete a single chatMessage or a chat message reply in a channel or a
chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-softdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.replies.chatMessage.softDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/softDelete
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete:
description: Provides operations to call the undoSoftDelete method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action undoSoftDelete
description: >-
Undo soft deletion of a single chatMessage or a chat message reply in a
channel or a chat.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-undosoftdelete?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.replies.chatMessage.undoSoftDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/undoSoftDelete
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction:
description: Provides operations to call the unsetReaction method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action unsetReaction
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.replies.chatMessage.unsetReaction
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
reactionType:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
- name: chatMessage-id1
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/unsetReaction
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.primaryChannel.messages.replies.GetCount-5af6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function delta
description: >-
Get the list of messages from all chats in which a user is a
participant, including one-on-one chats, group chats, and meeting chats.
When you use delta query, you can get new or updated messages. To get
the replies for a message, use the list message replies or the get
message reply operations. A GET request with the delta function returns
one of the following: State tokens are opaque to the client. To proceed
with a round of change tracking, copy and apply the @odata.nextLink or
@odata.deltaLink URL returned from the last GET request to the next
delta function call. An @odata.deltaLink returned in a response
signifies that the current round of change tracking is complete. You can
save and use the @odata.deltaLink URL when you begin to retrieve more
changes (messages changed or posted after you acquire @odata.deltaLink).
For more information, see the delta query documentation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-delta?view=graph-rest-1.0
operationId: >-
users.user.joinedTeams.team.primaryChannel.messages.chatMessage.replies.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: chatMessage-id
in: path
description: The unique identifier of chatMessage
required: true
schema:
type: string
x-ms-docs-key-type: chatMessage
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.primaryChannel.messages.GetCount-08f5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function delta
description: >-
Get the list of messages from all chats in which a user is a
participant, including one-on-one chats, group chats, and meeting chats.
When you use delta query, you can get new or updated messages. To get
the replies for a message, use the list message replies or the get
message reply operations. A GET request with the delta function returns
one of the following: State tokens are opaque to the client. To proceed
with a round of change tracking, copy and apply the @odata.nextLink or
@odata.deltaLink URL returned from the last GET request to the next
delta function call. An @odata.deltaLink returned in a response
signifies that the current round of change tracking is complete. You can
save and use the @odata.deltaLink URL when you begin to retrieve more
changes (messages changed or posted after you acquire @odata.deltaLink).
For more information, see the delta query documentation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/chatmessage-delta?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.messages.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/archive:
description: Provides operations to call the archive method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action archive
description: >-
Archive a channel in a team. When a channel is archived, users can't
send new messages or react to existing messages in the channel, edit the
channel settings, or make other changes to the channel. You can delete
an archived channel or add and remove members from it. If you archive a
team, its channels are also archived. Archiving is an asynchronous
operation; a channel is archived after the asynchronous archiving
operation completes successfully, which might occur after the response
returns. A channel without an owner or that belongs to a group that has
no owner, can't be archived. To restore a channel from its archived
state, use the channel: unarchive method. A channel can’t be archived or
unarchived if its team is archived.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-archive?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.archive
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
shouldSetSpoSiteReadOnlyForMembers:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/archive
- /users/{user-id}/joinedTeams/{team-id}/archive
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/completeMigration:
description: Provides operations to call the completeMigration method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action completeMigration
description: >-
Complete the message migration process by removing migration mode from a
channel in a team. Migration mode is a special state that prevents
certain operations, like sending messages and adding members, during the
data migration process. After a completeMigration request is made, you
can't import additional messages into the team. You can add members to
the team after the request returns a successful response.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-completemigration?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.completeMigration
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/completeMigration
- /users/{user-id}/joinedTeams/{team-id}/completeMigration
? /users/{user-id}/joinedTeams/{team-id}/primaryChannel/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')
: description: Provides operations to call the doesUserHaveAccess method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function doesUserHaveAccess
description: Determine whether a user has access to a channel.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-doesuserhaveaccess?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.doesUserHaveAccess
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: boolean
default: false
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: userId
in: query
description: 'Usage: userId=''@userId'''
schema:
type: string
nullable: true
- name: tenantId
in: query
description: 'Usage: tenantId=''@tenantId'''
schema:
type: string
nullable: true
- name: userPrincipalName
in: query
description: 'Usage: userPrincipalName=''@userPrincipalName'''
schema:
type: string
nullable: true
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/provisionEmail:
description: Provides operations to call the provisionEmail method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action provisionEmail
description: >-
Provision an email address for a channel. Microsoft Teams doesn't
automatically provision an email address for a channel by default. To
have Teams provision an email address, you can call provisionEmail, or
through the Teams user interface, select Get email address, which
triggers Teams to generate an email address if it has not already
provisioned one. To remove the email address of a channel, use the
removeEmail method.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-provisionemail?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.provisionEmail
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.provisionChannelEmailResult
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/provisionEmail
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/removeEmail:
description: Provides operations to call the removeEmail method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action removeEmail
description: >-
Remove the email address of a channel. You can remove an email address
only if it was provisioned using the provisionEmail method or through
the Microsoft Teams client.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-removeemail?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.removeEmail
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/removeEmail
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/unarchive:
description: Provides operations to call the unarchive method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action unarchive
description: >-
Restore an archived channel. Unarchiving restores the ability for users
to send messages and edit the channel. Channels are archived via the
channel: archive method. Unarchiving is an asynchronous operation; a
channel is unarchived when the asynchronous unarchiving operation
completes successfully, which might occur after this method responds.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/channel-unarchive?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.primaryChannel.unarchive
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/unarchive
- /users/{user-id}/joinedTeams/{team-id}/unarchive
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams:
description: >-
Provides operations to manage the sharedWithTeams property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get sharedWithTeams from users
description: A collection of teams with which a channel is shared.
operationId: users.joinedTeams.primaryChannel.ListSharedWithTeams
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sharedWithChannelTeamInfoCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to sharedWithTeams for users
operationId: users.joinedTeams.primaryChannel.CreateSharedWithTeams
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}:
description: >-
Provides operations to manage the sharedWithTeams property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get sharedWithTeams from users
description: A collection of teams with which a channel is shared.
operationId: users.joinedTeams.primaryChannel.GetSharedWithTeams
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property sharedWithTeams in users
operationId: users.joinedTeams.primaryChannel.UpdateSharedWithTeams
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property sharedWithTeams for users
operationId: users.joinedTeams.primaryChannel.DeleteSharedWithTeams
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers:
description: >-
Provides operations to manage the allowedMembers property of the
microsoft.graph.sharedWithChannelTeamInfo entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allowedMembers from users
description: A collection of team members who have access to the shared channel.
operationId: users.joinedTeams.primaryChannel.sharedWithTeams.ListAllowedMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.conversationMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers
? /users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers/{conversationMember-id}
: description: >-
Provides operations to manage the allowedMembers property of the
microsoft.graph.sharedWithChannelTeamInfo entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get allowedMembers from users
description: A collection of team members who have access to the shared channel.
operationId: users.joinedTeams.primaryChannel.sharedWithTeams.GetAllowedMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
- name: conversationMember-id
in: path
description: The unique identifier of conversationMember
required: true
schema:
type: string
x-ms-docs-key-type: conversationMember
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers/{conversationMember-id}
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/allowedMembers/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: >-
users.joinedTeams.primaryChannel.sharedWithTeams.allowedMembers.GetCount-3d16
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/team:
description: >-
Provides operations to manage the team property of the
microsoft.graph.teamInfo entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get team from users
operationId: users.joinedTeams.primaryChannel.sharedWithTeams.GetTeam
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: sharedWithChannelTeamInfo-id
in: path
description: The unique identifier of sharedWithChannelTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: sharedWithChannelTeamInfo
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/team
- /users/{user-id}/teamwork/associatedTeams/{associatedTeamInfo-id}/team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.primaryChannel.sharedWithTeams.GetCount-d3ab
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs:
description: >-
Provides operations to manage the tabs property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get tabs from users
description: A collection of all the tabs in the channel. A navigation property.
operationId: users.joinedTeams.primaryChannel.ListTabs
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.teamsTabCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to tabs for users
operationId: users.joinedTeams.primaryChannel.CreateTabs
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
x-ms-docs-grouped-path:
- /users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs/{teamsTab-id}:
description: >-
Provides operations to manage the tabs property of the
microsoft.graph.channel entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get tabs from users
description: A collection of all the tabs in the channel. A navigation property.
operationId: users.joinedTeams.primaryChannel.GetTabs
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property tabs in users
operationId: users.joinedTeams.primaryChannel.UpdateTabs
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property tabs for users
operationId: users.joinedTeams.primaryChannel.DeleteTabs
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs/{teamsTab-id}
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs/{teamsTab-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsTab entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get teamsApp from users
description: >-
The application that is linked to the tab. This can't be changed after
tab creation.
operationId: users.joinedTeams.primaryChannel.tabs.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamsTab-id
in: path
description: The unique identifier of teamsTab
required: true
schema:
type: string
x-ms-docs-key-type: teamsTab
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/tabs/{teamsTab-id}/teamsApp
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/tabs/{teamsTab-id}/teamsApp
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/tabs/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.primaryChannel.tabs.GetCount-86f9
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule:
description: >-
Provides operations to manage the schedule property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get schedule from users
description: The schedule of shifts for this team.
operationId: users.joinedTeams.GetSchedule
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property schedule in users
operationId: users.joinedTeams.SetSchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property schedule for users
operationId: users.joinedTeams.DeleteSchedule
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/dayNotes:
description: >-
Provides operations to manage the dayNotes property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get dayNotes from users
description: The day notes in the schedule.
operationId: users.joinedTeams.schedule.ListDayNotes
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.dayNoteCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to dayNotes for users
operationId: users.joinedTeams.schedule.CreateDayNotes
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dayNote'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dayNote'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/dayNotes/{dayNote-id}:
description: >-
Provides operations to manage the dayNotes property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get dayNotes from users
description: The day notes in the schedule.
operationId: users.joinedTeams.schedule.GetDayNotes
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dayNote'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property dayNotes in users
operationId: users.joinedTeams.schedule.UpdateDayNotes
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dayNote'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dayNote'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property dayNotes for users
operationId: users.joinedTeams.schedule.DeleteDayNotes
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: dayNote-id
in: path
description: The unique identifier of dayNote
required: true
schema:
type: string
x-ms-docs-key-type: dayNote
/users/{user-id}/joinedTeams/{team-id}/schedule/dayNotes/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.dayNotes.GetCount-282c
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/share:
description: Provides operations to call the share method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action share
description: >-
Share a schedule time range with schedule members. This action makes the
collections of shift, openshift and timeOff items in the specified time
range of the schedule viewable by the specified team members, including
employees and managers. Each shift, openshift and timeOff instance in a
schedule supports a draft version and a shared version of the item. The
draft version is viewable by only managers, and the shared version is
viewable by employees and managers. For each shift, openshift and
timeOff instance in the specified time range, the share action updates
the shared version from the draft version, so that in addition to
managers, employees can also view the most current information about the
item. The notifyTeam parameter further specifies which employees can
view the item.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/schedule-share?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.schedule.share
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
notifyTeam:
type: boolean
default: false
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
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
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/offerShiftRequests:
description: >-
Provides operations to manage the offerShiftRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get offerShiftRequests from users
description: The offer requests for shifts in the schedule.
operationId: users.joinedTeams.schedule.ListOfferShiftRequests
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.offerShiftRequestCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to offerShiftRequests for users
operationId: users.joinedTeams.schedule.CreateOfferShiftRequests
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/offerShiftRequests/{offerShiftRequest-id}:
description: >-
Provides operations to manage the offerShiftRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get offerShiftRequests from users
description: The offer requests for shifts in the schedule.
operationId: users.joinedTeams.schedule.GetOfferShiftRequests
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property offerShiftRequests in users
operationId: users.joinedTeams.schedule.UpdateOfferShiftRequests
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property offerShiftRequests for users
operationId: users.joinedTeams.schedule.DeleteOfferShiftRequests
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: offerShiftRequest-id
in: path
description: The unique identifier of offerShiftRequest
required: true
schema:
type: string
x-ms-docs-key-type: offerShiftRequest
/users/{user-id}/joinedTeams/{team-id}/schedule/offerShiftRequests/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.offerShiftRequests.GetCount-b933
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/openShiftChangeRequests:
description: >-
Provides operations to manage the openShiftChangeRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get openShiftChangeRequests from users
description: The open shift requests in the schedule.
operationId: users.joinedTeams.schedule.ListOpenShiftChangeRequests
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.openShiftChangeRequestCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to openShiftChangeRequests for users
operationId: users.joinedTeams.schedule.CreateOpenShiftChangeRequests
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/openShiftChangeRequests/{openShiftChangeRequest-id}:
description: >-
Provides operations to manage the openShiftChangeRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get openShiftChangeRequests from users
description: The open shift requests in the schedule.
operationId: users.joinedTeams.schedule.GetOpenShiftChangeRequests
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property openShiftChangeRequests in users
operationId: users.joinedTeams.schedule.UpdateOpenShiftChangeRequests
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property openShiftChangeRequests for users
operationId: users.joinedTeams.schedule.DeleteOpenShiftChangeRequests
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: openShiftChangeRequest-id
in: path
description: The unique identifier of openShiftChangeRequest
required: true
schema:
type: string
x-ms-docs-key-type: openShiftChangeRequest
/users/{user-id}/joinedTeams/{team-id}/schedule/openShiftChangeRequests/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.openShiftChangeRequests.GetCount-270a
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/openShifts:
description: >-
Provides operations to manage the openShifts property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get openShifts from users
description: The set of open shifts in a scheduling group in the schedule.
operationId: users.joinedTeams.schedule.ListOpenShifts
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.openShiftCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to openShifts for users
operationId: users.joinedTeams.schedule.CreateOpenShifts
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShift'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShift'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/openShifts/{openShift-id}:
description: >-
Provides operations to manage the openShifts property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get openShifts from users
description: The set of open shifts in a scheduling group in the schedule.
operationId: users.joinedTeams.schedule.GetOpenShifts
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShift'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property openShifts in users
operationId: users.joinedTeams.schedule.UpdateOpenShifts
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShift'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShift'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property openShifts for users
operationId: users.joinedTeams.schedule.DeleteOpenShifts
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: openShift-id
in: path
description: The unique identifier of openShift
required: true
schema:
type: string
x-ms-docs-key-type: openShift
/users/{user-id}/joinedTeams/{team-id}/schedule/openShifts/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.openShifts.GetCount-785e
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/schedulingGroups:
description: >-
Provides operations to manage the schedulingGroups property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get schedulingGroups from users
description: The logical grouping of users in the schedule (usually by role).
operationId: users.joinedTeams.schedule.ListSchedulingGroups
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.schedulingGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to schedulingGroups for users
operationId: users.joinedTeams.schedule.CreateSchedulingGroups
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/schedulingGroups/{schedulingGroup-id}:
description: >-
Provides operations to manage the schedulingGroups property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get schedulingGroups from users
description: The logical grouping of users in the schedule (usually by role).
operationId: users.joinedTeams.schedule.GetSchedulingGroups
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property schedulingGroups in users
operationId: users.joinedTeams.schedule.UpdateSchedulingGroups
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property schedulingGroups for users
operationId: users.joinedTeams.schedule.DeleteSchedulingGroups
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: schedulingGroup-id
in: path
description: The unique identifier of schedulingGroup
required: true
schema:
type: string
x-ms-docs-key-type: schedulingGroup
/users/{user-id}/joinedTeams/{team-id}/schedule/schedulingGroups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.schedulingGroups.GetCount-b253
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/shifts:
description: >-
Provides operations to manage the shifts property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get shifts from users
description: The shifts in the schedule.
operationId: users.joinedTeams.schedule.ListShifts
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.shiftCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to shifts for users
operationId: users.joinedTeams.schedule.CreateShifts
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shift'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shift'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/shifts/{shift-id}:
description: >-
Provides operations to manage the shifts property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get shifts from users
description: The shifts in the schedule.
operationId: users.joinedTeams.schedule.GetShifts
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shift'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property shifts in users
operationId: users.joinedTeams.schedule.UpdateShifts
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shift'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shift'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property shifts for users
operationId: users.joinedTeams.schedule.DeleteShifts
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: shift-id
in: path
description: The unique identifier of shift
required: true
schema:
type: string
x-ms-docs-key-type: shift
/users/{user-id}/joinedTeams/{team-id}/schedule/shifts/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.shifts.GetCount-6a1a
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/swapShiftsChangeRequests:
description: >-
Provides operations to manage the swapShiftsChangeRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get swapShiftsChangeRequests from users
description: The swap requests for shifts in the schedule.
operationId: users.joinedTeams.schedule.ListSwapShiftsChangeRequests
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.swapShiftsChangeRequestCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to swapShiftsChangeRequests for users
operationId: users.joinedTeams.schedule.CreateSwapShiftsChangeRequests
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/swapShiftsChangeRequests/{swapShiftsChangeRequest-id}:
description: >-
Provides operations to manage the swapShiftsChangeRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get swapShiftsChangeRequests from users
description: The swap requests for shifts in the schedule.
operationId: users.joinedTeams.schedule.GetSwapShiftsChangeRequests
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property swapShiftsChangeRequests in users
operationId: users.joinedTeams.schedule.UpdateSwapShiftsChangeRequests
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property swapShiftsChangeRequests for users
operationId: users.joinedTeams.schedule.DeleteSwapShiftsChangeRequests
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: swapShiftsChangeRequest-id
in: path
description: The unique identifier of swapShiftsChangeRequest
required: true
schema:
type: string
x-ms-docs-key-type: swapShiftsChangeRequest
/users/{user-id}/joinedTeams/{team-id}/schedule/swapShiftsChangeRequests/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.swapShiftsChangeRequests.GetCount-b5f7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards:
description: >-
Provides operations to manage the timeCards property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timeCards from users
description: The time cards in the schedule.
operationId: users.joinedTeams.schedule.ListTimeCards
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.timeCardCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to timeCards for users
operationId: users.joinedTeams.schedule.CreateTimeCards
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeCard'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeCard'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards/{timeCard-id}:
description: >-
Provides operations to manage the timeCards property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timeCards from users
description: The time cards in the schedule.
operationId: users.joinedTeams.schedule.GetTimeCards
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeCard'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property timeCards in users
operationId: users.joinedTeams.schedule.UpdateTimeCards
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeCard'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeCard'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property timeCards for users
operationId: users.joinedTeams.schedule.DeleteTimeCards
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeCard-id
in: path
description: The unique identifier of timeCard
required: true
schema:
type: string
x-ms-docs-key-type: timeCard
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards/{timeCard-id}/clockOut:
description: Provides operations to call the clockOut method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action clockOut
operationId: users.user.joinedTeams.team.schedule.timeCards.timeCard.clockOut
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isAtApprovedLocation:
type: boolean
default: false
nullable: true
notes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCard'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeCard-id
in: path
description: The unique identifier of timeCard
required: true
schema:
type: string
x-ms-docs-key-type: timeCard
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards/{timeCard-id}/confirm:
description: Provides operations to call the confirm method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action confirm
description: Confirm a timeCard.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/timecard-confirm?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.schedule.timeCards.timeCard.confirm
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCard'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeCard-id
in: path
description: The unique identifier of timeCard
required: true
schema:
type: string
x-ms-docs-key-type: timeCard
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards/{timeCard-id}/endBreak:
description: Provides operations to call the endBreak method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action endBreak
operationId: users.user.joinedTeams.team.schedule.timeCards.timeCard.endBreak
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isAtApprovedLocation:
type: boolean
default: false
nullable: true
notes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCard'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeCard-id
in: path
description: The unique identifier of timeCard
required: true
schema:
type: string
x-ms-docs-key-type: timeCard
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards/{timeCard-id}/startBreak:
description: Provides operations to call the startBreak method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action startBreak
operationId: users.user.joinedTeams.team.schedule.timeCards.timeCard.startBreak
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isAtApprovedLocation:
type: boolean
default: false
nullable: true
notes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCard'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeCard-id
in: path
description: The unique identifier of timeCard
required: true
schema:
type: string
x-ms-docs-key-type: timeCard
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.timeCards.GetCount-4f50
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timeCards/clockIn:
description: Provides operations to call the clockIn method.
post:
tags:
- Users.team
summary: Microsoft Graph Invoke action clockIn
description: Clock in to start a timeCard.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/timecard-clockin?view=graph-rest-1.0
operationId: users.user.joinedTeams.team.schedule.timeCards.clockIn
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isAtApprovedLocation:
type: boolean
default: false
nullable: true
onBehalfOfUserId:
type: string
nullable: true
notes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCard'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timeOffReasons:
description: >-
Provides operations to manage the timeOffReasons property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timeOffReasons from users
description: The set of reasons for a time off in the schedule.
operationId: users.joinedTeams.schedule.ListTimeOffReasons
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.timeOffReasonCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to timeOffReasons for users
operationId: users.joinedTeams.schedule.CreateTimeOffReasons
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timeOffReasons/{timeOffReason-id}:
description: >-
Provides operations to manage the timeOffReasons property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timeOffReasons from users
description: The set of reasons for a time off in the schedule.
operationId: users.joinedTeams.schedule.GetTimeOffReasons
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property timeOffReasons in users
operationId: users.joinedTeams.schedule.UpdateTimeOffReasons
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property timeOffReasons for users
operationId: users.joinedTeams.schedule.DeleteTimeOffReasons
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeOffReason-id
in: path
description: The unique identifier of timeOffReason
required: true
schema:
type: string
x-ms-docs-key-type: timeOffReason
/users/{user-id}/joinedTeams/{team-id}/schedule/timeOffReasons/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.timeOffReasons.GetCount-9789
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timeOffRequests:
description: >-
Provides operations to manage the timeOffRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timeOffRequests from users
description: The time off requests in the schedule.
operationId: users.joinedTeams.schedule.ListTimeOffRequests
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.timeOffRequestCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to timeOffRequests for users
operationId: users.joinedTeams.schedule.CreateTimeOffRequests
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timeOffRequests/{timeOffRequest-id}:
description: >-
Provides operations to manage the timeOffRequests property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timeOffRequests from users
description: The time off requests in the schedule.
operationId: users.joinedTeams.schedule.GetTimeOffRequests
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property timeOffRequests in users
operationId: users.joinedTeams.schedule.UpdateTimeOffRequests
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property timeOffRequests for users
operationId: users.joinedTeams.schedule.DeleteTimeOffRequests
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeOffRequest-id
in: path
description: The unique identifier of timeOffRequest
required: true
schema:
type: string
x-ms-docs-key-type: timeOffRequest
/users/{user-id}/joinedTeams/{team-id}/schedule/timeOffRequests/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.timeOffRequests.GetCount-c179
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timesOff:
description: >-
Provides operations to manage the timesOff property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timesOff from users
description: The instances of times off in the schedule.
operationId: users.joinedTeams.schedule.ListTimesOff
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.timeOffCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to timesOff for users
operationId: users.joinedTeams.schedule.CreateTimesOff
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOff'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOff'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/schedule/timesOff/{timeOff-id}:
description: >-
Provides operations to manage the timesOff property of the
microsoft.graph.schedule entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get timesOff from users
description: The instances of times off in the schedule.
operationId: users.joinedTeams.schedule.GetTimesOff
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOff'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property timesOff in users
operationId: users.joinedTeams.schedule.UpdateTimesOff
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOff'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOff'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property timesOff for users
operationId: users.joinedTeams.schedule.DeleteTimesOff
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: timeOff-id
in: path
description: The unique identifier of timeOff
required: true
schema:
type: string
x-ms-docs-key-type: timeOff
/users/{user-id}/joinedTeams/{team-id}/schedule/timesOff/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.schedule.timesOff.GetCount-1ead
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/tags:
description: >-
Provides operations to manage the tags property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get tags from users
description: The tags associated with the team.
operationId: users.joinedTeams.ListTags
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.teamworkTagCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to tags for users
operationId: users.joinedTeams.CreateTags
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/tags/{teamworkTag-id}:
description: >-
Provides operations to manage the tags property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get tags from users
description: The tags associated with the team.
operationId: users.joinedTeams.GetTags
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property tags in users
operationId: users.joinedTeams.UpdateTags
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property tags for users
operationId: users.joinedTeams.DeleteTags
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamworkTag-id
in: path
description: The unique identifier of teamworkTag
required: true
schema:
type: string
x-ms-docs-key-type: teamworkTag
/users/{user-id}/joinedTeams/{team-id}/tags/{teamworkTag-id}/members:
description: >-
Provides operations to manage the members property of the
microsoft.graph.teamworkTag entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: Users assigned to the tag.
operationId: users.joinedTeams.tags.ListMembers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.teamworkTagMemberCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.team
summary: Microsoft Graph Create new navigation property to members for users
operationId: users.joinedTeams.tags.CreateMembers
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamworkTag-id
in: path
description: The unique identifier of teamworkTag
required: true
schema:
type: string
x-ms-docs-key-type: teamworkTag
/users/{user-id}/joinedTeams/{team-id}/tags/{teamworkTag-id}/members/{teamworkTagMember-id}:
description: >-
Provides operations to manage the members property of the
microsoft.graph.teamworkTag entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get members from users
description: Users assigned to the tag.
operationId: users.joinedTeams.tags.GetMembers
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.team
summary: Microsoft Graph Update the navigation property members in users
operationId: users.joinedTeams.tags.UpdateMembers
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.team
summary: Microsoft Graph Delete navigation property members for users
operationId: users.joinedTeams.tags.DeleteMembers
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamworkTag-id
in: path
description: The unique identifier of teamworkTag
required: true
schema:
type: string
x-ms-docs-key-type: teamworkTag
- name: teamworkTagMember-id
in: path
description: The unique identifier of teamworkTagMember
required: true
schema:
type: string
x-ms-docs-key-type: teamworkTagMember
/users/{user-id}/joinedTeams/{team-id}/tags/{teamworkTag-id}/members/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.tags.members.GetCount-f8b7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
- name: teamworkTag-id
in: path
description: The unique identifier of teamworkTag
required: true
schema:
type: string
x-ms-docs-key-type: teamworkTag
/users/{user-id}/joinedTeams/{team-id}/tags/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.tags.GetCount-7511
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/{team-id}/template:
description: >-
Provides operations to manage the template property of the
microsoft.graph.team entity.
get:
tags:
- Users.team
summary: Microsoft Graph Get template from users
description: The template this team was created from. See available templates.
operationId: users.joinedTeams.GetTemplate
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTemplate'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: team-id
in: path
description: The unique identifier of team
required: true
schema:
type: string
x-ms-docs-key-type: team
/users/{user-id}/joinedTeams/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.team
summary: Microsoft Graph Get the number of the resource
operationId: users.joinedTeams.GetCount-0d57
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/joinedTeams/getAllMessages():
description: Provides operations to call the getAllMessages method.
get:
tags:
- Users.team
summary: Microsoft Graph Invoke function getAllMessages
operationId: users.user.joinedTeams.getAllMessages
parameters:
- name: model
in: query
description: The payment model for the API
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of chatMessage
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/chats/getAllMessages()
- /users/{user-id}/joinedTeams/{team-id}/channels/getAllMessages()
/users/{user-id}/licenseDetails:
description: >-
Provides operations to manage the licenseDetails property of the
microsoft.graph.user entity.
get:
tags:
- users.licenseDetails
summary: Microsoft Graph Get licenseDetails from users
description: A collection of this user's license details. Read-only.
operationId: users.ListLicenseDetails
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.licenseDetailsCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.licenseDetails
summary: Microsoft Graph Create new navigation property to licenseDetails for users
operationId: users.CreateLicenseDetails
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/licenseDetails/{licenseDetails-id}:
description: >-
Provides operations to manage the licenseDetails property of the
microsoft.graph.user entity.
get:
tags:
- users.licenseDetails
summary: Microsoft Graph Get licenseDetails from users
description: A collection of this user's license details. Read-only.
operationId: users.GetLicenseDetails
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.licenseDetails
summary: Microsoft Graph Update the navigation property licenseDetails in users
operationId: users.UpdateLicenseDetails
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.licenseDetails
summary: Microsoft Graph Delete navigation property licenseDetails for users
operationId: users.DeleteLicenseDetails
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: licenseDetails-id
in: path
description: The unique identifier of licenseDetails
required: true
schema:
type: string
x-ms-docs-key-type: licenseDetails
/users/{user-id}/licenseDetails/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.licenseDetails
summary: Microsoft Graph Get the number of the resource
operationId: users.licenseDetails.GetCount-a83d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/licenseDetails/getTeamsLicensingDetails():
description: Provides operations to call the getTeamsLicensingDetails method.
get:
tags:
- users.licenseDetails
summary: Microsoft Graph Invoke function getTeamsLicensingDetails
description: Get the license status of a user in Microsoft Teams.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/licensedetails-getteamslicensingdetails?view=graph-rest-1.0
operationId: users.user.licenseDetails.getTeamsLicensingDetails
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsLicensingDetails'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/mailboxSettings:
get:
tags:
- users.mailboxSettings
summary: Microsoft Graph Get mailboxSettings property value
description: >-
Settings for the primary mailbox of the signed-in user. You can get or
update settings for sending automatic replies to incoming messages,
locale, and time zone. Returned only on $select.
operationId: users.GetMailboxSettings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
patch:
tags:
- users.mailboxSettings
summary: Microsoft Graph Update property mailboxSettings value.
operationId: users.UpdateMailboxSettings
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/mailFolders:
description: >-
Provides operations to manage the mailFolders property of the
microsoft.graph.user entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get mailFolders from users
description: The user's mail folders. Read-only. Nullable.
operationId: users.ListMailFolders
parameters:
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.mailFolderCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to mailFolders for users
operationId: users.CreateMailFolders
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/mailFolders/{mailFolder-id}:
description: >-
Provides operations to manage the mailFolders property of the
microsoft.graph.user entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get mailFolders from users
description: The user's mail folders. Read-only. Nullable.
operationId: users.GetMailFolders
parameters:
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
schema:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property mailFolders in users
operationId: users.UpdateMailFolders
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property mailFolders for users
operationId: users.DeleteMailFolders
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders:
description: >-
Provides operations to manage the childFolders property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get childFolders from users
description: The collection of child folders in the mailFolder.
operationId: users.mailFolders.ListChildFolders
parameters:
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.mailFolderCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to childFolders for users
operationId: users.mailFolders.CreateChildFolders
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}:
description: >-
Provides operations to manage the childFolders property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get childFolders from users
description: The collection of child folders in the mailFolder.
operationId: users.mailFolders.GetChildFolders
parameters:
- name: includeHiddenFolders
in: query
description: Include Hidden Folders
schema:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property childFolders in users
operationId: users.mailFolders.UpdateChildFolders
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property childFolders for users
operationId: users.mailFolders.DeleteChildFolders
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules:
description: >-
Provides operations to manage the messageRules property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: users.mailFolders.childFolders.ListMessageRules
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageRuleCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to messageRules for users
operationId: users.mailFolders.childFolders.CreateMessageRules
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- /users/{user-id}/mailFolders/{mailFolder-id}/messageRules
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules/{messageRule-id}:
description: >-
Provides operations to manage the messageRules property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: users.mailFolders.childFolders.GetMessageRules
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property messageRules in users
operationId: users.mailFolders.childFolders.UpdateMessageRules
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property messageRules for users
operationId: users.mailFolders.childFolders.DeleteMessageRules
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
schema:
type: string
x-ms-docs-key-type: messageRule
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messageRules/{messageRule-id}
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.childFolders.messageRules.GetCount-22e6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messages from users
description: The collection of messages in the mailFolder.
operationId: users.mailFolders.childFolders.ListMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to messages for users
operationId: users.mailFolders.childFolders.CreateMessages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- /users/{user-id}/mailFolders/{mailFolder-id}/messages
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messages from users
description: The collection of messages in the mailFolder.
operationId: users.mailFolders.childFolders.GetMessages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property messages in users
operationId: users.mailFolders.childFolders.UpdateMessages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property messages for users
operationId: users.mailFolders.childFolders.DeleteMessages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get media content for the navigation property messages from users
description: The unique identifier for an entity. Read-only.
operationId: users.mailFolders.childFolders.GetMessagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.mailFolder
summary: Microsoft Graph Update media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: users.mailFolders.childFolders.UpdateMessagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: users.mailFolders.childFolders.DeleteMessagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: users.mailFolders.childFolders.messages.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.mailFolders.childFolders.messages.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments
- /users/{user-id}/messages/{message-id}/attachments
? /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/{attachment-id}
: description: >-
Provides operations to manage the attachments property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: users.mailFolders.childFolders.messages.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.mailFolders.childFolders.messages.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
schema:
type: string
x-ms-docs-key-type: attachment
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/{attachment-id}
- /users/{user-id}/messages/{message-id}/attachments/{attachment-id}
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.childFolders.messages.attachments.GetCount-5ef0
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
? /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
: description: Provides operations to call the createUploadSession method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session that allows an app to iteratively upload ranges
of a file, so as to attach the file to the specified Outlook item. The
item can be a message or event. Use this approach to attach a file if
the file size is between 3 MB and 150 MB. To attach a file that's
smaller than 3 MB, do a POST operation on the attachments navigation
property of the Outlook item; see how to do this for a message or for an
event. As part of the response, this action returns an upload URL that
you can use in subsequent sequential PUT queries. Request headers for
each PUT operation let you specify the exact range of bytes to be
uploaded. This allows transfer to be resumed, in case the network
connection is dropped during upload. The following are the steps to
attach a file to an Outlook item using an upload session: See attach
large files to Outlook messages or events for an example.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- /users/{user-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession
- /users/{user-id}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: users.mailFolders.childFolders.messages.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.mailFolders.childFolders.messages.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions
- /users/{user-id}/messages/{message-id}/extensions
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: users.mailFolders.childFolders.messages.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.mailFolders.childFolders.messages.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.mailFolders.childFolders.messages.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions/{extension-id}
- /users/{user-id}/messages/{message-id}/extensions/{extension-id}
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.childFolders.messages.extensions.GetCount-1433
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/copy:
description: Provides operations to call the copy method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action copy
description: Copy a message to a folder within the user's mailbox.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-copy?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.copy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/copy
- /users/{user-id}/messages/{message-id}/copy
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createForward:
description: Provides operations to call the createForward method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createForward
description: "Create a draft to forward an existing message, in either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error.\r\n- Update the draft later to add content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, forward a message in a single operation."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createforward?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.createForward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createForward
- /users/{user-id}/messages/{message-id}/createForward
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createReply:
description: Provides operations to call the createReply method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createReply
description: "Create a draft to reply to the sender of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If replyTo is specified in the original message, per Internet Message Format (RFC 2822), you should send the reply to the recipients in replyTo, and not the recipients in from.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply to a message in a single operation."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createreply?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.createReply
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createReply
- /users/{user-id}/messages/{message-id}/createReply
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createReplyAll:
description: Provides operations to call the createReplyAll method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createReplyAll
description: "Create a draft to reply to the sender and all recipients of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), you should send the reply to the recipients in the replyTo and toRecipients properties, and not the recipients in the from and toRecipients properties.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply-all to a message in a single action."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createreplyall?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.createReplyAll
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createReplyAll
- /users/{user-id}/messages/{message-id}/createReplyAll
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/forward:
description: Provides operations to call the forward method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action forward
description: "Forward a message using either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-forward?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.forward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/forward
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/events/{event-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/forward
- /users/{user-id}/messages/{message-id}/forward
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/move:
description: Provides operations to call the move method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action move
description: >-
Move a message to another folder within the specified user's mailbox.
This creates a new copy of the message in the destination folder and
removes the original message.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-move?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.move
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/move
- /users/{user-id}/messages/{message-id}/move
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/reply:
description: Provides operations to call the reply method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action reply
description: "Reply to the sender of a message using either JSON or MIME format. When using JSON format:\r\n* Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n* If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply to an existing message and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-reply?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.reply
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/reply
- /users/{user-id}/messages/{message-id}/reply
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/replyAll:
description: Provides operations to call the replyAll method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action replyAll
description: "Reply to all recipients of a message using either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply-all to a message and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-replyall?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.replyAll
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/replyAll
- /users/{user-id}/messages/{message-id}/replyAll
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/send:
description: Provides operations to call the send method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action send
description: >-
Send an existing draft message. The draft message can be a new message
draft, reply draft, reply-all draft, or a forward draft. This method
saves the message in the Sent Items folder. Alternatively, send a new
message in a single operation.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-send?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.message.send
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/send
- /users/{user-id}/messages/{message-id}/send
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.childFolders.messages.GetCount-a576
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of messages that have been added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls, you can [query for incremental changes in the messages in\r\nthat folder](/graph/delta-query-messages). This allows you to maintain and synchronize a local store of a user's messages without\r\nhaving to fetch the entire set of messages from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-delta?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.childFolders.mailFolder.messages.delta
parameters:
- name: changeType
in: query
description: >-
A custom query option to filter the delta response based on the type
of change. Supported values are created, updated or deleted.
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of message
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/copy:
description: Provides operations to call the copy method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action copy
description: Copy a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/mailfolder-copy?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.childFolders.mailFolder.copy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mailFolder'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/copy
- /users/{user-id}/messages/{message-id}/copy
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/move:
description: Provides operations to call the move method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action move
description: Move a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/mailfolder-move?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.childFolders.mailFolder.move
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mailFolder'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/move
- /users/{user-id}/messages/{message-id}/move
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: >-
users.user.mailFolders.mailFolder.childFolders.mailFolder.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: mailFolder-id1
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.childFolders.GetCount-d2d8
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of mail folders that have been added, deleted, or removed from the user's mailbox. A delta function call for mail folders in a mailbox is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls,\r\nyou can query for incremental changes in the mail folders. This allows you to maintain and synchronize\r\na local store of a user's mail folders without having to fetch all the mail folders of that mailbox from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/mailfolder-delta?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.childFolders.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of mailFolder
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/mailFolders/{mailFolder-id}/messageRules:
description: >-
Provides operations to manage the messageRules property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: users.mailFolders.ListMessageRules
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageRuleCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to messageRules for users
operationId: users.mailFolders.CreateMessageRules
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules
/users/{user-id}/mailFolders/{mailFolder-id}/messageRules/{messageRule-id}:
description: >-
Provides operations to manage the messageRules property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messageRules from users
description: The collection of rules that apply to the user's Inbox folder.
operationId: users.mailFolders.GetMessageRules
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property messageRules in users
operationId: users.mailFolders.UpdateMessageRules
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property messageRules for users
operationId: users.mailFolders.DeleteMessageRules
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: messageRule-id
in: path
description: The unique identifier of messageRule
required: true
schema:
type: string
x-ms-docs-key-type: messageRule
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messageRules/{messageRule-id}
/users/{user-id}/mailFolders/{mailFolder-id}/messageRules/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.messageRules.GetCount-f330
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/messages:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messages from users
description: The collection of messages in the mailFolder.
operationId: users.mailFolders.ListMessages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to messages for users
operationId: users.mailFolders.CreateMessages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.mailFolder entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get messages from users
description: The collection of messages in the mailFolder.
operationId: users.mailFolders.GetMessages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property messages in users
operationId: users.mailFolders.UpdateMessages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property messages for users
operationId: users.mailFolders.DeleteMessages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get media content for the navigation property messages from users
description: The unique identifier for an entity. Read-only.
operationId: users.mailFolders.GetMessagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.mailFolder
summary: Microsoft Graph Update media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: users.mailFolders.UpdateMessagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: users.mailFolders.DeleteMessagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: users.mailFolders.messages.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.mailFolders.messages.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments
- /users/{user-id}/messages/{message-id}/attachments
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/{attachment-id}:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: users.mailFolders.messages.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.mailFolders.messages.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
schema:
type: string
x-ms-docs-key-type: attachment
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/{attachment-id}
- /users/{user-id}/messages/{message-id}/attachments/{attachment-id}
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.messages.attachments.GetCount-3c73
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession:
description: Provides operations to call the createUploadSession method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session that allows an app to iteratively upload ranges
of a file, so as to attach the file to the specified Outlook item. The
item can be a message or event. Use this approach to attach a file if
the file size is between 3 MB and 150 MB. To attach a file that's
smaller than 3 MB, do a POST operation on the attachments navigation
property of the Outlook item; see how to do this for a message or for an
event. As part of the response, this action returns an upload URL that
you can use in subsequent sequential PUT queries. Request headers for
each PUT operation let you specify the exact range of bytes to be
uploaded. This allows transfer to be resumed, in case the network
connection is dropped during upload. The following are the steps to
attach a file to an Outlook item using an upload session: See attach
large files to Outlook messages or events for an example.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: >-
users.user.mailFolders.mailFolder.messages.message.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- /users/{user-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
- /users/{user-id}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: users.mailFolders.messages.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.mailFolder
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.mailFolders.messages.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions
- /users/{user-id}/messages/{message-id}/extensions
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.message entity.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: users.mailFolders.messages.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.mailFolder
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.mailFolders.messages.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.mailFolder
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.mailFolders.messages.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions/{extension-id}
- /users/{user-id}/messages/{message-id}/extensions/{extension-id}
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.messages.extensions.GetCount-651d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/copy:
description: Provides operations to call the copy method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action copy
description: Copy a message to a folder within the user's mailbox.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-copy?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.copy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/copy
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/copy
- /users/{user-id}/messages/{message-id}/copy
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createForward:
description: Provides operations to call the createForward method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createForward
description: "Create a draft to forward an existing message, in either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error.\r\n- Update the draft later to add content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, forward a message in a single operation."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createforward?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.createForward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createForward
- /users/{user-id}/messages/{message-id}/createForward
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createReply:
description: Provides operations to call the createReply method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createReply
description: "Create a draft to reply to the sender of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If replyTo is specified in the original message, per Internet Message Format (RFC 2822), you should send the reply to the recipients in replyTo, and not the recipients in from.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply to a message in a single operation."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createreply?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.createReply
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createReply
- /users/{user-id}/messages/{message-id}/createReply
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createReplyAll:
description: Provides operations to call the createReplyAll method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action createReplyAll
description: "Create a draft to reply to the sender and all recipients of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), you should send the reply to the recipients in the replyTo and toRecipients properties, and not the recipients in the from and toRecipients properties.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply-all to a message in a single action."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createreplyall?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.createReplyAll
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createReplyAll
- /users/{user-id}/messages/{message-id}/createReplyAll
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/forward:
description: Provides operations to call the forward method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action forward
description: "Forward a message using either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-forward?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.forward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/forward
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/events/{event-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/forward
- /users/{user-id}/messages/{message-id}/forward
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/move:
description: Provides operations to call the move method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action move
description: >-
Move a message to another folder within the specified user's mailbox.
This creates a new copy of the message in the destination folder and
removes the original message.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-move?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.move
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/move
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/move
- /users/{user-id}/messages/{message-id}/move
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.mailFolders.mailFolder.messages.message.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/reply:
description: Provides operations to call the reply method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action reply
description: "Reply to the sender of a message using either JSON or MIME format. When using JSON format:\r\n* Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n* If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply to an existing message and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-reply?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.reply
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/reply
- /users/{user-id}/messages/{message-id}/reply
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/replyAll:
description: Provides operations to call the replyAll method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action replyAll
description: "Reply to all recipients of a message using either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply-all to a message and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-replyall?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.replyAll
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/replyAll
- /users/{user-id}/messages/{message-id}/replyAll
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/send:
description: Provides operations to call the send method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action send
description: >-
Send an existing draft message. The draft message can be a new message
draft, reply draft, reply-all draft, or a forward draft. This method
saves the message in the Sent Items folder. Alternatively, send a new
message in a single operation.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-send?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.message.send
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/send
- /users/{user-id}/messages/{message-id}/send
/users/{user-id}/mailFolders/{mailFolder-id}/messages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.messages.GetCount-9534
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
/users/{user-id}/mailFolders/{mailFolder-id}/messages/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of messages that have been added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls, you can [query for incremental changes in the messages in\r\nthat folder](/graph/delta-query-messages). This allows you to maintain and synchronize a local store of a user's messages without\r\nhaving to fetch the entire set of messages from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-delta?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.messages.delta
parameters:
- name: changeType
in: query
description: >-
A custom query option to filter the delta response based on the type
of change. Supported values are created, updated or deleted.
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of message
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/mailFolders/{mailFolder-id}/copy:
description: Provides operations to call the copy method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action copy
description: Copy a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/mailfolder-copy?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.copy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mailFolder'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/copy
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/copy
- /users/{user-id}/messages/{message-id}/copy
/users/{user-id}/mailFolders/{mailFolder-id}/move:
description: Provides operations to call the move method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action move
description: Move a mailfolder and its contents to another mailfolder.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/mailfolder-move?view=graph-rest-1.0
operationId: users.user.mailFolders.mailFolder.move
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mailFolder'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/move
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/move
- /users/{user-id}/messages/{message-id}/move
/users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.mailFolders.mailFolder.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: mailFolder-id
in: path
description: The unique identifier of mailFolder
required: true
schema:
type: string
x-ms-docs-key-type: mailFolder
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/messages/{message-id}/permanentDelete
/users/{user-id}/mailFolders/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Get the number of the resource
operationId: users.mailFolders.GetCount-7dc9
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/mailFolders/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.mailFolder
summary: Microsoft Graph Invoke function delta
description: "Get a set of mail folders that have been added, deleted, or removed from the user's mailbox. A delta function call for mail folders in a mailbox is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls,\r\nyou can query for incremental changes in the mail folders. This allows you to maintain and synchronize\r\na local store of a user's mail folders without having to fetch all the mail folders of that mailbox from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/mailfolder-delta?view=graph-rest-1.0
operationId: users.user.mailFolders.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of mailFolder
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/managedAppRegistrations:
description: >-
Provides operations to manage the managedAppRegistrations property of the
microsoft.graph.user entity.
get:
tags:
- users.managedAppRegistration
summary: Microsoft Graph Get managedAppRegistrations from users
description: Zero or more managed app registrations that belong to the user.
operationId: users.ListManagedAppRegistrations
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.managedAppRegistrationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/managedAppRegistrations/{managedAppRegistration-id}:
description: >-
Provides operations to manage the managedAppRegistrations property of the
microsoft.graph.user entity.
get:
tags:
- users.managedAppRegistration
summary: Microsoft Graph Get managedAppRegistrations from users
description: Zero or more managed app registrations that belong to the user.
operationId: users.GetManagedAppRegistrations
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.managedAppRegistration'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedAppRegistration-id
in: path
description: The unique identifier of managedAppRegistration
required: true
schema:
type: string
x-ms-docs-key-type: managedAppRegistration
/users/{user-id}/managedAppRegistrations/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.managedAppRegistration
summary: Microsoft Graph Get the number of the resource
operationId: users.managedAppRegistrations.GetCount-9add
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/managedDevices:
description: >-
Provides operations to manage the managedDevices property of the
microsoft.graph.user entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get managedDevices from users
description: The managed devices associated with the user.
operationId: users.ListManagedDevices
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.managedDeviceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.managedDevice
summary: Microsoft Graph Create new navigation property to managedDevices for users
operationId: users.CreateManagedDevices
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/managedDevices/{managedDevice-id}:
description: >-
Provides operations to manage the managedDevices property of the
microsoft.graph.user entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get managedDevices from users
description: The managed devices associated with the user.
operationId: users.GetManagedDevices
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.managedDevice
summary: Microsoft Graph Update the navigation property managedDevices in users
operationId: users.UpdateManagedDevices
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete navigation property managedDevices for users
operationId: users.DeleteManagedDevices
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/deviceCategory:
description: >-
Provides operations to manage the deviceCategory property of the
microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get deviceCategory from users
description: Device category
operationId: users.managedDevices.GetDeviceCategory
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceCategory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.managedDevice
summary: Microsoft Graph Update the navigation property deviceCategory in users
operationId: users.managedDevices.UpdateDeviceCategory
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceCategory'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceCategory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete navigation property deviceCategory for users
operationId: users.managedDevices.DeleteDeviceCategory
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/deviceCategory/$ref:
description: Provides operations to manage the collection of user entities.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get ref of deviceCategory from users
description: Device category
operationId: users.managedDevices.GetRefDeviceCategory
responses:
2XX:
description: Retrieved navigation property link
content:
application/json:
schema:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- users.managedDevice
summary: Microsoft Graph Update the ref of navigation property deviceCategory in users
operationId: users.managedDevices.UpdateRefDeviceCategory
requestBody:
$ref: '#/components/requestBodies/refPutBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete ref of navigation property deviceCategory for users
operationId: users.managedDevices.DeleteRefDeviceCategory
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/deviceCompliancePolicyStates:
description: >-
Provides operations to manage the deviceCompliancePolicyStates property of
the microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get deviceCompliancePolicyStates from users
description: Device compliance policy states for this device.
operationId: users.managedDevices.ListDeviceCompliancePolicyStates
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.deviceCompliancePolicyStateCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.managedDevice
summary: Microsoft Graph Create new navigation property to deviceCompliancePolicyStates for users
operationId: users.managedDevices.CreateDeviceCompliancePolicyStates
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicyState'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceCompliancePolicyState
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/deviceCompliancePolicyStates/{deviceCompliancePolicyState-id}:
description: >-
Provides operations to manage the deviceCompliancePolicyStates property of
the microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get deviceCompliancePolicyStates from users
description: Device compliance policy states for this device.
operationId: users.managedDevices.GetDeviceCompliancePolicyStates
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceCompliancePolicyState
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.managedDevice
summary: Microsoft Graph Update the navigation property deviceCompliancePolicyStates in users
operationId: users.managedDevices.UpdateDeviceCompliancePolicyStates
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicyState'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceCompliancePolicyState
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete navigation property deviceCompliancePolicyStates for users
operationId: users.managedDevices.DeleteDeviceCompliancePolicyStates
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
- name: deviceCompliancePolicyState-id
in: path
description: The unique identifier of deviceCompliancePolicyState
required: true
schema:
type: string
x-ms-docs-key-type: deviceCompliancePolicyState
/users/{user-id}/managedDevices/{managedDevice-id}/deviceCompliancePolicyStates/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get the number of the resource
operationId: users.managedDevices.deviceCompliancePolicyStates.GetCount-51d2
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/deviceConfigurationStates:
description: >-
Provides operations to manage the deviceConfigurationStates property of
the microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get deviceConfigurationStates from users
description: Device configuration states for this device.
operationId: users.managedDevices.ListDeviceConfigurationStates
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.deviceConfigurationStateCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.managedDevice
summary: Microsoft Graph Create new navigation property to deviceConfigurationStates for users
operationId: users.managedDevices.CreateDeviceConfigurationStates
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/deviceConfigurationStates/{deviceConfigurationState-id}:
description: >-
Provides operations to manage the deviceConfigurationStates property of
the microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get deviceConfigurationStates from users
description: Device configuration states for this device.
operationId: users.managedDevices.GetDeviceConfigurationStates
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.managedDevice
summary: Microsoft Graph Update the navigation property deviceConfigurationStates in users
operationId: users.managedDevices.UpdateDeviceConfigurationStates
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete navigation property deviceConfigurationStates for users
operationId: users.managedDevices.DeleteDeviceConfigurationStates
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
- name: deviceConfigurationState-id
in: path
description: The unique identifier of deviceConfigurationState
required: true
schema:
type: string
x-ms-docs-key-type: deviceConfigurationState
/users/{user-id}/managedDevices/{managedDevice-id}/deviceConfigurationStates/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get the number of the resource
operationId: users.managedDevices.deviceConfigurationStates.GetCount-44c9
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/logCollectionRequests:
description: >-
Provides operations to manage the logCollectionRequests property of the
microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get logCollectionRequests from users
description: List of log collection requests
operationId: users.managedDevices.ListLogCollectionRequests
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.deviceLogCollectionResponseCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.managedDevice
summary: Microsoft Graph Create new navigation property to logCollectionRequests for users
operationId: users.managedDevices.CreateLogCollectionRequests
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceLogCollectionResponse'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceLogCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/logCollectionRequests/{deviceLogCollectionResponse-id}:
description: >-
Provides operations to manage the logCollectionRequests property of the
microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get logCollectionRequests from users
description: List of log collection requests
operationId: users.managedDevices.GetLogCollectionRequests
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceLogCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.managedDevice
summary: Microsoft Graph Update the navigation property logCollectionRequests in users
operationId: users.managedDevices.UpdateLogCollectionRequests
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceLogCollectionResponse'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.deviceLogCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete navigation property logCollectionRequests for users
operationId: users.managedDevices.DeleteLogCollectionRequests
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
- name: deviceLogCollectionResponse-id
in: path
description: The unique identifier of deviceLogCollectionResponse
required: true
schema:
type: string
x-ms-docs-key-type: deviceLogCollectionResponse
? /users/{user-id}/managedDevices/{managedDevice-id}/logCollectionRequests/{deviceLogCollectionResponse-id}/createDownloadUrl
: description: Provides operations to call the createDownloadUrl method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action createDownloadUrl
operationId: >-
users.user.managedDevices.managedDevice.logCollectionRequests.deviceLogCollectionResponse.createDownloadUrl
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: string
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
- name: deviceLogCollectionResponse-id
in: path
description: The unique identifier of deviceLogCollectionResponse
required: true
schema:
type: string
x-ms-docs-key-type: deviceLogCollectionResponse
/users/{user-id}/managedDevices/{managedDevice-id}/logCollectionRequests/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get the number of the resource
operationId: users.managedDevices.logCollectionRequests.GetCount-fcd3
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/bypassActivationLock:
description: Provides operations to call the bypassActivationLock method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action bypassActivationLock
description: Bypass activation lock
operationId: users.user.managedDevices.managedDevice.bypassActivationLock
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/cleanWindowsDevice:
description: Provides operations to call the cleanWindowsDevice method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action cleanWindowsDevice
description: Clean Windows device
operationId: users.user.managedDevices.managedDevice.cleanWindowsDevice
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keepUserData:
type: boolean
default: false
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/deleteUserFromSharedAppleDevice:
description: Provides operations to call the deleteUserFromSharedAppleDevice method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action deleteUserFromSharedAppleDevice
description: Delete user from shared Apple device
operationId: users.user.managedDevices.managedDevice.deleteUserFromSharedAppleDevice
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
userPrincipalName:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/disableLostMode:
description: Provides operations to call the disableLostMode method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action disableLostMode
description: Disable lost mode
operationId: users.user.managedDevices.managedDevice.disableLostMode
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/locateDevice:
description: Provides operations to call the locateDevice method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action locateDevice
description: Locate a device
operationId: users.user.managedDevices.managedDevice.locateDevice
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/logoutSharedAppleDeviceActiveUser:
description: Provides operations to call the logoutSharedAppleDeviceActiveUser method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action logoutSharedAppleDeviceActiveUser
description: Logout shared Apple device active user
operationId: >-
users.user.managedDevices.managedDevice.logoutSharedAppleDeviceActiveUser
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/rebootNow:
description: Provides operations to call the rebootNow method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action rebootNow
description: Reboot device
operationId: users.user.managedDevices.managedDevice.rebootNow
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/recoverPasscode:
description: Provides operations to call the recoverPasscode method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action recoverPasscode
description: Recover passcode
operationId: users.user.managedDevices.managedDevice.recoverPasscode
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/remoteLock:
description: Provides operations to call the remoteLock method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action remoteLock
description: Remote lock
operationId: users.user.managedDevices.managedDevice.remoteLock
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/requestRemoteAssistance:
description: Provides operations to call the requestRemoteAssistance method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action requestRemoteAssistance
description: Request remote assistance
operationId: users.user.managedDevices.managedDevice.requestRemoteAssistance
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/resetPasscode:
description: Provides operations to call the resetPasscode method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action resetPasscode
description: Reset passcode
operationId: users.user.managedDevices.managedDevice.resetPasscode
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/retire:
description: Provides operations to call the retire method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action retire
description: Retire a device
operationId: users.user.managedDevices.managedDevice.retire
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/shutDown:
description: Provides operations to call the shutDown method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action shutDown
description: Shut down device
operationId: users.user.managedDevices.managedDevice.shutDown
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/syncDevice:
description: Provides operations to call the syncDevice method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action syncDevice
operationId: users.user.managedDevices.managedDevice.syncDevice
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/updateWindowsDeviceAccount:
description: Provides operations to call the updateWindowsDeviceAccount method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action updateWindowsDeviceAccount
operationId: users.user.managedDevices.managedDevice.updateWindowsDeviceAccount
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
updateWindowsDeviceAccountActionParameter:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.updateWindowsDeviceAccountActionParameter
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/windowsDefenderScan:
description: Provides operations to call the windowsDefenderScan method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action windowsDefenderScan
operationId: users.user.managedDevices.managedDevice.windowsDefenderScan
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
quickScan:
type: boolean
default: false
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/windowsDefenderUpdateSignatures:
description: Provides operations to call the windowsDefenderUpdateSignatures method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action windowsDefenderUpdateSignatures
operationId: users.user.managedDevices.managedDevice.windowsDefenderUpdateSignatures
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/wipe:
description: Provides operations to call the wipe method.
post:
tags:
- users.managedDevice
summary: Microsoft Graph Invoke action wipe
description: Wipe a device
operationId: users.user.managedDevices.managedDevice.wipe
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keepEnrollmentData:
type: boolean
default: false
nullable: true
keepUserData:
type: boolean
default: false
nullable: true
macOsUnlockCode:
type: string
nullable: true
persistEsimDataPlan:
type: boolean
default: false
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/users:
description: >-
Provides operations to manage the users property of the
microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get users from users
description: The primary users associated with the managed device.
operationId: users.managedDevices.ListUsers
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.userCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/windowsProtectionState:
description: >-
Provides operations to manage the windowsProtectionState property of the
microsoft.graph.managedDevice entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get windowsProtectionState from users
description: The device protection status. This property is read-only.
operationId: users.managedDevices.GetWindowsProtectionState
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsProtectionState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.managedDevice
summary: Microsoft Graph Update the navigation property windowsProtectionState in users
operationId: users.managedDevices.UpdateWindowsProtectionState
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsProtectionState'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsProtectionState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete navigation property windowsProtectionState for users
operationId: users.managedDevices.DeleteWindowsProtectionState
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/{managedDevice-id}/windowsProtectionState/detectedMalwareState:
description: >-
Provides operations to manage the detectedMalwareState property of the
microsoft.graph.windowsProtectionState entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get detectedMalwareState from users
description: Device malware list
operationId: users.managedDevices.windowsProtectionState.ListDetectedMalwareState
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.windowsDeviceMalwareStateCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.managedDevice
summary: Microsoft Graph Create new navigation property to detectedMalwareState for users
operationId: users.managedDevices.windowsProtectionState.CreateDetectedMalwareState
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
? /users/{user-id}/managedDevices/{managedDevice-id}/windowsProtectionState/detectedMalwareState/{windowsDeviceMalwareState-id}
: description: >-
Provides operations to manage the detectedMalwareState property of the
microsoft.graph.windowsProtectionState entity.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get detectedMalwareState from users
description: Device malware list
operationId: users.managedDevices.windowsProtectionState.GetDetectedMalwareState
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.managedDevice
summary: Microsoft Graph Update the navigation property detectedMalwareState in users
operationId: users.managedDevices.windowsProtectionState.UpdateDetectedMalwareState
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.managedDevice
summary: Microsoft Graph Delete navigation property detectedMalwareState for users
operationId: users.managedDevices.windowsProtectionState.DeleteDetectedMalwareState
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
- name: windowsDeviceMalwareState-id
in: path
description: The unique identifier of windowsDeviceMalwareState
required: true
schema:
type: string
x-ms-docs-key-type: windowsDeviceMalwareState
/users/{user-id}/managedDevices/{managedDevice-id}/windowsProtectionState/detectedMalwareState/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get the number of the resource
operationId: >-
users.managedDevices.windowsProtectionState.detectedMalwareState.GetCount-21ad
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: managedDevice-id
in: path
description: The unique identifier of managedDevice
required: true
schema:
type: string
x-ms-docs-key-type: managedDevice
/users/{user-id}/managedDevices/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.managedDevice
summary: Microsoft Graph Get the number of the resource
operationId: users.managedDevices.GetCount-9db6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/manager:
description: >-
Provides operations to manage the manager property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph List manager
description: >-
Returns the user or organizational contact assigned as the user's
manager. Optionally, you can expand the manager's chain up to the root
node.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-manager?view=graph-rest-1.0
operationId: users.GetManager
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/manager/$ref:
description: Provides operations to manage the collection of user entities.
get:
tags:
- users.directoryObject
summary: Microsoft Graph List manager
description: >-
Returns the user or organizational contact assigned as the user's
manager. Optionally, you can expand the manager's chain up to the root
node.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-manager?view=graph-rest-1.0
operationId: users.GetRefManager
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
responses:
2XX:
description: Retrieved navigation property link
content:
application/json:
schema:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- users.directoryObject
summary: Microsoft Graph Assign manager
description: Assign a user's manager.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-post-manager?view=graph-rest-1.0
operationId: users.UpdateRefManager
requestBody:
$ref: '#/components/requestBodies/refPutBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.directoryObject
summary: Microsoft Graph Remove manager
description: Remove a user's manager.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-delete-manager?view=graph-rest-1.0
operationId: users.DeleteRefManager
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf:
description: >-
Provides operations to manage the memberOf property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph List a user's direct memberships
description: >-
Get groups, directory roles, and administrative units that the user is a
direct member of. This operation isn't transitive. To retrieve groups,
directory roles, and administrative units that the user is a member
through transitive membership, use the List user transitive memberOf
API.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-memberof?view=graph-rest-1.0
operationId: users.ListMemberOf
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf/{directoryObject-id}:
description: >-
Provides operations to manage the memberOf property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get memberOf from users
description: >-
The groups and directory roles that the user is a member of. Read-only.
Nullable. Supports $expand.
operationId: users.GetMemberOf
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/memberOf/{directoryObject-id}/graph.administrativeUnit:
description: Casts the previous resource to administrativeUnit.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit
operationId: users.GetMemberOf.AsAdministrativeUnit
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.administrativeUnit'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/memberOf/{directoryObject-id}/graph.directoryRole:
description: Casts the previous resource to directoryRole.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.directoryRole
operationId: users.GetMemberOf.AsDirectoryRole
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/memberOf/{directoryObject-id}/graph.group:
description: Casts the previous resource to group.
get:
tags:
- users.directoryObject
summary: Microsoft Graph List a user's direct memberships
description: >-
Get groups, directory roles, and administrative units that the user is a
direct member of. This operation isn't transitive. To retrieve groups,
directory roles, and administrative units that the user is a member
through transitive membership, use the List user transitive memberOf
API.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-memberof?view=graph-rest-1.0
operationId: users.GetMemberOf.AsGroup
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/memberOf/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.memberOf.GetCount-fc20
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf/graph.administrativeUnit:
description: Casts the previous resource to administrativeUnit.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection
operationId: users.ListMemberOf.AsAdministrativeUnit
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.administrativeUnitCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf/graph.administrativeUnit/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.MemberOf.GetCount.AsAdministrativeUnit-88a9
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf/graph.directoryRole:
description: Casts the previous resource to directoryRole.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.directoryRole in the microsoft.graph.directoryObject collection
operationId: users.ListMemberOf.AsDirectoryRole
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryRoleCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf/graph.directoryRole/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.MemberOf.GetCount.AsDirectoryRole-b036
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf/graph.group:
description: Casts the previous resource to group.
get:
tags:
- users.directoryObject
summary: Microsoft Graph List a user's direct memberships
description: >-
Get groups, directory roles, and administrative units that the user is a
direct member of. This operation isn't transitive. To retrieve groups,
directory roles, and administrative units that the user is a member
through transitive membership, use the List user transitive memberOf
API.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-memberof?view=graph-rest-1.0
operationId: users.ListMemberOf.AsGroup
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.groupCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/memberOf/graph.group/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.MemberOf.GetCount.AsGroup-48c0
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/messages:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.user entity.
get:
tags:
- Users.message
summary: Microsoft Graph Get messages from users
description: The messages in a mailbox or folder. Read-only. Nullable.
operationId: users.ListMessages
parameters:
- name: includeHiddenMessages
in: query
description: Include Hidden Messages
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
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.message
summary: Microsoft Graph Create new navigation property to messages for users
operationId: users.CreateMessages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/messages/{message-id}:
description: >-
Provides operations to manage the messages property of the
microsoft.graph.user entity.
get:
tags:
- Users.message
summary: Microsoft Graph Get messages from users
description: The messages in a mailbox or folder. Read-only. Nullable.
operationId: users.GetMessages
parameters:
- name: includeHiddenMessages
in: query
description: Include Hidden Messages
schema:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.message
summary: Microsoft Graph Update the navigation property messages in users
operationId: users.UpdateMessages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.message
summary: Microsoft Graph Delete navigation property messages for users
operationId: users.DeleteMessages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/messages/{message-id}/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.message
summary: Microsoft Graph Get media content for the navigation property messages from users
description: The unique identifier for an entity. Read-only.
operationId: users.GetMessagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.message
summary: Microsoft Graph Update media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: users.UpdateMessagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.message
summary: Microsoft Graph Delete media content for the navigation property messages in users
description: The unique identifier for an entity. Read-only.
operationId: users.DeleteMessagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/messages/{message-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.message entity.
get:
tags:
- Users.message
summary: Microsoft Graph Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: users.messages.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.attachmentCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.message
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.messages.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments
/users/{user-id}/messages/{message-id}/attachments/{attachment-id}:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.message entity.
get:
tags:
- Users.message
summary: Microsoft Graph Get attachments from users
description: The fileAttachment and itemAttachment attachments for the message.
operationId: users.messages.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.message
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.messages.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
- name: attachment-id
in: path
description: The unique identifier of attachment
required: true
schema:
type: string
x-ms-docs-key-type: attachment
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/{attachment-id}
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/{attachment-id}
/users/{user-id}/messages/{message-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.message
summary: Microsoft Graph Get the number of the resource
operationId: users.messages.attachments.GetCount-a586
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/messages/{message-id}/attachments/createUploadSession:
description: Provides operations to call the createUploadSession method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session that allows an app to iteratively upload ranges
of a file, so as to attach the file to the specified Outlook item. The
item can be a message or event. Use this approach to attach a file if
the file size is between 3 MB and 150 MB. To attach a file that's
smaller than 3 MB, do a POST operation on the attachments navigation
property of the Outlook item; see how to do this for a message or for an
event. As part of the response, this action returns an upload URL that
you can use in subsequent sequential PUT queries. Request headers for
each PUT operation let you specify the exact range of bytes to be
uploaded. This allows transfer to be resumed, in case the network
connection is dropped during upload. The following are the steps to
attach a file to an Outlook item using an upload session: See attach
large files to Outlook messages or events for an example.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/attachment-createuploadsession?view=graph-rest-1.0
operationId: users.user.messages.message.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
AttachmentItem:
$ref: '#/components/schemas/microsoft.graph.attachmentItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- /users/{user-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession
/users/{user-id}/messages/{message-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.message entity.
get:
tags:
- Users.message
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: users.messages.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.message
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.messages.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions
/users/{user-id}/messages/{message-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.message entity.
get:
tags:
- Users.message
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the message. Nullable.
operationId: users.messages.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.message
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.messages.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.message
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.messages.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/extensions/{extension-id}
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/extensions/{extension-id}
/users/{user-id}/messages/{message-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.message
summary: Microsoft Graph Get the number of the resource
operationId: users.messages.extensions.GetCount-5628
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
/users/{user-id}/messages/{message-id}/copy:
description: Provides operations to call the copy method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action copy
description: Copy a message to a folder within the user's mailbox.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-copy?view=graph-rest-1.0
operationId: users.user.messages.message.copy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/copy
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/copy
- /users/{user-id}/mailFolders/{mailFolder-id}/copy
/users/{user-id}/messages/{message-id}/createForward:
description: Provides operations to call the createForward method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action createForward
description: "Create a draft to forward an existing message, in either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error.\r\n- Update the draft later to add content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, forward a message in a single operation."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createforward?view=graph-rest-1.0
operationId: users.user.messages.message.createForward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createForward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createForward
/users/{user-id}/messages/{message-id}/createReply:
description: Provides operations to call the createReply method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action createReply
description: "Create a draft to reply to the sender of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If replyTo is specified in the original message, per Internet Message Format (RFC 2822), you should send the reply to the recipients in replyTo, and not the recipients in from.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply to a message in a single operation."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createreply?view=graph-rest-1.0
operationId: users.user.messages.message.createReply
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createReply
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createReply
/users/{user-id}/messages/{message-id}/createReplyAll:
description: Provides operations to call the createReplyAll method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action createReplyAll
description: "Create a draft to reply to the sender and all recipients of a message in either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), you should send the reply to the recipients in the replyTo and toRecipients properties, and not the recipients in the from and toRecipients properties.\r\n- You can update the draft later to add reply content to the body or change other message properties. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. Send the draft message in a subsequent operation. Alternatively, reply-all to a message in a single action."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-createreplyall?view=graph-rest-1.0
operationId: users.user.messages.message.createReplyAll
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/createReplyAll
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/createReplyAll
/users/{user-id}/messages/{message-id}/forward:
description: Provides operations to call the forward method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action forward
description: "Forward a message using either JSON or MIME format. When using JSON format, you can:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- Specify either the toRecipients parameter or the toRecipients property of the message parameter. Specifying both or specifying neither will return an HTTP 400 Bad Request error. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to forward a message, and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-forward?view=graph-rest-1.0
operationId: users.user.messages.message.forward
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ToRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/forward
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/calendars/{calendar-id}/events/{event-id}/forward
- /users/{user-id}/events/{event-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/forward
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/forward
/users/{user-id}/messages/{message-id}/move:
description: Provides operations to call the move method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action move
description: >-
Move a message to another folder within the specified user's mailbox.
This creates a new copy of the message in the destination folder and
removes the original message.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-move?view=graph-rest-1.0
operationId: users.user.messages.message.move
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
DestinationId:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/move
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/move
- /users/{user-id}/mailFolders/{mailFolder-id}/move
/users/{user-id}/messages/{message-id}/permanentDelete:
description: Provides operations to call the permanentDelete method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action permanentDelete
operationId: users.user.messages.message.permanentDelete
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/events/{event-id}/permanentDelete
- /users/{user-id}/calendar/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/permanentDelete
- /users/{user-id}/calendars/{calendar-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/{contact-id}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/permanentDelete
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/contactFolders/{contactFolder-id}/permanentDelete
- /users/{user-id}/contacts/{contact-id}/permanentDelete
- /users/{user-id}/events/{event-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/permanentDelete
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/permanentDelete
- /users/{user-id}/mailFolders/{mailFolder-id}/permanentDelete
/users/{user-id}/messages/{message-id}/reply:
description: Provides operations to call the reply method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action reply
description: "Reply to the sender of a message using either JSON or MIME format. When using JSON format:\r\n* Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n* If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply to an existing message and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-reply?view=graph-rest-1.0
operationId: users.user.messages.message.reply
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/reply
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/reply
/users/{user-id}/messages/{message-id}/replyAll:
description: Provides operations to call the replyAll method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action replyAll
description: "Reply to all recipients of a message using either JSON or MIME format. When using JSON format:\r\n- Specify either a comment or the body property of the message parameter. Specifying both will return an HTTP 400 Bad Request error.\r\n- If the original message specifies a recipient in the replyTo property, per Internet Message Format (RFC 2822), send the reply to the recipients in replyTo and not the recipient in the from property. When using MIME format:\r\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\r\n- Add any attachments and S/MIME properties to the MIME content. This method saves the message in the Sent Items folder. Alternatively, create a draft to reply-all to a message and send it later."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-replyall?view=graph-rest-1.0
operationId: users.user.messages.message.replyAll
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
Message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.message'
- type: object
nullable: true
Comment:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/replyAll
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/replyAll
/users/{user-id}/messages/{message-id}/send:
description: Provides operations to call the send method.
post:
tags:
- Users.message
summary: Microsoft Graph Invoke action send
description: >-
Send an existing draft message. The draft message can be a new message
draft, reply draft, reply-all draft, or a forward draft. This method
saves the message in the Sent Items folder. Alternatively, send a new
message in a single operation.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/message-send?view=graph-rest-1.0
operationId: users.user.messages.message.send
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: message-id
in: path
description: The unique identifier of message
required: true
schema:
type: string
x-ms-docs-key-type: message
x-ms-docs-grouped-path:
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/send
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/send
/users/{user-id}/messages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.message
summary: Microsoft Graph Get the number of the resource
operationId: users.messages.GetCount-0f52
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/messages/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.message
summary: Microsoft Graph Invoke function delta
description: "Get a set of messages that have been added, deleted, or updated in a specified folder. A delta function call for messages in a folder is similar to a GET request, except that by appropriately\r\napplying state tokens in one or more of these calls, you can [query for incremental changes in the messages in\r\nthat folder](/graph/delta-query-messages). This allows you to maintain and synchronize a local store of a user's messages without\r\nhaving to fetch the entire set of messages from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/message-delta?view=graph-rest-1.0
operationId: users.user.messages.delta
parameters:
- name: changeType
in: query
description: >-
A custom query option to filter the delta response based on the type
of change. Supported values are created, updated or deleted.
schema:
type: string
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of message
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/assignLicense:
description: Provides operations to call the assignLicense method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action assignLicense
description: >-
Add or remove licenses for the user to enable or disable their use of
Microsoft cloud offerings that the company has licenses to. For example,
an organization can have a Microsoft 365 Enterprise E3 subscription with
100 licenses, and this request assigns one of those licenses to a
specific user. You can also enable and disable specific plans associated
with a subscription. Direct user licensing method is an alternative to
group-based licensing.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-assignlicense?view=graph-rest-1.0
operationId: users.user.assignLicense
requestBody:
$ref: '#/components/requestBodies/assignLicenseRequestBody'
responses:
2XX:
$ref: '#/components/responses/assignLicenseResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/changePassword:
description: Provides operations to call the changePassword method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action changePassword
description: "Update the signed-in user's password. Any user can update their password without belonging to any administrator role.\r\nTo update another user's password in either delegated or app-only scenarios, update the passwordProfile property of the user instead. See Example 3: Update the passwordProfile of a user and reset their password."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-changepassword?view=graph-rest-1.0
operationId: users.user.changePassword
requestBody:
$ref: '#/components/requestBodies/changePasswordRequestBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/checkMemberGroups:
description: Provides operations to call the checkMemberGroups method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action checkMemberGroups
description: "Check for membership in a specified list of group IDs, and return from that list the IDs of groups where a specified object is a member. The specified object can be of one of the following types:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/directoryobject-checkmembergroups?view=graph-rest-1.0
operationId: users.user.checkMemberGroups
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupIds:
type: array
items:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/checkMemberObjects:
description: Provides operations to call the checkMemberObjects method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action checkMemberObjects
operationId: users.user.checkMemberObjects
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/exportDeviceAndAppManagementData():
description: Provides operations to call the exportDeviceAndAppManagementData method.
get:
tags:
- users.user.Functions
summary: Microsoft Graph Invoke function exportDeviceAndAppManagementData
operationId: users.user.exportDeviceAndAppManagementData-1a02
responses:
2XX:
$ref: '#/components/responses/exportDeviceAndAppManagementDataResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/exportDeviceAndAppManagementData(skip={skip},top={top})
/users/{user-id}/exportDeviceAndAppManagementData(skip={skip},top={top}):
description: Provides operations to call the exportDeviceAndAppManagementData method.
get:
tags:
- users.user.Functions
summary: Microsoft Graph Invoke function exportDeviceAndAppManagementData
operationId: users.user.exportDeviceAndAppManagementData-fd7c
responses:
2XX:
$ref: '#/components/responses/exportDeviceAndAppManagementDataResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: skip
in: path
description: 'Usage: skip={skip}'
required: true
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
- name: top
in: path
description: 'Usage: top={top}'
required: true
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-grouped-path:
- /users/{user-id}/exportDeviceAndAppManagementData()
/users/{user-id}/exportPersonalData:
description: Provides operations to call the exportPersonalData method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action exportPersonalData
description: >-
Submit a data policy operation request from a company administrator or
an application to export an organizational user's data. This data
includes the user's data stored in OneDrive and their activity reports.
For more information about exporting data while complying with
regulations, see Data Subject Requests and the GDPR and CCPA.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-exportpersonaldata?view=graph-rest-1.0
operationId: users.user.exportPersonalData
requestBody:
$ref: '#/components/requestBodies/exportPersonalDataRequestBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/findMeetingTimes:
description: Provides operations to call the findMeetingTimes method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action findMeetingTimes
description: "Suggest meeting times and locations based on organizer and attendee availability, and time or location constraints specified as parameters. If findMeetingTimes cannot return any meeting suggestions, the response would indicate a reason in the emptySuggestionsReason property.\r\nBased on this value, you can better adjust the parameters and call findMeetingTimes again. The algorithm used to suggest meeting times and locations undergoes fine-tuning from time to time. In scenarios like test environments where the input parameters and calendar data remain static, expect that the suggested results may differ over time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-findmeetingtimes?view=graph-rest-1.0
operationId: users.user.findMeetingTimes
requestBody:
$ref: '#/components/requestBodies/findMeetingTimesRequestBody'
responses:
2XX:
$ref: '#/components/responses/findMeetingTimesResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/getMailTips:
description: Provides operations to call the getMailTips method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action getMailTips
description: "Get the MailTips of one or more recipients as available to the signed-in user. Note that by making a POST call to the getMailTips action, you can request specific types of MailTips to\r\nbe returned for more than one recipient at one time. The requested MailTips are returned in a mailTips collection."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-getmailtips?view=graph-rest-1.0
operationId: users.user.getMailTips
requestBody:
$ref: '#/components/requestBodies/getMailTipsRequestBody'
responses:
2XX:
$ref: '#/components/responses/getMailTipsResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/getManagedAppDiagnosticStatuses():
description: Provides operations to call the getManagedAppDiagnosticStatuses method.
get:
tags:
- users.user.Functions
summary: Microsoft Graph Invoke function getManagedAppDiagnosticStatuses
description: Gets diagnostics validation status for a given user.
operationId: users.user.getManagedAppDiagnosticStatuses
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
$ref: '#/components/responses/getManagedAppDiagnosticStatusesResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/getManagedAppPolicies():
description: Provides operations to call the getManagedAppPolicies method.
get:
tags:
- users.user.Functions
summary: Microsoft Graph Invoke function getManagedAppPolicies
description: Gets app restrictions for a given user.
operationId: users.user.getManagedAppPolicies
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/getManagedAppPoliciesResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/getManagedDevicesWithAppFailures():
description: Provides operations to call the getManagedDevicesWithAppFailures method.
get:
tags:
- users.user.Functions
summary: Microsoft Graph Invoke function getManagedDevicesWithAppFailures
description: Retrieves the list of devices with failed apps
operationId: users.user.getManagedDevicesWithAppFailures
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
$ref: '#/components/responses/getManagedDevicesWithAppFailuresResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/getMemberGroups:
description: Provides operations to call the getMemberGroups method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action getMemberGroups
description: >-
Return all the group IDs for the groups that the specified user, group,
service principal, organizational contact, device, or directory object
is a member of. This function is transitive. This API returns up to
11,000 group IDs. If more than 11,000 results are available, it returns
a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error
code. If you get the DirectoryResultSizeLimitExceeded error code, use
the List group transitive memberOf API instead.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/directoryobject-getmembergroups?view=graph-rest-1.0
operationId: users.user.getMemberGroups
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/getMemberObjects:
description: Provides operations to call the getMemberObjects method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action getMemberObjects
description: "Return all IDs for the groups, administrative units, and directory roles that an object of one of the following types is a member of:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. Only users and role-enabled groups can be members of directory roles."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/directoryobject-getmemberobjects?view=graph-rest-1.0
operationId: users.user.getMemberObjects
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/reminderView(StartDateTime='{StartDateTime}',EndDateTime='{EndDateTime}'):
description: Provides operations to call the reminderView method.
get:
tags:
- users.user.Functions
summary: Microsoft Graph Invoke function reminderView
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-reminderview?view=graph-rest-1.0
operationId: users.user.reminderView
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
$ref: '#/components/responses/reminderViewResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: StartDateTime
in: path
description: 'Usage: StartDateTime=''{StartDateTime}'''
required: true
schema:
type: string
- name: EndDateTime
in: path
description: 'Usage: EndDateTime=''{EndDateTime}'''
required: true
schema:
type: string
nullable: true
/users/{user-id}/removeAllDevicesFromManagement:
description: Provides operations to call the removeAllDevicesFromManagement method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action removeAllDevicesFromManagement
description: Retire all devices from management for this user
operationId: users.user.removeAllDevicesFromManagement
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/reprocessLicenseAssignment:
description: Provides operations to call the reprocessLicenseAssignment method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action reprocessLicenseAssignment
description: >-
Reprocess all group-based license assignments for the user. To learn
more about group-based licensing, see What is group-based licensing in
Microsoft Entra ID. Also see Identify and resolve license assignment
problems for a group in Microsoft Entra ID for more details.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-reprocesslicenseassignment?view=graph-rest-1.0
operationId: users.user.reprocessLicenseAssignment
responses:
2XX:
$ref: '#/components/responses/reprocessLicenseAssignmentResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/restore:
description: Provides operations to call the restore method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action restore
description: "Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. Restore a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user If an item is accidentally deleted, you can fully restore the item. Additionally, restoring an application doesn't automatically restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/directory-deleteditems-restore?view=graph-rest-1.0
operationId: users.user.restore
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/cloudPCs/{cloudPC-id}/restore
/users/{user-id}/retryServiceProvisioning:
description: Provides operations to call the retryServiceProvisioning method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action retryServiceProvisioning
description: Retry the provisioning of a user object in Microsoft Entra ID.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-retryserviceprovisioning?view=graph-rest-1.0
operationId: users.user.retryServiceProvisioning
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/revokeSignInSessions:
description: Provides operations to call the revokeSignInSessions method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action revokeSignInSessions
description: >-
Invalidates all the refresh tokens issued to applications for a user
(and session cookies in a user's browser), by resetting the
signInSessionsValidFromDateTime user property to the current date-time.
Typically, this operation is performed (by the user or an administrator)
if the user has a lost or stolen device. This operation prevents access
to the organization's data through applications on the device by
requiring the user to sign in again to all applications that they
consented to previously, independent of device.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-revokesigninsessions?view=graph-rest-1.0
operationId: users.user.revokeSignInSessions
responses:
2XX:
$ref: '#/components/responses/revokeSignInSessionsResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/sendMail:
description: Provides operations to call the sendMail method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action sendMail
description: >-
Send the message specified in the request body using either JSON or MIME
format. When using JSON format, you can include a file attachment in the
same sendMail action call. When using MIME format: This method saves the
message in the Sent Items folder. Alternatively, create a draft message
to send later. To learn more about the steps involved in the backend
before a mail is delivered to recipients, see here.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-sendmail?view=graph-rest-1.0
operationId: users.user.sendMail
requestBody:
$ref: '#/components/requestBodies/sendMailRequestBody'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/translateExchangeIds:
description: Provides operations to call the translateExchangeIds method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action translateExchangeIds
description: Translate identifiers of Outlook-related resources between formats.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-translateexchangeids?view=graph-rest-1.0
operationId: users.user.translateExchangeIds
requestBody:
$ref: '#/components/requestBodies/translateExchangeIdsRequestBody'
responses:
2XX:
$ref: '#/components/responses/translateExchangeIdsResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/wipeManagedAppRegistrationsByDeviceTag:
description: >-
Provides operations to call the wipeManagedAppRegistrationsByDeviceTag
method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action wipeManagedAppRegistrationsByDeviceTag
description: >-
Issues a wipe operation on an app registration with specified device
tag.
operationId: users.user.wipeManagedAppRegistrationsByDeviceTag
requestBody:
$ref: >-
#/components/requestBodies/wipeManagedAppRegistrationsByDeviceTagRequestBody
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/oauth2PermissionGrants:
description: >-
Provides operations to manage the oauth2PermissionGrants property of the
microsoft.graph.user entity.
get:
tags:
- users.oAuth2PermissionGrant
summary: Microsoft Graph List a user's oauth2PermissionGrants
description: >-
Retrieve a list of oAuth2PermissionGrant entities, which represent
delegated permissions granted to enable a client application to access
an API on behalf of the user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-oauth2permissiongrants?view=graph-rest-1.0
operationId: users.ListOauth2PermissionGrants
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.oAuth2PermissionGrantCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/oauth2PermissionGrants/{oAuth2PermissionGrant-id}:
description: >-
Provides operations to manage the oauth2PermissionGrants property of the
microsoft.graph.user entity.
get:
tags:
- users.oAuth2PermissionGrant
summary: Microsoft Graph Get oauth2PermissionGrants from users
operationId: users.GetOauth2PermissionGrants
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: oAuth2PermissionGrant-id
in: path
description: The unique identifier of oAuth2PermissionGrant
required: true
schema:
type: string
x-ms-docs-key-type: oAuth2PermissionGrant
/users/{user-id}/oauth2PermissionGrants/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.oAuth2PermissionGrant
summary: Microsoft Graph Get the number of the resource
operationId: users.oauth2PermissionGrants.GetCount-fb7b
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote:
description: >-
Provides operations to manage the onenote property of the
microsoft.graph.user entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get onenote from users
operationId: users.GetOnenote
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenote'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property onenote in users
operationId: users.UpdateOnenote
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenote'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenote'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property onenote for users
operationId: users.DeleteOnenote
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/notebooks:
description: >-
Provides operations to manage the notebooks property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get notebooks from users
description: >-
The collection of OneNote notebooks that are owned by the user or group.
Read-only. Nullable.
operationId: users.onenote.ListNotebooks
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.notebookCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to notebooks for users
operationId: users.onenote.CreateNotebooks
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/notebooks/{notebook-id}:
description: >-
Provides operations to manage the notebooks property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get notebooks from users
description: >-
The collection of OneNote notebooks that are owned by the user or group.
Read-only. Nullable.
operationId: users.onenote.GetNotebooks
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property notebooks in users
operationId: users.onenote.UpdateNotebooks
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property notebooks for users
operationId: users.onenote.DeleteNotebooks
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
/users/{user-id}/onenote/notebooks/{notebook-id}/copyNotebook:
description: Provides operations to call the copyNotebook method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyNotebook
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/notebook-copynotebook?view=graph-rest-1.0
operationId: users.user.onenote.notebooks.notebook.copyNotebook
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
notebookFolder:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.notebook entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: The section groups in the notebook. Read-only. Nullable.
operationId: users.onenote.notebooks.ListSectionGroups
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sectionGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to sectionGroups for users
operationId: users.onenote.notebooks.CreateSectionGroups
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.notebook entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: The section groups in the notebook. Read-only. Nullable.
operationId: users.onenote.notebooks.GetSectionGroups
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property sectionGroups in users
operationId: users.onenote.notebooks.UpdateSectionGroups
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property sectionGroups for users
operationId: users.onenote.notebooks.DeleteSectionGroups
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the section group. Read-only.
operationId: users.onenote.notebooks.sectionGroups.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- /users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/parentNotebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/parentSectionGroup:
description: >-
Provides operations to manage the parentSectionGroup property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSectionGroup from users
description: The section group that contains the section group. Read-only.
operationId: users.onenote.notebooks.sectionGroups.GetParentSectionGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/parentSectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sectionGroups:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: The section groups in the section. Read-only. Nullable.
operationId: users.onenote.notebooks.sectionGroups.ListSectionGroups
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sectionGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- /users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sectionGroups
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sectionGroups/{sectionGroup-id1}:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: The section groups in the section. Read-only. Nullable.
operationId: users.onenote.notebooks.sectionGroups.GetSectionGroups
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: sectionGroup-id1
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sectionGroups/{sectionGroup-id1}
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sectionGroups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.notebooks.sectionGroups.sectionGroups.GetCount-2e9f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: The sections in the section group. Read-only. Nullable.
operationId: users.onenote.notebooks.sectionGroups.ListSections
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.onenoteSectionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to sections for users
operationId: users.onenote.notebooks.sectionGroups.CreateSections
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- /users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: The sections in the section group. Read-only. Nullable.
operationId: users.onenote.notebooks.sectionGroups.GetSections
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property sections in users
operationId: users.onenote.notebooks.sectionGroups.UpdateSections
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property sections for users
operationId: users.onenote.notebooks.sectionGroups.DeleteSections
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook
: description: Provides operations to call the copyToNotebook method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToNotebook
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytonotebook?view=graph-rest-1.0
operationId: >-
users.user.onenote.notebooks.notebook.sectionGroups.sectionGroup.sections.onenoteSection.copyToNotebook
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook
- /users/{user-id}/onenote/sections/{onenoteSection-id}/copyToNotebook
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup
: description: Provides operations to call the copyToSectionGroup method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSectionGroup
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytosectiongroup?view=graph-rest-1.0
operationId: >-
users.user.onenote.notebooks.notebook.sectionGroups.sectionGroup.sections.onenoteSection.copyToSectionGroup
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToSectionGroup
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup
- /users/{user-id}/onenote/sections/{onenoteSection-id}/copyToSectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.notebooks.sectionGroups.sections.ListPages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.onenotePageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to pages for users
operationId: users.onenote.notebooks.sectionGroups.sections.CreatePages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages
- /users/{user-id}/onenote/sections/{onenoteSection-id}/pages
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
: description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.notebooks.sectionGroups.sections.GetPages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property pages in users
operationId: users.onenote.notebooks.sectionGroups.sections.UpdatePages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property pages for users
operationId: users.onenote.notebooks.sectionGroups.sections.DeletePages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/content
: description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get content for the navigation property pages from users
description: The page's HTML content.
operationId: users.onenote.notebooks.sectionGroups.sections.GetPagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.onenote
summary: Microsoft Graph Update content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.notebooks.sectionGroups.sections.UpdatePagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.notebooks.sectionGroups.sections.DeletePagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
: description: Provides operations to call the copyToSection method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSection
description: >-
Copy a page to a specific section. For copy operations, you follow an
asynchronous calling pattern: First call the Copy action, and then poll
the operation endpoint for the result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/page-copytosection?view=graph-rest-1.0
operationId: >-
users.user.onenote.notebooks.notebook.sectionGroups.sectionGroup.sections.onenoteSection.pages.onenotePage.copyToSection
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
: description: Provides operations to call the onenotePatchContent method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action onenotePatchContent
operationId: >-
users.user.onenote.notebooks.notebook.sectionGroups.sectionGroup.sections.onenoteSection.pages.onenotePage.onenotePatchContent
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
commands:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.onenotePatchContentCommand
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- /users/{user-id}/onenote/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
: description: Provides operations to call the preview method.
get:
tags:
- Users.onenote
summary: Microsoft Graph Invoke function preview
operationId: >-
users.user.onenote.notebooks.notebook.sectionGroups.sectionGroup.sections.onenoteSection.pages.onenotePage.preview
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePagePreview'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- /users/{user-id}/onenote/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
: description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the page. Read-only.
operationId: users.onenote.notebooks.sectionGroups.sections.pages.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
: description: >-
Provides operations to manage the parentSection property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSection from users
description: The section that contains the page. Read-only.
operationId: users.onenote.notebooks.sectionGroups.sections.pages.GetParentSection
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.notebooks.sectionGroups.sections.pages.GetCount-a323
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook
: description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the section. Read-only.
operationId: users.onenote.notebooks.sectionGroups.sections.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook
- /users/{user-id}/onenote/sections/{onenoteSection-id}/parentNotebook
? /users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup
: description: >-
Provides operations to manage the parentSectionGroup property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSectionGroup from users
description: The section group that contains the section. Read-only.
operationId: users.onenote.notebooks.sectionGroups.sections.GetParentSectionGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentSectionGroup
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup
- /users/{user-id}/onenote/sections/{onenoteSection-id}/parentSectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.notebooks.sectionGroups.sections.GetCount-2e73
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.notebooks.sectionGroups.GetCount-2e9f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sections:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.notebook entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: The sections in the notebook. Read-only. Nullable.
operationId: users.onenote.notebooks.ListSections
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.onenoteSectionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to sections for users
operationId: users.onenote.notebooks.CreateSections
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.notebook entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: The sections in the notebook. Read-only. Nullable.
operationId: users.onenote.notebooks.GetSections
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property sections in users
operationId: users.onenote.notebooks.UpdateSections
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property sections for users
operationId: users.onenote.notebooks.DeleteSections
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToNotebook:
description: Provides operations to call the copyToNotebook method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToNotebook
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytonotebook?view=graph-rest-1.0
operationId: >-
users.user.onenote.notebooks.notebook.sections.onenoteSection.copyToNotebook
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook
- /users/{user-id}/onenote/sections/{onenoteSection-id}/copyToNotebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToSectionGroup:
description: Provides operations to call the copyToSectionGroup method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSectionGroup
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytosectiongroup?view=graph-rest-1.0
operationId: >-
users.user.onenote.notebooks.notebook.sections.onenoteSection.copyToSectionGroup
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup
- /users/{user-id}/onenote/sections/{onenoteSection-id}/copyToSectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.notebooks.sections.ListPages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.onenotePageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to pages for users
operationId: users.onenote.notebooks.sections.CreatePages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages
- /users/{user-id}/onenote/sections/{onenoteSection-id}/pages
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.notebooks.sections.GetPages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property pages in users
operationId: users.onenote.notebooks.sections.UpdatePages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property pages for users
operationId: users.onenote.notebooks.sections.DeletePages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get content for the navigation property pages from users
description: The page's HTML content.
operationId: users.onenote.notebooks.sections.GetPagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.onenote
summary: Microsoft Graph Update content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.notebooks.sections.UpdatePagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.notebooks.sections.DeletePagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection:
description: Provides operations to call the copyToSection method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSection
description: >-
Copy a page to a specific section. For copy operations, you follow an
asynchronous calling pattern: First call the Copy action, and then poll
the operation endpoint for the result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/page-copytosection?view=graph-rest-1.0
operationId: >-
users.user.onenote.notebooks.notebook.sections.onenoteSection.pages.onenotePage.copyToSection
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent:
description: Provides operations to call the onenotePatchContent method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action onenotePatchContent
operationId: >-
users.user.onenote.notebooks.notebook.sections.onenoteSection.pages.onenotePage.onenotePatchContent
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
commands:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.onenotePatchContentCommand
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- /users/{user-id}/onenote/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview():
description: Provides operations to call the preview method.
get:
tags:
- Users.onenote
summary: Microsoft Graph Invoke function preview
operationId: >-
users.user.onenote.notebooks.notebook.sections.onenoteSection.pages.onenotePage.preview
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePagePreview'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- /users/{user-id}/onenote/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the page. Read-only.
operationId: users.onenote.notebooks.sections.pages.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection:
description: >-
Provides operations to manage the parentSection property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSection from users
description: The section that contains the page. Read-only.
operationId: users.onenote.notebooks.sections.pages.GetParentSection
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.notebooks.sections.pages.GetCount-c5e5
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the section. Read-only.
operationId: users.onenote.notebooks.sections.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook
- /users/{user-id}/onenote/sections/{onenoteSection-id}/parentNotebook
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentSectionGroup:
description: >-
Provides operations to manage the parentSectionGroup property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSectionGroup from users
description: The section group that contains the section. Read-only.
operationId: users.onenote.notebooks.sections.GetParentSectionGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup
- /users/{user-id}/onenote/sections/{onenoteSection-id}/parentSectionGroup
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.notebooks.sections.GetCount-2f79
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: notebook-id
in: path
description: The unique identifier of notebook
required: true
schema:
type: string
x-ms-docs-key-type: notebook
/users/{user-id}/onenote/notebooks/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.notebooks.GetCount-af06
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/notebooks/getNotebookFromWebUrl:
description: Provides operations to call the getNotebookFromWebUrl method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action getNotebookFromWebUrl
description: >-
Retrieve the properties and relationships of a notebook object by using
its URL path. The location can be user notebooks on Microsoft 365, group
notebooks, or SharePoint site-hosted team notebooks on Microsoft 365.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/notebook-getnotebookfromweburl?view=graph-rest-1.0
operationId: users.user.onenote.notebooks.getNotebookFromWebUrl
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
webUrl:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.CopyNotebookModel'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/notebooks/getRecentNotebooks(includePersonalNotebooks={includePersonalNotebooks}):
description: Provides operations to call the getRecentNotebooks method.
get:
tags:
- Users.onenote
summary: Microsoft Graph Invoke function getRecentNotebooks
description: >-
Get a list of recentNotebook instances that have been accessed by the
signed-in user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/notebook-getrecentnotebooks?view=graph-rest-1.0
operationId: users.user.onenote.notebooks.getRecentNotebooks
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recentNotebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: includePersonalNotebooks
in: path
description: 'Usage: includePersonalNotebooks={includePersonalNotebooks}'
required: true
schema:
type: boolean
default: false
/users/{user-id}/onenote/operations:
description: >-
Provides operations to manage the operations property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get operations from users
description: >-
The status of OneNote operations. Getting an operations collection isn't
supported, but you can get the status of long-running operations if the
Operation-Location header is returned in the response. Read-only.
Nullable.
operationId: users.onenote.ListOperations
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.onenoteOperationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to operations for users
operationId: users.onenote.CreateOperations
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/operations/{onenoteOperation-id}:
description: >-
Provides operations to manage the operations property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get operations from users
description: >-
The status of OneNote operations. Getting an operations collection isn't
supported, but you can get the status of long-running operations if the
Operation-Location header is returned in the response. Read-only.
Nullable.
operationId: users.onenote.GetOperations
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property operations in users
operationId: users.onenote.UpdateOperations
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property operations for users
operationId: users.onenote.DeleteOperations
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteOperation-id
in: path
description: The unique identifier of onenoteOperation
required: true
schema:
type: string
x-ms-docs-key-type: onenoteOperation
/users/{user-id}/onenote/operations/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.operations.GetCount-adfa
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/pages:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: >-
The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
operationId: users.onenote.ListPages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.onenotePageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to pages for users
operationId: users.onenote.CreatePages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/pages/{onenotePage-id}:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: >-
The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
operationId: users.onenote.GetPages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property pages in users
operationId: users.onenote.UpdatePages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property pages for users
operationId: users.onenote.DeletePages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
/users/{user-id}/onenote/pages/{onenotePage-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get content for the navigation property pages from users
description: The page's HTML content.
operationId: users.onenote.GetPagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.onenote
summary: Microsoft Graph Update content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.UpdatePagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.DeletePagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
/users/{user-id}/onenote/pages/{onenotePage-id}/copyToSection:
description: Provides operations to call the copyToSection method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSection
description: >-
Copy a page to a specific section. For copy operations, you follow an
asynchronous calling pattern: First call the Copy action, and then poll
the operation endpoint for the result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/page-copytosection?view=graph-rest-1.0
operationId: users.user.onenote.pages.onenotePage.copyToSection
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
/users/{user-id}/onenote/pages/{onenotePage-id}/onenotePatchContent:
description: Provides operations to call the onenotePatchContent method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action onenotePatchContent
operationId: users.user.onenote.pages.onenotePage.onenotePatchContent
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
commands:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.onenotePatchContentCommand
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
/users/{user-id}/onenote/pages/{onenotePage-id}/preview():
description: Provides operations to call the preview method.
get:
tags:
- Users.onenote
summary: Microsoft Graph Invoke function preview
operationId: users.user.onenote.pages.onenotePage.preview
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePagePreview'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
/users/{user-id}/onenote/pages/{onenotePage-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the page. Read-only.
operationId: users.onenote.pages.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
/users/{user-id}/onenote/pages/{onenotePage-id}/parentSection:
description: >-
Provides operations to manage the parentSection property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSection from users
description: The section that contains the page. Read-only.
operationId: users.onenote.pages.GetParentSection
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
/users/{user-id}/onenote/pages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.pages.GetCount-b080
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/resources:
description: >-
Provides operations to manage the resources property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get resources from users
description: >-
The image and other file resources in OneNote pages. Getting a resources
collection isn't supported, but you can get the binary content of a
specific resource. Read-only. Nullable.
operationId: users.onenote.ListResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.onenoteResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to resources for users
operationId: users.onenote.CreateResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/resources/{onenoteResource-id}:
description: >-
Provides operations to manage the resources property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get resources from users
description: >-
The image and other file resources in OneNote pages. Getting a resources
collection isn't supported, but you can get the binary content of a
specific resource. Read-only. Nullable.
operationId: users.onenote.GetResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property resources in users
operationId: users.onenote.UpdateResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property resources for users
operationId: users.onenote.DeleteResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteResource-id
in: path
description: The unique identifier of onenoteResource
required: true
schema:
type: string
x-ms-docs-key-type: onenoteResource
/users/{user-id}/onenote/resources/{onenoteResource-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get content for the navigation property resources from users
description: The content stream
operationId: users.onenote.GetResourcesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.onenote
summary: Microsoft Graph Update content for the navigation property resources in users
description: The content stream
operationId: users.onenote.UpdateResourcesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete content for the navigation property resources in users
description: The content stream
operationId: users.onenote.DeleteResourcesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteResource-id
in: path
description: The unique identifier of onenoteResource
required: true
schema:
type: string
x-ms-docs-key-type: onenoteResource
/users/{user-id}/onenote/resources/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.resources.GetCount-dba6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/sectionGroups:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: >-
The section groups in all OneNote notebooks that are owned by the user
or group. Read-only. Nullable.
operationId: users.onenote.ListSectionGroups
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sectionGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to sectionGroups for users
operationId: users.onenote.CreateSectionGroups
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: >-
The section groups in all OneNote notebooks that are owned by the user
or group. Read-only. Nullable.
operationId: users.onenote.GetSectionGroups
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property sectionGroups in users
operationId: users.onenote.UpdateSectionGroups
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property sectionGroups for users
operationId: users.onenote.DeleteSectionGroups
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the section group. Read-only.
operationId: users.onenote.sectionGroups.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/parentNotebook
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/parentSectionGroup:
description: >-
Provides operations to manage the parentSectionGroup property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSectionGroup from users
description: The section group that contains the section group. Read-only.
operationId: users.onenote.sectionGroups.GetParentSectionGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/parentSectionGroup
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sectionGroups:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: The section groups in the section. Read-only. Nullable.
operationId: users.onenote.sectionGroups.ListSectionGroups
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.sectionGroupCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sectionGroups
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sectionGroups/{sectionGroup-id1}:
description: >-
Provides operations to manage the sectionGroups property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sectionGroups from users
description: The section groups in the section. Read-only. Nullable.
operationId: users.onenote.sectionGroups.GetSectionGroups
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: sectionGroup-id1
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sectionGroups/{sectionGroup-id1}
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sectionGroups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.sectionGroups.sectionGroups.GetCount-497a
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: The sections in the section group. Read-only. Nullable.
operationId: users.onenote.sectionGroups.ListSections
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.onenoteSectionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to sections for users
operationId: users.onenote.sectionGroups.CreateSections
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.sectionGroup entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: The sections in the section group. Read-only. Nullable.
operationId: users.onenote.sectionGroups.GetSections
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property sections in users
operationId: users.onenote.sectionGroups.UpdateSections
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property sections for users
operationId: users.onenote.sectionGroups.DeleteSections
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook:
description: Provides operations to call the copyToNotebook method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToNotebook
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytonotebook?view=graph-rest-1.0
operationId: >-
users.user.onenote.sectionGroups.sectionGroup.sections.onenoteSection.copyToNotebook
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToNotebook
- /users/{user-id}/onenote/sections/{onenoteSection-id}/copyToNotebook
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup:
description: Provides operations to call the copyToSectionGroup method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSectionGroup
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytosectiongroup?view=graph-rest-1.0
operationId: >-
users.user.onenote.sectionGroups.sectionGroup.sections.onenoteSection.copyToSectionGroup
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToSectionGroup
- /users/{user-id}/onenote/sections/{onenoteSection-id}/copyToSectionGroup
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.sectionGroups.sections.ListPages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.onenotePageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to pages for users
operationId: users.onenote.sectionGroups.sections.CreatePages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages
- /users/{user-id}/onenote/sections/{onenoteSection-id}/pages
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.sectionGroups.sections.GetPages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property pages in users
operationId: users.onenote.sectionGroups.sections.UpdatePages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property pages for users
operationId: users.onenote.sectionGroups.sections.DeletePages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get content for the navigation property pages from users
description: The page's HTML content.
operationId: users.onenote.sectionGroups.sections.GetPagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.onenote
summary: Microsoft Graph Update content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.sectionGroups.sections.UpdatePagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.sectionGroups.sections.DeletePagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection:
description: Provides operations to call the copyToSection method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSection
description: >-
Copy a page to a specific section. For copy operations, you follow an
asynchronous calling pattern: First call the Copy action, and then poll
the operation endpoint for the result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/page-copytosection?view=graph-rest-1.0
operationId: >-
users.user.onenote.sectionGroups.sectionGroup.sections.onenoteSection.pages.onenotePage.copyToSection
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
? /users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
: description: Provides operations to call the onenotePatchContent method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action onenotePatchContent
operationId: >-
users.user.onenote.sectionGroups.sectionGroup.sections.onenoteSection.pages.onenotePage.onenotePatchContent
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
commands:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.onenotePatchContentCommand
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- /users/{user-id}/onenote/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview():
description: Provides operations to call the preview method.
get:
tags:
- Users.onenote
summary: Microsoft Graph Invoke function preview
operationId: >-
users.user.onenote.sectionGroups.sectionGroup.sections.onenoteSection.pages.onenotePage.preview
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePagePreview'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- /users/{user-id}/onenote/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
? /users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
: description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the page. Read-only.
operationId: users.onenote.sectionGroups.sections.pages.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection:
description: >-
Provides operations to manage the parentSection property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSection from users
description: The section that contains the page. Read-only.
operationId: users.onenote.sectionGroups.sections.pages.GetParentSection
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.sectionGroups.sections.pages.GetCount-dfde
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the section. Read-only.
operationId: users.onenote.sectionGroups.sections.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentNotebook
- /users/{user-id}/onenote/sections/{onenoteSection-id}/parentNotebook
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup:
description: >-
Provides operations to manage the parentSectionGroup property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSectionGroup from users
description: The section group that contains the section. Read-only.
operationId: users.onenote.sectionGroups.sections.GetParentSectionGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentSectionGroup
- /users/{user-id}/onenote/sections/{onenoteSection-id}/parentSectionGroup
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.sectionGroups.sections.GetCount-6826
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: sectionGroup-id
in: path
description: The unique identifier of sectionGroup
required: true
schema:
type: string
x-ms-docs-key-type: sectionGroup
/users/{user-id}/onenote/sectionGroups/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.sectionGroups.GetCount-497a
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/sections:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: >-
The sections in all OneNote notebooks that are owned by the user or
group. Read-only. Nullable.
operationId: users.onenote.ListSections
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.onenoteSectionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to sections for users
operationId: users.onenote.CreateSections
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onenote/sections/{onenoteSection-id}:
description: >-
Provides operations to manage the sections property of the
microsoft.graph.onenote entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get sections from users
description: >-
The sections in all OneNote notebooks that are owned by the user or
group. Read-only. Nullable.
operationId: users.onenote.GetSections
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property sections in users
operationId: users.onenote.UpdateSections
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property sections for users
operationId: users.onenote.DeleteSections
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
/users/{user-id}/onenote/sections/{onenoteSection-id}/copyToNotebook:
description: Provides operations to call the copyToNotebook method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToNotebook
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytonotebook?view=graph-rest-1.0
operationId: users.user.onenote.sections.onenoteSection.copyToNotebook
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToNotebook
/users/{user-id}/onenote/sections/{onenoteSection-id}/copyToSectionGroup:
description: Provides operations to call the copyToSectionGroup method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSectionGroup
description: >-
For Copy operations, you follow an asynchronous calling pattern: First
call the Copy action, and then poll the operation endpoint for the
result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/section-copytosectiongroup?view=graph-rest-1.0
operationId: users.user.onenote.sections.onenoteSection.copyToSectionGroup
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
renameAs:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/copyToSectionGroup
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/copyToSectionGroup
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.sections.ListPages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.onenotePageCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.onenote
summary: Microsoft Graph Create new navigation property to pages for users
operationId: users.onenote.sections.CreatePages
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}:
description: >-
Provides operations to manage the pages property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get pages from users
description: The collection of pages in the section. Read-only. Nullable.
operationId: users.onenote.sections.GetPages
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.onenote
summary: Microsoft Graph Update the navigation property pages in users
operationId: users.onenote.sections.UpdatePages
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete navigation property pages for users
operationId: users.onenote.sections.DeletePages
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get content for the navigation property pages from users
description: The page's HTML content.
operationId: users.onenote.sections.GetPagesContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.onenote
summary: Microsoft Graph Update content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.sections.UpdatePagesContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.onenote
summary: Microsoft Graph Delete content for the navigation property pages in users
description: The page's HTML content.
operationId: users.onenote.sections.DeletePagesContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection:
description: Provides operations to call the copyToSection method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action copyToSection
description: >-
Copy a page to a specific section. For copy operations, you follow an
asynchronous calling pattern: First call the Copy action, and then poll
the operation endpoint for the result.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/page-copytosection?view=graph-rest-1.0
operationId: >-
users.user.onenote.sections.onenoteSection.pages.onenotePage.copyToSection
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
id:
type: string
nullable: true
groupId:
type: string
nullable: true
siteCollectionId:
type: string
nullable: true
siteId:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/copyToSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/copyToSection
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent:
description: Provides operations to call the onenotePatchContent method.
post:
tags:
- Users.onenote
summary: Microsoft Graph Invoke action onenotePatchContent
operationId: >-
users.user.onenote.sections.onenoteSection.pages.onenotePage.onenotePatchContent
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
commands:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.onenotePatchContentCommand
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
- /users/{user-id}/onenote/pages/{onenotePage-id}/onenotePatchContent
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/onenotePatchContent
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview():
description: Provides operations to call the preview method.
get:
tags:
- Users.onenote
summary: Microsoft Graph Invoke function preview
operationId: users.user.onenote.sections.onenoteSection.pages.onenotePage.preview
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePagePreview'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
- /users/{user-id}/onenote/pages/{onenotePage-id}/preview()
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/preview()
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the page. Read-only.
operationId: users.onenote.sections.pages.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentNotebook
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection:
description: >-
Provides operations to manage the parentSection property of the
microsoft.graph.onenotePage entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSection from users
description: The section that contains the page. Read-only.
operationId: users.onenote.sections.pages.GetParentSection
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
- name: onenotePage-id
in: path
description: The unique identifier of onenotePage
required: true
schema:
type: string
x-ms-docs-key-type: onenotePage
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
- /users/{user-id}/onenote/pages/{onenotePage-id}/parentSection
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/pages/{onenotePage-id}/parentSection
/users/{user-id}/onenote/sections/{onenoteSection-id}/pages/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.sections.pages.GetCount-17eb
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
/users/{user-id}/onenote/sections/{onenoteSection-id}/parentNotebook:
description: >-
Provides operations to manage the parentNotebook property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentNotebook from users
description: The notebook that contains the section. Read-only.
operationId: users.onenote.sections.GetParentNotebook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebook'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentNotebook
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentNotebook
/users/{user-id}/onenote/sections/{onenoteSection-id}/parentSectionGroup:
description: >-
Provides operations to manage the parentSectionGroup property of the
microsoft.graph.onenoteSection entity.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get parentSectionGroup from users
description: The section group that contains the section. Read-only.
operationId: users.onenote.sections.GetParentSectionGroup
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onenoteSection-id
in: path
description: The unique identifier of onenoteSection
required: true
schema:
type: string
x-ms-docs-key-type: onenoteSection
x-ms-docs-grouped-path:
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup
- >-
/users/{user-id}/onenote/notebooks/{notebook-id}/sections/{onenoteSection-id}/parentSectionGroup
- >-
/users/{user-id}/onenote/sectionGroups/{sectionGroup-id}/sections/{onenoteSection-id}/parentSectionGroup
/users/{user-id}/onenote/sections/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.onenote
summary: Microsoft Graph Get the number of the resource
operationId: users.onenote.sections.GetCount-8b0b
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onlineMeetings:
description: >-
Provides operations to manage the onlineMeetings property of the
microsoft.graph.user entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get onlineMeetings from users
description: >-
Information about a meeting, including the URL used to join a meeting,
the attendees list, and the description.
operationId: users.ListOnlineMeetings
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.onlineMeetingCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Create new navigation property to onlineMeetings for users
operationId: users.CreateOnlineMeetings
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onlineMeetings/{onlineMeeting-id}:
description: >-
Provides operations to manage the onlineMeetings property of the
microsoft.graph.user entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get onlineMeetings from users
description: >-
Information about a meeting, including the URL used to join a meeting,
the attendees list, and the description.
operationId: users.GetOnlineMeetings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update the navigation property onlineMeetings in users
operationId: users.UpdateOnlineMeetings
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete navigation property onlineMeetings for users
operationId: users.DeleteOnlineMeetings
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/attendanceReports:
description: >-
Provides operations to manage the attendanceReports property of the
microsoft.graph.onlineMeetingBase entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get attendanceReports from users
description: The attendance reports of an online meeting. Read-only.
operationId: users.onlineMeetings.ListAttendanceReports
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.meetingAttendanceReportCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Create new navigation property to attendanceReports for users
operationId: users.onlineMeetings.CreateAttendanceReports
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/attendanceReports/{meetingAttendanceReport-id}:
description: >-
Provides operations to manage the attendanceReports property of the
microsoft.graph.onlineMeetingBase entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get attendanceReports from users
description: The attendance reports of an online meeting. Read-only.
operationId: users.onlineMeetings.GetAttendanceReports
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update the navigation property attendanceReports in users
operationId: users.onlineMeetings.UpdateAttendanceReports
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete navigation property attendanceReports for users
operationId: users.onlineMeetings.DeleteAttendanceReports
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: meetingAttendanceReport-id
in: path
description: The unique identifier of meetingAttendanceReport
required: true
schema:
type: string
x-ms-docs-key-type: meetingAttendanceReport
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/attendanceReports/{meetingAttendanceReport-id}/attendanceRecords:
description: >-
Provides operations to manage the attendanceRecords property of the
microsoft.graph.meetingAttendanceReport entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get attendanceRecords from users
description: List of attendance records of an attendance report. Read-only.
operationId: users.onlineMeetings.attendanceReports.ListAttendanceRecords
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.attendanceRecordCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Create new navigation property to attendanceRecords for users
operationId: users.onlineMeetings.attendanceReports.CreateAttendanceRecords
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attendanceRecord'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attendanceRecord'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: meetingAttendanceReport-id
in: path
description: The unique identifier of meetingAttendanceReport
required: true
schema:
type: string
x-ms-docs-key-type: meetingAttendanceReport
? /users/{user-id}/onlineMeetings/{onlineMeeting-id}/attendanceReports/{meetingAttendanceReport-id}/attendanceRecords/{attendanceRecord-id}
: description: >-
Provides operations to manage the attendanceRecords property of the
microsoft.graph.meetingAttendanceReport entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get attendanceRecords from users
description: List of attendance records of an attendance report. Read-only.
operationId: users.onlineMeetings.attendanceReports.GetAttendanceRecords
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attendanceRecord'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update the navigation property attendanceRecords in users
operationId: users.onlineMeetings.attendanceReports.UpdateAttendanceRecords
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attendanceRecord'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attendanceRecord'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete navigation property attendanceRecords for users
operationId: users.onlineMeetings.attendanceReports.DeleteAttendanceRecords
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: meetingAttendanceReport-id
in: path
description: The unique identifier of meetingAttendanceReport
required: true
schema:
type: string
x-ms-docs-key-type: meetingAttendanceReport
- name: attendanceRecord-id
in: path
description: The unique identifier of attendanceRecord
required: true
schema:
type: string
x-ms-docs-key-type: attendanceRecord
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/attendanceReports/{meetingAttendanceReport-id}/attendanceRecords/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get the number of the resource
operationId: users.onlineMeetings.attendanceReports.attendanceRecords.GetCount-3340
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: meetingAttendanceReport-id
in: path
description: The unique identifier of meetingAttendanceReport
required: true
schema:
type: string
x-ms-docs-key-type: meetingAttendanceReport
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/attendanceReports/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get the number of the resource
operationId: users.onlineMeetings.attendanceReports.GetCount-e849
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/attendeeReport:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get attendeeReport for the navigation property onlineMeetings from users
description: >-
The content stream of the attendee report of a Microsoft Teams live
event. Read-only.
operationId: users.GetOnlineMeetingsAttendeeReport
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.onlineMeeting
summary: >-
Microsoft Graph Update attendeeReport for the navigation property onlineMeetings in users
description: >-
The content stream of the attendee report of a Microsoft Teams live
event. Read-only.
operationId: users.UpdateOnlineMeetingsAttendeeReport
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.onlineMeeting
summary: >-
Microsoft Graph Delete attendeeReport for the navigation property onlineMeetings in users
description: >-
The content stream of the attendee report of a Microsoft Teams live
event. Read-only.
operationId: users.DeleteOnlineMeetingsAttendeeReport
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/getVirtualAppointmentJoinWebUrl():
description: Provides operations to call the getVirtualAppointmentJoinWebUrl method.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke function getVirtualAppointmentJoinWebUrl
description: >-
Get a join web URL for a Microsoft Virtual Appointment. This web URL
includes enhanced business-to-customer experiences such as mobile
browser join and virtual lobby rooms. With Teams Premium, you can
configure a custom lobby room experience for attendees by adding your
company logo and access the Virtual Appointments usage report for
organizational analytics.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/virtualappointment-getvirtualappointmentjoinweburl?view=graph-rest-1.0
operationId: users.user.onlineMeetings.onlineMeeting.getVirtualAppointmentJoinWebUrl
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: string
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/sendVirtualAppointmentReminderSms:
description: Provides operations to call the sendVirtualAppointmentReminderSms method.
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke action sendVirtualAppointmentReminderSms
description: >-
Send an SMS reminder to external attendees for a Teams virtual
appointment. This feature requires Teams premium and attendees must have
a valid United States phone number to receive SMS notifications.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/virtualappointment-sendvirtualappointmentremindersms?view=graph-rest-1.0
operationId: >-
users.user.onlineMeetings.onlineMeeting.sendVirtualAppointmentReminderSms
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
remindBeforeTimeInMinutesType:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.remindBeforeTimeInMinutesType
- type: object
nullable: true
attendees:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.attendeeNotificationInfo
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/sendVirtualAppointmentSms:
description: Provides operations to call the sendVirtualAppointmentSms method.
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke action sendVirtualAppointmentSms
description: >-
Send an SMS notification to external attendees when a Teams virtual
appointment is confirmed, rescheduled, or canceled. This feature
requires Teams premium. Attendees must have a valid United States phone
number to receive these SMS notifications.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/virtualappointment-sendvirtualappointmentsms?view=graph-rest-1.0
operationId: users.user.onlineMeetings.onlineMeeting.sendVirtualAppointmentSms
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
messageType:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.virtualAppointmentMessageType
- type: object
nullable: true
attendees:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.attendeeNotificationInfo
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings:
description: >-
Provides operations to manage the recordings property of the
microsoft.graph.onlineMeeting entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get callRecording
description: >-
Get a callRecording object associated with a scheduled online meeting
and an ad hoc call. This API supports the retrieval of call recordings
from all meeting types except live events. For a recording, this API
returns the metadata of the single recording associated with the online
meeting or an ad hoc call. For the content of a recording, this API
returns the stream of bytes associated with the recording.
operationId: users.onlineMeetings.ListRecordings
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.callRecordingCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Create new navigation property to recordings for users
operationId: users.onlineMeetings.CreateRecordings
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecording'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecording'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/{callRecording-id}:
description: >-
Provides operations to manage the recordings property of the
microsoft.graph.onlineMeeting entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get callRecording
description: >-
Get a callRecording object associated with a scheduled online meeting
and an ad hoc call. This API supports the retrieval of call recordings
from all meeting types except live events. For a recording, this API
returns the metadata of the single recording associated with the online
meeting or an ad hoc call. For the content of a recording, this API
returns the stream of bytes associated with the recording.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/callrecording-get?view=graph-rest-1.0
operationId: users.onlineMeetings.GetRecordings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecording'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update the navigation property recordings in users
operationId: users.onlineMeetings.UpdateRecordings
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecording'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecording'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete navigation property recordings for users
operationId: users.onlineMeetings.DeleteRecordings
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: callRecording-id
in: path
description: The unique identifier of callRecording
required: true
schema:
type: string
x-ms-docs-key-type: callRecording
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/{callRecording-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get content for the navigation property recordings from users
description: The content of the recording. Read-only.
operationId: users.onlineMeetings.GetRecordingsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update content for the navigation property recordings in users
description: The content of the recording. Read-only.
operationId: users.onlineMeetings.UpdateRecordingsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecording'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete content for the navigation property recordings in users
description: The content of the recording. Read-only.
operationId: users.onlineMeetings.DeleteRecordingsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: callRecording-id
in: path
description: The unique identifier of callRecording
required: true
schema:
type: string
x-ms-docs-key-type: callRecording
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get the number of the resource
operationId: users.onlineMeetings.recordings.GetCount-6c9a
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke function delta
operationId: users.user.onlineMeetings.onlineMeeting.recordings.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of callRecording
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts:
description: >-
Provides operations to manage the transcripts property of the
microsoft.graph.onlineMeeting entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph List transcripts
description: >-
Retrieve the list of callTranscript objects associated with a scheduled
onlineMeeting. This API supports the retrieval of call transcripts from
all meeting types except live events.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/onlinemeeting-list-transcripts?view=graph-rest-1.0
operationId: users.onlineMeetings.ListTranscripts
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.callTranscriptCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Create new navigation property to transcripts for users
operationId: users.onlineMeetings.CreateTranscripts
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/{callTranscript-id}:
description: >-
Provides operations to manage the transcripts property of the
microsoft.graph.onlineMeeting entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get callTranscript
description: >-
Retrieve a callTranscript object associated with a scheduled
onlineMeeting. This API supports the retrieval of call transcripts from
all meeting types except live events. Retrieving the transcript returns
the metadata of the single transcript associated with an online meeting
or an ad hoc call. Retrieving the content of the transcript returns the
stream of text associated with the transcript.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calltranscript-get?view=graph-rest-1.0
operationId: users.onlineMeetings.GetTranscripts
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update the navigation property transcripts in users
operationId: users.onlineMeetings.UpdateTranscripts
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete navigation property transcripts for users
operationId: users.onlineMeetings.DeleteTranscripts
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: callTranscript-id
in: path
description: The unique identifier of callTranscript
required: true
schema:
type: string
x-ms-docs-key-type: callTranscript
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/{callTranscript-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get callTranscript
description: >-
Retrieve a callTranscript object associated with a scheduled
onlineMeeting. This API supports the retrieval of call transcripts from
all meeting types except live events. Retrieving the transcript returns
the metadata of the single transcript associated with an online meeting
or an ad hoc call. Retrieving the content of the transcript returns the
stream of text associated with the transcript.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calltranscript-get?view=graph-rest-1.0
operationId: users.onlineMeetings.GetTranscriptsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update content for the navigation property transcripts in users
description: The content of the transcript. Read-only.
operationId: users.onlineMeetings.UpdateTranscriptsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete content for the navigation property transcripts in users
description: The content of the transcript. Read-only.
operationId: users.onlineMeetings.DeleteTranscriptsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: callTranscript-id
in: path
description: The unique identifier of callTranscript
required: true
schema:
type: string
x-ms-docs-key-type: callTranscript
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/{callTranscript-id}/metadataContent:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get callTranscript
description: >-
Retrieve a callTranscript object associated with a scheduled
onlineMeeting. This API supports the retrieval of call transcripts from
all meeting types except live events. Retrieving the transcript returns
the metadata of the single transcript associated with an online meeting
or an ad hoc call. Retrieving the content of the transcript returns the
stream of text associated with the transcript.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/calltranscript-get?view=graph-rest-1.0
operationId: users.onlineMeetings.GetTranscriptsMetadataContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.onlineMeeting
summary: Microsoft Graph Update metadataContent for the navigation property transcripts in users
description: >-
The time-aligned metadata of the utterances in the transcript.
Read-only.
operationId: users.onlineMeetings.UpdateTranscriptsMetadataContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.onlineMeeting
summary: Microsoft Graph Delete metadataContent for the navigation property transcripts in users
description: >-
The time-aligned metadata of the utterances in the transcript.
Read-only.
operationId: users.onlineMeetings.DeleteTranscriptsMetadataContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
- name: callTranscript-id
in: path
description: The unique identifier of callTranscript
required: true
schema:
type: string
x-ms-docs-key-type: callTranscript
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get the number of the resource
operationId: users.onlineMeetings.transcripts.GetCount-3b6f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
/users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke function delta
operationId: users.user.onlineMeetings.onlineMeeting.transcripts.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of callTranscript
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: onlineMeeting-id
in: path
description: The unique identifier of onlineMeeting
required: true
schema:
type: string
x-ms-docs-key-type: onlineMeeting
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/onlineMeetings/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Get the number of the resource
operationId: users.onlineMeetings.GetCount-1fc7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/onlineMeetings/createOrGet:
description: Provides operations to call the createOrGet method.
post:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke action createOrGet
description: >-
Create an onlineMeeting object with a custom specified external ID. If
the external ID already exists, this API will return the onlineMeeting
object with that external ID.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/onlinemeeting-createorget?view=graph-rest-1.0
operationId: users.user.onlineMeetings.createOrGet
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
chatInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.chatInfo'
- type: object
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
format: date-time
nullable: true
externalId:
type: string
participants:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.meetingParticipants'
- type: object
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
subject:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onlineMeeting'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
? /users/{user-id}/onlineMeetings/getAllRecordings(meetingOrganizerUserId='@meetingOrganizerUserId',startDateTime=@startDateTime,endDateTime=@endDateTime)
: description: Provides operations to call the getAllRecordings method.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke function getAllRecordings
description: >-
Get all recordings from scheduled onlineMeeting instances for which the
specified user is the organizer. This API currently doesn't support
getting call recordings from channel meetings. You can apply the delta
function on getAllRecordings to synchronize and get callRecording
resources as they're added for onlineMeeting instances organized by the
specified user. The delta query supports both full synchronization and
incremental synchronization. Full synchronization gets all the
recordings for online meetings organized by the user. Incremental
synchronization gets recordings that are added since the last
synchronization. Typically, you perform an initial full synchronization,
and then get incremental changes to that recording view periodically.
Find more information in the delta query documentation. For more
examples, see callRecording: delta. To learn more about using the
Microsoft Teams export APIs to export content, see Export content with
the Microsoft Teams export APIs.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/onlinemeeting-getallrecordings?view=graph-rest-1.0
operationId: users.user.onlineMeetings.getAllRecordings
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of callRecording
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: meetingOrganizerUserId
in: query
description: 'Usage: meetingOrganizerUserId=''@meetingOrganizerUserId'''
schema:
type: string
nullable: true
- name: startDateTime
in: query
description: 'Usage: startDateTime=@startDateTime'
schema:
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
- name: endDateTime
in: query
description: 'Usage: endDateTime=@endDateTime'
schema:
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
? /users/{user-id}/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='@meetingOrganizerUserId',startDateTime=@startDateTime,endDateTime=@endDateTime)
: description: Provides operations to call the getAllTranscripts method.
get:
tags:
- users.onlineMeeting
summary: Microsoft Graph Invoke function getAllTranscripts
description: >-
Get all transcripts from scheduled onlineMeeting instances for which the
specified user is the organizer. This API currently doesn't support
getting call transcripts from channel meetings. You can apply the delta
function on getAllTranscripts to synchronize and get callTranscript
resources as they're added for onlineMeeting instances organized by the
specified user. Delta query supports both full synchronization and
incremental synchronization. Full synchronization gets all the
transcripts for online meetings organized by the user. Incremental
synchronization gets transcripts that are added since the last
synchronization. Typically, you perform an initial full synchronization,
and then get incremental changes to that recording view periodically.
For more information, see delta query. For more examples, see
callTranscript: delta. To learn more about using the Microsoft Teams
export APIs to export content, see Export content with the Microsoft
Teams export APIs.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/onlinemeeting-getalltranscripts?view=graph-rest-1.0
operationId: users.user.onlineMeetings.getAllTranscripts
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of callTranscript
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: meetingOrganizerUserId
in: query
description: 'Usage: meetingOrganizerUserId=''@meetingOrganizerUserId'''
schema:
type: string
nullable: true
- name: startDateTime
in: query
description: 'Usage: startDateTime=@startDateTime'
schema:
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
- name: endDateTime
in: query
description: 'Usage: endDateTime=@endDateTime'
schema:
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
/users/{user-id}/outlook:
description: >-
Provides operations to manage the outlook property of the
microsoft.graph.user entity.
get:
tags:
- users.outlookUser
summary: Microsoft Graph Get outlook from users
operationId: users.GetOutlook
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.outlookUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/outlook/masterCategories:
description: >-
Provides operations to manage the masterCategories property of the
microsoft.graph.outlookUser entity.
get:
tags:
- users.outlookUser
summary: Microsoft Graph Get masterCategories from users
description: A list of categories defined for the user.
operationId: users.outlook.ListMasterCategories
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.outlookCategoryCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.outlookUser
summary: Microsoft Graph Create new navigation property to masterCategories for users
operationId: users.outlook.CreateMasterCategories
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/outlook/masterCategories/{outlookCategory-id}:
description: >-
Provides operations to manage the masterCategories property of the
microsoft.graph.outlookUser entity.
get:
tags:
- users.outlookUser
summary: Microsoft Graph Get masterCategories from users
description: A list of categories defined for the user.
operationId: users.outlook.GetMasterCategories
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.outlookUser
summary: Microsoft Graph Update the navigation property masterCategories in users
operationId: users.outlook.UpdateMasterCategories
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.outlookUser
summary: Microsoft Graph Delete navigation property masterCategories for users
operationId: users.outlook.DeleteMasterCategories
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: outlookCategory-id
in: path
description: The unique identifier of outlookCategory
required: true
schema:
type: string
x-ms-docs-key-type: outlookCategory
/users/{user-id}/outlook/masterCategories/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.outlookUser
summary: Microsoft Graph Get the number of the resource
operationId: users.outlook.masterCategories.GetCount-8560
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/outlook/supportedLanguages():
description: Provides operations to call the supportedLanguages method.
get:
tags:
- users.outlookUser
summary: Microsoft Graph Invoke function supportedLanguages
description: "Get the list of locales and languages that are supported for the user, as configured on the user's mailbox server. When setting up an Outlook client, the user selects the preferred language from this supported list. You can subsequently get the preferred language by\r\ngetting the user's mailbox settings."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/outlookuser-supportedlanguages?view=graph-rest-1.0
operationId: users.user.outlook.supportedLanguages
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.localeInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/outlook/supportedTimeZones():
description: Provides operations to call the supportedTimeZones method.
get:
tags:
- users.outlookUser
summary: Microsoft Graph Invoke function supportedTimeZones
operationId: users.user.outlook.supportedTimeZones-5c4f
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.timeZoneInformation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- >-
/users/{user-id}/outlook/supportedTimeZones(TimeZoneStandard='{TimeZoneStandard}')
/users/{user-id}/outlook/supportedTimeZones(TimeZoneStandard='{TimeZoneStandard}'):
description: Provides operations to call the supportedTimeZones method.
get:
tags:
- users.outlookUser
summary: Microsoft Graph Invoke function supportedTimeZones
operationId: users.user.outlook.supportedTimeZones-0d20
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.timeZoneInformation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: TimeZoneStandard
in: path
description: 'Usage: TimeZoneStandard=''{TimeZoneStandard}'''
required: true
schema:
$ref: '#/components/schemas/microsoft.graph.timeZoneStandard'
x-ms-docs-grouped-path:
- /users/{user-id}/outlook/supportedTimeZones()
/users/{user-id}/ownedDevices:
description: >-
Provides operations to manage the ownedDevices property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get ownedDevices from users
description: >-
Devices the user owns. Read-only. Nullable. Supports $expand and $filter
(/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
operationId: users.ListOwnedDevices
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedDevices/{directoryObject-id}:
description: >-
Provides operations to manage the ownedDevices property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get ownedDevices from users
description: >-
Devices the user owns. Read-only. Nullable. Supports $expand and $filter
(/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
operationId: users.GetOwnedDevices
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedDevices/{directoryObject-id}/graph.appRoleAssignment:
description: Casts the previous resource to appRoleAssignment.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.appRoleAssignment
operationId: users.GetOwnedDevices.AsAppRoleAssignment
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedDevices/{directoryObject-id}/graph.device:
description: Casts the previous resource to device.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.device
operationId: users.GetOwnedDevices.AsDevice
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedDevices/{directoryObject-id}/graph.endpoint:
description: Casts the previous resource to endpoint.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.endpoint
operationId: users.GetOwnedDevices.AsEndpoint
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedDevices/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.ownedDevices.GetCount-e76d
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedDevices/graph.appRoleAssignment:
description: Casts the previous resource to appRoleAssignment.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.appRoleAssignment in the microsoft.graph.directoryObject collection
operationId: users.ListOwnedDevices.AsAppRoleAssignment
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.appRoleAssignmentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedDevices/graph.appRoleAssignment/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.OwnedDevices.GetCount.AsAppRoleAssignment-59f6
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedDevices/graph.device:
description: Casts the previous resource to device.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.device in the microsoft.graph.directoryObject collection
operationId: users.ListOwnedDevices.AsDevice
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.deviceCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedDevices/graph.device/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.OwnedDevices.GetCount.AsDevice-64a9
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedDevices/graph.endpoint:
description: Casts the previous resource to endpoint.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.endpoint in the microsoft.graph.directoryObject collection
operationId: users.ListOwnedDevices.AsEndpoint
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.endpointCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedDevices/graph.endpoint/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.OwnedDevices.GetCount.AsEndpoint-bd17
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects:
description: >-
Provides operations to manage the ownedObjects property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get ownedObjects from users
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).
operationId: users.ListOwnedObjects
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects/{directoryObject-id}:
description: >-
Provides operations to manage the ownedObjects property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get ownedObjects from users
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).
operationId: users.GetOwnedObjects
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedObjects/{directoryObject-id}/graph.application:
description: Casts the previous resource to application.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.application
operationId: users.GetOwnedObjects.AsApplication
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedObjects/{directoryObject-id}/graph.group:
description: Casts the previous resource to group.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.group
operationId: users.GetOwnedObjects.AsGroup
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedObjects/{directoryObject-id}/graph.servicePrincipal:
description: Casts the previous resource to servicePrincipal.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal
operationId: users.GetOwnedObjects.AsServicePrincipal
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/ownedObjects/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.ownedObjects.GetCount-2c09
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects/graph.application:
description: Casts the previous resource to application.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.application in the microsoft.graph.directoryObject collection
operationId: users.ListOwnedObjects.AsApplication
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.applicationCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects/graph.application/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.OwnedObjects.GetCount.AsApplication-1b6d
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects/graph.group:
description: Casts the previous resource to group.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.group in the microsoft.graph.directoryObject collection
operationId: users.ListOwnedObjects.AsGroup
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.groupCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects/graph.group/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.OwnedObjects.GetCount.AsGroup-7af3
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects/graph.servicePrincipal:
description: Casts the previous resource to servicePrincipal.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection
operationId: users.ListOwnedObjects.AsServicePrincipal
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.servicePrincipalCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/ownedObjects/graph.servicePrincipal/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.OwnedObjects.GetCount.AsServicePrincipal-370f
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/people:
description: >-
Provides operations to manage the people property of the
microsoft.graph.user entity.
get:
tags:
- Users.person
summary: Microsoft Graph Get people from users
description: People that are relevant to the user. Read-only. Nullable.
operationId: users.ListPeople
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.personCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/people/{person-id}:
description: >-
Provides operations to manage the people property of the
microsoft.graph.user entity.
get:
tags:
- Users.person
summary: Microsoft Graph Get people from users
description: People that are relevant to the user. Read-only. Nullable.
operationId: users.GetPeople
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.person'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: person-id
in: path
description: The unique identifier of person
required: true
schema:
type: string
x-ms-docs-key-type: person
/users/{user-id}/people/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.person
summary: Microsoft Graph Get the number of the resource
operationId: users.people.GetCount-d516
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/permissionGrants:
description: >-
Provides operations to manage the permissionGrants property of the
microsoft.graph.user entity.
get:
tags:
- users.resourceSpecificPermissionGrant
summary: Microsoft Graph List permissionGrants of a user
description: >-
List all resource-specific permission grants of a user. This list
specifies the Microsoft Entra apps that have access to the user, along
with the corresponding resource-specific access that each app has.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-permissiongrants?view=graph-rest-1.0
operationId: users.ListPermissionGrants
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.resourceSpecificPermissionGrantCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.resourceSpecificPermissionGrant
summary: Microsoft Graph Create new navigation property to permissionGrants for users
operationId: users.CreatePermissionGrants
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/permissionGrants/{resourceSpecificPermissionGrant-id}:
description: >-
Provides operations to manage the permissionGrants property of the
microsoft.graph.user entity.
get:
tags:
- users.resourceSpecificPermissionGrant
summary: Microsoft Graph Get permissionGrants from users
description: List all resource-specific permission grants of a user.
operationId: users.GetPermissionGrants
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.resourceSpecificPermissionGrant
summary: Microsoft Graph Update the navigation property permissionGrants in users
operationId: users.UpdatePermissionGrants
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.resourceSpecificPermissionGrant
summary: Microsoft Graph Delete navigation property permissionGrants for users
operationId: users.DeletePermissionGrants
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: resourceSpecificPermissionGrant-id
in: path
description: The unique identifier of resourceSpecificPermissionGrant
required: true
schema:
type: string
x-ms-docs-key-type: resourceSpecificPermissionGrant
/users/{user-id}/permissionGrants/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.resourceSpecificPermissionGrant
summary: Microsoft Graph Get the number of the resource
operationId: users.permissionGrants.GetCount-07aa
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/photo:
description: >-
Provides operations to manage the photo property of the
microsoft.graph.user entity.
get:
tags:
- users.profilePhoto
summary: Microsoft Graph Get photo from users
description: The user's profile photo. Read-only.
operationId: users.GetPhoto
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.profilePhoto
summary: Microsoft Graph Update the navigation property photo in users
operationId: users.UpdatePhoto
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.profilePhoto
summary: Microsoft Graph Delete navigation property photo for users
operationId: users.DeletePhoto
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/photo/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.profilePhoto
summary: Microsoft Graph Get media content for the navigation property photo from users
description: The user's profile photo. Read-only.
operationId: users.GetPhotoContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.profilePhoto
summary: Microsoft Graph Update media content for the navigation property photo in users
description: The user's profile photo. Read-only.
operationId: users.UpdatePhotoContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.profilePhoto
summary: Microsoft Graph Delete media content for the navigation property photo in users
description: The user's profile photo. Read-only.
operationId: users.DeletePhotoContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/photos:
description: >-
Provides operations to manage the photos property of the
microsoft.graph.user entity.
get:
tags:
- users.profilePhoto
summary: Microsoft Graph Get photos from users
description: >-
The collection of the user's profile photos in different sizes.
Read-only.
operationId: users.ListPhotos
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.profilePhotoCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/photos/{profilePhoto-id}:
description: >-
Provides operations to manage the photos property of the
microsoft.graph.user entity.
get:
tags:
- users.profilePhoto
summary: Microsoft Graph Get photos from users
description: >-
The collection of the user's profile photos in different sizes.
Read-only.
operationId: users.GetPhotos
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: profilePhoto-id
in: path
description: The unique identifier of profilePhoto
required: true
schema:
type: string
x-ms-docs-key-type: profilePhoto
/users/{user-id}/photos/{profilePhoto-id}/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- users.profilePhoto
summary: Microsoft Graph Get media content for the navigation property photos from users
description: The unique identifier for an entity. Read-only.
operationId: users.GetPhotosContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- users.profilePhoto
summary: Microsoft Graph Update media content for the navigation property photos in users
description: The unique identifier for an entity. Read-only.
operationId: users.UpdatePhotosContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- users.profilePhoto
summary: Microsoft Graph Delete media content for the navigation property photos in users
description: The unique identifier for an entity. Read-only.
operationId: users.DeletePhotosContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: profilePhoto-id
in: path
description: The unique identifier of profilePhoto
required: true
schema:
type: string
x-ms-docs-key-type: profilePhoto
/users/{user-id}/planner:
description: >-
Provides operations to manage the planner property of the
microsoft.graph.user entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get planner from users
description: >-
Entry-point to the Planner resource that might exist for a user.
Read-only.
operationId: users.GetPlanner
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property planner in users
operationId: users.UpdatePlanner
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerUser'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerUser'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property planner for users
operationId: users.DeletePlanner
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/planner/plans:
description: >-
Provides operations to manage the plans property of the
microsoft.graph.plannerUser entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get plans from users
description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
operationId: users.planner.ListPlans
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.plannerPlanCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.plannerUser
summary: Microsoft Graph Create new navigation property to plans for users
operationId: users.planner.CreatePlans
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/planner/plans/{plannerPlan-id}:
description: >-
Provides operations to manage the plans property of the
microsoft.graph.plannerUser entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get plans from users
description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
operationId: users.planner.GetPlans
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property plans in users
operationId: users.planner.UpdatePlans
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property plans for users
operationId: users.planner.DeletePlans
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets:
description: >-
Provides operations to manage the buckets property of the
microsoft.graph.plannerPlan entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get buckets from users
description: Read-only. Nullable. Collection of buckets in the plan.
operationId: users.planner.plans.ListBuckets
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.plannerBucketCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.plannerUser
summary: Microsoft Graph Create new navigation property to buckets for users
operationId: users.planner.plans.CreateBuckets
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}:
description: >-
Provides operations to manage the buckets property of the
microsoft.graph.plannerPlan entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get buckets from users
description: Read-only. Nullable. Collection of buckets in the plan.
operationId: users.planner.plans.GetBuckets
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property buckets in users
operationId: users.planner.plans.UpdateBuckets
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property buckets for users
operationId: users.planner.plans.DeleteBuckets
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerBucket entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get tasks from users
description: Read-only. Nullable. The collection of tasks in the bucket.
operationId: users.planner.plans.buckets.ListTasks
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.plannerTaskCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.plannerUser
summary: Microsoft Graph Create new navigation property to tasks for users
operationId: users.planner.plans.buckets.CreateTasks
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerBucket entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get tasks from users
description: Read-only. Nullable. The collection of tasks in the bucket.
operationId: users.planner.plans.buckets.GetTasks
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property tasks in users
operationId: users.planner.plans.buckets.UpdateTasks
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property tasks for users
operationId: users.planner.plans.buckets.DeleteTasks
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
? /users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat
: description: >-
Provides operations to manage the assignedToTaskBoardFormat property of
the microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get assignedToTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by assignedTo.
operationId: users.planner.plans.buckets.tasks.GetAssignedToTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property assignedToTaskBoardFormat in users
operationId: users.planner.plans.buckets.tasks.UpdateAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property assignedToTaskBoardFormat for users
operationId: users.planner.plans.buckets.tasks.DeleteAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat
- >-
/users/{user-id}/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat:
description: >-
Provides operations to manage the bucketTaskBoardFormat property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get bucketTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by bucket.
operationId: users.planner.plans.buckets.tasks.GetBucketTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property bucketTaskBoardFormat in users
operationId: users.planner.plans.buckets.tasks.UpdateBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property bucketTaskBoardFormat for users
operationId: users.planner.plans.buckets.tasks.DeleteBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat
- /users/{user-id}/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details:
description: >-
Provides operations to manage the details property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get details from users
description: Read-only. Nullable. More details about the task.
operationId: users.planner.plans.buckets.tasks.GetDetails
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property details in users
operationId: users.planner.plans.buckets.tasks.UpdateDetails
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property details for users
operationId: users.planner.plans.buckets.tasks.DeleteDetails
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details
- /users/{user-id}/planner/tasks/{plannerTask-id}/details
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat:
description: >-
Provides operations to manage the progressTaskBoardFormat property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get progressTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by progress.
operationId: users.planner.plans.buckets.tasks.GetProgressTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property progressTaskBoardFormat in users
operationId: users.planner.plans.buckets.tasks.UpdateProgressTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property progressTaskBoardFormat for users
operationId: users.planner.plans.buckets.tasks.DeleteProgressTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat
- /users/{user-id}/planner/tasks/{plannerTask-id}/progressTaskBoardFormat
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get the number of the resource
operationId: users.planner.plans.buckets.tasks.GetCount-de1b
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerBucket-id
in: path
description: The unique identifier of plannerBucket
required: true
schema:
type: string
x-ms-docs-key-type: plannerBucket
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get the number of the resource
operationId: users.planner.plans.buckets.GetCount-f7f0
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/users/{user-id}/planner/plans/{plannerPlan-id}/details:
description: >-
Provides operations to manage the details property of the
microsoft.graph.plannerPlan entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get details from users
description: Read-only. Nullable. Extra details about the plan.
operationId: users.planner.plans.GetDetails
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property details in users
operationId: users.planner.plans.UpdateDetails
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property details for users
operationId: users.planner.plans.DeleteDetails
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerPlan entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get tasks from users
description: Read-only. Nullable. Collection of tasks in the plan.
operationId: users.planner.plans.ListTasks
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.plannerTaskCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.plannerUser
summary: Microsoft Graph Create new navigation property to tasks for users
operationId: users.planner.plans.CreateTasks
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerPlan entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get tasks from users
description: Read-only. Nullable. Collection of tasks in the plan.
operationId: users.planner.plans.GetTasks
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property tasks in users
operationId: users.planner.plans.UpdateTasks
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property tasks for users
operationId: users.planner.plans.DeleteTasks
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat:
description: >-
Provides operations to manage the assignedToTaskBoardFormat property of
the microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get assignedToTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by assignedTo.
operationId: users.planner.plans.tasks.GetAssignedToTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property assignedToTaskBoardFormat in users
operationId: users.planner.plans.tasks.UpdateAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property assignedToTaskBoardFormat for users
operationId: users.planner.plans.tasks.DeleteAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat
- >-
/users/{user-id}/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat:
description: >-
Provides operations to manage the bucketTaskBoardFormat property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get bucketTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by bucket.
operationId: users.planner.plans.tasks.GetBucketTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property bucketTaskBoardFormat in users
operationId: users.planner.plans.tasks.UpdateBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property bucketTaskBoardFormat for users
operationId: users.planner.plans.tasks.DeleteBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat
- /users/{user-id}/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details:
description: >-
Provides operations to manage the details property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get details from users
description: Read-only. Nullable. More details about the task.
operationId: users.planner.plans.tasks.GetDetails
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property details in users
operationId: users.planner.plans.tasks.UpdateDetails
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property details for users
operationId: users.planner.plans.tasks.DeleteDetails
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details
- /users/{user-id}/planner/tasks/{plannerTask-id}/details
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat:
description: >-
Provides operations to manage the progressTaskBoardFormat property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get progressTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by progress.
operationId: users.planner.plans.tasks.GetProgressTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property progressTaskBoardFormat in users
operationId: users.planner.plans.tasks.UpdateProgressTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property progressTaskBoardFormat for users
operationId: users.planner.plans.tasks.DeleteProgressTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat
- /users/{user-id}/planner/tasks/{plannerTask-id}/progressTaskBoardFormat
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get the number of the resource
operationId: users.planner.plans.tasks.GetCount-082b
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerPlan-id
in: path
description: The unique identifier of plannerPlan
required: true
schema:
type: string
x-ms-docs-key-type: plannerPlan
/users/{user-id}/planner/plans/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get the number of the resource
operationId: users.planner.plans.GetCount-b724
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/planner/tasks:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerUser entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get tasks from users
description: Read-only. Nullable. Returns the plannerPlans shared with the user.
operationId: users.planner.ListTasks
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.plannerTaskCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.plannerUser
summary: Microsoft Graph Create new navigation property to tasks for users
operationId: users.planner.CreateTasks
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/planner/tasks/{plannerTask-id}:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.plannerUser entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get tasks from users
description: Read-only. Nullable. Returns the plannerPlans shared with the user.
operationId: users.planner.GetTasks
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property tasks in users
operationId: users.planner.UpdateTasks
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property tasks for users
operationId: users.planner.DeleteTasks
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
/users/{user-id}/planner/tasks/{plannerTask-id}/assignedToTaskBoardFormat:
description: >-
Provides operations to manage the assignedToTaskBoardFormat property of
the microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get assignedToTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by assignedTo.
operationId: users.planner.tasks.GetAssignedToTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property assignedToTaskBoardFormat in users
operationId: users.planner.tasks.UpdateAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property assignedToTaskBoardFormat for users
operationId: users.planner.tasks.DeleteAssignedToTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/assignedToTaskBoardFormat
/users/{user-id}/planner/tasks/{plannerTask-id}/bucketTaskBoardFormat:
description: >-
Provides operations to manage the bucketTaskBoardFormat property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get bucketTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by bucket.
operationId: users.planner.tasks.GetBucketTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property bucketTaskBoardFormat in users
operationId: users.planner.tasks.UpdateBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property bucketTaskBoardFormat for users
operationId: users.planner.tasks.DeleteBucketTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/bucketTaskBoardFormat
/users/{user-id}/planner/tasks/{plannerTask-id}/details:
description: >-
Provides operations to manage the details property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get details from users
description: Read-only. Nullable. More details about the task.
operationId: users.planner.tasks.GetDetails
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property details in users
operationId: users.planner.tasks.UpdateDetails
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property details for users
operationId: users.planner.tasks.DeleteDetails
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/details
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/details
/users/{user-id}/planner/tasks/{plannerTask-id}/progressTaskBoardFormat:
description: >-
Provides operations to manage the progressTaskBoardFormat property of the
microsoft.graph.plannerTask entity.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get progressTaskBoardFormat from users
description: >-
Read-only. Nullable. Used to render the task correctly in the task board
view when grouped by progress.
operationId: users.planner.tasks.GetProgressTaskBoardFormat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.plannerUser
summary: Microsoft Graph Update the navigation property progressTaskBoardFormat in users
operationId: users.planner.tasks.UpdateProgressTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag value.
required: true
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.plannerUser
summary: Microsoft Graph Delete navigation property progressTaskBoardFormat for users
operationId: users.planner.tasks.DeleteProgressTaskBoardFormat
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: plannerTask-id
in: path
description: The unique identifier of plannerTask
required: true
schema:
type: string
x-ms-docs-key-type: plannerTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/buckets/{plannerBucket-id}/tasks/{plannerTask-id}/progressTaskBoardFormat
- >-
/users/{user-id}/planner/plans/{plannerPlan-id}/tasks/{plannerTask-id}/progressTaskBoardFormat
/users/{user-id}/planner/tasks/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.plannerUser
summary: Microsoft Graph Get the number of the resource
operationId: users.planner.tasks.GetCount-8740
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/presence:
description: >-
Provides operations to manage the presence property of the
microsoft.graph.user entity.
get:
tags:
- Users.presence
summary: Microsoft Graph Get presence
description: Get a user's presence information.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/presence-get?view=graph-rest-1.0
operationId: users.GetPresence
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.presence'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.presence
summary: Microsoft Graph Update the navigation property presence in users
operationId: users.UpdatePresence
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.presence'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.presence'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.presence
summary: Microsoft Graph Delete navigation property presence for users
operationId: users.DeletePresence
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/presence/clearPresence:
description: Provides operations to call the clearPresence method.
post:
tags:
- Users.presence
summary: Microsoft Graph Invoke action clearPresence
description: >-
Clear the application's presence session for a user. If it is the user's
only presence session, the user's presence will change to
Offline/Offline. For details about presences sessions, see presence:
setPresence.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/presence-clearpresence?view=graph-rest-1.0
operationId: users.user.presence.clearPresence
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
sessionId:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/presence/clearUserPreferredPresence:
description: Provides operations to call the clearUserPreferredPresence method.
post:
tags:
- Users.presence
summary: Microsoft Graph Invoke action clearUserPreferredPresence
description: Clear the preferred availability and activity status for a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/presence-clearuserpreferredpresence?view=graph-rest-1.0
operationId: users.user.presence.clearUserPreferredPresence
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/presence/setPresence:
description: Provides operations to call the setPresence method.
post:
tags:
- Users.presence
summary: Microsoft Graph Invoke action setPresence
description: >-
Set the state of a user's presence session as an application. For more
information about presence sessions, states permutations, and timeouts,
see Manage presence state using the Microsoft Graph API.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/presence-setpresence?view=graph-rest-1.0
operationId: users.user.presence.setPresence
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
sessionId:
type: string
nullable: true
availability:
type: string
activity:
type: string
expirationDuration:
pattern: >-
^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$
type: string
format: duration
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/presence/setStatusMessage:
description: Provides operations to call the setStatusMessage method.
post:
tags:
- Users.presence
summary: Microsoft Graph Invoke action setStatusMessage
description: >-
Set a presence status message for a user. An optional expiration date
and time can be supplied.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/presence-setstatusmessage?view=graph-rest-1.0
operationId: users.user.presence.setStatusMessage
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
statusMessage:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.presenceStatusMessage
- type: object
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/presence/setUserPreferredPresence:
description: Provides operations to call the setUserPreferredPresence method.
post:
tags:
- Users.presence
summary: Microsoft Graph Invoke action setUserPreferredPresence
description: >-
Set the preferred availability and activity status for a user. If the
preferred presence of a user is set, the user's presence shows as the
preferred status. Preferred presence takes effect only when at least one
presence session exists for the user. Otherwise, the user's presence
shows as Offline. A presence session is created as a result of a
successful setPresence operation, or if the user is signed in on a
Microsoft Teams client. For more details, see presence sessions and
time-out and expiration.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/presence-setuserpreferredpresence?view=graph-rest-1.0
operationId: users.user.presence.setUserPreferredPresence
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
availability:
type: string
activity:
type: string
expirationDuration:
pattern: >-
^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$
type: string
format: duration
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices:
description: >-
Provides operations to manage the registeredDevices property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get registeredDevices from users
description: >-
Devices that are registered for the user. Read-only. Nullable. Supports
$expand and returns up to 100 objects.
operationId: users.ListRegisteredDevices
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices/{directoryObject-id}:
description: >-
Provides operations to manage the registeredDevices property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get registeredDevices from users
description: >-
Devices that are registered for the user. Read-only. Nullable. Supports
$expand and returns up to 100 objects.
operationId: users.GetRegisteredDevices
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/registeredDevices/{directoryObject-id}/graph.appRoleAssignment:
description: Casts the previous resource to appRoleAssignment.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.appRoleAssignment
operationId: users.GetRegisteredDevices.AsAppRoleAssignment
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/registeredDevices/{directoryObject-id}/graph.device:
description: Casts the previous resource to device.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.device
operationId: users.GetRegisteredDevices.AsDevice
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.device'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/registeredDevices/{directoryObject-id}/graph.endpoint:
description: Casts the previous resource to endpoint.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.endpoint
operationId: users.GetRegisteredDevices.AsEndpoint
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/registeredDevices/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.registeredDevices.GetCount-0403
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices/graph.appRoleAssignment:
description: Casts the previous resource to appRoleAssignment.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.appRoleAssignment in the microsoft.graph.directoryObject collection
operationId: users.ListRegisteredDevices.AsAppRoleAssignment
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.appRoleAssignmentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices/graph.appRoleAssignment/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.RegisteredDevices.GetCount.AsAppRoleAssignment-cd2d
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices/graph.device:
description: Casts the previous resource to device.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.device in the microsoft.graph.directoryObject collection
operationId: users.ListRegisteredDevices.AsDevice
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.deviceCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices/graph.device/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.RegisteredDevices.GetCount.AsDevice-16e2
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices/graph.endpoint:
description: Casts the previous resource to endpoint.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.endpoint in the microsoft.graph.directoryObject collection
operationId: users.ListRegisteredDevices.AsEndpoint
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.endpointCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/registeredDevices/graph.endpoint/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.RegisteredDevices.GetCount.AsEndpoint-87c6
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/scopedRoleMemberOf:
description: >-
Provides operations to manage the scopedRoleMemberOf property of the
microsoft.graph.user entity.
get:
tags:
- users.scopedRoleMembership
summary: Microsoft Graph Get scopedRoleMemberOf from users
operationId: users.ListScopedRoleMemberOf
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.scopedRoleMembershipCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.scopedRoleMembership
summary: Microsoft Graph Create new navigation property to scopedRoleMemberOf for users
operationId: users.CreateScopedRoleMemberOf
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/scopedRoleMemberOf/{scopedRoleMembership-id}:
description: >-
Provides operations to manage the scopedRoleMemberOf property of the
microsoft.graph.user entity.
get:
tags:
- users.scopedRoleMembership
summary: Microsoft Graph Get scopedRoleMemberOf from users
operationId: users.GetScopedRoleMemberOf
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.scopedRoleMembership
summary: Microsoft Graph Update the navigation property scopedRoleMemberOf in users
operationId: users.UpdateScopedRoleMemberOf
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.scopedRoleMembership
summary: Microsoft Graph Delete navigation property scopedRoleMemberOf for users
operationId: users.DeleteScopedRoleMemberOf
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: scopedRoleMembership-id
in: path
description: The unique identifier of scopedRoleMembership
required: true
schema:
type: string
x-ms-docs-key-type: scopedRoleMembership
/users/{user-id}/scopedRoleMemberOf/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.scopedRoleMembership
summary: Microsoft Graph Get the number of the resource
operationId: users.scopedRoleMemberOf.GetCount-0e30
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/serviceProvisioningErrors:
get:
tags:
- users.serviceProvisioningError
summary: Microsoft Graph Get serviceProvisioningErrors property value
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).
operationId: users.ListServiceProvisioningErrors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/serviceProvisioningErrors/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.serviceProvisioningError
summary: Microsoft Graph Get the number of the resource
operationId: users.ServiceProvisioningErrors.GetCount-bccc
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings:
description: >-
Provides operations to manage the settings property of the
microsoft.graph.user entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get settings from users
operationId: users.GetSettings
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update the navigation property settings in users
operationId: users.UpdateSettings
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property settings for users
operationId: users.DeleteSettings
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/itemInsights:
description: >-
Provides operations to manage the itemInsights property of the
microsoft.graph.userSettings entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get itemInsights from users
description: >-
The user's settings for the visibility of meeting hour insights, and
insights derived between a user and other items in Microsoft 365, such
as documents or sites. Get userInsightsSettings through this navigation
property.
operationId: users.settings.GetItemInsights
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update userInsightsSettings
description: >-
Update the privacy settings for itemInsights and meeting hours insights
of a user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userinsightssettings-update?view=graph-rest-1.0
operationId: users.settings.UpdateItemInsights
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property itemInsights for users
operationId: users.settings.DeleteItemInsights
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/shiftPreferences:
description: >-
Provides operations to manage the shiftPreferences property of the
microsoft.graph.userSettings entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get shiftPreferences
description: >-
Retrieve the properties and relationships of a shiftPreferences object
by ID.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/shiftpreferences-get?view=graph-rest-1.0
operationId: users.settings.GetShiftPreferences
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shiftPreferences'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update shiftPreferences
description: Update the properties and relationships of a shiftPreferences object.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/shiftpreferences-put?view=graph-rest-1.0
operationId: users.settings.UpdateShiftPreferences
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shiftPreferences'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shiftPreferences'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property shiftPreferences for users
operationId: users.settings.DeleteShiftPreferences
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/storage:
description: >-
Provides operations to manage the storage property of the
microsoft.graph.userSettings entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get storage from users
operationId: users.settings.GetStorage
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userStorage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update the navigation property storage in users
operationId: users.settings.UpdateStorage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userStorage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userStorage'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property storage for users
operationId: users.settings.DeleteStorage
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/storage/quota:
description: >-
Provides operations to manage the quota property of the
microsoft.graph.userStorage entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get quota from users
operationId: users.settings.storage.GetQuota
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedStorageQuota'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update the navigation property quota in users
operationId: users.settings.storage.UpdateQuota
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedStorageQuota'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedStorageQuota'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property quota for users
operationId: users.settings.storage.DeleteQuota
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/storage/quota/services:
description: >-
Provides operations to manage the services property of the
microsoft.graph.unifiedStorageQuota entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get services from users
operationId: users.settings.storage.quota.ListServices
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.serviceStorageQuotaBreakdownCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userSettings
summary: Microsoft Graph Create new navigation property to services for users
operationId: users.settings.storage.quota.CreateServices
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.serviceStorageQuotaBreakdown
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.serviceStorageQuotaBreakdown
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/storage/quota/services/{serviceStorageQuotaBreakdown-id}:
description: >-
Provides operations to manage the services property of the
microsoft.graph.unifiedStorageQuota entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get services from users
operationId: users.settings.storage.quota.GetServices
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.serviceStorageQuotaBreakdown
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update the navigation property services in users
operationId: users.settings.storage.quota.UpdateServices
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.serviceStorageQuotaBreakdown
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.serviceStorageQuotaBreakdown
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property services for users
operationId: users.settings.storage.quota.DeleteServices
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: serviceStorageQuotaBreakdown-id
in: path
description: The unique identifier of serviceStorageQuotaBreakdown
required: true
schema:
type: string
x-ms-docs-key-type: serviceStorageQuotaBreakdown
/users/{user-id}/settings/storage/quota/services/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get the number of the resource
operationId: users.settings.storage.quota.services.GetCount-bab7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/windows:
description: >-
Provides operations to manage the windows property of the
microsoft.graph.userSettings entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get windows from users
operationId: users.settings.ListWindows
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.windowsSettingCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userSettings
summary: Microsoft Graph Create new navigation property to windows for users
operationId: users.settings.CreateWindows
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/settings/windows/{windowsSetting-id}:
description: >-
Provides operations to manage the windows property of the
microsoft.graph.userSettings entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get windows from users
operationId: users.settings.GetWindows
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update the navigation property windows in users
operationId: users.settings.UpdateWindows
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property windows for users
operationId: users.settings.DeleteWindows
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: windowsSetting-id
in: path
description: The unique identifier of windowsSetting
required: true
schema:
type: string
x-ms-docs-key-type: windowsSetting
/users/{user-id}/settings/windows/{windowsSetting-id}/instances:
description: >-
Provides operations to manage the instances property of the
microsoft.graph.windowsSetting entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get instances from users
description: A collection of setting values for a given windowsSetting.
operationId: users.settings.windows.ListInstances
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.windowsSettingInstanceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userSettings
summary: Microsoft Graph Create new navigation property to instances for users
operationId: users.settings.windows.CreateInstances
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: windowsSetting-id
in: path
description: The unique identifier of windowsSetting
required: true
schema:
type: string
x-ms-docs-key-type: windowsSetting
/users/{user-id}/settings/windows/{windowsSetting-id}/instances/{windowsSettingInstance-id}:
description: >-
Provides operations to manage the instances property of the
microsoft.graph.windowsSetting entity.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get instances from users
description: A collection of setting values for a given windowsSetting.
operationId: users.settings.windows.GetInstances
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSettings
summary: Microsoft Graph Update the navigation property instances in users
operationId: users.settings.windows.UpdateInstances
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSettings
summary: Microsoft Graph Delete navigation property instances for users
operationId: users.settings.windows.DeleteInstances
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: windowsSetting-id
in: path
description: The unique identifier of windowsSetting
required: true
schema:
type: string
x-ms-docs-key-type: windowsSetting
- name: windowsSettingInstance-id
in: path
description: The unique identifier of windowsSettingInstance
required: true
schema:
type: string
x-ms-docs-key-type: windowsSettingInstance
/users/{user-id}/settings/windows/{windowsSetting-id}/instances/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get the number of the resource
operationId: users.settings.windows.instances.GetCount-b9e0
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: windowsSetting-id
in: path
description: The unique identifier of windowsSetting
required: true
schema:
type: string
x-ms-docs-key-type: windowsSetting
/users/{user-id}/settings/windows/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userSettings
summary: Microsoft Graph Get the number of the resource
operationId: users.settings.windows.GetCount-855b
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/solutions:
description: >-
Provides operations to manage the solutions property of the
microsoft.graph.user entity.
get:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Get solutions from users
description: >-
The identifier that relates the user to the working time schedule
triggers. Read-Only. Nullable
operationId: users.GetSolutions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userSolutionRoot'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Update the navigation property solutions in users
operationId: users.UpdateSolutions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userSolutionRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userSolutionRoot'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Delete navigation property solutions for users
operationId: users.DeleteSolutions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/solutions/workingTimeSchedule:
description: >-
Provides operations to manage the workingTimeSchedule property of the
microsoft.graph.userSolutionRoot entity.
get:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Get workingTimeSchedule from users
description: The working time schedule entity associated with the solution.
operationId: users.solutions.GetWorkingTimeSchedule
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.workingTimeSchedule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Update the navigation property workingTimeSchedule in users
operationId: users.solutions.UpdateWorkingTimeSchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.workingTimeSchedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.workingTimeSchedule'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Delete navigation property workingTimeSchedule for users
operationId: users.solutions.DeleteWorkingTimeSchedule
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/solutions/workingTimeSchedule/endWorkingTime:
description: Provides operations to call the endWorkingTime method.
post:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Invoke action endWorkingTime
description: >-
Trigger the policies associated with the end of working hours for a
specific user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/workingtimeschedule-endworkingtime?view=graph-rest-1.0
operationId: users.user.solutions.workingTimeSchedule.endWorkingTime
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/solutions/workingTimeSchedule/startWorkingTime:
description: Provides operations to call the startWorkingTime method.
post:
tags:
- users.userSolutionRoot
summary: Microsoft Graph Invoke action startWorkingTime
description: >-
Trigger the policies associated with the start of working hours for a
specific user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/workingtimeschedule-startworkingtime?view=graph-rest-1.0
operationId: users.user.solutions.workingTimeSchedule.startWorkingTime
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/sponsors:
description: >-
Provides operations to manage the sponsors property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph List sponsors
description: >-
Get a user's sponsors. Sponsors are users and groups that are
responsible for this guest's privileges in the tenant and for keeping
the guest's information and access up to date.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-sponsors?view=graph-rest-1.0
operationId: users.ListSponsors
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/sponsors/{directoryObject-id}:
description: >-
Provides operations to manage the sponsors property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get sponsors from users
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.
operationId: users.GetSponsors
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/sponsors/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.sponsors.GetCount-f3b9
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/teamwork:
description: >-
Provides operations to manage the teamwork property of the
microsoft.graph.user entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get userTeamwork
description: >-
Get the userTeamwork settings for a specified user, which includes the
Microsoft Teams region and the locale chosen by the user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userteamwork-get?view=graph-rest-1.0
operationId: users.GetTeamwork
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userTeamwork
summary: Microsoft Graph Update the navigation property teamwork in users
operationId: users.UpdateTeamwork
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userTeamwork
summary: Microsoft Graph Delete navigation property teamwork for users
operationId: users.DeleteTeamwork
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/teamwork/associatedTeams:
description: >-
Provides operations to manage the associatedTeams property of the
microsoft.graph.userTeamwork entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get associatedTeams from users
description: The list of associatedTeamInfo objects that a user is associated with.
operationId: users.teamwork.ListAssociatedTeams
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.associatedTeamInfoCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userTeamwork
summary: Microsoft Graph Create new navigation property to associatedTeams for users
operationId: users.teamwork.CreateAssociatedTeams
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/teamwork/associatedTeams/{associatedTeamInfo-id}:
description: >-
Provides operations to manage the associatedTeams property of the
microsoft.graph.userTeamwork entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get associatedTeams from users
description: The list of associatedTeamInfo objects that a user is associated with.
operationId: users.teamwork.GetAssociatedTeams
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userTeamwork
summary: Microsoft Graph Update the navigation property associatedTeams in users
operationId: users.teamwork.UpdateAssociatedTeams
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userTeamwork
summary: Microsoft Graph Delete navigation property associatedTeams for users
operationId: users.teamwork.DeleteAssociatedTeams
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: associatedTeamInfo-id
in: path
description: The unique identifier of associatedTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: associatedTeamInfo
/users/{user-id}/teamwork/associatedTeams/{associatedTeamInfo-id}/team:
description: >-
Provides operations to manage the team property of the
microsoft.graph.teamInfo entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get team from users
operationId: users.teamwork.associatedTeams.GetTeam
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.team'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: associatedTeamInfo-id
in: path
description: The unique identifier of associatedTeamInfo
required: true
schema:
type: string
x-ms-docs-key-type: associatedTeamInfo
x-ms-docs-grouped-path:
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/sharedWithTeams/{sharedWithChannelTeamInfo-id}/team
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/sharedWithTeams/{sharedWithChannelTeamInfo-id}/team
/users/{user-id}/teamwork/associatedTeams/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get the number of the resource
operationId: users.teamwork.associatedTeams.GetCount-97ef
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/teamwork/installedApps:
description: >-
Provides operations to manage the installedApps property of the
microsoft.graph.userTeamwork entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph List apps installed for user
description: >-
Retrieve the list of apps installed in the personal scope of the
specified user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userteamwork-list-installedapps?view=graph-rest-1.0
operationId: users.teamwork.ListInstalledApps
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.userScopeTeamsAppInstallationCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.userTeamwork
summary: Microsoft Graph Install app for user
description: Install an app in the personal scope of the specified user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userteamwork-post-installedapps?view=graph-rest-1.0
operationId: users.teamwork.CreateInstalledApps
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}:
description: >-
Provides operations to manage the installedApps property of the
microsoft.graph.userTeamwork entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get installed app for user
description: Retrieve the app installed in the personal scope of the specified user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userteamwork-get-installedapps?view=graph-rest-1.0
operationId: users.teamwork.GetInstalledApps
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.userTeamwork
summary: Microsoft Graph Update the navigation property installedApps in users
operationId: users.teamwork.UpdateInstalledApps
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.userTeamwork
summary: Microsoft Graph Uninstall app for user
description: Uninstall an app from the personal scope of the specified user.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userteamwork-delete-installedapps?view=graph-rest-1.0
operationId: users.teamwork.DeleteInstalledApps
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userScopeTeamsAppInstallation-id
in: path
description: The unique identifier of userScopeTeamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: userScopeTeamsAppInstallation
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}/chat:
description: >-
Provides operations to manage the chat property of the
microsoft.graph.userScopeTeamsAppInstallation entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get chat between user and teamsApp
description: Retrieve the chat of the specified user and Teams app.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userscopeteamsappinstallation-get-chat?view=graph-rest-1.0
operationId: users.teamwork.installedApps.GetChat
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userScopeTeamsAppInstallation-id
in: path
description: The unique identifier of userScopeTeamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: userScopeTeamsAppInstallation
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}/teamsApp:
description: >-
Provides operations to manage the teamsApp property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get teamsApp from users
description: The app that is installed.
operationId: users.teamwork.installedApps.GetTeamsApp
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userScopeTeamsAppInstallation-id
in: path
description: The unique identifier of userScopeTeamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: userScopeTeamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsApp
- >-
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/teamsApp
/users/{user-id}/teamwork/installedApps/{userScopeTeamsAppInstallation-id}/teamsAppDefinition:
description: >-
Provides operations to manage the teamsAppDefinition property of the
microsoft.graph.teamsAppInstallation entity.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get teamsAppDefinition from users
description: The details of this version of the app.
operationId: users.teamwork.installedApps.GetTeamsAppDefinition
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: userScopeTeamsAppInstallation-id
in: path
description: The unique identifier of userScopeTeamsAppInstallation
required: true
schema:
type: string
x-ms-docs-key-type: userScopeTeamsAppInstallation
x-ms-docs-grouped-path:
- >-
/users/{user-id}/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition
- >-
/users/{user-id}/joinedTeams/{team-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition
/users/{user-id}/teamwork/installedApps/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.userTeamwork
summary: Microsoft Graph Get the number of the resource
operationId: users.teamwork.installedApps.GetCount-0292
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/teamwork/sendActivityNotification:
description: Provides operations to call the sendActivityNotification method.
post:
tags:
- users.userTeamwork
summary: Microsoft Graph Invoke action sendActivityNotification
description: >-
Send an activity feed notification to a user. For more information, see
sending Teams activity notifications.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/userteamwork-sendactivitynotification?view=graph-rest-1.0
operationId: users.user.teamwork.sendActivityNotification
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
topic:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkActivityTopic
- type: object
nullable: true
activityType:
type: string
nullable: true
chainId:
type: number
format: int64
nullable: true
previewText:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
teamsAppId:
type: string
nullable: true
templateParameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValuePair'
iconId:
type: string
nullable: true
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/chats/{chat-id}/sendActivityNotification
- /users/{user-id}/joinedTeams/{team-id}/sendActivityNotification
/users/{user-id}/todo:
description: >-
Provides operations to manage the todo property of the
microsoft.graph.user entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get todo from users
description: Represents the To Do services available to a user.
operationId: users.GetTodo
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property todo in users
operationId: users.UpdateTodo
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todo'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todo'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property todo for users
operationId: users.DeleteTodo
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/todo/lists:
description: >-
Provides operations to manage the lists property of the
microsoft.graph.todo entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get lists from users
description: The task lists in the users mailbox.
operationId: users.todo.ListLists
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.todoTaskListCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.todo
summary: Microsoft Graph Create new navigation property to lists for users
operationId: users.todo.CreateLists
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/todo/lists/{todoTaskList-id}:
description: >-
Provides operations to manage the lists property of the
microsoft.graph.todo entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get lists from users
description: The task lists in the users mailbox.
operationId: users.todo.GetLists
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property lists in users
operationId: users.todo.UpdateLists
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property lists for users
operationId: users.todo.DeleteLists
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
/users/{user-id}/todo/lists/{todoTaskList-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.todoTaskList entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the task list. Nullable.
operationId: users.todo.lists.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.todo
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.todo.lists.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
/users/{user-id}/todo/lists/{todoTaskList-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.todoTaskList entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the task list. Nullable.
operationId: users.todo.lists.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.todo.lists.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.todo.lists.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
/users/{user-id}/todo/lists/{todoTaskList-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.extensions.GetCount-27f6
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.todoTaskList entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get tasks from users
description: The tasks in this task list. Read-only. Nullable.
operationId: users.todo.lists.ListTasks
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.todoTaskCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.todo
summary: Microsoft Graph Create new navigation property to tasks for users
operationId: users.todo.lists.CreateTasks
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTask'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}:
description: >-
Provides operations to manage the tasks property of the
microsoft.graph.todoTaskList entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get tasks from users
description: The tasks in this task list. Read-only. Nullable.
operationId: users.todo.lists.GetTasks
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property tasks in users
operationId: users.todo.lists.UpdateTasks
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTask'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property tasks for users
operationId: users.todo.lists.DeleteTasks
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get attachments from users
description: A collection of file attachments for the task.
operationId: users.todo.lists.tasks.ListAttachments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.attachmentBaseCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.todo
summary: Microsoft Graph Create new navigation property to attachments for users
operationId: users.todo.lists.tasks.CreateAttachments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentBase'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentBase'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/{attachmentBase-id}:
description: >-
Provides operations to manage the attachments property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get attachments from users
description: A collection of file attachments for the task.
operationId: users.todo.lists.tasks.GetAttachments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentBase'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property attachments for users
operationId: users.todo.lists.tasks.DeleteAttachments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
- name: attachmentBase-id
in: path
description: The unique identifier of attachmentBase
required: true
schema:
type: string
x-ms-docs-key-type: attachmentBase
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/{attachmentBase-id}/$value:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get media content for the navigation property attachments from users
description: The unique identifier for an entity. Read-only.
operationId: users.todo.lists.tasks.GetAttachmentsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.todo
summary: Microsoft Graph Update media content for the navigation property attachments in users
description: The unique identifier for an entity. Read-only.
operationId: users.todo.lists.tasks.UpdateAttachmentsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete media content for the navigation property attachments in users
description: The unique identifier for an entity. Read-only.
operationId: users.todo.lists.tasks.DeleteAttachmentsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
- name: attachmentBase-id
in: path
description: The unique identifier of attachmentBase
required: true
schema:
type: string
x-ms-docs-key-type: attachmentBase
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.tasks.attachments.GetCount-e9c9
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachments/createUploadSession:
description: Provides operations to call the createUploadSession method.
post:
tags:
- Users.todo
summary: Microsoft Graph Invoke action createUploadSession
description: >-
Create an upload session to iteratively upload ranges of a file as an
attachment to a todoTask. As part of the response, this action returns
an upload URL that you can use in subsequent sequential PUT queries. The
request headers for each PUT operation let you specify the exact range
of bytes to be uploaded. This allows the transfer to be resumed, in case
the network connection is dropped during the upload. The following are
the steps to attach a file to a Microsoft To Do task using an upload
session: For an example that describes the end-to-end attachment
process, see attach files to a To Do task.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/taskfileattachment-createuploadsession?view=graph-rest-1.0
operationId: >-
users.user.todo.lists.todoTaskList.tasks.todoTask.attachments.createUploadSession
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
attachmentInfo:
$ref: '#/components/schemas/microsoft.graph.attachmentInfo'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.uploadSession'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
x-ms-docs-grouped-path:
- >-
/users/{user-id}/calendar/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/attachments/createUploadSession
- /users/{user-id}/events/{event-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/{message-id}/attachments/createUploadSession
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/messages/{message-id}/attachments/createUploadSession
- /users/{user-id}/messages/{message-id}/attachments/createUploadSession
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachmentSessions:
description: >-
Provides operations to manage the attachmentSessions property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get attachmentSessions from users
operationId: users.todo.lists.tasks.ListAttachmentSessions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.attachmentSessionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachmentSessions/{attachmentSession-id}:
description: >-
Provides operations to manage the attachmentSessions property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get attachmentSessions from users
operationId: users.todo.lists.tasks.GetAttachmentSessions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentSession'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property attachmentSessions in users
operationId: users.todo.lists.tasks.UpdateAttachmentSessions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentSession'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property attachmentSessions for users
operationId: users.todo.lists.tasks.DeleteAttachmentSessions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
- name: attachmentSession-id
in: path
description: The unique identifier of attachmentSession
required: true
schema:
type: string
x-ms-docs-key-type: attachmentSession
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachmentSessions/{attachmentSession-id}/content:
description: Provides operations to manage the media for the user entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get content for the navigation property attachmentSessions from users
description: The content streams that are uploaded.
operationId: users.todo.lists.tasks.GetAttachmentSessionsContent
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
put:
tags:
- Users.todo
summary: Microsoft Graph Update content for the navigation property attachmentSessions in users
description: The content streams that are uploaded.
operationId: users.todo.lists.tasks.UpdateAttachmentSessionsContent
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentSession'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete content for the navigation property attachmentSessions in users
description: The content streams that are uploaded.
operationId: users.todo.lists.tasks.DeleteAttachmentSessionsContent
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
- name: attachmentSession-id
in: path
description: The unique identifier of attachmentSession
required: true
schema:
type: string
x-ms-docs-key-type: attachmentSession
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/attachmentSessions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.tasks.attachmentSessions.GetCount-53ee
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/checklistItems:
description: >-
Provides operations to manage the checklistItems property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get checklistItems from users
description: A collection of checklistItems linked to a task.
operationId: users.todo.lists.tasks.ListChecklistItems
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.checklistItemCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.todo
summary: Microsoft Graph Create new navigation property to checklistItems for users
operationId: users.todo.lists.tasks.CreateChecklistItems
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checklistItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checklistItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/checklistItems/{checklistItem-id}:
description: >-
Provides operations to manage the checklistItems property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get checklistItems from users
description: A collection of checklistItems linked to a task.
operationId: users.todo.lists.tasks.GetChecklistItems
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checklistItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property checklistItems in users
operationId: users.todo.lists.tasks.UpdateChecklistItems
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checklistItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checklistItem'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property checklistItems for users
operationId: users.todo.lists.tasks.DeleteChecklistItems
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
- name: checklistItem-id
in: path
description: The unique identifier of checklistItem
required: true
schema:
type: string
x-ms-docs-key-type: checklistItem
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/checklistItems/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.tasks.checklistItems.GetCount-f104
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/extensions:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the task. Nullable.
operationId: users.todo.lists.tasks.ListExtensions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.extensionCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.todo
summary: Microsoft Graph Create new navigation property to extensions for users
operationId: users.todo.lists.tasks.CreateExtensions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/extensions/{extension-id}:
description: >-
Provides operations to manage the extensions property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get extensions from users
description: The collection of open extensions defined for the task. Nullable.
operationId: users.todo.lists.tasks.GetExtensions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property extensions in users
operationId: users.todo.lists.tasks.UpdateExtensions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extension'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property extensions for users
operationId: users.todo.lists.tasks.DeleteExtensions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
- name: extension-id
in: path
description: The unique identifier of extension
required: true
schema:
type: string
x-ms-docs-key-type: extension
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/extensions/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.tasks.extensions.GetCount-c962
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/linkedResources:
description: >-
Provides operations to manage the linkedResources property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get linkedResources from users
description: A collection of resources linked to the task.
operationId: users.todo.lists.tasks.ListLinkedResources
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.linkedResourceCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Users.todo
summary: Microsoft Graph Create new navigation property to linkedResources for users
operationId: users.todo.lists.tasks.CreateLinkedResources
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.linkedResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.linkedResource'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/linkedResources/{linkedResource-id}:
description: >-
Provides operations to manage the linkedResources property of the
microsoft.graph.todoTask entity.
get:
tags:
- Users.todo
summary: Microsoft Graph Get linkedResources from users
description: A collection of resources linked to the task.
operationId: users.todo.lists.tasks.GetLinkedResources
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.linkedResource'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.todo
summary: Microsoft Graph Update the navigation property linkedResources in users
operationId: users.todo.lists.tasks.UpdateLinkedResources
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.linkedResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.linkedResource'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.todo
summary: Microsoft Graph Delete navigation property linkedResources for users
operationId: users.todo.lists.tasks.DeleteLinkedResources
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
- name: linkedResource-id
in: path
description: The unique identifier of linkedResource
required: true
schema:
type: string
x-ms-docs-key-type: linkedResource
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/{todoTask-id}/linkedResources/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.tasks.linkedResources.GetCount-58c2
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
- name: todoTask-id
in: path
description: The unique identifier of todoTask
required: true
schema:
type: string
x-ms-docs-key-type: todoTask
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.tasks.GetCount-9520
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
/users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.todo
summary: Microsoft Graph Invoke function delta
description: >-
Get a set of todoTask resources that have been added, deleted, or
updated in a specified todoTaskList. A delta function call for todoTask
resources in a todoTaskList is similar to a GET request, except that by
appropriately applying state tokens in one or more of these calls, you
can query for incremental changes in the todoTask in that todoTaskList.
This allows you to maintain and synchronize a local store of a user's
todoTask resources without having to fetch the entire set from the
server every time.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/todotask-delta?view=graph-rest-1.0
operationId: users.user.todo.lists.todoTaskList.tasks.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of todoTask
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTask'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: todoTaskList-id
in: path
description: The unique identifier of todoTaskList
required: true
schema:
type: string
x-ms-docs-key-type: todoTaskList
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/todo/lists/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.todo
summary: Microsoft Graph Get the number of the resource
operationId: users.todo.lists.GetCount-47c4
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/todo/lists/delta():
description: Provides operations to call the delta method.
get:
tags:
- Users.todo
summary: Microsoft Graph Invoke function delta
description: "Get a set of todoTaskList resources that have been added, deleted, or removed in Microsoft To Do. A delta function call for todoTaskList is similar to a GET request, except that by appropriately applying state tokens in one or more of these calls, \r\nyou can query for incremental changes in the todoTaskList. This allows you to maintain and synchronize a local store of a user's todoTaskList without having to fetch all the todoTaskList from the server every time."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/todotasklist-delta?view=graph-rest-1.0
operationId: users.user.todo.lists.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of todoTaskList
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/delta()
- /users/delta()
/users/{user-id}/transitiveMemberOf:
description: >-
Provides operations to manage the transitiveMemberOf property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph List a user's memberships (direct and transitive)
description: >-
Get groups, directory roles, and administrative units that the user is a
member of through either direct or transitive membership.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/user-list-transitivememberof?view=graph-rest-1.0
operationId: users.ListTransitiveMemberOf
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryObjectCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/transitiveMemberOf/{directoryObject-id}:
description: >-
Provides operations to manage the transitiveMemberOf property of the
microsoft.graph.user entity.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get transitiveMemberOf from users
description: >-
The groups, including nested groups, and directory roles that a user is
a member of. Nullable.
operationId: users.GetTransitiveMemberOf
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/transitiveMemberOf/{directoryObject-id}/graph.administrativeUnit:
description: Casts the previous resource to administrativeUnit.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit
operationId: users.GetTransitiveMemberOf.AsAdministrativeUnit
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.administrativeUnit'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/transitiveMemberOf/{directoryObject-id}/graph.directoryRole:
description: Casts the previous resource to directoryRole.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.directoryRole
operationId: users.GetTransitiveMemberOf.AsDirectoryRole
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/transitiveMemberOf/{directoryObject-id}/graph.group:
description: Casts the previous resource to group.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.group
operationId: users.GetTransitiveMemberOf.AsGroup
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
schema:
type: string
x-ms-docs-key-type: directoryObject
/users/{user-id}/transitiveMemberOf/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.transitiveMemberOf.GetCount-b904
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/transitiveMemberOf/graph.administrativeUnit:
description: Casts the previous resource to administrativeUnit.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection
operationId: users.ListTransitiveMemberOf.AsAdministrativeUnit
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.administrativeUnitCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/transitiveMemberOf/graph.administrativeUnit/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.TransitiveMemberOf.GetCount.AsAdministrativeUnit-9c79
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/transitiveMemberOf/graph.directoryRole:
description: Casts the previous resource to directoryRole.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.directoryRole in the microsoft.graph.directoryObject collection
operationId: users.ListTransitiveMemberOf.AsDirectoryRole
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.directoryRoleCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/transitiveMemberOf/graph.directoryRole/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.TransitiveMemberOf.GetCount.AsDirectoryRole-462d
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/transitiveMemberOf/graph.group:
description: Casts the previous resource to group.
get:
tags:
- users.directoryObject
summary: >-
Microsoft Graph Get the items of type microsoft.graph.group in the microsoft.graph.directoryObject collection
operationId: users.ListTransitiveMemberOf.AsGroup
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.groupCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users/{user-id}/transitiveMemberOf/graph.group/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- users.directoryObject
summary: Microsoft Graph Get the number of the resource
operationId: users.TransitiveMemberOf.GetCount.AsGroup-062f
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
schema:
type: string
x-ms-docs-key-type: user
/users(userPrincipalName='{userPrincipalName}'):
description: Provides operations to manage the collection of user entities.
get:
tags:
- Users.user
summary: Microsoft Graph Get a user
description: >-
Retrieve the properties and relationships of user object. This operation
returns by default only a subset of the more commonly used properties
for each user. These default properties are noted in the Properties
section. To get properties that are not returned by default, do a GET
operation for the user and specify the properties in a $select OData
query option. Because the user resource supports extensions, you can
also use the GET operation to get custom properties and extension data
in a user instance. Customers through Microsoft Entra ID for customers
can also use this API operation to retrieve their details.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-get?view=graph-rest-1.0
operationId: users.user.GetUserByUserPrincipalName
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Users.user
summary: Microsoft Graph Update user
description: Update the properties of a user object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-update?view=graph-rest-1.0
operationId: users.user.UpdateUserByUserPrincipalName
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Users.user
summary: Microsoft Graph Delete a user
description: >-
Delete a user object. When deleted, user resources, including their
mailbox and license assignments, are moved to a temporary container and
if the user is restored within 30 days, these objects are restored to
them. The user is also restored to any groups they were a member of.
After 30 days and if not restored, the user object is permanently
deleted and their assigned resources freed. To manage the deleted user
object, see deletedItems.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-delete?view=graph-rest-1.0
operationId: users.user.DeleteUserByUserPrincipalName
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: userPrincipalName
in: path
description: Alternate key of user
required: true
schema:
type: string
nullable: true
/users/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Users.user
summary: Microsoft Graph Get the number of the resource
operationId: users.GetCount-ee47
parameters:
- name: ConsistencyLevel
in: header
description: >-
Indicates the requested consistency level. Documentation URL:
https://docs.microsoft.com/graph/aad-advanced-queries
schema:
type: string
examples:
example-1:
description: >-
$search and $count queries require the client to set the
ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/users/delta():
description: Provides operations to call the delta method.
get:
tags:
- users.user.Functions
summary: Microsoft Graph Invoke function delta
description: >-
Get newly created, updated, or deleted users without having to perform a
full read of the entire user collection. For more information, see Use
delta query to track changes in Microsoft Graph data for details.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-delta?view=graph-rest-1.0
operationId: users.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of user
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-grouped-path:
- /users/{user-id}/calendar/calendarView/delta()
- /users/{user-id}/calendar/events/{event-id}/instances/delta()
- /users/{user-id}/calendar/events/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- >-
/users/{user-id}/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendars/{calendar-id}/calendarView/delta()
- >-
/users/{user-id}/calendars/{calendar-id}/events/{event-id}/instances/delta()
- /users/{user-id}/calendars/{calendar-id}/events/delta()
- /users/{user-id}/calendarView/delta()
- >-
/users/{user-id}/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/chats/{chat-id}/messages/delta()
- >-
/users/{user-id}/contactFolders/{contactFolder-id}/childFolders/{contactFolder-id1}/contacts/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/childFolders/delta()
- /users/{user-id}/contactFolders/{contactFolder-id}/contacts/delta()
- /users/{user-id}/contactFolders/delta()
- /users/{user-id}/contacts/delta()
- /users/{user-id}/events/{event-id}/instances/delta()
- /users/{user-id}/events/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/{chatMessage-id}/replies/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/channels/{channel-id}/messages/delta()
- >-
/users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/{chatMessage-id}/replies/delta()
- /users/{user-id}/joinedTeams/{team-id}/primaryChannel/messages/delta()
- >-
/users/{user-id}/mailFolders/{mailFolder-id}/childFolders/{mailFolder-id1}/messages/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/childFolders/delta()
- /users/{user-id}/mailFolders/{mailFolder-id}/messages/delta()
- /users/{user-id}/mailFolders/delta()
- /users/{user-id}/messages/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/recordings/delta()
- /users/{user-id}/onlineMeetings/{onlineMeeting-id}/transcripts/delta()
- /users/{user-id}/todo/lists/{todoTaskList-id}/tasks/delta()
- /users/{user-id}/todo/lists/delta()
- /users/delta()
/users/getAvailableExtensionProperties:
description: Provides operations to call the getAvailableExtensionProperties method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action getAvailableExtensionProperties
description: >-
Return all directory extension definitions that are registered in a
directory, including through multitenant apps. The following entities
support extension properties:
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0
operationId: users.getAvailableExtensionProperties
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isSyncedFromOnPremises:
type: boolean
default: false
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of extensionProperty
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.extensionProperty
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/users/getByIds:
description: Provides operations to call the getByIds method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action getByIds
description: >-
Return the directory objects specified in a list of IDs. Only a subset
of user properties are returned by default in v1.0. Some common uses for
this function are to:
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0
operationId: users.getByIds
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
types:
type: array
items:
type: string
nullable: true
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of directoryObject
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/users/validateProperties:
description: Provides operations to call the validateProperties method.
post:
tags:
- users.user.Actions
summary: Microsoft Graph Invoke action validateProperties
description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\r\n1. Validate the prefix and suffix naming policy\r\n2. Validate the custom banned words policy\r\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you're only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0
operationId: users.validateProperties
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
entityType:
type: string
nullable: true
displayName:
type: string
nullable: true
mailNickname:
type: string
nullable: true
onBehalfOfUserId:
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
required: true
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
components:
schemas:
microsoft.graph.aiUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: aiUser
required:
- '@odata.type'
type: object
properties:
interactionHistory:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.aiInteractionHistory'
- type: object
nullable: true
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.aiUser'
microsoft.graph.aiInteractionHistory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: aiInteractionHistory
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.aiInteractionHistory'
BaseCollectionPaginationCountResponse:
title: Base collection pagination and count responses
type: object
properties:
'@odata.count':
type: integer
format: int64
nullable: true
'@odata.nextLink':
type: string
nullable: true
microsoft.graph.aiInteraction:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: aiInteraction
required:
- '@odata.type'
type: object
properties:
appClass:
type: string
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.aiInteractionAttachment'
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
contexts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.aiInteractionContext'
conversationType:
type: string
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
format: date-time
nullable: true
etag:
type: string
nullable: true
from:
$ref: '#/components/schemas/microsoft.graph.identitySet'
interactionType:
$ref: '#/components/schemas/microsoft.graph.aiInteractionType'
links:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.aiInteractionLink'
locale:
type: string
mentions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.aiInteractionMention'
requestId:
type: string
sessionId:
type: string
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.aiInteraction'
microsoft.graph.educationUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationUser
required:
- '@odata.type'
type: object
properties:
accountEnabled:
type: boolean
description: >-
True if the account is enabled; otherwise, false. This property
is required when a user is created. Supports $filter.
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: The licenses that are assigned to the user. Not nullable.
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
description: >-
The plans that are assigned to the user. Read-only. Not
nullable.
businessPhones:
type: array
items:
type: string
description: >-
The telephone numbers for the user. Note: Although this is a
string collection, only one number can be set for this property.
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The entity who created the user.
department:
type: string
description: >-
The name for the department in which the user works. Supports
$filter.
nullable: true
displayName:
type: string
description: >-
The name displayed in the address book for the user. This is
usually the combination of the user's first name, middle
initial, and last name. This property is required when a user is
created and it cannot be cleared during updates. Supports
$filter and $orderby.
nullable: true
externalSource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationExternalSource'
- type: object
nullable: true
description: >-
Where this user was created from. The possible values are: sis,
manual.
externalSourceDetail:
type: string
description: >-
The name of the external source this resource was generated
from.
nullable: true
givenName:
type: string
description: The given name (first name) of the user. Supports $filter.
nullable: true
mail:
type: string
description: >-
The SMTP address for the user, for example, jeff@contoso.com.
Read-Only. Supports $filter.
nullable: true
mailingAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
- type: object
nullable: true
description: The mail address of the user.
mailNickname:
type: string
description: >-
The mail alias for the user. This property must be specified
when a user is created. Supports $filter.
nullable: true
middleName:
type: string
description: The middle name of the user.
nullable: true
mobilePhone:
type: string
description: The primary cellular telephone number for the user.
nullable: true
officeLocation:
type: string
description: The office location for the user.
nullable: true
onPremisesInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationOnPremisesInfo'
- type: object
nullable: true
description: >-
Additional information used to associate the Microsoft Entra
user with its Active Directory counterpart.
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 can be specified together; for example:
DisablePasswordExpiration, DisableStrongPassword.
nullable: true
passwordProfile:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.passwordProfile'
- type: object
nullable: true
description: >-
Specifies the password profile for the user. The profile
contains the user's password. This property is required when a
user is created. The password in the profile must satisfy
minimum requirements as specified by the passwordPolicies
property. By default, a strong password is required.
preferredLanguage:
type: string
description: >-
The preferred language for the user that should follow the ISO
639-1 code, for example, en-US.
nullable: true
primaryRole:
$ref: '#/components/schemas/microsoft.graph.educationUserRole'
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
description: >-
The plans that are provisioned for the user. Read-only. Not
nullable.
refreshTokensValidFromDateTime:
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 sessions tokens (session cookies) issued
before this time are invalid, and applications get an error when
using an invalid refresh or sessions 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. Returned
only on $select. Read-only.
format: date-time
nullable: true
relatedContacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.relatedContact'
description: Related records associated with the user. Read-only.
residenceAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
- type: object
nullable: true
description: The address where the user lives.
showInAddressList:
type: boolean
description: >-
True if the Outlook Global Address List should contain this
user; otherwise, false. If not set, this will be treated as
true. For users invited through the invitation manager, this
property will be set to false.
nullable: true
student:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationStudent'
- type: object
nullable: true
description: >-
If the primary role is student, this block will contain student
specific data.
surname:
type: string
description: The user's surname (family name or last name). Supports $filter.
nullable: true
teacher:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationTeacher'
- type: object
nullable: true
description: >-
If the primary role is teacher, this block will contain teacher
specific data.
usageLocation:
type: string
description: >-
A two-letter country code (ISO standard 3166). Required for
users who will be assigned licenses due to a legal requirement
to check for availability of services in countries or regions.
Examples include: US, JP, and GB. Not nullable. Supports
$filter.
nullable: true
userPrincipalName:
type: string
description: >-
The user principal name (UPN) of the user. The UPN is an
internet-style login name for the user based on the internet
standard RFC 822. By convention, this should map to the user's
email name. The general format is alias@domain, where 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 the organization. Supports $filter and $orderby.
nullable: true
userType:
type: string
description: >-
A string value that can be used to classify user types in your
directory, such as Member and Guest. Supports $filter.
nullable: true
assignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationAssignment'
description: Assignments belonging to the user.
x-ms-navigationProperty: true
classes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationClass'
description: Classes to which the user belongs. Nullable.
x-ms-navigationProperty: true
rubrics:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationRubric'
description: When set, the grading rubric attached to the assignment.
x-ms-navigationProperty: true
schools:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationSchool'
description: Schools to which the user belongs. Nullable.
x-ms-navigationProperty: true
taughtClasses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationClass'
description: Classes for which the user is a teacher.
x-ms-navigationProperty: true
user:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
- type: object
nullable: true
description: The directory user that corresponds to this user.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationUser'
microsoft.graph.educationAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationAssignment
required:
- '@odata.type'
type: object
properties:
addedStudentAction:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAddedStudentAction
- type: object
nullable: true
description: >-
Optional field to control the assignment behavior for students
who are added after the assignment is published. If not
specified, defaults to none. Supported values are: none,
assignIfOpen. For example, a teacher can use assignIfOpen to
indicate that an assignment should be assigned to any new
student who joins the class while the assignment is still open,
and none to indicate that an assignment shouldn't be assigned to
new students.
addToCalendarAction:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAddToCalendarOptions
- type: object
nullable: true
description: >-
Optional field to control the assignment behavior for adding
assignments to students' and teachers' calendars when the
assignment is published. The possible values are: none,
studentsAndPublisher, studentsAndTeamOwners, unknownFutureValue,
and studentsOnly. Use the Prefer: include-unknown-enum-members
request header to get the following values in this evolvable
enum: studentsOnly. The default value is none.
allowLateSubmissions:
type: boolean
description: >-
Identifies whether students can submit after the due date. If
this property isn't specified during create, it defaults to
true.
nullable: true
allowStudentsToAddResourcesToSubmission:
type: boolean
description: >-
Identifies whether students can add their own resources to a
submission or if they can only modify resources added by the
teacher.
nullable: true
assignDateTime:
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 when the assignment should become active. If in the
future, the assignment isn't shown to the student until this
date. 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
readOnly: true
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 moment that the assignment was published to students and the
assignment shows up on the students timeline. 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
readOnly: true
assignTo:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAssignmentRecipient
- type: object
nullable: true
description: >-
Which users, or whole class should receive a submission object
once the assignment is published.
classId:
type: string
description: Class to which this assignment belongs.
nullable: true
closeDateTime:
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 when the assignment is closed for submissions. This is an
optional field that can be null if the assignment doesn't
allowLateSubmissions or when the closeDateTime is the same as
the dueDateTime. But if specified, then the closeDateTime must
be greater than or equal to the dueDateTime. 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
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Who created the assignment.
readOnly: 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: >-
Moment when the 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
format: date-time
nullable: true
readOnly: true
displayName:
type: string
description: Name of the assignment.
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 when the students assignment 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
feedbackResourcesFolderUrl:
type: string
description: >-
Folder URL where all the feedback file resources for this
assignment are stored.
nullable: true
readOnly: true
grading:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAssignmentGradeType
- type: object
nullable: true
description: How the assignment will be graded.
instructions:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationItemBody'
- type: object
nullable: true
description: >-
Instructions for the assignment. The instructions and the
display name tell the student what to do.
languageTag:
type: string
description: >-
Specifies the language in which UI notifications for the
assignment are displayed. If languageTag isn't provided, the
default language is en-US. Optional.
nullable: true
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Who last modified the assignment.
readOnly: 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 on which the assignment was modified. A
student submission doesn't modify the assignment; only teachers
can update assignments. 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
readOnly: true
moduleUrl:
type: string
description: The URL of the module from which to access the assignment.
nullable: true
notificationChannelUrl:
type: string
description: >-
Optional field to specify the URL of the channel to post the
assignment publish notification. If not specified or null,
defaults to the General channel. This field only applies to
assignments where the assignTo value is
educationAssignmentClassRecipient. Updating the
notificationChannelUrl isn't allowed after the assignment is
published.
nullable: true
resourcesFolderUrl:
type: string
description: >-
Folder URL where all the file resources for this assignment are
stored.
nullable: true
readOnly: true
status:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAssignmentStatus
- type: object
nullable: true
description: >-
Status of the assignment. You can't PATCH this value. The
possible values are: draft, scheduled, published, assigned,
unknownFutureValue, inactive. Use the Prefer:
include-unknown-enum-members request header to get the following
members in this evolvable enum: inactive.
readOnly: true
webUrl:
type: string
description: The deep link URL for the given assignment.
nullable: true
readOnly: true
categories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationCategory'
description: >-
When set, enables users to easily find assignments of a given
type. Read-only. Nullable.
x-ms-navigationProperty: true
gradingCategory:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationGradingCategory
- type: object
nullable: true
description: >-
When set, enables users to weight assignments differently when
computing a class average grade.
x-ms-navigationProperty: true
gradingScheme:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationGradingScheme'
- type: object
nullable: true
description: >-
When set, enables users to configure custom string grades based
on the percentage of total points earned on this assignment.
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
description: >-
Learning objects that are associated with this assignment. Only
teachers can modify this list. Nullable.
x-ms-navigationProperty: true
rubric:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationRubric'
- type: object
nullable: true
description: When set, the grading rubric attached to this assignment.
x-ms-navigationProperty: true
submissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationSubmission'
description: >-
Once published, there's a submission object for each student
representing their work and grade. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationAssignment'
microsoft.graph.educationCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationCategory
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: Unique identifier for the category.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationCategory'
BaseDeltaFunctionResponse:
title: Base delta function response
type: object
properties:
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
microsoft.graph.educationGradingCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationGradingCategory
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The name of the grading category.
percentageWeight:
maximum: 2147483647
minimum: -2147483648
type: number
description: The weight of the category; an integer between 0 and 100.
format: int32
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationGradingCategory'
microsoft.graph.educationGradingScheme:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationGradingScheme
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The name of the grading scheme.
grades:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationGradingSchemeGrade
description: The grades that make up the scheme.
hidePointsDuringGrading:
type: boolean
description: >-
The display setting for the UI. Indicates whether teachers can
grade with points in addition to letter grades.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationGradingScheme'
microsoft.graph.educationAssignmentResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationAssignmentResource
required:
- '@odata.type'
type: object
properties:
distributeForStudentWork:
type: boolean
description: >-
Indicates whether this resource should be copied to each student
submission for modification and submission. Required
nullable: true
resource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationResource'
- type: object
nullable: true
description: Resource object that has been associated with this assignment.
dependentResources:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationAssignmentResource
description: >-
A collection of assignment resources that depend on the parent
educationAssignmentResource.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationAssignmentResource'
microsoft.graph.educationRubric:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationRubric
required:
- '@odata.type'
type: object
properties:
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The user who created this resource.
readOnly: 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 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
readOnly: true
description:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationItemBody'
- type: object
nullable: true
description: The description of this rubric.
displayName:
type: string
description: The name of this rubric.
nullable: true
grading:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAssignmentGradeType
- type: object
nullable: true
description: >-
The grading type of this rubric. You can use null for a
no-points rubric or educationAssignmentPointsGradeType for a
points rubric.
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The last user to modify the resource.
readOnly: 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: >-
Moment in time when the resource was last modified. 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
readOnly: true
levels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.rubricLevel'
description: The collection of levels making up this rubric.
qualities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.rubricQuality'
description: The collection of qualities making up this rubric.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationRubric'
microsoft.graph.educationSubmission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationSubmission
required:
- '@odata.type'
type: object
properties:
assignmentId:
type: string
description: >-
The unique identifier for the assignment with which this
submission is associated. A submission is always associated with
one and only one assignment.
nullable: true
readOnly: true
excusedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The user that marked the submission as excused.
readOnly: true
excusedDateTime:
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 that the submission was excused. 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
readOnly: true
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The identities of those who modified the submission.
readOnly: 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 submission was modified.
format: date-time
nullable: true
readOnly: true
reassignedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: User who moved the status of this submission to reassigned.
readOnly: true
reassignedDateTime:
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: >-
Moment in time when the submission was reassigned. 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
readOnly: true
recipient:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationSubmissionRecipient
- type: object
nullable: true
description: Who this submission is assigned to.
resourcesFolderUrl:
type: string
description: >-
Folder where all file resources for this submission need to be
stored.
nullable: true
readOnly: true
returnedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: User who moved the status of this submission to returned.
readOnly: true
returnedDateTime:
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: >-
Moment in time when the submission was returned. 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
readOnly: true
status:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationSubmissionStatus
- type: object
nullable: true
description: >-
Read-only. The possible values are: excused, reassigned,
returned, submitted and working. Use the Prefer:
include-unknown-enum-members request header to get the following
values in this evolvable enum: excused and reassigned.
readOnly: true
submittedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: User who moved the resource into the submitted state.
readOnly: true
submittedDateTime:
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: >-
Moment in time when the submission was moved into the submitted
state. 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
readOnly: true
unsubmittedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: >-
User who moved the resource from submitted into the working
state.
readOnly: true
unsubmittedDateTime:
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: >-
Moment in time when the submission was moved from submitted into
the working state. 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
readOnly: true
webUrl:
type: string
description: The deep link URL for the given submission.
nullable: true
readOnly: true
outcomes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationOutcome'
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
x-ms-navigationProperty: true
submittedResources:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationSubmission'
microsoft.graph.educationOutcome:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationOutcome
required:
- '@odata.type'
type: object
properties:
lastModifiedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The individual who updated the resource.
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 moment in time when the resource was last modified. 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, 2021 is 2021-01-01T00:00:00Z.
format: date-time
nullable: true
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.educationFeedbackOutcome': '#/components/schemas/microsoft.graph.educationFeedbackOutcome'
'#microsoft.graph.educationFeedbackResourceOutcome': >-
#/components/schemas/microsoft.graph.educationFeedbackResourceOutcome
'#microsoft.graph.educationPointsOutcome': '#/components/schemas/microsoft.graph.educationPointsOutcome'
'#microsoft.graph.educationRubricOutcome': '#/components/schemas/microsoft.graph.educationRubricOutcome'
microsoft.graph.educationSubmissionResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationSubmissionResource
required:
- '@odata.type'
type: object
properties:
assignmentResourceUrl:
type: string
description: >-
Pointer to the assignment from which the resource was copied. If
the value is null, the student uploaded the resource.
nullable: true
resource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationResource'
- type: object
nullable: true
description: Resource object.
dependentResources:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.educationSubmissionResource
description: >-
A collection of submission resources that depend on the parent
educationSubmissionResource.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationSubmissionResource'
microsoft.graph.educationClass:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: educationClass
required:
- '@odata.type'
type: object
properties:
classCode:
type: string
description: Class code used by the school to identify the class.
nullable: true
course:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationCourse'
- type: object
nullable: true
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Entity who created the class
description:
type: string
description: Description of the class.
nullable: true
displayName:
type: string
description: Name of the class.
externalId:
type: string
description: ID of the class from the syncing system.
nullable: true
externalName:
type: string
description: Name of the class in the syncing system.
nullable: true
externalSource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationExternalSource'
- type: object
nullable: true
description: >-
How this class was created. The possible values are: sis,
manual.
externalSourceDetail:
type: string
description: >-
The name of the external source this resource was generated
from.
nullable: true
grade:
type: string
description: Grade level of the class.
nullable: true
mailNickname:
type: string
description: Mail name for sending email to all members, if this is enabled.
term:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.educationTerm'
- type: object
nullable: true
description: Term for this class.
assignmentCategories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationCategory'
description: All categories associated with this class. Nullable.
x-ms-navigationProperty: true
assignmentDefaults:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAssignmentDefaults
- type: object
nullable: true
description: >-
Specifies class-level defaults respected by new assignments
created in the class.
x-ms-navigationProperty: true
assignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationAssignment'
description: All assignments associated with this class. Nullable.
x-ms-navigationProperty: true
assignmentSettings:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.educationAssignmentSettings
- type: object
nullable: true
description: Specifies class-level assignments settings.
x-ms-navigationProperty: true
group:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.group'
- type: object
nullable: true
description: The underlying Microsoft 365 group object.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationUser'
description: All users in the class. Nullable.
x-ms-navigationProperty: true
modules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationModule'
description: All modules in the class. Nullable.
x-ms-navigationProperty: true
schools:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationSchool'
description: All schools that this class is associated with. Nullable.
x-ms-navigationProperty: true
teachers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationUser'
description: All teachers in the class. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.educationClass'
microsoft.graph.educationSchool:
allOf:
- $ref: '#/components/schemas/microsoft.graph.educationOrganization'
- title: educationSchool
required:
- '@odata.type'
type: object
properties:
address:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
- type: object
nullable: true
description: Address of the school.
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Entity who created the school.
externalId:
type: string
description: ID of school in syncing system.
nullable: true
externalPrincipalId:
type: string
description: ID of principal in syncing system.
nullable: true
fax:
type: string
nullable: true
highestGrade:
type: string
description: Highest grade taught.
nullable: true
lowestGrade:
type: string
description: Lowest grade taught.
nullable: true
phone:
type: string
description: Phone number of school.
nullable: true
principalEmail:
type: string
description: Email address of the principal.
nullable: true
principalName:
type: string
description: Name of the principal.
nullable: true
schoolNumber:
type: string
description: School Number.
nullable: true
administrativeUnit:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.administrativeUnit'
- type: object
nullable: true
description: The underlying administrativeUnit for this school.
x-ms-navigationProperty: true
classes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationClass'
description: Classes taught at the school. Nullable.
x-ms-navigationProperty: true
users:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.educationUser'
description: Users in the school. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.educationSchool'
x-ms-discriminator-value: '#microsoft.graph.educationSchool'
microsoft.graph.user:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: user
required:
- '@odata.type'
type: object
properties:
aboutMe:
type: string
description: >-
A freeform text entry field for the user to describe themselves.
Returned only on $select.
nullable: true
accountEnabled:
type: boolean
description: >-
true if the account is enabled; otherwise, false. This property
is required when a user is created. Returned only on $select.
Supports $filter (eq, ne, not, and in).
nullable: true
ageGroup:
type: string
description: >-
Sets the age group of the user. Allowed values: null, Minor,
NotAdult, and Adult. For more information, see legal age group
property definitions. Returned only on $select. Supports $filter
(eq, ne, not, and in).
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: >-
The licenses that are assigned to the user, including inherited
(group-based) licenses. This property doesn't differentiate
between directly assigned and inherited licenses. Use the
licenseAssignmentStates property to identify the directly
assigned and inherited licenses. Not nullable. Returned only on
$select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
description: >-
The plans that are assigned to the user. Read-only. Not
nullable. Returned only on $select. Supports $filter (eq and
not).
authorizationInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.authorizationInfo'
- type: object
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 birthday of the user. The Timestamp type represents date and
time information using ISO 8601 format and is always in UTC. For
example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z.
Returned only on $select.
format: date-time
businessPhones:
type: array
items:
type: string
description: >-
The telephone numbers for the user. NOTE: Although it's a string
collection, only one number can be set for this property.
Read-only for users synced from the on-premises directory.
Returned by default. Supports $filter (eq, not, ge, le,
startsWith).
city:
type: string
description: >-
The city where the user is located. Maximum length is 128
characters. Returned only on $select. Supports $filter (eq, ne,
not, ge, le, in, startsWith, and eq on null values).
nullable: true
companyName:
type: string
description: >-
The name of the company that the user is associated with. This
property can be useful for describing the company that a guest
comes from. The maximum length is 64 characters.Returned only on
$select. Supports $filter (eq, ne, not, ge, le, in, startsWith,
and eq on null values).
nullable: true
consentProvidedForMinor:
type: string
description: >-
Sets whether consent was obtained for minors. Allowed values:
null, Granted, Denied, and NotRequired. For more information,
see legal age group property definitions. Returned only on
$select. Supports $filter (eq, ne, not, and in).
nullable: true
country:
type: string
description: >-
The country or region where the user is located; for example, US
or UK. Maximum length is 128 characters. Returned only on
$select. Supports $filter (eq, ne, not, ge, le, in, startsWith,
and eq on null values).
nullable: true
createdDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The date and time the user was created, in ISO 8601 format and
UTC. The value can't be modified and is automatically populated
when the entity is created. Nullable. For on-premises users, the
value represents when they were first created in Microsoft Entra
ID. Property is null for some users created before June 2018 and
on-premises users that were synced to Microsoft Entra ID before
June 2018. Read-only. Returned only on $select. Supports $filter
(eq, ne, not , ge, le, in).
format: date-time
nullable: true
creationType:
type: string
description: >-
Indicates whether the user account was created through one of
the following methods: As a regular school or work account
(null). As an external account (Invitation). As a local account
for an Azure Active Directory B2C tenant (LocalAccount). Through
self-service sign-up by an internal user using email
verification (EmailVerified). Through self-service sign-up by a
guest signing up through a link that is part of a user flow
(SelfServiceSignUp). Read-only.Returned only on $select.
Supports $filter (eq, ne, not, in).
nullable: true
customSecurityAttributes:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.customSecurityAttributeValue
- type: object
nullable: true
description: >-
An open complex type that holds the value of a custom security
attribute that is assigned to a directory object. Nullable.
Returned only on $select. Supports $filter (eq, ne, not,
startsWith). The filter value is case-sensitive. To read this
property, the calling app must be assigned the
CustomSecAttributeAssignment.Read.All permission. To write this
property, the calling app must be assigned the
CustomSecAttributeAssignment.ReadWrite.All permissions. To read
or write this property in delegated scenarios, the admin must be
assigned the Attribute Assignment Administrator role.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.employeeOrgData'
- type: object
nullable: true
description: >-
Represents organization data (for example, division and
costCenter) associated with a user. Returned only on $select.
Supports $filter (eq, ne, not , ge, le, in).
employeeType:
type: string
description: >-
Captures enterprise worker type. For example, Employee,
Contractor, Consultant, or Vendor. Returned only on $select.
Supports $filter (eq, ne, not , ge, le, in, startsWith).
nullable: true
externalUserState:
type: string
description: >-
For a guest invited to the tenant using the invitation API, this
property represents the invited user's invitation status. For
invited users, the state can be PendingAcceptance or Accepted,
or null for all other users. Returned only on $select. Supports
$filter (eq, ne, not , in).
nullable: true
externalUserStateChangeDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Shows the timestamp for the latest change to the
externalUserState property. Returned only on $select. Supports
$filter (eq, ne, not , in).
format: date-time
nullable: true
faxNumber:
type: string
description: >-
The fax number of the user. Returned only on $select. Supports
$filter (eq, ne, not , ge, le, in, startsWith, and eq on null
values).
nullable: true
givenName:
type: string
description: >-
The given name (first name) of the user. Maximum length is 64
characters. Returned by default. Supports $filter (eq, ne, not ,
ge, le, in, startsWith, and eq on null values).
nullable: true
hireDate:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The hire date of the user. The Timestamp type represents date
and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014, is
2014-01-01T00:00:00Z. Returned only on $select. Note: This
property is specific to SharePoint in Microsoft 365. We
recommend using the native employeeHireDate property to set and
update hire date values using Microsoft Graph APIs.
format: date-time
identities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectIdentity'
description: >-
Represents the identities that can be used to sign in to this
user account. Microsoft (also known as a local account),
organizations, or social identity providers such as Facebook,
Google, and Microsoft can provide identity and tie it to a user
account. It might contain multiple items with the same
signInType value. Returned only on $select. Supports $filter
(eq) with limitations.
imAddresses:
type: array
items:
type: string
nullable: true
description: >-
The instant message voice-over IP (VOIP) session initiation
protocol (SIP) addresses for the user. Read-only. Returned only
on $select. Supports $filter (eq, not, ge, le, startsWith).
interests:
type: array
items:
type: string
nullable: true
description: >-
A list for the user to describe their interests. Returned only
on $select.
isManagementRestricted:
type: boolean
description: >-
true if the user is a member of a restricted management
administrative unit. If not set, the default value is null and
the default behavior is false. Read-only. To manage a user who
is a member of a restricted management administrative unit, the
administrator or calling app must be assigned a Microsoft Entra
role at the scope of the restricted management administrative
unit. Returned only on $select.
nullable: true
isResourceAccount:
type: boolean
description: Don't use – reserved for future use.
nullable: true
jobTitle:
type: string
description: >-
The user's job title. Maximum length is 128 characters. Returned
by default. Supports $filter (eq, ne, not , ge, le, in,
startsWith, and eq on null values).
nullable: true
lastPasswordChangeDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The time when this Microsoft Entra user last changed their
password or when their password was created, whichever date the
latest action was performed. The date and time information uses
ISO 8601 format and is always in UTC. For example, midnight UTC
on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on
$select.
format: date-time
nullable: true
legalAgeGroupClassification:
type: string
description: >-
Used by enterprise applications to determine the legal age group
of the user. This property is read-only and calculated based on
ageGroup and consentProvidedForMinor properties. Allowed values:
null, Undefined, MinorWithOutParentalConsent,
MinorWithParentalConsent, MinorNoParentalConsentRequired,
NotAdult, and Adult. For more information, see legal age group
property definitions. Returned only on $select.
nullable: true
licenseAssignmentStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseAssignmentState'
description: >-
State of license assignments for this user. Also indicates
licenses that are directly assigned or the user inherited
through group memberships. Read-only. Returned only on $select.
mail:
type: string
description: >-
The SMTP address for the user, for example, jeff@contoso.com.
Changes to this property update the user's proxyAddresses
collection to include the value as an SMTP address. This
property can't contain accent characters. NOTE: We don't
recommend updating this property for Azure AD B2C user profiles.
Use the otherMails property instead. Returned by default.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith,
and eq on null values).
nullable: true
mailboxSettings:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mailboxSettings'
- type: object
nullable: true
description: >-
Settings for the primary mailbox of the signed-in user. You can
get or update settings for sending automatic replies to incoming
messages, locale, and time zone. Returned only on $select.
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.onPremisesExtensionAttributes
- type: object
nullable: true
description: >-
Contains extensionAttributes1-15 for the user. These extension
attributes are also known as Exchange custom attributes 1-15.
Each attribute can store up to 1024 characters. For an
onPremisesSyncEnabled user, the source of authority for this set
of properties is the on-premises and is read-only. For a
cloud-only user (where onPremisesSyncEnabled is false), these
properties can be set during the creation or update of a user
object. For a cloud-only user previously synced from
on-premises Active Directory, these properties are read-only in
Microsoft Graph but can be fully managed through the Exchange
Admin Center or the Exchange Online V2 module in PowerShell.
Returned only on $select. Supports $filter (eq, ne, not, in).
onPremisesImmutableId:
type: string
description: >-
This property is used to associate an on-premises Active
Directory user account to their Microsoft Entra user object.
This property must be specified when creating a new user account
in the Graph if you're using a federated domain for the user's
userPrincipalName (UPN) property. NOTE: The $ and _ characters
can't be used when specifying this property. Returned only on
$select. Supports $filter (eq, ne, not, ge, le, in).
nullable: true
onPremisesLastSyncDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Indicates the last time at which the object was synced with the
on-premises directory; for example: 2013-02-16T03:04:54Z. The
Timestamp type represents date and time information using ISO
8601 format and is always in UTC. For example, midnight UTC on
Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on
$select. Supports $filter (eq, ne, not, ge, le, in).
format: date-time
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.onPremisesProvisioningError
description: >-
Errors when using Microsoft synchronization product during
provisioning. Returned only on $select. Supports $filter (eq,
not, ge, le).
onPremisesSamAccountName:
type: string
description: >-
Contains the on-premises samAccountName synchronized from the
on-premises directory. The property is only populated for
customers who are synchronizing their on-premises directory to
Microsoft Entra ID via Microsoft Entra Connect. Read-only.
Returned only on $select. Supports $filter (eq, ne, not, ge, le,
in, startsWith).
nullable: true
onPremisesSecurityIdentifier:
type: string
description: >-
Contains the on-premises security identifier (SID) for the user
that was synchronized from on-premises to the cloud. Read-only.
Returned only on $select. Supports $filter (eq including on null
values).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: >-
true if this user object is currently being synced from an
on-premises Active Directory (AD); otherwise the user isn't
being synced and can be managed in Microsoft Entra ID.
Read-only. Returned only on $select. Supports $filter (eq, ne,
not, in, and eq on null values).
nullable: true
onPremisesUserPrincipalName:
type: string
description: >-
Contains the on-premises userPrincipalName synchronized from the
on-premises directory. The property is only populated for
customers who are synchronizing their on-premises directory to
Microsoft Entra ID via Microsoft Entra Connect. Read-only.
Returned only on $select. Supports $filter (eq, ne, not, ge, le,
in, startsWith).
nullable: true
otherMails:
type: array
items:
type: string
description: >-
A list of other email addresses for the user; for example:
['bob@contoso.com', 'Robert@fabrikam.com']. Can store up to 250
values, each with a limit of 250 characters. NOTE: This property
can't contain accent characters. Returned only on $select.
Supports $filter (eq, not, ge, le, in, startsWith, endsWith,
/$count eq 0, /$count ne 0).
passwordPolicies:
type: string
description: >-
Specifies password policies for the user. This value is an
enumeration with one possible value being DisableStrongPassword,
which allows weaker passwords than the default policy to be
specified. DisablePasswordExpiration can also be specified. The
two might be specified together; for example:
DisablePasswordExpiration, DisableStrongPassword. Returned only
on $select. For more information on the default password
policies, see Microsoft Entra password policies. Supports
$filter (ne, not, and eq on null values).
nullable: true
passwordProfile:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.passwordProfile'
- type: object
nullable: true
description: >-
Specifies the password profile for the user. The profile
contains the user's password. This property is required when a
user is created. The password in the profile must satisfy
minimum requirements as specified by the passwordPolicies
property. By default, a strong password is required. Returned
only on $select. Supports $filter (eq, ne, not, in, and eq on
null values). To update this property: User-PasswordProfile.ReadWrite.All is the least privileged
permission to update this property. In delegated scenarios, the
User Administrator Microsoft Entra role is the least privileged
admin role supported to update this property for nonadmin users.
Privileged Authentication Administrator is the least privileged
role that's allowed to update this property for all
administrators in the tenant. In general, the signed-in user
must have a higher privileged administrator role as indicated in
Who can reset passwords. In app-only scenarios, the calling app
must be assigned a supported permission and at least the User
Administrator Microsoft Entra role.
pastProjects:
type: array
items:
type: string
nullable: true
description: >-
A list for the user to enumerate their past projects. Returned
only on $select.
postalCode:
type: string
description: >-
The postal code for the user's postal address. The postal code
is specific to the user's country or region. In the United
States of America, this attribute contains the ZIP code. Maximum
length is 40 characters. Returned only on $select. Supports
$filter (eq, ne, not, ge, le, in, startsWith, and eq on null
values).
nullable: true
preferredDataLocation:
type: string
description: >-
The preferred data location for the user. For more information,
see OneDrive Online Multi-Geo.
nullable: true
preferredLanguage:
type: string
description: >-
The preferred language for the user. The preferred language
format is based on RFC 4646. The name is a combination of an ISO
639 two-letter lowercase culture code associated with the
language, and an ISO 3166 two-letter uppercase subculture code
associated with the country or region. Example: 'en-US', or
'es-ES'. Returned by default. Supports $filter (eq, ne, not, ge,
le, in, startsWith, and eq on null values)
nullable: true
preferredName:
type: string
description: >-
The preferred name for the user. Not Supported. This attribute
returns an empty string.Returned only on $select.
nullable: true
print:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userPrint'
- type: object
nullable: true
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
description: >-
The plans that are provisioned for the user. Read-only. Not
nullable. Returned only on $select. Supports $filter (eq, not,
ge, le).
proxyAddresses:
type: array
items:
type: string
description: >-
For example: ['SMTP: bob@contoso.com', 'smtp:
bob@sales.contoso.com']. Changes to the mail property update
this collection to include the value as an SMTP address. For
more information, see mail and proxyAddresses properties. The
proxy address prefixed with SMTP (capitalized) is the primary
proxy address, while those addresses prefixed with smtp are the
secondary proxy addresses. For Azure AD B2C accounts, this
property has a limit of 10 unique addresses. Read-only in
Microsoft Graph; you can update this property only through the
Microsoft 365 admin center. Not nullable. Returned only on
$select. Supports $filter (eq, not, ge, le, startsWith,
endsWith, /$count eq 0, /$count ne 0).
responsibilities:
type: array
items:
type: string
nullable: true
description: >-
A list for the user to enumerate their responsibilities.
Returned only on $select.
schools:
type: array
items:
type: string
nullable: true
description: >-
A list for the user to enumerate the schools they attended.
Returned only on $select.
securityIdentifier:
type: string
description: >-
Security identifier (SID) of the user, used in Windows
scenarios. Read-only. Returned by default. Supports $select and
$filter (eq, not, ge, le, startsWith).
nullable: true
serviceProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: >-
Errors published by a federated service describing a
nontransient, service-specific error regarding the properties or
link from a user object. Supports $filter (eq, not, for
isResolved and serviceInstance).
showInAddressList:
type: boolean
description: >-
Do not use in Microsoft Graph. Manage this property through the
Microsoft 365 admin center instead. Represents whether the user
should be included in the Outlook global address list. See Known
issue.
nullable: true
signInActivity:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.signInActivity'
- type: object
nullable: true
description: >-
Get the last signed-in date and request ID of the sign-in for a
given user. Read-only.Returned only on $select. Supports $filter
(eq, ne, not, ge, le) but not with any other filterable
properties. Note: Details for this property require a Microsoft
Entra ID P1 or P2 license and the AuditLog.Read.All
permission.This property isn't returned for a user who never
signed in or last signed in before April 2020.
signInSessionsValidFromDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Any refresh tokens or session tokens (session cookies) issued
before this time are invalid. Applications get an error when
using an invalid refresh or session token to acquire a delegated
access token (to access APIs such as Microsoft Graph). If this
happens, the application needs to acquire a new refresh token by
requesting the authorized endpoint. Read-only. Use
revokeSignInSessions to reset. Returned only on $select.
format: date-time
nullable: true
skills:
type: array
items:
type: string
nullable: true
description: >-
A list for the user to enumerate their skills. Returned only on
$select.
state:
type: string
description: >-
The state or province in the user's address. Maximum length is
128 characters. Returned only on $select. Supports $filter (eq,
ne, not, ge, le, in, startsWith, and eq on null values).
nullable: true
streetAddress:
type: string
description: >-
The street address of the user's place of business. Maximum
length is 1,024 characters. Returned only on $select. Supports
$filter (eq, ne, not, ge, le, in, startsWith, and eq on null
values).
nullable: true
surname:
type: string
description: >-
The user's surname (family name or last name). Maximum length is
64 characters. Returned by default. Supports $filter (eq, ne,
not, ge, le, in, startsWith, and eq on null values).
nullable: true
usageLocation:
type: string
description: >-
A two-letter country code (ISO standard 3166). Required for
users that are assigned licenses due to legal requirements to
check for availability of services in countries/regions.
Examples include: US, JP, and GB. Not nullable. Returned only on
$select. Supports $filter (eq, ne, not, ge, le, in, startsWith,
and eq on null values).
nullable: true
userPrincipalName:
type: string
description: >-
The user principal name (UPN) of the user. The UPN is an
Internet-style sign-in name for the user based on the Internet
standard RFC 822. By convention, this value should map to the
user's email name. The general format is alias@domain, where the
domain must be present in the tenant's collection of verified
domains. This property is required when a user is created. The
verified domains for the tenant can be accessed from the
verifiedDomains property of organization.NOTE: This property
can't contain accent characters. Only the following characters
are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. For the
complete list of allowed characters, see username policies.
Returned by default. Supports $filter (eq, ne, not, ge, le, in,
startsWith, endsWith) and $orderby.
nullable: true
userType:
type: string
description: >-
A string value that can be used to classify user types in your
directory. The possible values are Member and Guest. Returned
only on $select. Supports $filter (eq, ne, not, in, and eq on
null values). NOTE: For more information about the permissions
for members and guests, see What are the default user
permissions in Microsoft Entra ID?
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userActivity'
description: The user's activities across devices. Read-only. Nullable.
x-ms-navigationProperty: true
agreementAcceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: >-
The user's terms of use acceptance statuses. Read-only.
Nullable.
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: >-
Represents the app roles a user is granted for an application.
Supports $expand.
x-ms-navigationProperty: true
authentication:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.authentication'
- type: object
nullable: true
description: The authentication methods that are supported for the user.
x-ms-navigationProperty: true
calendar:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendar'
- type: object
nullable: true
description: The user's primary calendar. Read-only.
x-ms-navigationProperty: true
calendarGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
description: The user's calendar groups. Read-only. Nullable.
x-ms-navigationProperty: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The user's calendars. Read-only. Nullable.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
chats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chat'
x-ms-navigationProperty: true
cloudClipboard:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot'
- type: object
nullable: true
x-ms-navigationProperty: true
cloudPCs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
description: The user's Cloud PCs. Read-only. Nullable.
x-ms-navigationProperty: true
contactFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The user's contacts folders. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The user's contacts. Read-only. Nullable.
x-ms-navigationProperty: true
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Directory objects that the user created. Read-only. Nullable.
x-ms-navigationProperty: true
dataSecurityAndGovernance:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.userDataSecurityAndGovernance
- type: object
nullable: true
description: >-
The data security and governance settings for the user.
Read-only. Nullable.
x-ms-navigationProperty: true
deviceManagementTroubleshootingEvents:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent
description: The list of troubleshooting events for this user.
x-ms-navigationProperty: true
directReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
The users and contacts that report to the user. (The users and
contacts that have their manager property set to this user.)
Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
drive:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.drive'
- type: object
nullable: true
description: The user's OneDrive. Read-only.
x-ms-navigationProperty: true
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: A collection of drives available for this user. Read-only.
x-ms-navigationProperty: true
employeeExperience:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
- type: object
nullable: true
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: >-
The user's events. Default is to show Events under the Default
Calendar. Read-only. Nullable.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the user.
Read-only. Supports $expand. Nullable.
x-ms-navigationProperty: true
followedSites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
x-ms-navigationProperty: true
inferenceClassification:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.inferenceClassification'
- type: object
nullable: true
description: >-
Relevance classification of the user's messages based on
explicit designations that override inferred relevance or
importance.
x-ms-navigationProperty: true
insights:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemInsights'
- type: object
nullable: true
description: >-
Represents relationships between a user and items such as
OneDrive for work or school documents, calculated using advanced
analytics and machine learning techniques. Read-only. Nullable.
x-ms-navigationProperty: true
joinedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.team'
x-ms-navigationProperty: true
licenseDetails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
description: A collection of this user's license details. Read-only.
x-ms-navigationProperty: true
mailFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The user's mail folders. Read-only. Nullable.
x-ms-navigationProperty: true
managedAppRegistrations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppRegistration'
description: Zero or more managed app registrations that belong to the user.
x-ms-navigationProperty: true
managedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
description: The managed devices associated with the user.
x-ms-navigationProperty: true
manager:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- type: object
nullable: true
description: >-
The user or contact that is this user's manager. Read-only.
Supports $expand.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
The groups and directory roles that the user is a member of.
Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The messages in a mailbox or folder. Read-only. Nullable.
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
x-ms-navigationProperty: true
onenote:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenote'
- type: object
nullable: true
x-ms-navigationProperty: true
onlineMeetings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
description: >-
Information about a meeting, including the URL used to join a
meeting, the attendees list, and the description.
x-ms-navigationProperty: true
outlook:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.outlookUser'
- type: object
nullable: true
x-ms-navigationProperty: true
ownedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Devices the user owns. Read-only. Nullable. Supports $expand and
$filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne
1).
x-ms-navigationProperty: true
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Directory objects the user owns. Read-only. Nullable. Supports
$expand, $select nested in $expand, and $filter (/$count eq 0,
/$count ne 0, /$count eq 1, /$count ne 1).
x-ms-navigationProperty: true
people:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.person'
description: People that are relevant to the user. Read-only. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
description: List all resource-specific permission grants of a user.
x-ms-navigationProperty: true
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- type: object
nullable: true
description: The user's profile photo. Read-only.
x-ms-navigationProperty: true
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: >-
The collection of the user's profile photos in different sizes.
Read-only.
x-ms-navigationProperty: true
planner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerUser'
- type: object
nullable: true
description: >-
Entry-point to the Planner resource that might exist for a user.
Read-only.
x-ms-navigationProperty: true
presence:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.presence'
- type: object
nullable: true
x-ms-navigationProperty: true
registeredDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Devices that are registered for the user. Read-only. Nullable.
Supports $expand and returns up to 100 objects.
x-ms-navigationProperty: true
scopedRoleMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
x-ms-navigationProperty: true
settings:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userSettings'
- type: object
nullable: true
x-ms-navigationProperty: true
solutions:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userSolutionRoot'
- type: object
nullable: true
description: >-
The identifier that relates the user to the working time
schedule triggers. Read-Only. Nullable
x-ms-navigationProperty: true
sponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
The users and groups responsible for this guest's privileges in
the tenant and keeping the guest's information and access
updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand.
x-ms-navigationProperty: true
teamwork:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userTeamwork'
- type: object
nullable: true
description: >-
A container for Microsoft Teams features available for the user.
Read-only. Nullable.
x-ms-navigationProperty: true
todo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.todo'
- type: object
nullable: true
description: Represents the To Do services available to a user.
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
The groups, including nested groups, and directory roles that a
user is a member of. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.user'
description: Represents a Microsoft Entra user account.
x-ms-discriminator-value: '#microsoft.graph.user'
microsoft.graph.mailboxSettings:
title: mailboxSettings
required:
- '@odata.type'
type: object
properties:
archiveFolder:
type: string
description: Folder ID of an archive folder for the user.
nullable: true
automaticRepliesSetting:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
- type: object
nullable: true
description: >-
Configuration settings to automatically notify the sender of an
incoming email with a message from the signed-in user.
dateFormat:
type: string
description: The date format for the user's mailbox.
nullable: true
delegateMeetingMessageDeliveryOptions:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions
- type: object
nullable: true
description: >-
If the user has a calendar delegate, this specifies whether the
delegate, mailbox owner, or both receive meeting messages and
meeting responses. The possible values are:
sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal,
sendToDelegateOnly.
language:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- type: object
nullable: true
description: >-
The locale information for the user, including the preferred
language and country/region.
timeFormat:
type: string
description: The time format for the user's mailbox.
nullable: true
timeZone:
type: string
description: The default time zone for the user's mailbox.
nullable: true
userPurpose:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userPurpose'
- type: object
nullable: true
description: >-
The purpose of the mailbox. Differentiates a mailbox for a single
user from a shared mailbox and equipment mailbox in Exchange Online.
The possible values are: user, linked, shared, room, equipment,
others, unknownFutureValue. Read-only.
workingHours:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workingHours'
- type: object
nullable: true
description: >-
The days of the week and hours in a specific time zone that the user
works.
'@odata.type':
type: string
microsoft.graph.includedUserTypes:
title: includedUserTypes
enum:
- all
- member
- guest
- unknownFutureValue
type: string
microsoft.graph.includedUserRoles:
title: includedUserRoles
enum:
- all
- privilegedAdmin
- admin
- user
- unknownFutureValue
type: string
microsoft.graph.userActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userActivity
required:
- '@odata.type'
type: object
properties:
activationUrl:
type: string
description: >-
Required. URL used to launch the activity in the best native
experience represented by the appId. Might launch a web-based
app if no native app exists.
activitySourceHost:
type: string
description: >-
Required. URL for the domain representing the cross-platform
identity mapping for the app. Mapping is stored either as a JSON
file hosted on the domain or configurable via Windows Dev
Center. The JSON file is named cross-platform-app-identifiers
and is hosted at root of your HTTPS domain, either at the top
level domain or include a sub domain. For example:
https://contoso.com or https://myapp.contoso.com but NOT
https://myapp.contoso.com/somepath. You must have a unique file
and domain (or sub domain) per cross-platform app identity. For
example, a separate file and domain is needed for Word vs.
PowerPoint.
appActivityId:
type: string
description: >-
Required. The unique activity ID in the context of the app -
supplied by caller and immutable thereafter.
appDisplayName:
type: string
description: >-
Optional. Short text description of the app used to generate the
activity for use in cases when the app is not installed on the
user’s local device.
nullable: true
contentInfo:
description: >-
Optional. A custom piece of data - JSON-LD extensible
description of content according to schema.org syntax.
contentUrl:
type: string
description: >-
Optional. Used in the event the content can be rendered outside
of a native or web-based app experience (for example, a pointer
to an item in an RSS feed).
nullable: true
createdDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Set by the server. DateTime in UTC when the object was created
on the server.
format: date-time
nullable: true
expirationDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Set by the server. DateTime in UTC when the object expired on
the server.
format: date-time
nullable: true
fallbackUrl:
type: string
description: >-
Optional. URL used to launch the activity in a web-based app, if
available.
nullable: true
lastModifiedDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Set by the server. DateTime in UTC when the object was modified
on the server.
format: date-time
nullable: true
status:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.status'
- type: object
nullable: true
description: >-
Set by the server. A status code used to identify valid objects.
Values: active, updated, deleted, ignored.
userTimezone:
type: string
description: >-
Optional. The timezone in which the user's device used to
generate the activity was located at activity creation time;
values supplied as Olson IDs in order to support cross-platform
representation.
nullable: true
visualElements:
$ref: '#/components/schemas/microsoft.graph.visualInfo'
historyItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
description: >-
Optional. NavigationProperty/Containment; navigation property to
the activity's historyItems.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.userActivity'
microsoft.graph.activityHistoryItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: activityHistoryItem
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.status'
- type: object
nullable: true
description: >-
Set by the server. A status code used to identify valid objects.
Values: active, updated, deleted, ignored.
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/microsoft.graph.userActivity'
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.activityHistoryItem'
microsoft.graph.agreementAcceptance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreementAcceptance
required:
- '@odata.type'
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.agreementAcceptanceState
- type: object
nullable: true
description: >-
The state of the agreement acceptance. The possible values are:
accepted, declined. Supports $filter (eq).
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.agreementAcceptance'
microsoft.graph.appRoleAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: appRoleAssignment
required:
- '@odata.type'
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
'@odata.type':
type: string
default: '#microsoft.graph.appRoleAssignment'
x-ms-discriminator-value: '#microsoft.graph.appRoleAssignment'
microsoft.graph.authentication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authentication
required:
- '@odata.type'
type: object
properties:
emailMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
description: The email address registered to a user for authentication.
x-ms-navigationProperty: true
fido2Methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
description: >-
Represents the FIDO2 security keys registered to a user for
authentication.
x-ms-navigationProperty: true
methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
description: Represents all authentication methods registered to a user.
x-ms-navigationProperty: true
microsoftAuthenticatorMethods:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod
description: >-
The details of the Microsoft Authenticator app registered to a
user for authentication.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
description: >-
Represents the status of a long-running operation, such as a
password reset operation.
x-ms-navigationProperty: true
passwordMethods:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.passwordAuthenticationMethod
description: >-
Represents the password registered to a user for authentication.
For security, the password itself is never returned in the
object, but action can be taken to reset a password.
x-ms-navigationProperty: true
phoneMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
description: The phone numbers registered to a user for authentication.
x-ms-navigationProperty: true
platformCredentialMethods:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod
description: >-
Represents a platform credential instance registered to a user
on Mac OS.
x-ms-navigationProperty: true
softwareOathMethods:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod
description: >-
The software OATH time-based one-time password (TOTP)
applications registered to a user for authentication.
x-ms-navigationProperty: true
temporaryAccessPassMethods:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod
description: >-
Represents a Temporary Access Pass registered to a user for
authentication through time-limited passcodes.
x-ms-navigationProperty: true
windowsHelloForBusinessMethods:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod
description: >-
Represents the Windows Hello for Business authentication method
registered to a user for authentication.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.authentication'
microsoft.graph.emailAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: emailAuthenticationMethod
required:
- '@odata.type'
type: object
properties:
emailAddress:
type: string
description: The email address registered to this user.
nullable: true
'@odata.type':
type: string
default: '#microsoft.graph.emailAuthenticationMethod'
x-ms-discriminator-value: '#microsoft.graph.emailAuthenticationMethod'
microsoft.graph.fido2AuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: fido2AuthenticationMethod
required:
- '@odata.type'
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
items:
type: string
nullable: true
description: The attestation certificate(s) attached to this security key.
attestationLevel:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attestationLevel'
- type: object
nullable: true
description: >-
The attestation level of this FIDO2 security key. The possible
values are: attested, or notAttested.
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
'@odata.type':
type: string
default: '#microsoft.graph.fido2AuthenticationMethod'
x-ms-discriminator-value: '#microsoft.graph.fido2AuthenticationMethod'
microsoft.graph.authenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationMethod
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.emailAuthenticationMethod': '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
'#microsoft.graph.fido2AuthenticationMethod': '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
'#microsoft.graph.microsoftAuthenticatorAuthenticationMethod': >-
#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod
'#microsoft.graph.passwordAuthenticationMethod': >-
#/components/schemas/microsoft.graph.passwordAuthenticationMethod
'#microsoft.graph.phoneAuthenticationMethod': '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
'#microsoft.graph.platformCredentialAuthenticationMethod': >-
#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod
'#microsoft.graph.softwareOathAuthenticationMethod': >-
#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod
'#microsoft.graph.temporaryAccessPassAuthenticationMethod': >-
#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod
'#microsoft.graph.windowsHelloForBusinessAuthenticationMethod': >-
#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod
microsoft.graph.passwordResetResponse:
title: passwordResetResponse
required:
- '@odata.type'
type: object
properties:
newPassword:
type: string
description: The Microsoft Entra ID-generated password.
nullable: true
'@odata.type':
type: string
microsoft.graph.device:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: device
required:
- '@odata.type'
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
items:
$ref: '#/components/schemas/microsoft.graph.alternativeSecurityId'
description: >-
For internal use only. Not nullable. Supports $filter (eq, not,
ge, le).
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. The 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. The
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. The 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
items:
type: string
description: >-
For internal use only. Not nullable. Supports $filter (eq, not,
ge, le, startsWith,/$count eq 0, /$count ne 0).
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
items:
type: string
description: >-
List of labels applied to the device by the system. Supports
$filter (/$count eq 0, /$count ne 0).
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
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the device.
Read-only. Nullable.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Groups and administrative units that this device is a member of.
Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
registeredOwners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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.
x-ms-navigationProperty: true
registeredUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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.
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Groups and administrative units that the device is a member of.
This operation is transitive. Supports $expand.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.device'
x-ms-discriminator-value: '#microsoft.graph.device'
microsoft.graph.longRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: longRunningOperation
required:
- '@odata.type'
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.longRunningOperationStatus
- type: object
nullable: true
description: >-
The status of the operation. The possible values are:
notStarted, running, succeeded, failed, unknownFutureValue.
statusDetail:
type: string
description: Details about the status of the operation.
nullable: true
'@odata.type':
type: string
description: The status of a long-running operation.
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.attackSimulationOperation': '#/components/schemas/microsoft.graph.attackSimulationOperation'
'#microsoft.graph.engagementAsyncOperation': '#/components/schemas/microsoft.graph.engagementAsyncOperation'
'#microsoft.graph.richLongRunningOperation': '#/components/schemas/microsoft.graph.richLongRunningOperation'
microsoft.graph.phoneAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: phoneAuthenticationMethod
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationPhoneType'
- type: object
nullable: true
description: >-
The type of this phone. The possible values are: mobile,
alternateMobile, or office.
smsSignInState:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.authenticationMethodSignInState
- type: object
nullable: true
description: >-
Whether a phone is ready to be used for SMS sign-in or not. The
possible values are: notSupported, notAllowedByPolicy,
notEnabled, phoneNumberNotUnique, ready, or notConfigured,
unknownFutureValue.
'@odata.type':
type: string
default: '#microsoft.graph.phoneAuthenticationMethod'
x-ms-discriminator-value: '#microsoft.graph.phoneAuthenticationMethod'
microsoft.graph.calendar:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendar
required:
- '@odata.type'
type: object
properties:
allowedOnlineMeetingProviders:
type: array
items:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.onlineMeetingProviderType
- type: object
nullable: true
description: >-
Represent the online meeting service providers that can be used
to create online meetings in this calendar. The possible values
are: unknown, skypeForBusiness, skypeForConsumer,
teamsForBusiness.
canEdit:
type: boolean
description: >-
true if the user can write to the calendar, false otherwise.
This property is true for the user who created the calendar.
This property is also true for a user who shared a calendar and
granted write access.
nullable: true
canShare:
type: boolean
description: >-
true if the user has permission to share the calendar, false
otherwise. Only the user who created the calendar can share it.
nullable: true
canViewPrivateItems:
type: boolean
description: >-
If true, the user can read calendar items that have been marked
private, false otherwise.
nullable: true
changeKey:
type: string
description: >-
Identifies the version of the calendar object. Every time the
calendar is changed, changeKey changes as well. This allows
Exchange to apply changes to the correct version of the object.
Read-only.
nullable: true
color:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendarColor'
- type: object
nullable: true
description: >-
Specifies the color theme to distinguish the calendar from other
calendars in a UI. The property values are: auto, lightBlue,
lightGreen, lightOrange, lightGray, lightYellow, lightTeal,
lightPink, lightBrown, lightRed, maxColor.
defaultOnlineMeetingProvider:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.onlineMeetingProviderType
- type: object
nullable: true
description: >-
The default online meeting provider for meetings sent from this
calendar. The possible values are: unknown, skypeForBusiness,
skypeForConsumer, teamsForBusiness.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
- type: object
nullable: true
description: >-
If set, this represents the user who created or added the
calendar. For a calendar that the user created or added, the
owner property is set to the user. For a calendar shared with
the user, the owner property is set to the person who shared
that calendar with the user.
calendarPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
description: The permissions of the users with whom the calendar is shared.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: >-
The calendar view for the calendar. Navigation property.
Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The events in the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty
description: >-
The collection of multi-value extended properties defined for
the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty
description: >-
The collection of single-value extended properties defined for
the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.calendar'
microsoft.graph.calendarPermission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarPermission
required:
- '@odata.type'
type: object
properties:
allowedRoles:
type: array
items:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendarRoleType'
- type: object
nullable: true
description: >-
List of allowed sharing or delegating permission levels for the
calendar. The possible values are: none, freeBusyRead,
limitedRead, read, write, delegateWithoutPrivateEventAccess,
delegateWithPrivateEventAccess, custom.
emailAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
- type: object
nullable: true
description: >-
Represents a share recipient or delegate who has access to the
calendar. For the 'My Organization' share recipient, the address
property is null. Read-only.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendarRoleType'
- type: object
nullable: true
description: >-
Current permission level of the calendar share recipient or
delegate.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.calendarPermission'
microsoft.graph.event:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: event
required:
- '@odata.type'
type: object
properties:
allowNewTimeProposals:
type: boolean
description: >-
true if the meeting organizer allows invitees to propose a new
time when responding; otherwise, false. Optional. The default is
true.
nullable: true
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendee'
description: The collection of attendees for the event.
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: >-
The body of the message associated with the event. It can be in
HTML or text format.
bodyPreview:
type: string
description: >-
The preview of the message associated with the event. It's in
text format.
nullable: true
cancelledOccurrences:
type: array
items:
type: string
description: >-
Contains occurrenceId property values of canceled instances in a
recurring series, if the event is the series master. Instances
in a recurring series that are canceled are called canceled
occurences.Returned only on $select in a Get operation which
specifies the ID (seriesMasterId property value) of a series
master event.
end:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
description: >-
The date, time, and time zone that the event ends. By default,
the end time is in UTC.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.importance'
- type: object
nullable: true
description: >-
The importance of the event. The possible values are: low,
normal, high.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.location'
- type: object
nullable: true
description: The location of the event.
locations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: >-
The locations where the event is held or attended from. The
location and locations properties always correspond with each
other. If you update the location property, any prior locations
in the locations collection are removed and replaced by the new
location value.
onlineMeeting:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingInfo'
- type: object
nullable: true
description: >-
Details for an attendee to join the meeting online. The default
is null. Read-only. After you set the isOnlineMeeting and
onlineMeetingProvider properties to enable a meeting online,
Microsoft Graph initializes onlineMeeting. When set, the meeting
remains available online, and you can't change the
isOnlineMeeting, onlineMeetingProvider, and onlneMeeting
properties again.
onlineMeetingProvider:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.onlineMeetingProviderType
- type: object
nullable: true
description: >-
Represents the online meeting service provider. By default,
onlineMeetingProvider is unknown. The possible values are
unknown, teamsForBusiness, skypeForBusiness, and
skypeForConsumer. Optional. After you set
onlineMeetingProvider, Microsoft Graph initializes
onlineMeeting. Subsequently, you can't change
onlineMeetingProvider again, and the meeting remains available
online.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- type: object
nullable: true
description: The organizer of the event.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
- type: object
nullable: true
description: The recurrence pattern for the event.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.responseStatus'
- type: object
nullable: true
description: >-
Indicates the type of response sent in response to an event
message.
sensitivity:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sensitivity'
- type: object
nullable: true
description: >-
The possible values are: normal, personal, private, and
confidential.
seriesMasterId:
type: string
description: >-
The ID for the recurring series master item, if this event is
part of a recurring series.
nullable: true
showAs:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
- type: object
nullable: true
description: >-
The status to show. The possible values are: free, tentative,
busy, oof, workingElsewhere, unknown.
start:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
description: >-
The start date, time, and time zone of the event. By default,
the start time is in UTC.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.eventType'
- type: object
nullable: true
description: >-
The event type. The possible values are: singleInstance,
occurrence, exception, seriesMaster. Read-only
webLink:
type: string
description: >-
The URL to open the event in Outlook on the web.Outlook on the
web opens the event in the browser if you are signed in to your
mailbox. Otherwise, Outlook on the web prompts you to sign
in.This URL can't be accessed from within an iFrame.
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: >-
The collection of FileAttachment, ItemAttachment, and
referenceAttachment attachments for the event. Navigation
property. Read-only. Nullable.
x-ms-navigationProperty: true
calendar:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendar'
- type: object
nullable: true
description: >-
The calendar that contains the event. Navigation property.
Read-only.
x-ms-navigationProperty: true
exceptionOccurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: >-
Contains the id property values of the event instances that are
exceptions in a recurring series.Exceptions can differ from
other occurrences in a recurring series, such as the subject,
start or end times, or attendees. Exceptions don't include
canceled occurrences.Returned only on $select and $expand in a
GET operation that specifies the ID (seriesMasterId property
value) of a series master event.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the event.
Nullable.
x-ms-navigationProperty: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: >-
The occurrences of a recurring series, if the event is a series
master. This property includes occurrences that are part of the
recurrence pattern, and exceptions modified, but doesn't include
occurrences canceled from the series. Navigation property.
Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty
description: >-
The collection of multi-value extended properties defined for
the event. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty
description: >-
The collection of single-value extended properties defined for
the event. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.event'
x-ms-discriminator-value: '#microsoft.graph.event'
microsoft.graph.attachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachment
required:
- '@odata.type'
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
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.fileAttachment': '#/components/schemas/microsoft.graph.fileAttachment'
'#microsoft.graph.itemAttachment': '#/components/schemas/microsoft.graph.itemAttachment'
'#microsoft.graph.referenceAttachment': '#/components/schemas/microsoft.graph.referenceAttachment'
microsoft.graph.attachmentItem:
title: attachmentItem
required:
- '@odata.type'
type: object
properties:
attachmentType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attachmentType'
- type: object
nullable: true
description: >-
The type of attachment. The possible values are: file, item,
reference. Required.
contentId:
type: string
description: >-
The CID or Content-Id of the attachment for referencing for the
in-line attachments using the
tag in HTML
messages. Optional.
nullable: true
contentType:
type: string
description: The nature of the data in the attachment. Optional.
nullable: true
isInline:
type: boolean
description: >-
true if the attachment is an inline attachment; otherwise, false.
Optional.
nullable: true
name:
type: string
description: >-
The display name of the attachment. This can be a descriptive string
and doesn't have to be the actual file name. Required.
nullable: true
size:
type: number
description: The length of the attachment in bytes. Required.
format: int64
nullable: true
'@odata.type':
type: string
microsoft.graph.uploadSession:
title: uploadSession
required:
- '@odata.type'
type: object
properties:
expirationDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The date and time in UTC that the upload session expires. The
complete file must be uploaded before this expiration time is
reached. Each fragment uploaded during the session extends the
expiration time.
format: date-time
nullable: true
nextExpectedRanges:
type: array
items:
type: string
nullable: true
description: >-
A collection of byte ranges that the server is missing for the file.
These ranges are zero indexed and of the format 'start-end' (for
example '0-26' to indicate the first 27 bytes of the file). When
uploading files as Outlook attachments, instead of a collection of
ranges, this property always indicates a single value '{start}', the
location in the file where the next upload should begin.
uploadUrl:
type: string
description: >-
The URL endpoint that accepts PUT requests for byte ranges of the
file.
nullable: true
'@odata.type':
type: string
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.openTypeExtension': '#/components/schemas/microsoft.graph.openTypeExtension'
microsoft.graph.timeSlot:
title: timeSlot
required:
- '@odata.type'
type: object
properties:
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
'@odata.type':
type: string
microsoft.graph.recipient:
title: recipient
required:
- '@odata.type'
type: object
properties:
emailAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
- type: object
nullable: true
description: The recipient's email address.
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.attendeeBase': '#/components/schemas/microsoft.graph.attendeeBase'
'#microsoft.graph.attendee': '#/components/schemas/microsoft.graph.attendee'
microsoft.graph.dateTimeTimeZone:
title: dateTimeTimeZone
required:
- '@odata.type'
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
'@odata.type':
type: string
microsoft.graph.calendarGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarGroup
required:
- '@odata.type'
type: object
properties:
changeKey:
type: string
description: >-
Identifies the version of the calendar group. Every time the
calendar group is changed, ChangeKey changes as well. This
allows Exchange to apply changes to the correct version of the
object. Read-only.
nullable: true
classId:
pattern: >-
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
description: The class identifier. Read-only.
format: uuid
nullable: true
name:
type: string
description: The group name.
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: >-
The calendars in the calendar group. Navigation property.
Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.calendarGroup'
microsoft.graph.chat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chat
required:
- '@odata.type'
type: object
properties:
chatType:
$ref: '#/components/schemas/microsoft.graph.chatType'
createdDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: Date and time at which the chat was created. Read-only.
format: date-time
nullable: true
isHiddenForAllMembers:
type: boolean
description: >-
Indicates whether the chat is hidden for all its members.
Read-only.
nullable: true
lastUpdatedDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Date and time at which the chat was renamed or the list of
members was last changed. Read-only.
format: date-time
nullable: true
onlineMeetingInfo:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamworkOnlineMeetingInfo
- type: object
nullable: true
description: >-
Represents details about an online meeting. If the chat isn't
associated with an online meeting, the property is empty.
Read-only.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.chatViewpoint'
- type: object
nullable: true
description: >-
Represents caller-specific information about the chat, such as
the last message read date and time. This property is populated
only when the request is made in a delegated context.
webUrl:
type: string
description: >-
The URL for the chat in Microsoft Teams. The URL should be
treated as an opaque blob, and not parsed. Read-only.
nullable: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: A collection of all the apps in the chat. Nullable.
x-ms-navigationProperty: true
lastMessagePreview:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
- type: object
nullable: true
description: >-
Preview of the last message sent in the chat. Null if no
messages were sent in the chat. Currently, only the list chats
operation supports this property.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of all the members in the chat. Nullable.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the chat. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
description: A collection of permissions granted to apps for the chat.
x-ms-navigationProperty: true
pinnedMessages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
description: A collection of all the pinned messages in the chat. Nullable.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the chat. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.chat'
microsoft.graph.teamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppInstallation
required:
- '@odata.type'
type: object
properties:
consentedPermissionSet:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'
- type: object
nullable: true
description: >-
The set of resource-specific permissions consented to while
installing or upgrading the teamsApp.
teamsApp:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsApp'
- type: object
nullable: true
description: The app that is installed.
x-ms-navigationProperty: true
teamsAppDefinition:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
- type: object
nullable: true
description: The details of this version of the app.
x-ms-navigationProperty: true
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.userScopeTeamsAppInstallation': >-
#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation
microsoft.graph.teamsApp:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsApp
required:
- '@odata.type'
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.teamsAppDistributionMethod
- type: object
nullable: true
description: The method of distribution for the app. Read-only.
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
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
description: The details for each version of the app.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamsApp'
microsoft.graph.teamsAppDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppDefinition
required:
- '@odata.type'
type: object
properties:
authorization:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsAppAuthorization'
- type: object
nullable: true
description: Authorization requirements specified in the Teams app manifest.
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsAppPublishingState'
- type: object
nullable: true
description: >-
The published status of a specific version of a Teams app. The
possible values are:submitted—The specific version of the Teams
app was submitted and is under review.published—The request to
publish the specific version of the Teams app was approved by
the admin and the app is published.rejected—The admin rejected
the request to publish the specific version of the Teams app.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamworkBot'
- type: object
nullable: true
description: The details of the bot specified in the Teams app manifest.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamsAppDefinition'
microsoft.graph.chatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessageInfo
required:
- '@odata.type'
type: object
properties:
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: >-
Body of the chatMessage. This will still contain markers for
@mentions and attachments even though the object doesn't return
@mentions and attachments.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
- type: object
nullable: true
description: >-
Read-only. If present, represents details of an event that
happened in a chat, a channel, or a team, for example, members
were added, and so on. For event messages, the messageType
property is set to systemEventMessage.
from:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.chatMessageFromIdentitySet
- type: object
nullable: true
description: Information about the sender of the message.
isDeleted:
type: boolean
description: If set to true, the original message has been deleted.
nullable: true
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.chatMessageInfo'
microsoft.graph.conversationMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationMember
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The display name of the user.
nullable: true
roles:
type: array
items:
type: string
nullable: true
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.
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
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.aadUserConversationMember': '#/components/schemas/microsoft.graph.aadUserConversationMember'
'#microsoft.graph.anonymousGuestConversationMember': >-
#/components/schemas/microsoft.graph.anonymousGuestConversationMember
'#microsoft.graph.azureCommunicationServicesUserConversationMember': >-
#/components/schemas/microsoft.graph.azureCommunicationServicesUserConversationMember
'#microsoft.graph.microsoftAccountUserConversationMember': >-
#/components/schemas/microsoft.graph.microsoftAccountUserConversationMember
'#microsoft.graph.phoneUserConversationMember': '#/components/schemas/microsoft.graph.phoneUserConversationMember'
'#microsoft.graph.skypeForBusinessUserConversationMember': >-
#/components/schemas/microsoft.graph.skypeForBusinessUserConversationMember
'#microsoft.graph.skypeUserConversationMember': '#/components/schemas/microsoft.graph.skypeUserConversationMember'
microsoft.graph.chatMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessage
required:
- '@odata.type'
type: object
properties:
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageAttachment'
description: References to attached objects like files, tabs, meetings etc.
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
channelIdentity:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.channelIdentity'
- type: object
nullable: true
description: >-
If the message was sent in a channel, represents identity of the
channel.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
- type: object
nullable: true
description: >-
Read-only. If present, represents details of an event that
happened in a chat, a channel, or a team, for example, adding
new members. For event messages, the messageType property will
be set to systemEventMessage.
from:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.chatMessageFromIdentitySet
- type: object
nullable: true
description: >-
Details of the sender of the chat message. Can only be set
during migration.
importance:
$ref: '#/components/schemas/microsoft.graph.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
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageMention'
description: >-
List of entities mentioned in the chat message. Supported
entities are: user, bot, team, channel, chat, and tag.
messageHistory:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHistoryItem'
description: >-
List of activity history of a message item, including
modification time and actions, such as reactionAdded,
reactionRemoved, or reaction changes, on the message.
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
policyViolation:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.chatMessagePolicyViolation
- type: object
nullable: true
description: >-
Defines the properties of a policy violation set by a data loss
prevention (DLP) application.
reactions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
description: Reactions for this chat message (for example, Like).
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
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
description: >-
Content in a message hosted by Microsoft Teams - for example,
images or code snippets.
x-ms-navigationProperty: true
replies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: >-
Replies for a specified message. Supports $expand for channel
messages.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.chatMessage'
microsoft.graph.chatMessageHostedContent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamworkHostedContent'
- title: chatMessageHostedContent
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.chatMessageHostedContent'
microsoft.graph.itemBody:
title: itemBody
required:
- '@odata.type'
type: object
properties:
content:
type: string
description: The content of the item.
nullable: true
contentType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.bodyType'
- type: object
nullable: true
description: The type of the content. Possible values are text and html.
'@odata.type':
type: string
microsoft.graph.keyValuePair:
title: keyValuePair
required:
- '@odata.type'
type: object
properties:
name:
type: string
description: Name for this key-value pair
value:
type: string
description: Value for this key-value pair
nullable: true
'@odata.type':
type: string
microsoft.graph.pinnedChatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: pinnedChatMessageInfo
required:
- '@odata.type'
type: object
properties:
message:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.chatMessage'
- type: object
nullable: true
description: Represents details about the chat message that is pinned.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.pinnedChatMessageInfo'
microsoft.graph.teamsTab:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTab
required:
- '@odata.type'
type: object
properties:
configuration:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsTabConfiguration'
- type: object
nullable: true
description: >-
Container for custom settings applied to a tab. The tab is
considered configured only once this property is set.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsApp'
- type: object
nullable: true
description: >-
The application that is linked to the tab. This can't be changed
after tab creation.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamsTab'
microsoft.graph.cloudClipboardRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudClipboardRoot
required:
- '@odata.type'
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
description: Represents a collection of Cloud Clipboard items.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.cloudClipboardRoot'
microsoft.graph.cloudClipboardItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudClipboardItem
required:
- '@odata.type'
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
items:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItemPayload'
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.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.cloudClipboardItem'
microsoft.graph.cloudPC:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudPC
required:
- '@odata.type'
type: object
properties:
aadDeviceId:
type: string
description: >-
The Microsoft Entra device ID for the Cloud PC, also known as
the Azure Active Directory (Azure AD) device ID, that consists
of 32 characters in a GUID format. Generated on a VM joined to
Microsoft Entra ID. Read-only.
nullable: true
displayName:
type: string
description: >-
The display name for the Cloud PC. Maximum length is 64
characters. Read-only. You can use the cloudPC: rename API to
modify the Cloud PC name.
nullable: true
gracePeriodEndDateTime:
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 grace period ends and reprovisioning
or deprovisioning happen. Required only if the status is
inGracePeriod. The timestamp is shown in ISO 8601 format and
Coordinated Universal Time (UTC). For example, midnight UTC on
Jan 1, 2014 is 2014-01-01T00:00:00Z.
format: date-time
nullable: true
imageDisplayName:
type: string
description: >-
The name of the operating system image used for the Cloud PC.
Maximum length is 50 characters. Only letters (A-Z, a-z),
numbers (0-9), and special characters (-,,.) are allowed for
this property. The property value can't begin or end with an
underscore. 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 last modified date and time of the Cloud PC. 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
managedDeviceId:
type: string
description: >-
The Intune enrolled device ID for the Cloud PC that consists of
32 characters in a GUID format. The managedDeviceId property of
Windows 365 Business Cloud PCs is always null as Windows 365
Business Cloud PCs aren't Intune-enrolled automatically by
Windows 365. Read-only.
nullable: true
managedDeviceName:
type: string
description: >-
The Intune enrolled device name for the Cloud PC. The
managedDeviceName property of Windows 365 Business Cloud PCs is
always null as Windows 365 Business Cloud PCs aren't
Intune-enrolled automatically by Windows 365. Read-only.
nullable: true
onPremisesConnectionName:
type: string
description: >-
The on-premises connection that applied during the provisioning
of Cloud PCs. Read-only.
nullable: true
provisioningPolicyId:
type: string
description: >-
The provisioning policy ID for the Cloud PC that consists of 32
characters in a GUID format. A policy defines the type of Cloud
PC the user wants to create. Read-only.
nullable: true
provisioningPolicyName:
type: string
description: >-
The provisioning policy that applied during the provisioning of
Cloud PCs. Maximum length is 120 characters. Read-only.
nullable: true
provisioningType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningType'
- type: object
nullable: true
description: >-
The type of licenses to be used when provisioning Cloud PCs
using this policy. The possible values are: dedicated, shared,
unknownFutureValue. The default value is dedicated.
servicePlanId:
type: string
description: >-
The service plan ID for the Cloud PC that consists of 32
characters in a GUID format. For more information about service
plans, see Product names and service plan identifiers for
licensing. Read-only.
nullable: true
servicePlanName:
type: string
description: >-
The service plan name for the customer-facing Cloud PC entity.
Read-only.
nullable: true
userPrincipalName:
type: string
description: >-
The user principal name (UPN) of the user assigned to the Cloud
PC. Maximum length is 113 characters. For more information on
username policies, see Password policies and account
restrictions in Microsoft Entra ID. Read-only.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.cloudPC'
microsoft.graph.contactFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contactFolder
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The folder's display name.
nullable: true
parentFolderId:
type: string
description: The ID of the folder's parent folder.
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: >-
The collection of child folders in the folder. Navigation
property. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: >-
The contacts in the folder. Navigation property. Read-only.
Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty
description: >-
The collection of multi-value extended properties defined for
the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty
description: >-
The collection of single-value extended properties defined for
the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.contactFolder'
microsoft.graph.contact:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: contact
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
- type: object
nullable: true
description: The contact's business address.
businessHomePage:
type: string
description: The business home page of the contact.
nullable: true
businessPhones:
type: array
items:
type: string
nullable: true
description: The contact's business phone numbers.
children:
type: array
items:
type: string
nullable: true
description: The names of the contact's children.
companyName:
type: string
description: The name of the contact's company.
nullable: true
department:
type: string
description: The contact's department.
nullable: true
displayName:
type: string
description: >-
The contact's display name. You can specify the display name in
a create or update operation. Note that later updates to other
properties may cause an automatically generated value to
overwrite the displayName value you have specified. To preserve
a pre-existing value, always include it as displayName in an
update operation.
nullable: true
emailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
description: The contact's email addresses.
fileAs:
type: string
description: The name the contact is filed under.
nullable: true
generation:
type: string
description: The contact's suffix.
nullable: true
givenName:
type: string
description: The contact's given name.
nullable: true
homeAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
- type: object
nullable: true
description: The contact's home address.
homePhones:
type: array
items:
type: string
nullable: true
description: The contact's home phone numbers.
imAddresses:
type: array
items:
type: string
nullable: true
description: The contact's instant messaging (IM) addresses.
initials:
type: string
description: The contact's initials.
nullable: true
jobTitle:
type: string
description: The contact’s job title.
nullable: true
manager:
type: string
description: The name of the contact's manager.
nullable: true
middleName:
type: string
description: The contact's middle name.
nullable: true
mobilePhone:
type: string
description: The contact's mobile phone number.
nullable: true
nickName:
type: string
description: The contact's nickname.
nullable: true
officeLocation:
type: string
description: The location of the contact's office.
nullable: true
otherAddress:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
- type: object
nullable: true
description: Other addresses for the contact.
parentFolderId:
type: string
description: The ID of the contact's parent folder.
nullable: true
personalNotes:
type: string
description: The user's notes about the contact.
nullable: true
profession:
type: string
description: The contact's profession.
nullable: true
spouseName:
type: string
description: The name of the contact's spouse/partner.
nullable: true
surname:
type: string
description: The contact's surname.
nullable: true
title:
type: string
description: The contact's title.
nullable: true
yomiCompanyName:
type: string
description: The phonetic Japanese company name of the contact.
nullable: true
yomiGivenName:
type: string
description: The phonetic Japanese given name (first name) of the contact.
nullable: true
yomiSurname:
type: string
description: The phonetic Japanese surname (last name) of the contact.
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the contact.
Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty
description: >-
The collection of multi-value extended properties defined for
the contact. Read-only. Nullable.
x-ms-navigationProperty: true
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- type: object
nullable: true
description: >-
Optional contact picture. You can get or set a photo for a
contact.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty
description: >-
The collection of single-value extended properties defined for
the contact. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.contact'
x-ms-discriminator-value: '#microsoft.graph.contact'
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
required:
- '@odata.type'
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: The height of the photo. Read-only.
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: The width of the photo. Read-only.
format: int32
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.profilePhoto'
microsoft.graph.directoryObject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: directoryObject
required:
- '@odata.type'
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
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.administrativeUnit': '#/components/schemas/microsoft.graph.administrativeUnit'
'#microsoft.graph.application': '#/components/schemas/microsoft.graph.application'
'#microsoft.graph.appRoleAssignment': '#/components/schemas/microsoft.graph.appRoleAssignment'
'#microsoft.graph.certificateAuthorityDetail': '#/components/schemas/microsoft.graph.certificateAuthorityDetail'
'#microsoft.graph.certificateBasedAuthPki': '#/components/schemas/microsoft.graph.certificateBasedAuthPki'
'#microsoft.graph.contract': '#/components/schemas/microsoft.graph.contract'
'#microsoft.graph.device': '#/components/schemas/microsoft.graph.device'
'#microsoft.graph.directoryObjectPartnerReference': >-
#/components/schemas/microsoft.graph.directoryObjectPartnerReference
'#microsoft.graph.directoryRole': '#/components/schemas/microsoft.graph.directoryRole'
'#microsoft.graph.directoryRoleTemplate': '#/components/schemas/microsoft.graph.directoryRoleTemplate'
'#microsoft.graph.endpoint': '#/components/schemas/microsoft.graph.endpoint'
'#microsoft.graph.extensionProperty': '#/components/schemas/microsoft.graph.extensionProperty'
'#microsoft.graph.group': '#/components/schemas/microsoft.graph.group'
'#microsoft.graph.groupSettingTemplate': '#/components/schemas/microsoft.graph.groupSettingTemplate'
'#microsoft.graph.multiTenantOrganizationMember': >-
#/components/schemas/microsoft.graph.multiTenantOrganizationMember
'#microsoft.graph.organization': '#/components/schemas/microsoft.graph.organization'
'#microsoft.graph.orgContact': '#/components/schemas/microsoft.graph.orgContact'
'#microsoft.graph.policyBase': '#/components/schemas/microsoft.graph.policyBase'
'#microsoft.graph.appManagementPolicy': '#/components/schemas/microsoft.graph.appManagementPolicy'
'#microsoft.graph.authorizationPolicy': '#/components/schemas/microsoft.graph.authorizationPolicy'
'#microsoft.graph.crossTenantAccessPolicy': '#/components/schemas/microsoft.graph.crossTenantAccessPolicy'
'#microsoft.graph.identitySecurityDefaultsEnforcementPolicy': >-
#/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy
'#microsoft.graph.permissionGrantPolicy': '#/components/schemas/microsoft.graph.permissionGrantPolicy'
'#microsoft.graph.stsPolicy': '#/components/schemas/microsoft.graph.stsPolicy'
'#microsoft.graph.activityBasedTimeoutPolicy': '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
'#microsoft.graph.claimsMappingPolicy': '#/components/schemas/microsoft.graph.claimsMappingPolicy'
'#microsoft.graph.homeRealmDiscoveryPolicy': '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
'#microsoft.graph.tokenIssuancePolicy': '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
'#microsoft.graph.tokenLifetimePolicy': '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
'#microsoft.graph.tenantAppManagementPolicy': '#/components/schemas/microsoft.graph.tenantAppManagementPolicy'
'#microsoft.graph.resourceSpecificPermissionGrant': >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
'#microsoft.graph.servicePrincipal': '#/components/schemas/microsoft.graph.servicePrincipal'
'#microsoft.graph.user': '#/components/schemas/microsoft.graph.user'
microsoft.graph.servicePrincipal:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: servicePrincipal
required:
- '@odata.type'
type: object
properties:
accountEnabled:
type: boolean
description: >-
true if the service principal account is enabled; otherwise,
false. If set to false, then no users are able to sign in to
this app, even if they're assigned to it. Supports $filter (eq,
ne, not, in).
nullable: true
addIns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.addIn'
description: >-
Defines custom behavior that a consuming service can use to call
an app in specific contexts. For example, applications that can
render file streams may set the addIns property for its
'FileHandler' functionality. This lets services like Microsoft
365 call the application in the context of a document the user
is working on.
alternativeNames:
type: array
items:
type: string
description: >-
Used to retrieve service principals by subscription, identify
resource group and full resource IDs for managed identities.
Supports $filter (eq, not, ge, le, startsWith).
appDescription:
type: string
description: The description exposed by the associated application.
nullable: true
appDisplayName:
type: string
description: >-
The display name exposed by the associated application. Maximum
length is 256 characters.
nullable: true
appId:
type: string
description: >-
The unique identifier for the associated application (its appId
property). Alternate key. Supports $filter (eq, ne, not, in,
startsWith).
nullable: true
applicationTemplateId:
type: string
description: >-
Unique identifier of the applicationTemplate. Supports $filter
(eq, not, ne). Read-only. null if the service principal wasn't
created from an application template.
nullable: true
appOwnerOrganizationId:
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: >-
Contains the tenant ID where the application is registered. This
is applicable only to service principals backed by applications.
Supports $filter (eq, ne, NOT, ge, le).
format: uuid
nullable: true
appRoleAssignmentRequired:
type: boolean
description: >-
Specifies whether users or other service principals need to be
granted an app role assignment for this service principal before
users can sign in or apps can get tokens. The default value is
false. Not nullable. Supports $filter (eq, ne, NOT).
appRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRole'
description: >-
The roles exposed by the application that's linked to this
service principal. For more information, see the appRoles
property definition on the application entity. Not nullable.
customSecurityAttributes:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.customSecurityAttributeValue
- type: object
nullable: true
description: >-
An open complex type that holds the value of a custom security
attribute that is assigned to a directory object. Nullable.
Returned only on $select. Supports $filter (eq, ne, not,
startsWith). Filter value is case sensitive. To read this
property, the calling app must be assigned the
CustomSecAttributeAssignment.Read.All permission. To write this
property, the calling app must be assigned the
CustomSecAttributeAssignment.ReadWrite.All permissions. To read
or write this property in delegated scenarios, the admin must be
assigned the Attribute Assignment Administrator role.
description:
type: string
description: >-
Free text field to provide an internal end-user facing
description of the service principal. End-user portals such
MyApps displays the application description in this field. The
maximum allowed size is 1,024 characters. Supports $filter (eq,
ne, not, ge, le, startsWith) and $search.
nullable: true
disabledByMicrosoftStatus:
type: string
description: >-
Specifies whether Microsoft has disabled the registered
application. The possible values are: null (default value),
NotDisabled, and DisabledDueToViolationOfServicesAgreement
(reasons include suspicious, abusive, or malicious activity, or
a violation of the Microsoft Services Agreement). Supports
$filter (eq, ne, not).
nullable: true
displayName:
type: string
description: >-
The display name for the service principal. Supports $filter
(eq, ne, not, ge, le, in, startsWith, and eq on null values),
$search, and $orderby.
nullable: true
homepage:
type: string
description: Home page or landing page of the application.
nullable: true
info:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.informationalUrl'
- type: object
nullable: true
description: >-
Basic profile information of the acquired application such as
app's marketing, support, terms of service and privacy statement
URLs. The terms of service and privacy statement are surfaced to
users through the user consent experience. For more info, see
How to: Add Terms of service and privacy statement for
registered Microsoft Entra apps. Supports $filter (eq, ne, not,
ge, le, and eq on null values).
keyCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
description: >-
The collection of key credentials associated with the service
principal. Not nullable. Supports $filter (eq, not, ge, le).
loginUrl:
type: string
description: >-
Specifies the URL where the service provider redirects the user
to Microsoft Entra ID to authenticate. Microsoft Entra ID uses
the URL to launch the application from Microsoft 365 or the
Microsoft Entra My Apps. When blank, Microsoft Entra ID performs
IdP-initiated sign-on for applications configured with
SAML-based single sign-on. The user launches the application
from Microsoft 365, the Microsoft Entra My Apps, or the
Microsoft Entra SSO URL.
nullable: true
logoutUrl:
type: string
description: >-
Specifies the URL that the Microsoft's authorization service
uses to sign out a user using OpenID Connect front-channel,
back-channel, or SAML sign out protocols.
nullable: true
notes:
type: string
description: >-
Free text field to capture information about the service
principal, typically used for operational purposes. Maximum
allowed size is 1,024 characters.
nullable: true
notificationEmailAddresses:
type: array
items:
type: string
description: >-
Specifies the list of email addresses where Microsoft Entra ID
sends a notification when the active certificate is near the
expiration date. This is only for the certificates used to sign
the SAML token issued for Microsoft Entra Gallery applications.
oauth2PermissionScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionScope'
description: >-
The delegated permissions exposed by the application. For more
information, see the oauth2PermissionScopes property on the
application entity's api property. Not nullable.
passwordCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
description: >-
The collection of password credentials associated with the
application. Not nullable.
preferredSingleSignOnMode:
type: string
description: >-
Specifies the single sign-on mode configured for this
application. Microsoft Entra ID uses the preferred single
sign-on mode to launch the application from Microsoft 365 or the
My Apps portal. The supported values are password, saml,
notSupported, and oidc. Note: This field might be null for older
SAML apps and for OIDC applications where it isn't set
automatically.
nullable: true
preferredTokenSigningKeyThumbprint:
type: string
description: >-
This property can be used on SAML applications (apps that have
preferredSingleSignOnMode set to saml) to control which
certificate is used to sign the SAML responses. For applications
that aren't SAML, don't write or otherwise rely on this
property.
nullable: true
replyUrls:
type: array
items:
type: string
description: >-
The URLs that user tokens are sent to for sign in with the
associated application, or the redirect URIs that OAuth 2.0
authorization codes and access tokens are sent to for the
associated application. Not nullable.
resourceSpecificApplicationPermissions:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermission
description: >-
The resource-specific application permissions exposed by this
application. Currently, resource-specific permissions are only
supported for Teams apps accessing to specific chats and teams
using Microsoft Graph. Read-only.
samlSingleSignOnSettings:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.samlSingleSignOnSettings
- type: object
nullable: true
description: The collection for settings related to saml single sign-on.
servicePrincipalNames:
type: array
items:
type: string
description: >-
Contains the list of identifiersUris, copied over from the
associated application. Additional values can be added to hybrid
applications. These values can be used to identify the
permissions exposed by this app within Microsoft Entra ID. For
example,Client apps can specify a resource URI that is based on
the values of this property to acquire an access token, which is
the URI returned in the 'aud' claim.The any operator is required
for filter expressions on multi-valued properties. Not
nullable. Supports $filter (eq, not, ge, le, startsWith).
servicePrincipalType:
type: string
description: >-
Identifies whether the service principal represents an
application, a managed identity, or a legacy application. This
is set by Microsoft Entra ID internally. The
servicePrincipalType property can be set to three different
values: Application - A service principal that represents an
application or service. The appId property identifies the
associated app registration, and matches the appId of an
application, possibly from a different tenant. If the associated
app registration is missing, tokens aren't issued for the
service principal.ManagedIdentity - A service principal that
represents a managed identity. Service principals representing
managed identities can be granted access and permissions, but
can't be updated or modified directly.Legacy - A service
principal that represents an app created before app
registrations, or through legacy experiences. A legacy service
principal can have credentials, service principal names, reply
URLs, and other properties that are editable by an authorized
user, but doesn't have an associated app registration. The appId
value doesn't associate the service principal with an app
registration. The service principal can only be used in the
tenant where it was created.SocialIdp - For internal use.
nullable: true
signInAudience:
type: string
description: >-
Specifies the Microsoft accounts that are supported for the
current application. Read-only. Supported values
are:AzureADMyOrg: Users with a Microsoft work or school account
in my organization's Microsoft Entra tenant
(single-tenant).AzureADMultipleOrgs: Users with a Microsoft work
or school account in any organization's Microsoft Entra tenant
(multitenant).AzureADandPersonalMicrosoftAccount: Users with a
personal Microsoft account, or a work or school account in any
organization's Microsoft Entra tenant.PersonalMicrosoftAccount:
Users with a personal Microsoft account only.
nullable: true
tags:
type: array
items:
type: string
description: >-
Custom strings that can be used to categorize and identify the
service principal. Not nullable. The value is the union of
strings set here and on the associated application entity's tags
property.Supports $filter (eq, not, ge, le, startsWith).
tokenEncryptionKeyId:
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: >-
Specifies the keyId of a public key from the keyCredentials
collection. When configured, Microsoft Entra ID issues tokens
for this application encrypted using the key specified by this
property. The application code that receives the encrypted token
must use the matching private key to decrypt the token before it
can be used for the signed-in user.
format: uuid
nullable: true
verifiedPublisher:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.verifiedPublisher'
- type: object
nullable: true
description: >-
Specifies the verified publisher of the application that's
linked to this service principal.
appManagementPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
description: The appManagementPolicy applied to this application.
x-ms-navigationProperty: true
appRoleAssignedTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: >-
App role assignments for this app or service, granted to users,
groups, and other service principals. Supports $expand.
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: >-
App role assignment for another app or service, granted to this
service principal. Supports $expand.
x-ms-navigationProperty: true
claimsMappingPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
description: >-
The claimsMappingPolicies assigned to this service principal.
Supports $expand.
x-ms-navigationProperty: true
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Directory objects created by this service principal. Read-only.
Nullable.
x-ms-navigationProperty: true
delegatedPermissionClassifications:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.delegatedPermissionClassification
x-ms-navigationProperty: true
endpoints:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.endpoint'
x-ms-navigationProperty: true
federatedIdentityCredentials:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.federatedIdentityCredential
description: >-
Federated identities for a specific type of service principal -
managed identity. Supports $expand and $filter (/$count eq 0,
/$count ne 0).
x-ms-navigationProperty: true
homeRealmDiscoveryPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
description: >-
The homeRealmDiscoveryPolicies assigned to this service
principal. Supports $expand.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Roles that this service principal is a member of. HTTP Methods:
GET Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
description: >-
Delegated permission grants authorizing this service principal
to access an API on behalf of a signed-in user. Read-only.
Nullable.
x-ms-navigationProperty: true
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Directory objects that this service principal owns. Read-only.
Nullable. Supports $expand, $select nested in $expand, and
$filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne
1).
x-ms-navigationProperty: true
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Directory objects that are owners of this servicePrincipal. The
owners are a set of nonadmin users or servicePrincipals who are
allowed to modify this object. Supports $expand, $filter
(/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and
$select nested in $expand.
x-ms-navigationProperty: true
remoteDesktopSecurityConfiguration:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration
- type: object
nullable: true
description: >-
The remoteDesktopSecurityConfiguration object applied to this
service principal. Supports $filter (eq) for
isRemoteDesktopProtocolEnabled property.
x-ms-navigationProperty: true
synchronization:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.synchronization'
- type: object
nullable: true
description: >-
Represents the capability for Microsoft Entra identity
synchronization through the Microsoft Graph API.
x-ms-navigationProperty: true
tokenIssuancePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
description: The tokenIssuancePolicies assigned to this service principal.
x-ms-navigationProperty: true
tokenLifetimePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
description: The tokenLifetimePolicies assigned to this service principal.
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.servicePrincipal'
x-ms-discriminator-value: '#microsoft.graph.servicePrincipal'
microsoft.graph.activitiesContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: activitiesContainer
required:
- '@odata.type'
type: object
properties:
contentActivities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
description: Collection of activity logs related to content processing.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.activitiesContainer'
microsoft.graph.contentActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentActivity
required:
- '@odata.type'
type: object
properties:
contentMetadata:
$ref: '#/components/schemas/microsoft.graph.processContentRequest'
scopeIdentifier:
type: string
description: The scope identified from computed protection scopes.
nullable: true
userId:
type: string
description: ID of the user.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.contentActivity'
microsoft.graph.userActivityTypes:
title: userActivityTypes
enum:
- none
- uploadText
- uploadFile
- downloadText
- downloadFile
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.policyLocation:
title: policyLocation
required:
- '@odata.type'
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').
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.policyLocationApplication': '#/components/schemas/microsoft.graph.policyLocationApplication'
'#microsoft.graph.policyLocationDomain': '#/components/schemas/microsoft.graph.policyLocationDomain'
'#microsoft.graph.policyLocationUrl': '#/components/schemas/microsoft.graph.policyLocationUrl'
microsoft.graph.policyPivotProperty:
title: policyPivotProperty
enum:
- none
- activity
- location
- unknownFutureValue
type: string
microsoft.graph.deviceMetadata:
title: deviceMetadata
required:
- '@odata.type'
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.operatingSystemSpecifications
- type: object
nullable: true
description: Details about the operating system platform and version.
'@odata.type':
type: string
microsoft.graph.policyUserScope:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyScopeBase'
- title: policyUserScope
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
default: '#microsoft.graph.policyUserScope'
x-ms-discriminator-value: '#microsoft.graph.policyUserScope'
microsoft.graph.sensitivityLabel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: sensitivityLabel
required:
- '@odata.type'
type: object
properties:
actionSource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.labelActionSource'
- type: object
nullable: true
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.usageRightsIncluded'
- type: object
nullable: true
x-ms-navigationProperty: true
sublabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.sensitivityLabel'
microsoft.graph.usageRightsIncluded:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: usageRightsIncluded
required:
- '@odata.type'
type: object
properties:
ownerEmail:
type: string
description: The email of owner label rights.
nullable: true
userEmail:
type: string
description: The email of user with label user rights.
nullable: true
value:
$ref: '#/components/schemas/microsoft.graph.usageRights'
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.usageRightsIncluded'
microsoft.graph.protectedContent:
title: protectedContent
required:
- '@odata.type'
type: object
properties:
cid:
type: string
description: The content id
nullable: true
format:
type: string
description: The content format.
nullable: true
labelId:
type: string
description: >-
The unique identifier for the sensitivity label applied to the
content.
'@odata.type':
type: string
microsoft.graph.orgContact:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: orgContact
required:
- '@odata.type'
type: object
properties:
addresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.physicalOfficeAddress'
description: >-
Postal addresses for this organizational contact. For now a
contact can only have one physical address.
companyName:
type: string
description: >-
Name of the company that this organizational contact belongs
to. Supports $filter (eq, ne, not, ge, le, in, startsWith, and
eq for null values).
nullable: true
department:
type: string
description: >-
The name for the department in which the contact works. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq
for null values).
nullable: true
displayName:
type: string
description: >-
Display name for this organizational contact. Maximum length is
256 characters. Supports $filter (eq, ne, not, ge, le, in,
startsWith, and eq for null values), $search, and $orderby.
nullable: true
givenName:
type: string
description: >-
First name for this organizational contact. Supports $filter
(eq, ne, not, ge, le, in, startsWith, and eq for null values).
nullable: true
jobTitle:
type: string
description: >-
Job title for this organizational contact. Supports $filter (eq,
ne, not, ge, le, in, startsWith, and eq for null values).
nullable: true
mail:
type: string
description: >-
The SMTP address for the contact, for example,
'jeff@contoso.com'. Supports $filter (eq, ne, not, ge, le, in,
startsWith, and eq for null values).
nullable: true
mailNickname:
type: string
description: >-
Email alias (portion of email address pre-pending the @ symbol)
for this organizational contact. Supports $filter (eq, ne, not,
ge, le, in, startsWith, and eq for null values).
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: >-
Date and time when this organizational contact was last
synchronized from on-premises AD. This 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. Supports
$filter (eq, ne, not, ge, le, in).
format: date-time
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.onPremisesProvisioningError
description: >-
List of any synchronization provisioning errors for this
organizational contact. Supports $filter (eq, not for category
and propertyCausingError), /$count eq 0, /$count ne 0.
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 and now mastered in Exchange;
null if this object has never been synced from an on-premises
directory (default). Supports $filter (eq, ne, not, in, and eq
for null values).
nullable: true
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: >-
List of phones for this organizational contact. Phone types can
be mobile, business, and businessFax. Only one of each type can
ever be present in the collection.
proxyAddresses:
type: array
items:
type: string
description: >-
For example: 'SMTP: bob@contoso.com', 'smtp:
bob@sales.contoso.com'. The any operator is required for filter
expressions on multi-valued properties. Supports $filter (eq,
not, ge, le, startsWith, /$count eq 0, /$count ne 0).
serviceProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: >-
Errors published by a federated service describing a
non-transient, service-specific error regarding the properties
or link from an organizational contact object . Supports
$filter (eq, not, for isResolved and serviceInstance).
surname:
type: string
description: >-
Last name for this organizational contact. Supports $filter (eq,
ne, not, ge, le, in, startsWith, and eq for null values).
nullable: true
directReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
The contact's direct reports. (The users and contacts that have
their manager property set to this contact.) Read-only.
Nullable. Supports $expand.
x-ms-navigationProperty: true
manager:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- type: object
nullable: true
description: >-
The user or contact that is this contact's manager. Read-only.
Supports $expand and $filter (eq) by id.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Groups that this contact is a member of. Read-only. Nullable.
Supports $expand.
x-ms-navigationProperty: true
onPremisesSyncBehavior:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onPremisesSyncBehavior'
- type: object
nullable: true
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Groups that this contact is a member of, including groups that
the contact is nested under. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.orgContact'
x-ms-discriminator-value: '#microsoft.graph.orgContact'
microsoft.graph.drive:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: drive
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Optional. The user account that owns the drive. Read-only.
quota:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.quota'
- type: object
nullable: true
description: >-
Optional. Information about the drive's storage space quota.
Read-only.
sharePointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
- type: object
nullable: true
system:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.systemFacet'
- type: object
nullable: true
description: >-
If present, indicates that it's a system-managed drive.
Read-only.
bundles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: >-
Collection of bundles (albums and multi-select-shared sets of
items). Only in personal OneDrive.
x-ms-navigationProperty: true
following:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: >-
The list of items the user is following. Only in OneDrive for
Business.
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: All items contained in the drive. Read-only. Nullable.
x-ms-navigationProperty: true
list:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.list'
- type: object
nullable: true
description: >-
For drives in SharePoint, the underlying document library list.
Read-only. Nullable.
x-ms-navigationProperty: true
root:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
- type: object
nullable: true
description: The root folder of the drive. Read-only.
x-ms-navigationProperty: true
special:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: >-
Collection of common folders available in OneDrive. Read-only.
Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.drive'
x-ms-discriminator-value: '#microsoft.graph.drive'
microsoft.graph.employeeExperienceUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: employeeExperienceUser
required:
- '@odata.type'
type: object
properties:
assignedRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
description: >-
Represents the collection of Viva Engage roles assigned to a
user.
x-ms-navigationProperty: true
learningCourseActivities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.employeeExperienceUser'
microsoft.graph.engagementRole:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: engagementRole
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The name of the role.
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
description: Users that have this role assigned.
x-ms-navigationProperty: true
'@odata.type':
type: string
description: Represents a Viva Engage role and its members
x-ms-discriminator-value: '#microsoft.graph.engagementRole'
microsoft.graph.engagementRoleMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: engagementRoleMember
required:
- '@odata.type'
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 role was assigned to 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.
format: date-time
readOnly: true
userId:
type: string
description: The Microsoft Entra ID of the user who has the role assigned.
nullable: true
readOnly: true
user:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
- type: object
nullable: true
description: The user who has this role assigned.
x-ms-navigationProperty: true
'@odata.type':
type: string
description: Entity to represent the assignment of a role to a user.
x-ms-discriminator-value: '#microsoft.graph.engagementRoleMember'
microsoft.graph.learningCourseActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: learningCourseActivity
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.courseStatus'
- type: object
nullable: true
description: >-
The status of the course activity. The possible values are:
notStarted, inProgress, completed. Required.
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.learningAssignment': '#/components/schemas/microsoft.graph.learningAssignment'
'#microsoft.graph.learningSelfInitiatedCourse': '#/components/schemas/microsoft.graph.learningSelfInitiatedCourse'
microsoft.graph.site:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: site
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The full title for the site. Read-only.
nullable: true
error:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.publicError'
- type: object
nullable: true
isPersonalSite:
type: boolean
description: Identifies whether the site is personal or not. Read-only.
nullable: true
root:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.root'
- type: object
nullable: true
description: >-
If present, provides the root site in the site collection.
Read-only.
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
- type: object
nullable: true
description: >-
Returns identifiers useful for SharePoint REST compatibility.
Read-only.
siteCollection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.siteCollection'
- type: object
nullable: true
description: >-
Provides details about the site's site collection. Available
only on the root site. Read-only.
analytics:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemAnalytics'
- type: object
nullable: true
description: >-
Analytics about the view activities that took place on this
site.
x-ms-navigationProperty: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: >-
The collection of column definitions reusable across lists under
this site.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types defined for this site.
x-ms-navigationProperty: true
drive:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.drive'
- type: object
nullable: true
description: The default drive (document library) for this site.
x-ms-navigationProperty: true
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The collection of drives (document libraries) under this site.
x-ms-navigationProperty: true
externalColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseItem'
description: >-
Used to address any item contained in this site. This collection
can't be enumerated.
x-ms-navigationProperty: true
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.list'
description: The collection of lists under this site.
x-ms-navigationProperty: true
onenote:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenote'
- type: object
nullable: true
description: Calls the OneNote service for notebook related operations.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the site.
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseSitePage'
description: The collection of pages in the baseSitePages list in this site.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The permissions associated with the site. Nullable.
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The collection of the sub-sites under this site.
x-ms-navigationProperty: true
termStore:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.termStore.store'
- type: object
nullable: true
description: The default termStore under this site.
x-ms-navigationProperty: true
termStores:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
description: The collection of termStores under this site.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.site'
x-ms-discriminator-value: '#microsoft.graph.site'
microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassification
required:
- '@odata.type'
type: object
properties:
overrides:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.inferenceClassificationOverride
description: >-
A set of overrides for a user to always classify messages from
specific senders in certain ways: focused, or other. Read-only.
Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.inferenceClassification'
microsoft.graph.itemInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.officeGraphInsights'
- title: itemInsights
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.itemInsights'
microsoft.graph.sharedInsight:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: sharedInsight
required:
- '@odata.type'
type: object
properties:
lastShared:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharingDetail'
- type: object
nullable: true
description: Details about the shared item. Read only.
resourceReference:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.resourceReference'
- type: object
nullable: true
description: >-
Reference properties of the shared document, such as the url and
type of the document. Read-only
readOnly: true
resourceVisualization:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.resourceVisualization'
- type: object
nullable: true
description: >-
Properties that you can use to visualize the document in your
experience. Read-only
readOnly: true
sharingHistory:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharingDetail'
lastSharedMethod:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- type: object
nullable: true
x-ms-navigationProperty: true
resource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- type: object
nullable: true
description: >-
Used for navigating to the item that was shared. For file
attachments, the type is fileAttachment. For linked attachments,
the type is driveItem.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.sharedInsight'
microsoft.graph.entity:
title: entity
required:
- '@odata.type'
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.accessPackage': '#/components/schemas/microsoft.graph.accessPackage'
'#microsoft.graph.accessPackageAssignment': '#/components/schemas/microsoft.graph.accessPackageAssignment'
'#microsoft.graph.accessPackageAssignmentPolicy': '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
'#microsoft.graph.accessPackageAssignmentRequest': '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
'#microsoft.graph.accessPackageCatalog': '#/components/schemas/microsoft.graph.accessPackageCatalog'
'#microsoft.graph.accessPackageQuestion': '#/components/schemas/microsoft.graph.accessPackageQuestion'
'#microsoft.graph.accessPackageMultipleChoiceQuestion': >-
#/components/schemas/microsoft.graph.accessPackageMultipleChoiceQuestion
'#microsoft.graph.accessPackageTextInputQuestion': '#/components/schemas/microsoft.graph.accessPackageTextInputQuestion'
'#microsoft.graph.accessPackageResource': '#/components/schemas/microsoft.graph.accessPackageResource'
'#microsoft.graph.accessPackageResourceEnvironment': >-
#/components/schemas/microsoft.graph.accessPackageResourceEnvironment
'#microsoft.graph.accessPackageResourceRequest': '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
'#microsoft.graph.accessPackageResourceRole': '#/components/schemas/microsoft.graph.accessPackageResourceRole'
'#microsoft.graph.accessPackageResourceRoleScope': '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
'#microsoft.graph.accessPackageResourceScope': '#/components/schemas/microsoft.graph.accessPackageResourceScope'
'#microsoft.graph.accessPackageSubject': '#/components/schemas/microsoft.graph.accessPackageSubject'
'#microsoft.graph.accessReviewHistoryDefinition': '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
'#microsoft.graph.accessReviewHistoryInstance': '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
'#microsoft.graph.accessReviewInstance': '#/components/schemas/microsoft.graph.accessReviewInstance'
'#microsoft.graph.accessReviewInstanceDecisionItem': >-
#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem
'#microsoft.graph.accessReviewReviewer': '#/components/schemas/microsoft.graph.accessReviewReviewer'
'#microsoft.graph.accessReviewScheduleDefinition': '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
'#microsoft.graph.accessReviewSet': '#/components/schemas/microsoft.graph.accessReviewSet'
'#microsoft.graph.accessReviewStage': '#/components/schemas/microsoft.graph.accessReviewStage'
'#microsoft.graph.activitiesContainer': '#/components/schemas/microsoft.graph.activitiesContainer'
'#microsoft.graph.activityHistoryItem': '#/components/schemas/microsoft.graph.activityHistoryItem'
'#microsoft.graph.adminConsentRequestPolicy': '#/components/schemas/microsoft.graph.adminConsentRequestPolicy'
'#microsoft.graph.adminMicrosoft365Apps': '#/components/schemas/microsoft.graph.adminMicrosoft365Apps'
'#microsoft.graph.adminReportSettings': '#/components/schemas/microsoft.graph.adminReportSettings'
'#microsoft.graph.agreement': '#/components/schemas/microsoft.graph.agreement'
'#microsoft.graph.agreementAcceptance': '#/components/schemas/microsoft.graph.agreementAcceptance'
'#microsoft.graph.agreementFileProperties': '#/components/schemas/microsoft.graph.agreementFileProperties'
'#microsoft.graph.agreementFile': '#/components/schemas/microsoft.graph.agreementFile'
'#microsoft.graph.agreementFileLocalization': '#/components/schemas/microsoft.graph.agreementFileLocalization'
'#microsoft.graph.agreementFileVersion': '#/components/schemas/microsoft.graph.agreementFileVersion'
'#microsoft.graph.aiInteraction': '#/components/schemas/microsoft.graph.aiInteraction'
'#microsoft.graph.aiInteractionHistory': '#/components/schemas/microsoft.graph.aiInteractionHistory'
'#microsoft.graph.aiUser': '#/components/schemas/microsoft.graph.aiUser'
'#microsoft.graph.alert': '#/components/schemas/microsoft.graph.alert'
'#microsoft.graph.allowedValue': '#/components/schemas/microsoft.graph.allowedValue'
'#microsoft.graph.appCatalogs': '#/components/schemas/microsoft.graph.appCatalogs'
'#microsoft.graph.appConsentApprovalRoute': '#/components/schemas/microsoft.graph.appConsentApprovalRoute'
'#microsoft.graph.appConsentRequest': '#/components/schemas/microsoft.graph.appConsentRequest'
'#microsoft.graph.applePushNotificationCertificate': >-
#/components/schemas/microsoft.graph.applePushNotificationCertificate
'#microsoft.graph.applicationTemplate': '#/components/schemas/microsoft.graph.applicationTemplate'
'#microsoft.graph.appLogCollectionRequest': '#/components/schemas/microsoft.graph.appLogCollectionRequest'
'#microsoft.graph.approval': '#/components/schemas/microsoft.graph.approval'
'#microsoft.graph.approvalStage': '#/components/schemas/microsoft.graph.approvalStage'
'#microsoft.graph.appScope': '#/components/schemas/microsoft.graph.appScope'
'#microsoft.graph.attachment': '#/components/schemas/microsoft.graph.attachment'
'#microsoft.graph.fileAttachment': '#/components/schemas/microsoft.graph.fileAttachment'
'#microsoft.graph.itemAttachment': '#/components/schemas/microsoft.graph.itemAttachment'
'#microsoft.graph.referenceAttachment': '#/components/schemas/microsoft.graph.referenceAttachment'
'#microsoft.graph.attachmentBase': '#/components/schemas/microsoft.graph.attachmentBase'
'#microsoft.graph.taskFileAttachment': '#/components/schemas/microsoft.graph.taskFileAttachment'
'#microsoft.graph.attachmentSession': '#/components/schemas/microsoft.graph.attachmentSession'
'#microsoft.graph.attackSimulationRoot': '#/components/schemas/microsoft.graph.attackSimulationRoot'
'#microsoft.graph.attendanceRecord': '#/components/schemas/microsoft.graph.attendanceRecord'
'#microsoft.graph.attributeMappingFunctionSchema': '#/components/schemas/microsoft.graph.attributeMappingFunctionSchema'
'#microsoft.graph.attributeSet': '#/components/schemas/microsoft.graph.attributeSet'
'#microsoft.graph.audioRoutingGroup': '#/components/schemas/microsoft.graph.audioRoutingGroup'
'#microsoft.graph.auditEvent': '#/components/schemas/microsoft.graph.auditEvent'
'#microsoft.graph.auditLogRoot': '#/components/schemas/microsoft.graph.auditLogRoot'
'#microsoft.graph.authentication': '#/components/schemas/microsoft.graph.authentication'
'#microsoft.graph.authenticationCombinationConfiguration': >-
#/components/schemas/microsoft.graph.authenticationCombinationConfiguration
'#microsoft.graph.fido2CombinationConfiguration': '#/components/schemas/microsoft.graph.fido2CombinationConfiguration'
'#microsoft.graph.x509CertificateCombinationConfiguration': >-
#/components/schemas/microsoft.graph.x509CertificateCombinationConfiguration
'#microsoft.graph.authenticationContextClassReference': >-
#/components/schemas/microsoft.graph.authenticationContextClassReference
'#microsoft.graph.authenticationEventListener': '#/components/schemas/microsoft.graph.authenticationEventListener'
'#microsoft.graph.onAttributeCollectionListener': '#/components/schemas/microsoft.graph.onAttributeCollectionListener'
'#microsoft.graph.onAttributeCollectionStartListener': >-
#/components/schemas/microsoft.graph.onAttributeCollectionStartListener
'#microsoft.graph.onAttributeCollectionSubmitListener': >-
#/components/schemas/microsoft.graph.onAttributeCollectionSubmitListener
'#microsoft.graph.onAuthenticationMethodLoadStartListener': >-
#/components/schemas/microsoft.graph.onAuthenticationMethodLoadStartListener
'#microsoft.graph.onEmailOtpSendListener': '#/components/schemas/microsoft.graph.onEmailOtpSendListener'
'#microsoft.graph.onFraudProtectionLoadStartListener': >-
#/components/schemas/microsoft.graph.onFraudProtectionLoadStartListener
'#microsoft.graph.onInteractiveAuthFlowStartListener': >-
#/components/schemas/microsoft.graph.onInteractiveAuthFlowStartListener
'#microsoft.graph.onTokenIssuanceStartListener': '#/components/schemas/microsoft.graph.onTokenIssuanceStartListener'
'#microsoft.graph.onUserCreateStartListener': '#/components/schemas/microsoft.graph.onUserCreateStartListener'
'#microsoft.graph.authenticationEventsFlow': '#/components/schemas/microsoft.graph.authenticationEventsFlow'
'#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow': >-
#/components/schemas/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow
'#microsoft.graph.authenticationFlowsPolicy': '#/components/schemas/microsoft.graph.authenticationFlowsPolicy'
'#microsoft.graph.authenticationMethod': '#/components/schemas/microsoft.graph.authenticationMethod'
'#microsoft.graph.emailAuthenticationMethod': '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
'#microsoft.graph.fido2AuthenticationMethod': '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
'#microsoft.graph.microsoftAuthenticatorAuthenticationMethod': >-
#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod
'#microsoft.graph.passwordAuthenticationMethod': '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
'#microsoft.graph.phoneAuthenticationMethod': '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
'#microsoft.graph.platformCredentialAuthenticationMethod': >-
#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod
'#microsoft.graph.softwareOathAuthenticationMethod': >-
#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod
'#microsoft.graph.temporaryAccessPassAuthenticationMethod': >-
#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod
'#microsoft.graph.windowsHelloForBusinessAuthenticationMethod': >-
#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod
'#microsoft.graph.authenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.authenticationMethodConfiguration
'#microsoft.graph.emailAuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.emailAuthenticationMethodConfiguration
'#microsoft.graph.fido2AuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.fido2AuthenticationMethodConfiguration
'#microsoft.graph.microsoftAuthenticatorAuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethodConfiguration
'#microsoft.graph.smsAuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.smsAuthenticationMethodConfiguration
'#microsoft.graph.softwareOathAuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.softwareOathAuthenticationMethodConfiguration
'#microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration
'#microsoft.graph.voiceAuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.voiceAuthenticationMethodConfiguration
'#microsoft.graph.x509CertificateAuthenticationMethodConfiguration': >-
#/components/schemas/microsoft.graph.x509CertificateAuthenticationMethodConfiguration
'#microsoft.graph.authenticationMethodModeDetail': '#/components/schemas/microsoft.graph.authenticationMethodModeDetail'
'#microsoft.graph.authenticationMethodsPolicy': '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
'#microsoft.graph.authenticationMethodsRoot': '#/components/schemas/microsoft.graph.authenticationMethodsRoot'
'#microsoft.graph.authenticationMethodTarget': '#/components/schemas/microsoft.graph.authenticationMethodTarget'
'#microsoft.graph.microsoftAuthenticatorAuthenticationMethodTarget': >-
#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethodTarget
'#microsoft.graph.smsAuthenticationMethodTarget': '#/components/schemas/microsoft.graph.smsAuthenticationMethodTarget'
'#microsoft.graph.authenticationStrengthPolicy': '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
'#microsoft.graph.authenticationStrengthRoot': '#/components/schemas/microsoft.graph.authenticationStrengthRoot'
'#microsoft.graph.authoredNote': '#/components/schemas/microsoft.graph.authoredNote'
'#microsoft.graph.backupRestoreRoot': '#/components/schemas/microsoft.graph.backupRestoreRoot'
'#microsoft.graph.baseItem': '#/components/schemas/microsoft.graph.baseItem'
'#microsoft.graph.baseSitePage': '#/components/schemas/microsoft.graph.baseSitePage'
'#microsoft.graph.sitePage': '#/components/schemas/microsoft.graph.sitePage'
'#microsoft.graph.drive': '#/components/schemas/microsoft.graph.drive'
'#microsoft.graph.driveItem': '#/components/schemas/microsoft.graph.driveItem'
'#microsoft.graph.list': '#/components/schemas/microsoft.graph.list'
'#microsoft.graph.listItem': '#/components/schemas/microsoft.graph.listItem'
'#microsoft.graph.recycleBin': '#/components/schemas/microsoft.graph.recycleBin'
'#microsoft.graph.recycleBinItem': '#/components/schemas/microsoft.graph.recycleBinItem'
'#microsoft.graph.sharedDriveItem': '#/components/schemas/microsoft.graph.sharedDriveItem'
'#microsoft.graph.site': '#/components/schemas/microsoft.graph.site'
'#microsoft.graph.baseItemVersion': '#/components/schemas/microsoft.graph.baseItemVersion'
'#microsoft.graph.driveItemVersion': '#/components/schemas/microsoft.graph.driveItemVersion'
'#microsoft.graph.listItemVersion': '#/components/schemas/microsoft.graph.listItemVersion'
'#microsoft.graph.documentSetVersion': '#/components/schemas/microsoft.graph.documentSetVersion'
'#microsoft.graph.baseMapFeature': '#/components/schemas/microsoft.graph.baseMapFeature'
'#microsoft.graph.buildingMap': '#/components/schemas/microsoft.graph.buildingMap'
'#microsoft.graph.fixtureMap': '#/components/schemas/microsoft.graph.fixtureMap'
'#microsoft.graph.footprintMap': '#/components/schemas/microsoft.graph.footprintMap'
'#microsoft.graph.levelMap': '#/components/schemas/microsoft.graph.levelMap'
'#microsoft.graph.sectionMap': '#/components/schemas/microsoft.graph.sectionMap'
'#microsoft.graph.unitMap': '#/components/schemas/microsoft.graph.unitMap'
'#microsoft.graph.bitlocker': '#/components/schemas/microsoft.graph.bitlocker'
'#microsoft.graph.bitlockerRecoveryKey': '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
'#microsoft.graph.bookingAppointment': '#/components/schemas/microsoft.graph.bookingAppointment'
'#microsoft.graph.bookingBusiness': '#/components/schemas/microsoft.graph.bookingBusiness'
'#microsoft.graph.bookingCurrency': '#/components/schemas/microsoft.graph.bookingCurrency'
'#microsoft.graph.bookingCustomerBase': '#/components/schemas/microsoft.graph.bookingCustomerBase'
'#microsoft.graph.bookingCustomer': '#/components/schemas/microsoft.graph.bookingCustomer'
'#microsoft.graph.bookingCustomQuestion': '#/components/schemas/microsoft.graph.bookingCustomQuestion'
'#microsoft.graph.bookingService': '#/components/schemas/microsoft.graph.bookingService'
'#microsoft.graph.bookingStaffMemberBase': '#/components/schemas/microsoft.graph.bookingStaffMemberBase'
'#microsoft.graph.bookingStaffMember': '#/components/schemas/microsoft.graph.bookingStaffMember'
'#microsoft.graph.browserSharedCookie': '#/components/schemas/microsoft.graph.browserSharedCookie'
'#microsoft.graph.browserSite': '#/components/schemas/microsoft.graph.browserSite'
'#microsoft.graph.browserSiteList': '#/components/schemas/microsoft.graph.browserSiteList'
'#microsoft.graph.bulkUpload': '#/components/schemas/microsoft.graph.bulkUpload'
'#microsoft.graph.calendar': '#/components/schemas/microsoft.graph.calendar'
'#microsoft.graph.calendarGroup': '#/components/schemas/microsoft.graph.calendarGroup'
'#microsoft.graph.calendarPermission': '#/components/schemas/microsoft.graph.calendarPermission'
'#microsoft.graph.call': '#/components/schemas/microsoft.graph.call'
'#microsoft.graph.callEvent': '#/components/schemas/microsoft.graph.callEvent'
'#microsoft.graph.emergencyCallEvent': '#/components/schemas/microsoft.graph.emergencyCallEvent'
'#microsoft.graph.callRecording': '#/components/schemas/microsoft.graph.callRecording'
'#microsoft.graph.callTranscript': '#/components/schemas/microsoft.graph.callTranscript'
'#microsoft.graph.canvasLayout': '#/components/schemas/microsoft.graph.canvasLayout'
'#microsoft.graph.certificateBasedAuthConfiguration': >-
#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration
'#microsoft.graph.changeTrackedEntity': '#/components/schemas/microsoft.graph.changeTrackedEntity'
'#microsoft.graph.dayNote': '#/components/schemas/microsoft.graph.dayNote'
'#microsoft.graph.openShift': '#/components/schemas/microsoft.graph.openShift'
'#microsoft.graph.scheduleChangeRequest': '#/components/schemas/microsoft.graph.scheduleChangeRequest'
'#microsoft.graph.offerShiftRequest': '#/components/schemas/microsoft.graph.offerShiftRequest'
'#microsoft.graph.swapShiftsChangeRequest': '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
'#microsoft.graph.openShiftChangeRequest': '#/components/schemas/microsoft.graph.openShiftChangeRequest'
'#microsoft.graph.timeOffRequest': '#/components/schemas/microsoft.graph.timeOffRequest'
'#microsoft.graph.schedulingGroup': '#/components/schemas/microsoft.graph.schedulingGroup'
'#microsoft.graph.shift': '#/components/schemas/microsoft.graph.shift'
'#microsoft.graph.shiftPreferences': '#/components/schemas/microsoft.graph.shiftPreferences'
'#microsoft.graph.timeCard': '#/components/schemas/microsoft.graph.timeCard'
'#microsoft.graph.timeOff': '#/components/schemas/microsoft.graph.timeOff'
'#microsoft.graph.timeOffReason': '#/components/schemas/microsoft.graph.timeOffReason'
'#microsoft.graph.workforceIntegration': '#/components/schemas/microsoft.graph.workforceIntegration'
'#microsoft.graph.channel': '#/components/schemas/microsoft.graph.channel'
'#microsoft.graph.chat': '#/components/schemas/microsoft.graph.chat'
'#microsoft.graph.chatMessage': '#/components/schemas/microsoft.graph.chatMessage'
'#microsoft.graph.chatMessageInfo': '#/components/schemas/microsoft.graph.chatMessageInfo'
'#microsoft.graph.checklistItem': '#/components/schemas/microsoft.graph.checklistItem'
'#microsoft.graph.cloudClipboardItem': '#/components/schemas/microsoft.graph.cloudClipboardItem'
'#microsoft.graph.cloudClipboardRoot': '#/components/schemas/microsoft.graph.cloudClipboardRoot'
'#microsoft.graph.cloudPC': '#/components/schemas/microsoft.graph.cloudPC'
'#microsoft.graph.cloudPcAuditEvent': '#/components/schemas/microsoft.graph.cloudPcAuditEvent'
'#microsoft.graph.cloudPcDeviceImage': '#/components/schemas/microsoft.graph.cloudPcDeviceImage'
'#microsoft.graph.cloudPcGalleryImage': '#/components/schemas/microsoft.graph.cloudPcGalleryImage'
'#microsoft.graph.cloudPcOnPremisesConnection': '#/components/schemas/microsoft.graph.cloudPcOnPremisesConnection'
'#microsoft.graph.cloudPcProvisioningPolicy': '#/components/schemas/microsoft.graph.cloudPcProvisioningPolicy'
'#microsoft.graph.cloudPcProvisioningPolicyAssignment': >-
#/components/schemas/microsoft.graph.cloudPcProvisioningPolicyAssignment
'#microsoft.graph.cloudPcUserSetting': '#/components/schemas/microsoft.graph.cloudPcUserSetting'
'#microsoft.graph.cloudPcUserSettingAssignment': '#/components/schemas/microsoft.graph.cloudPcUserSettingAssignment'
'#microsoft.graph.columnDefinition': '#/components/schemas/microsoft.graph.columnDefinition'
'#microsoft.graph.columnLink': '#/components/schemas/microsoft.graph.columnLink'
'#microsoft.graph.commsOperation': '#/components/schemas/microsoft.graph.commsOperation'
'#microsoft.graph.addLargeGalleryViewOperation': '#/components/schemas/microsoft.graph.addLargeGalleryViewOperation'
'#microsoft.graph.cancelMediaProcessingOperation': '#/components/schemas/microsoft.graph.cancelMediaProcessingOperation'
'#microsoft.graph.inviteParticipantsOperation': '#/components/schemas/microsoft.graph.inviteParticipantsOperation'
'#microsoft.graph.muteParticipantOperation': '#/components/schemas/microsoft.graph.muteParticipantOperation'
'#microsoft.graph.playPromptOperation': '#/components/schemas/microsoft.graph.playPromptOperation'
'#microsoft.graph.recordOperation': '#/components/schemas/microsoft.graph.recordOperation'
'#microsoft.graph.sendDtmfTonesOperation': '#/components/schemas/microsoft.graph.sendDtmfTonesOperation'
'#microsoft.graph.startHoldMusicOperation': '#/components/schemas/microsoft.graph.startHoldMusicOperation'
'#microsoft.graph.stopHoldMusicOperation': '#/components/schemas/microsoft.graph.stopHoldMusicOperation'
'#microsoft.graph.subscribeToToneOperation': '#/components/schemas/microsoft.graph.subscribeToToneOperation'
'#microsoft.graph.unmuteParticipantOperation': '#/components/schemas/microsoft.graph.unmuteParticipantOperation'
'#microsoft.graph.updateRecordingStatusOperation': '#/components/schemas/microsoft.graph.updateRecordingStatusOperation'
'#microsoft.graph.community': '#/components/schemas/microsoft.graph.community'
'#microsoft.graph.companySubscription': '#/components/schemas/microsoft.graph.companySubscription'
'#microsoft.graph.complianceManagementPartner': '#/components/schemas/microsoft.graph.complianceManagementPartner'
'#microsoft.graph.conditionalAccessPolicy': '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
'#microsoft.graph.whatIfAnalysisResult': '#/components/schemas/microsoft.graph.whatIfAnalysisResult'
'#microsoft.graph.conditionalAccessRoot': '#/components/schemas/microsoft.graph.conditionalAccessRoot'
'#microsoft.graph.conditionalAccessTemplate': '#/components/schemas/microsoft.graph.conditionalAccessTemplate'
'#microsoft.graph.connectedOrganization': '#/components/schemas/microsoft.graph.connectedOrganization'
'#microsoft.graph.contactFolder': '#/components/schemas/microsoft.graph.contactFolder'
'#microsoft.graph.contentActivity': '#/components/schemas/microsoft.graph.contentActivity'
'#microsoft.graph.contentSharingSession': '#/components/schemas/microsoft.graph.contentSharingSession'
'#microsoft.graph.contentType': '#/components/schemas/microsoft.graph.contentType'
'#microsoft.graph.conversation': '#/components/schemas/microsoft.graph.conversation'
'#microsoft.graph.conversationMember': '#/components/schemas/microsoft.graph.conversationMember'
'#microsoft.graph.aadUserConversationMember': '#/components/schemas/microsoft.graph.aadUserConversationMember'
'#microsoft.graph.anonymousGuestConversationMember': >-
#/components/schemas/microsoft.graph.anonymousGuestConversationMember
'#microsoft.graph.azureCommunicationServicesUserConversationMember': >-
#/components/schemas/microsoft.graph.azureCommunicationServicesUserConversationMember
'#microsoft.graph.microsoftAccountUserConversationMember': >-
#/components/schemas/microsoft.graph.microsoftAccountUserConversationMember
'#microsoft.graph.phoneUserConversationMember': '#/components/schemas/microsoft.graph.phoneUserConversationMember'
'#microsoft.graph.skypeForBusinessUserConversationMember': >-
#/components/schemas/microsoft.graph.skypeForBusinessUserConversationMember
'#microsoft.graph.skypeUserConversationMember': '#/components/schemas/microsoft.graph.skypeUserConversationMember'
'#microsoft.graph.conversationThread': '#/components/schemas/microsoft.graph.conversationThread'
'#microsoft.graph.copilotAdmin': '#/components/schemas/microsoft.graph.copilotAdmin'
'#microsoft.graph.copilotAdminLimitedMode': '#/components/schemas/microsoft.graph.copilotAdminLimitedMode'
'#microsoft.graph.copilotAdminSetting': '#/components/schemas/microsoft.graph.copilotAdminSetting'
'#microsoft.graph.copilotReportRoot': '#/components/schemas/microsoft.graph.copilotReportRoot'
'#microsoft.graph.crossTenantAccessPolicyConfigurationDefault': >-
#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationDefault
'#microsoft.graph.customCalloutExtension': '#/components/schemas/microsoft.graph.customCalloutExtension'
'#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension': >-
#/components/schemas/microsoft.graph.accessPackageAssignmentRequestWorkflowExtension
'#microsoft.graph.accessPackageAssignmentWorkflowExtension': >-
#/components/schemas/microsoft.graph.accessPackageAssignmentWorkflowExtension
'#microsoft.graph.customAuthenticationExtension': '#/components/schemas/microsoft.graph.customAuthenticationExtension'
'#microsoft.graph.onAttributeCollectionStartCustomExtension': >-
#/components/schemas/microsoft.graph.onAttributeCollectionStartCustomExtension
'#microsoft.graph.onAttributeCollectionSubmitCustomExtension': >-
#/components/schemas/microsoft.graph.onAttributeCollectionSubmitCustomExtension
'#microsoft.graph.onOtpSendCustomExtension': '#/components/schemas/microsoft.graph.onOtpSendCustomExtension'
'#microsoft.graph.onTokenIssuanceStartCustomExtension': >-
#/components/schemas/microsoft.graph.onTokenIssuanceStartCustomExtension
'#microsoft.graph.identityGovernance.customTaskExtension': >-
#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension
'#microsoft.graph.customExtensionStageSetting': '#/components/schemas/microsoft.graph.customExtensionStageSetting'
'#microsoft.graph.customSecurityAttributeDefinition': >-
#/components/schemas/microsoft.graph.customSecurityAttributeDefinition
'#microsoft.graph.dataPolicyOperation': '#/components/schemas/microsoft.graph.dataPolicyOperation'
'#microsoft.graph.dataSecurityAndGovernance': '#/components/schemas/microsoft.graph.dataSecurityAndGovernance'
'#microsoft.graph.tenantDataSecurityAndGovernance': '#/components/schemas/microsoft.graph.tenantDataSecurityAndGovernance'
'#microsoft.graph.userDataSecurityAndGovernance': '#/components/schemas/microsoft.graph.userDataSecurityAndGovernance'
'#microsoft.graph.delegatedAdminAccessAssignment': '#/components/schemas/microsoft.graph.delegatedAdminAccessAssignment'
'#microsoft.graph.delegatedAdminCustomer': '#/components/schemas/microsoft.graph.delegatedAdminCustomer'
'#microsoft.graph.delegatedAdminRelationship': '#/components/schemas/microsoft.graph.delegatedAdminRelationship'
'#microsoft.graph.resellerDelegatedAdminRelationship': >-
#/components/schemas/microsoft.graph.resellerDelegatedAdminRelationship
'#microsoft.graph.delegatedAdminRelationshipOperation': >-
#/components/schemas/microsoft.graph.delegatedAdminRelationshipOperation
'#microsoft.graph.delegatedAdminRelationshipRequest': >-
#/components/schemas/microsoft.graph.delegatedAdminRelationshipRequest
'#microsoft.graph.delegatedAdminServiceManagementDetail': >-
#/components/schemas/microsoft.graph.delegatedAdminServiceManagementDetail
'#microsoft.graph.delegatedPermissionClassification': >-
#/components/schemas/microsoft.graph.delegatedPermissionClassification
'#microsoft.graph.deletedChat': '#/components/schemas/microsoft.graph.deletedChat'
'#microsoft.graph.deletedItemContainer': '#/components/schemas/microsoft.graph.deletedItemContainer'
'#microsoft.graph.deletedTeam': '#/components/schemas/microsoft.graph.deletedTeam'
'#microsoft.graph.deltaParticipants': '#/components/schemas/microsoft.graph.deltaParticipants'
'#microsoft.graph.detectedApp': '#/components/schemas/microsoft.graph.detectedApp'
'#microsoft.graph.deviceAppManagement': '#/components/schemas/microsoft.graph.deviceAppManagement'
'#microsoft.graph.deviceCategory': '#/components/schemas/microsoft.graph.deviceCategory'
'#microsoft.graph.deviceComplianceActionItem': '#/components/schemas/microsoft.graph.deviceComplianceActionItem'
'#microsoft.graph.deviceComplianceDeviceOverview': '#/components/schemas/microsoft.graph.deviceComplianceDeviceOverview'
'#microsoft.graph.deviceComplianceDeviceStatus': '#/components/schemas/microsoft.graph.deviceComplianceDeviceStatus'
'#microsoft.graph.deviceCompliancePolicy': '#/components/schemas/microsoft.graph.deviceCompliancePolicy'
'#microsoft.graph.androidCompliancePolicy': '#/components/schemas/microsoft.graph.androidCompliancePolicy'
'#microsoft.graph.androidWorkProfileCompliancePolicy': >-
#/components/schemas/microsoft.graph.androidWorkProfileCompliancePolicy
'#microsoft.graph.iosCompliancePolicy': '#/components/schemas/microsoft.graph.iosCompliancePolicy'
'#microsoft.graph.macOSCompliancePolicy': '#/components/schemas/microsoft.graph.macOSCompliancePolicy'
'#microsoft.graph.windows10CompliancePolicy': '#/components/schemas/microsoft.graph.windows10CompliancePolicy'
'#microsoft.graph.windows10MobileCompliancePolicy': '#/components/schemas/microsoft.graph.windows10MobileCompliancePolicy'
'#microsoft.graph.windows81CompliancePolicy': '#/components/schemas/microsoft.graph.windows81CompliancePolicy'
'#microsoft.graph.windowsPhone81CompliancePolicy': '#/components/schemas/microsoft.graph.windowsPhone81CompliancePolicy'
'#microsoft.graph.deviceCompliancePolicyAssignment': >-
#/components/schemas/microsoft.graph.deviceCompliancePolicyAssignment
'#microsoft.graph.deviceCompliancePolicyDeviceStateSummary': >-
#/components/schemas/microsoft.graph.deviceCompliancePolicyDeviceStateSummary
'#microsoft.graph.deviceCompliancePolicySettingStateSummary': >-
#/components/schemas/microsoft.graph.deviceCompliancePolicySettingStateSummary
'#microsoft.graph.deviceCompliancePolicyState': '#/components/schemas/microsoft.graph.deviceCompliancePolicyState'
'#microsoft.graph.deviceComplianceScheduledActionForRule': >-
#/components/schemas/microsoft.graph.deviceComplianceScheduledActionForRule
'#microsoft.graph.deviceComplianceSettingState': '#/components/schemas/microsoft.graph.deviceComplianceSettingState'
'#microsoft.graph.deviceComplianceUserOverview': '#/components/schemas/microsoft.graph.deviceComplianceUserOverview'
'#microsoft.graph.deviceComplianceUserStatus': '#/components/schemas/microsoft.graph.deviceComplianceUserStatus'
'#microsoft.graph.deviceConfiguration': '#/components/schemas/microsoft.graph.deviceConfiguration'
'#microsoft.graph.androidCustomConfiguration': '#/components/schemas/microsoft.graph.androidCustomConfiguration'
'#microsoft.graph.androidGeneralDeviceConfiguration': >-
#/components/schemas/microsoft.graph.androidGeneralDeviceConfiguration
'#microsoft.graph.androidWorkProfileCustomConfiguration': >-
#/components/schemas/microsoft.graph.androidWorkProfileCustomConfiguration
'#microsoft.graph.androidWorkProfileGeneralDeviceConfiguration': >-
#/components/schemas/microsoft.graph.androidWorkProfileGeneralDeviceConfiguration
'#microsoft.graph.appleDeviceFeaturesConfigurationBase': >-
#/components/schemas/microsoft.graph.appleDeviceFeaturesConfigurationBase
'#microsoft.graph.iosDeviceFeaturesConfiguration': '#/components/schemas/microsoft.graph.iosDeviceFeaturesConfiguration'
'#microsoft.graph.macOSDeviceFeaturesConfiguration': >-
#/components/schemas/microsoft.graph.macOSDeviceFeaturesConfiguration
'#microsoft.graph.editionUpgradeConfiguration': '#/components/schemas/microsoft.graph.editionUpgradeConfiguration'
'#microsoft.graph.iosCertificateProfile': '#/components/schemas/microsoft.graph.iosCertificateProfile'
'#microsoft.graph.iosCustomConfiguration': '#/components/schemas/microsoft.graph.iosCustomConfiguration'
'#microsoft.graph.iosGeneralDeviceConfiguration': '#/components/schemas/microsoft.graph.iosGeneralDeviceConfiguration'
'#microsoft.graph.iosUpdateConfiguration': '#/components/schemas/microsoft.graph.iosUpdateConfiguration'
'#microsoft.graph.macOSCustomConfiguration': '#/components/schemas/microsoft.graph.macOSCustomConfiguration'
'#microsoft.graph.macOSGeneralDeviceConfiguration': '#/components/schemas/microsoft.graph.macOSGeneralDeviceConfiguration'
'#microsoft.graph.sharedPCConfiguration': '#/components/schemas/microsoft.graph.sharedPCConfiguration'
'#microsoft.graph.windows10CustomConfiguration': '#/components/schemas/microsoft.graph.windows10CustomConfiguration'
'#microsoft.graph.windows10EndpointProtectionConfiguration': >-
#/components/schemas/microsoft.graph.windows10EndpointProtectionConfiguration
'#microsoft.graph.windows10EnterpriseModernAppManagementConfiguration': >-
#/components/schemas/microsoft.graph.windows10EnterpriseModernAppManagementConfiguration
'#microsoft.graph.windows10GeneralConfiguration': '#/components/schemas/microsoft.graph.windows10GeneralConfiguration'
'#microsoft.graph.windows10SecureAssessmentConfiguration': >-
#/components/schemas/microsoft.graph.windows10SecureAssessmentConfiguration
'#microsoft.graph.windows10TeamGeneralConfiguration': >-
#/components/schemas/microsoft.graph.windows10TeamGeneralConfiguration
'#microsoft.graph.windows81GeneralConfiguration': '#/components/schemas/microsoft.graph.windows81GeneralConfiguration'
'#microsoft.graph.windowsDefenderAdvancedThreatProtectionConfiguration': >-
#/components/schemas/microsoft.graph.windowsDefenderAdvancedThreatProtectionConfiguration
'#microsoft.graph.windowsPhone81CustomConfiguration': >-
#/components/schemas/microsoft.graph.windowsPhone81CustomConfiguration
'#microsoft.graph.windowsPhone81GeneralConfiguration': >-
#/components/schemas/microsoft.graph.windowsPhone81GeneralConfiguration
'#microsoft.graph.windowsUpdateForBusinessConfiguration': >-
#/components/schemas/microsoft.graph.windowsUpdateForBusinessConfiguration
'#microsoft.graph.deviceConfigurationAssignment': '#/components/schemas/microsoft.graph.deviceConfigurationAssignment'
'#microsoft.graph.deviceConfigurationDeviceOverview': >-
#/components/schemas/microsoft.graph.deviceConfigurationDeviceOverview
'#microsoft.graph.deviceConfigurationDeviceStateSummary': >-
#/components/schemas/microsoft.graph.deviceConfigurationDeviceStateSummary
'#microsoft.graph.deviceConfigurationDeviceStatus': '#/components/schemas/microsoft.graph.deviceConfigurationDeviceStatus'
'#microsoft.graph.deviceConfigurationState': '#/components/schemas/microsoft.graph.deviceConfigurationState'
'#microsoft.graph.deviceConfigurationUserOverview': '#/components/schemas/microsoft.graph.deviceConfigurationUserOverview'
'#microsoft.graph.deviceConfigurationUserStatus': '#/components/schemas/microsoft.graph.deviceConfigurationUserStatus'
'#microsoft.graph.deviceEnrollmentConfiguration': '#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration'
'#microsoft.graph.deviceEnrollmentLimitConfiguration': >-
#/components/schemas/microsoft.graph.deviceEnrollmentLimitConfiguration
'#microsoft.graph.deviceEnrollmentPlatformRestrictionsConfiguration': >-
#/components/schemas/microsoft.graph.deviceEnrollmentPlatformRestrictionsConfiguration
'#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration': >-
#/components/schemas/microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration
'#microsoft.graph.windows10EnrollmentCompletionPageConfiguration': >-
#/components/schemas/microsoft.graph.windows10EnrollmentCompletionPageConfiguration
'#microsoft.graph.deviceInstallState': '#/components/schemas/microsoft.graph.deviceInstallState'
'#microsoft.graph.deviceLocalCredentialInfo': '#/components/schemas/microsoft.graph.deviceLocalCredentialInfo'
'#microsoft.graph.deviceLogCollectionResponse': '#/components/schemas/microsoft.graph.deviceLogCollectionResponse'
'#microsoft.graph.deviceManagement': '#/components/schemas/microsoft.graph.deviceManagement'
'#microsoft.graph.deviceManagementCachedReportConfiguration': >-
#/components/schemas/microsoft.graph.deviceManagementCachedReportConfiguration
'#microsoft.graph.deviceManagementExchangeConnector': >-
#/components/schemas/microsoft.graph.deviceManagementExchangeConnector
'#microsoft.graph.deviceManagementExportJob': '#/components/schemas/microsoft.graph.deviceManagementExportJob'
'#microsoft.graph.deviceManagementPartner': '#/components/schemas/microsoft.graph.deviceManagementPartner'
'#microsoft.graph.deviceManagementReports': '#/components/schemas/microsoft.graph.deviceManagementReports'
'#microsoft.graph.deviceManagementTroubleshootingEvent': >-
#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent
'#microsoft.graph.enrollmentTroubleshootingEvent': '#/components/schemas/microsoft.graph.enrollmentTroubleshootingEvent'
'#microsoft.graph.deviceRegistrationPolicy': '#/components/schemas/microsoft.graph.deviceRegistrationPolicy'
'#microsoft.graph.directory': '#/components/schemas/microsoft.graph.directory'
'#microsoft.graph.directoryAudit': '#/components/schemas/microsoft.graph.directoryAudit'
'#microsoft.graph.directoryDefinition': '#/components/schemas/microsoft.graph.directoryDefinition'
'#microsoft.graph.directoryObject': '#/components/schemas/microsoft.graph.directoryObject'
'#microsoft.graph.administrativeUnit': '#/components/schemas/microsoft.graph.administrativeUnit'
'#microsoft.graph.application': '#/components/schemas/microsoft.graph.application'
'#microsoft.graph.appRoleAssignment': '#/components/schemas/microsoft.graph.appRoleAssignment'
'#microsoft.graph.certificateAuthorityDetail': '#/components/schemas/microsoft.graph.certificateAuthorityDetail'
'#microsoft.graph.certificateBasedAuthPki': '#/components/schemas/microsoft.graph.certificateBasedAuthPki'
'#microsoft.graph.contract': '#/components/schemas/microsoft.graph.contract'
'#microsoft.graph.device': '#/components/schemas/microsoft.graph.device'
'#microsoft.graph.directoryObjectPartnerReference': '#/components/schemas/microsoft.graph.directoryObjectPartnerReference'
'#microsoft.graph.directoryRole': '#/components/schemas/microsoft.graph.directoryRole'
'#microsoft.graph.directoryRoleTemplate': '#/components/schemas/microsoft.graph.directoryRoleTemplate'
'#microsoft.graph.endpoint': '#/components/schemas/microsoft.graph.endpoint'
'#microsoft.graph.extensionProperty': '#/components/schemas/microsoft.graph.extensionProperty'
'#microsoft.graph.group': '#/components/schemas/microsoft.graph.group'
'#microsoft.graph.groupSettingTemplate': '#/components/schemas/microsoft.graph.groupSettingTemplate'
'#microsoft.graph.multiTenantOrganizationMember': '#/components/schemas/microsoft.graph.multiTenantOrganizationMember'
'#microsoft.graph.organization': '#/components/schemas/microsoft.graph.organization'
'#microsoft.graph.orgContact': '#/components/schemas/microsoft.graph.orgContact'
'#microsoft.graph.policyBase': '#/components/schemas/microsoft.graph.policyBase'
'#microsoft.graph.appManagementPolicy': '#/components/schemas/microsoft.graph.appManagementPolicy'
'#microsoft.graph.authorizationPolicy': '#/components/schemas/microsoft.graph.authorizationPolicy'
'#microsoft.graph.crossTenantAccessPolicy': '#/components/schemas/microsoft.graph.crossTenantAccessPolicy'
'#microsoft.graph.identitySecurityDefaultsEnforcementPolicy': >-
#/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy
'#microsoft.graph.permissionGrantPolicy': '#/components/schemas/microsoft.graph.permissionGrantPolicy'
'#microsoft.graph.stsPolicy': '#/components/schemas/microsoft.graph.stsPolicy'
'#microsoft.graph.activityBasedTimeoutPolicy': '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
'#microsoft.graph.claimsMappingPolicy': '#/components/schemas/microsoft.graph.claimsMappingPolicy'
'#microsoft.graph.homeRealmDiscoveryPolicy': '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
'#microsoft.graph.tokenIssuancePolicy': '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
'#microsoft.graph.tokenLifetimePolicy': '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
'#microsoft.graph.tenantAppManagementPolicy': '#/components/schemas/microsoft.graph.tenantAppManagementPolicy'
'#microsoft.graph.resourceSpecificPermissionGrant': '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
'#microsoft.graph.servicePrincipal': '#/components/schemas/microsoft.graph.servicePrincipal'
'#microsoft.graph.user': '#/components/schemas/microsoft.graph.user'
'#microsoft.graph.domain': '#/components/schemas/microsoft.graph.domain'
'#microsoft.graph.domainDnsRecord': '#/components/schemas/microsoft.graph.domainDnsRecord'
'#microsoft.graph.domainDnsCnameRecord': '#/components/schemas/microsoft.graph.domainDnsCnameRecord'
'#microsoft.graph.domainDnsMxRecord': '#/components/schemas/microsoft.graph.domainDnsMxRecord'
'#microsoft.graph.domainDnsSrvRecord': '#/components/schemas/microsoft.graph.domainDnsSrvRecord'
'#microsoft.graph.domainDnsTxtRecord': '#/components/schemas/microsoft.graph.domainDnsTxtRecord'
'#microsoft.graph.domainDnsUnavailableRecord': '#/components/schemas/microsoft.graph.domainDnsUnavailableRecord'
'#microsoft.graph.eBookInstallSummary': '#/components/schemas/microsoft.graph.eBookInstallSummary'
'#microsoft.graph.edge': '#/components/schemas/microsoft.graph.edge'
'#microsoft.graph.educationAssignment': '#/components/schemas/microsoft.graph.educationAssignment'
'#microsoft.graph.educationAssignmentDefaults': '#/components/schemas/microsoft.graph.educationAssignmentDefaults'
'#microsoft.graph.educationAssignmentResource': '#/components/schemas/microsoft.graph.educationAssignmentResource'
'#microsoft.graph.educationAssignmentSettings': '#/components/schemas/microsoft.graph.educationAssignmentSettings'
'#microsoft.graph.educationCategory': '#/components/schemas/microsoft.graph.educationCategory'
'#microsoft.graph.educationClass': '#/components/schemas/microsoft.graph.educationClass'
'#microsoft.graph.educationGradingCategory': '#/components/schemas/microsoft.graph.educationGradingCategory'
'#microsoft.graph.educationGradingScheme': '#/components/schemas/microsoft.graph.educationGradingScheme'
'#microsoft.graph.educationModule': '#/components/schemas/microsoft.graph.educationModule'
'#microsoft.graph.educationModuleResource': '#/components/schemas/microsoft.graph.educationModuleResource'
'#microsoft.graph.educationOrganization': '#/components/schemas/microsoft.graph.educationOrganization'
'#microsoft.graph.educationSchool': '#/components/schemas/microsoft.graph.educationSchool'
'#microsoft.graph.educationOutcome': '#/components/schemas/microsoft.graph.educationOutcome'
'#microsoft.graph.educationFeedbackOutcome': '#/components/schemas/microsoft.graph.educationFeedbackOutcome'
'#microsoft.graph.educationFeedbackResourceOutcome': >-
#/components/schemas/microsoft.graph.educationFeedbackResourceOutcome
'#microsoft.graph.educationPointsOutcome': '#/components/schemas/microsoft.graph.educationPointsOutcome'
'#microsoft.graph.educationRubricOutcome': '#/components/schemas/microsoft.graph.educationRubricOutcome'
'#microsoft.graph.educationRubric': '#/components/schemas/microsoft.graph.educationRubric'
'#microsoft.graph.educationSubmission': '#/components/schemas/microsoft.graph.educationSubmission'
'#microsoft.graph.educationSubmissionResource': '#/components/schemas/microsoft.graph.educationSubmissionResource'
'#microsoft.graph.educationUser': '#/components/schemas/microsoft.graph.educationUser'
'#microsoft.graph.employeeExperienceUser': '#/components/schemas/microsoft.graph.employeeExperienceUser'
'#microsoft.graph.endUserNotification': '#/components/schemas/microsoft.graph.endUserNotification'
'#microsoft.graph.endUserNotificationDetail': '#/components/schemas/microsoft.graph.endUserNotificationDetail'
'#microsoft.graph.engagementConversation': '#/components/schemas/microsoft.graph.engagementConversation'
'#microsoft.graph.onlineMeetingEngagementConversation': >-
#/components/schemas/microsoft.graph.onlineMeetingEngagementConversation
'#microsoft.graph.engagementConversationMessage': '#/components/schemas/microsoft.graph.engagementConversationMessage'
'#microsoft.graph.engagementConversationDiscussionMessage': >-
#/components/schemas/microsoft.graph.engagementConversationDiscussionMessage
'#microsoft.graph.engagementConversationQuestionMessage': >-
#/components/schemas/microsoft.graph.engagementConversationQuestionMessage
'#microsoft.graph.engagementConversationSystemMessage': >-
#/components/schemas/microsoft.graph.engagementConversationSystemMessage
'#microsoft.graph.engagementConversationMessageReaction': >-
#/components/schemas/microsoft.graph.engagementConversationMessageReaction
'#microsoft.graph.engagementRole': '#/components/schemas/microsoft.graph.engagementRole'
'#microsoft.graph.engagementRoleMember': '#/components/schemas/microsoft.graph.engagementRoleMember'
'#microsoft.graph.enrollmentConfigurationAssignment': >-
#/components/schemas/microsoft.graph.enrollmentConfigurationAssignment
'#microsoft.graph.enterpriseCodeSigningCertificate': >-
#/components/schemas/microsoft.graph.enterpriseCodeSigningCertificate
'#microsoft.graph.entitlementManagement': '#/components/schemas/microsoft.graph.entitlementManagement'
'#microsoft.graph.entitlementManagementSettings': '#/components/schemas/microsoft.graph.entitlementManagementSettings'
'#microsoft.graph.extension': '#/components/schemas/microsoft.graph.extension'
'#microsoft.graph.openTypeExtension': '#/components/schemas/microsoft.graph.openTypeExtension'
'#microsoft.graph.externalDomainName': '#/components/schemas/microsoft.graph.externalDomainName'
'#microsoft.graph.featureRolloutPolicy': '#/components/schemas/microsoft.graph.featureRolloutPolicy'
'#microsoft.graph.federatedIdentityCredential': '#/components/schemas/microsoft.graph.federatedIdentityCredential'
'#microsoft.graph.fieldValueSet': '#/components/schemas/microsoft.graph.fieldValueSet'
'#microsoft.graph.fileStorage': '#/components/schemas/microsoft.graph.fileStorage'
'#microsoft.graph.fileStorageContainer': '#/components/schemas/microsoft.graph.fileStorageContainer'
'#microsoft.graph.filterOperatorSchema': '#/components/schemas/microsoft.graph.filterOperatorSchema'
'#microsoft.graph.fraudProtectionProvider': '#/components/schemas/microsoft.graph.fraudProtectionProvider'
'#microsoft.graph.arkoseFraudProtectionProvider': '#/components/schemas/microsoft.graph.arkoseFraudProtectionProvider'
'#microsoft.graph.humanSecurityFraudProtectionProvider': >-
#/components/schemas/microsoft.graph.humanSecurityFraudProtectionProvider
'#microsoft.graph.governanceInsight': '#/components/schemas/microsoft.graph.governanceInsight'
'#microsoft.graph.membershipOutlierInsight': '#/components/schemas/microsoft.graph.membershipOutlierInsight'
'#microsoft.graph.userSignInInsight': '#/components/schemas/microsoft.graph.userSignInInsight'
'#microsoft.graph.groupLifecyclePolicy': '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
'#microsoft.graph.groupSetting': '#/components/schemas/microsoft.graph.groupSetting'
'#microsoft.graph.horizontalSection': '#/components/schemas/microsoft.graph.horizontalSection'
'#microsoft.graph.horizontalSectionColumn': '#/components/schemas/microsoft.graph.horizontalSectionColumn'
'#microsoft.graph.identityApiConnector': '#/components/schemas/microsoft.graph.identityApiConnector'
'#microsoft.graph.identityContainer': '#/components/schemas/microsoft.graph.identityContainer'
'#microsoft.graph.identityProvider': '#/components/schemas/microsoft.graph.identityProvider'
'#microsoft.graph.identityProviderBase': '#/components/schemas/microsoft.graph.identityProviderBase'
'#microsoft.graph.appleManagedIdentityProvider': '#/components/schemas/microsoft.graph.appleManagedIdentityProvider'
'#microsoft.graph.builtInIdentityProvider': '#/components/schemas/microsoft.graph.builtInIdentityProvider'
'#microsoft.graph.samlOrWsFedProvider': '#/components/schemas/microsoft.graph.samlOrWsFedProvider'
'#microsoft.graph.internalDomainFederation': '#/components/schemas/microsoft.graph.internalDomainFederation'
'#microsoft.graph.samlOrWsFedExternalDomainFederation': >-
#/components/schemas/microsoft.graph.samlOrWsFedExternalDomainFederation
'#microsoft.graph.socialIdentityProvider': '#/components/schemas/microsoft.graph.socialIdentityProvider'
'#microsoft.graph.identityUserFlow': '#/components/schemas/microsoft.graph.identityUserFlow'
'#microsoft.graph.b2xIdentityUserFlow': '#/components/schemas/microsoft.graph.b2xIdentityUserFlow'
'#microsoft.graph.identityUserFlowAttribute': '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
'#microsoft.graph.identityBuiltInUserFlowAttribute': >-
#/components/schemas/microsoft.graph.identityBuiltInUserFlowAttribute
'#microsoft.graph.identityCustomUserFlowAttribute': '#/components/schemas/microsoft.graph.identityCustomUserFlowAttribute'
'#microsoft.graph.identityUserFlowAttributeAssignment': >-
#/components/schemas/microsoft.graph.identityUserFlowAttributeAssignment
'#microsoft.graph.importedWindowsAutopilotDeviceIdentity': >-
#/components/schemas/microsoft.graph.importedWindowsAutopilotDeviceIdentity
'#microsoft.graph.importedWindowsAutopilotDeviceIdentityUpload': >-
#/components/schemas/microsoft.graph.importedWindowsAutopilotDeviceIdentityUpload
'#microsoft.graph.inferenceClassification': '#/components/schemas/microsoft.graph.inferenceClassification'
'#microsoft.graph.inferenceClassificationOverride': '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
'#microsoft.graph.insightsSettings': '#/components/schemas/microsoft.graph.insightsSettings'
'#microsoft.graph.internetExplorerMode': '#/components/schemas/microsoft.graph.internetExplorerMode'
'#microsoft.graph.invitation': '#/components/schemas/microsoft.graph.invitation'
'#microsoft.graph.iosLobAppProvisioningConfigurationAssignment': >-
#/components/schemas/microsoft.graph.iosLobAppProvisioningConfigurationAssignment
'#microsoft.graph.iosUpdateDeviceStatus': '#/components/schemas/microsoft.graph.iosUpdateDeviceStatus'
'#microsoft.graph.itemActivity': '#/components/schemas/microsoft.graph.itemActivity'
'#microsoft.graph.itemActivityStat': '#/components/schemas/microsoft.graph.itemActivityStat'
'#microsoft.graph.itemAnalytics': '#/components/schemas/microsoft.graph.itemAnalytics'
'#microsoft.graph.itemRetentionLabel': '#/components/schemas/microsoft.graph.itemRetentionLabel'
'#microsoft.graph.labelContentRight': '#/components/schemas/microsoft.graph.labelContentRight'
'#microsoft.graph.landingPage': '#/components/schemas/microsoft.graph.landingPage'
'#microsoft.graph.landingPageDetail': '#/components/schemas/microsoft.graph.landingPageDetail'
'#microsoft.graph.learningContent': '#/components/schemas/microsoft.graph.learningContent'
'#microsoft.graph.learningCourseActivity': '#/components/schemas/microsoft.graph.learningCourseActivity'
'#microsoft.graph.learningAssignment': '#/components/schemas/microsoft.graph.learningAssignment'
'#microsoft.graph.learningSelfInitiatedCourse': '#/components/schemas/microsoft.graph.learningSelfInitiatedCourse'
'#microsoft.graph.learningProvider': '#/components/schemas/microsoft.graph.learningProvider'
'#microsoft.graph.licenseDetails': '#/components/schemas/microsoft.graph.licenseDetails'
'#microsoft.graph.linkedResource': '#/components/schemas/microsoft.graph.linkedResource'
'#microsoft.graph.localizedNotificationMessage': '#/components/schemas/microsoft.graph.localizedNotificationMessage'
'#microsoft.graph.loginPage': '#/components/schemas/microsoft.graph.loginPage'
'#microsoft.graph.longRunningOperation': '#/components/schemas/microsoft.graph.longRunningOperation'
'#microsoft.graph.attackSimulationOperation': '#/components/schemas/microsoft.graph.attackSimulationOperation'
'#microsoft.graph.engagementAsyncOperation': '#/components/schemas/microsoft.graph.engagementAsyncOperation'
'#microsoft.graph.richLongRunningOperation': '#/components/schemas/microsoft.graph.richLongRunningOperation'
'#microsoft.graph.m365AppsInstallationOptions': '#/components/schemas/microsoft.graph.m365AppsInstallationOptions'
'#microsoft.graph.mailFolder': '#/components/schemas/microsoft.graph.mailFolder'
'#microsoft.graph.mailSearchFolder': '#/components/schemas/microsoft.graph.mailSearchFolder'
'#microsoft.graph.malwareStateForWindowsDevice': '#/components/schemas/microsoft.graph.malwareStateForWindowsDevice'
'#microsoft.graph.managedAppOperation': '#/components/schemas/microsoft.graph.managedAppOperation'
'#microsoft.graph.managedAppPolicy': '#/components/schemas/microsoft.graph.managedAppPolicy'
'#microsoft.graph.managedAppConfiguration': '#/components/schemas/microsoft.graph.managedAppConfiguration'
'#microsoft.graph.targetedManagedAppConfiguration': '#/components/schemas/microsoft.graph.targetedManagedAppConfiguration'
'#microsoft.graph.managedAppProtection': '#/components/schemas/microsoft.graph.managedAppProtection'
'#microsoft.graph.defaultManagedAppProtection': '#/components/schemas/microsoft.graph.defaultManagedAppProtection'
'#microsoft.graph.targetedManagedAppProtection': '#/components/schemas/microsoft.graph.targetedManagedAppProtection'
'#microsoft.graph.androidManagedAppProtection': '#/components/schemas/microsoft.graph.androidManagedAppProtection'
'#microsoft.graph.iosManagedAppProtection': '#/components/schemas/microsoft.graph.iosManagedAppProtection'
'#microsoft.graph.windowsInformationProtection': '#/components/schemas/microsoft.graph.windowsInformationProtection'
'#microsoft.graph.mdmWindowsInformationProtectionPolicy': >-
#/components/schemas/microsoft.graph.mdmWindowsInformationProtectionPolicy
'#microsoft.graph.windowsInformationProtectionPolicy': >-
#/components/schemas/microsoft.graph.windowsInformationProtectionPolicy
'#microsoft.graph.managedAppPolicyDeploymentSummary': >-
#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary
'#microsoft.graph.managedAppRegistration': '#/components/schemas/microsoft.graph.managedAppRegistration'
'#microsoft.graph.androidManagedAppRegistration': '#/components/schemas/microsoft.graph.androidManagedAppRegistration'
'#microsoft.graph.iosManagedAppRegistration': '#/components/schemas/microsoft.graph.iosManagedAppRegistration'
'#microsoft.graph.managedAppStatus': '#/components/schemas/microsoft.graph.managedAppStatus'
'#microsoft.graph.managedAppStatusRaw': '#/components/schemas/microsoft.graph.managedAppStatusRaw'
'#microsoft.graph.managedDevice': '#/components/schemas/microsoft.graph.managedDevice'
'#microsoft.graph.managedDeviceMobileAppConfiguration': >-
#/components/schemas/microsoft.graph.managedDeviceMobileAppConfiguration
'#microsoft.graph.iosMobileAppConfiguration': '#/components/schemas/microsoft.graph.iosMobileAppConfiguration'
'#microsoft.graph.managedDeviceMobileAppConfigurationAssignment': >-
#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationAssignment
'#microsoft.graph.managedDeviceMobileAppConfigurationDeviceStatus': >-
#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationDeviceStatus
'#microsoft.graph.managedDeviceMobileAppConfigurationDeviceSummary': >-
#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationDeviceSummary
'#microsoft.graph.managedDeviceMobileAppConfigurationUserStatus': >-
#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationUserStatus
'#microsoft.graph.managedDeviceMobileAppConfigurationUserSummary': >-
#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationUserSummary
'#microsoft.graph.managedDeviceOverview': '#/components/schemas/microsoft.graph.managedDeviceOverview'
'#microsoft.graph.managedEBook': '#/components/schemas/microsoft.graph.managedEBook'
'#microsoft.graph.iosVppEBook': '#/components/schemas/microsoft.graph.iosVppEBook'
'#microsoft.graph.managedEBookAssignment': '#/components/schemas/microsoft.graph.managedEBookAssignment'
'#microsoft.graph.iosVppEBookAssignment': '#/components/schemas/microsoft.graph.iosVppEBookAssignment'
'#microsoft.graph.managedMobileApp': '#/components/schemas/microsoft.graph.managedMobileApp'
'#microsoft.graph.meetingAttendanceReport': '#/components/schemas/microsoft.graph.meetingAttendanceReport'
'#microsoft.graph.messageRule': '#/components/schemas/microsoft.graph.messageRule'
'#microsoft.graph.mobileApp': '#/components/schemas/microsoft.graph.mobileApp'
'#microsoft.graph.androidStoreApp': '#/components/schemas/microsoft.graph.androidStoreApp'
'#microsoft.graph.iosiPadOSWebClip': '#/components/schemas/microsoft.graph.iosiPadOSWebClip'
'#microsoft.graph.iosStoreApp': '#/components/schemas/microsoft.graph.iosStoreApp'
'#microsoft.graph.iosVppApp': '#/components/schemas/microsoft.graph.iosVppApp'
'#microsoft.graph.macOSMicrosoftDefenderApp': '#/components/schemas/microsoft.graph.macOSMicrosoftDefenderApp'
'#microsoft.graph.macOSMicrosoftEdgeApp': '#/components/schemas/microsoft.graph.macOSMicrosoftEdgeApp'
'#microsoft.graph.macOSOfficeSuiteApp': '#/components/schemas/microsoft.graph.macOSOfficeSuiteApp'
'#microsoft.graph.managedApp': '#/components/schemas/microsoft.graph.managedApp'
'#microsoft.graph.managedAndroidStoreApp': '#/components/schemas/microsoft.graph.managedAndroidStoreApp'
'#microsoft.graph.managedIOSStoreApp': '#/components/schemas/microsoft.graph.managedIOSStoreApp'
'#microsoft.graph.managedMobileLobApp': '#/components/schemas/microsoft.graph.managedMobileLobApp'
'#microsoft.graph.managedAndroidLobApp': '#/components/schemas/microsoft.graph.managedAndroidLobApp'
'#microsoft.graph.managedIOSLobApp': '#/components/schemas/microsoft.graph.managedIOSLobApp'
'#microsoft.graph.microsoftStoreForBusinessApp': '#/components/schemas/microsoft.graph.microsoftStoreForBusinessApp'
'#microsoft.graph.mobileLobApp': '#/components/schemas/microsoft.graph.mobileLobApp'
'#microsoft.graph.androidLobApp': '#/components/schemas/microsoft.graph.androidLobApp'
'#microsoft.graph.iosLobApp': '#/components/schemas/microsoft.graph.iosLobApp'
'#microsoft.graph.macOSDmgApp': '#/components/schemas/microsoft.graph.macOSDmgApp'
'#microsoft.graph.macOSLobApp': '#/components/schemas/microsoft.graph.macOSLobApp'
'#microsoft.graph.win32LobApp': '#/components/schemas/microsoft.graph.win32LobApp'
'#microsoft.graph.windowsAppX': '#/components/schemas/microsoft.graph.windowsAppX'
'#microsoft.graph.windowsMobileMSI': '#/components/schemas/microsoft.graph.windowsMobileMSI'
'#microsoft.graph.windowsUniversalAppX': '#/components/schemas/microsoft.graph.windowsUniversalAppX'
'#microsoft.graph.webApp': '#/components/schemas/microsoft.graph.webApp'
'#microsoft.graph.windowsMicrosoftEdgeApp': '#/components/schemas/microsoft.graph.windowsMicrosoftEdgeApp'
'#microsoft.graph.windowsWebApp': '#/components/schemas/microsoft.graph.windowsWebApp'
'#microsoft.graph.mobileAppAssignment': '#/components/schemas/microsoft.graph.mobileAppAssignment'
'#microsoft.graph.mobileAppCategory': '#/components/schemas/microsoft.graph.mobileAppCategory'
'#microsoft.graph.mobileAppContent': '#/components/schemas/microsoft.graph.mobileAppContent'
'#microsoft.graph.mobileAppContentFile': '#/components/schemas/microsoft.graph.mobileAppContentFile'
'#microsoft.graph.mobileAppRelationship': '#/components/schemas/microsoft.graph.mobileAppRelationship'
'#microsoft.graph.mobileAppTroubleshootingEvent': '#/components/schemas/microsoft.graph.mobileAppTroubleshootingEvent'
'#microsoft.graph.mobileContainedApp': '#/components/schemas/microsoft.graph.mobileContainedApp'
'#microsoft.graph.windowsUniversalAppXContainedApp': >-
#/components/schemas/microsoft.graph.windowsUniversalAppXContainedApp
'#microsoft.graph.mobileThreatDefenseConnector': '#/components/schemas/microsoft.graph.mobileThreatDefenseConnector'
'#microsoft.graph.multiTenantOrganization': '#/components/schemas/microsoft.graph.multiTenantOrganization'
'#microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate': >-
#/components/schemas/microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate
'#microsoft.graph.multiTenantOrganizationJoinRequestRecord': >-
#/components/schemas/microsoft.graph.multiTenantOrganizationJoinRequestRecord
'#microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate': >-
#/components/schemas/microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate
'#microsoft.graph.multiValueLegacyExtendedProperty': >-
#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty
'#microsoft.graph.namedLocation': '#/components/schemas/microsoft.graph.namedLocation'
'#microsoft.graph.countryNamedLocation': '#/components/schemas/microsoft.graph.countryNamedLocation'
'#microsoft.graph.ipNamedLocation': '#/components/schemas/microsoft.graph.ipNamedLocation'
'#microsoft.graph.notificationMessageTemplate': '#/components/schemas/microsoft.graph.notificationMessageTemplate'
'#microsoft.graph.oAuth2PermissionGrant': '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
'#microsoft.graph.officeGraphInsights': '#/components/schemas/microsoft.graph.officeGraphInsights'
'#microsoft.graph.itemInsights': '#/components/schemas/microsoft.graph.itemInsights'
'#microsoft.graph.onenote': '#/components/schemas/microsoft.graph.onenote'
'#microsoft.graph.onenoteEntityBaseModel': '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
'#microsoft.graph.onenoteEntitySchemaObjectModel': '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
'#microsoft.graph.onenoteEntityHierarchyModel': '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
'#microsoft.graph.notebook': '#/components/schemas/microsoft.graph.notebook'
'#microsoft.graph.onenoteSection': '#/components/schemas/microsoft.graph.onenoteSection'
'#microsoft.graph.sectionGroup': '#/components/schemas/microsoft.graph.sectionGroup'
'#microsoft.graph.onenotePage': '#/components/schemas/microsoft.graph.onenotePage'
'#microsoft.graph.onenoteResource': '#/components/schemas/microsoft.graph.onenoteResource'
'#microsoft.graph.onlineMeetingBase': '#/components/schemas/microsoft.graph.onlineMeetingBase'
'#microsoft.graph.onlineMeeting': '#/components/schemas/microsoft.graph.onlineMeeting'
'#microsoft.graph.virtualEventSession': '#/components/schemas/microsoft.graph.virtualEventSession'
'#microsoft.graph.onPremisesConditionalAccessSettings': >-
#/components/schemas/microsoft.graph.onPremisesConditionalAccessSettings
'#microsoft.graph.onPremisesDirectorySynchronization': >-
#/components/schemas/microsoft.graph.onPremisesDirectorySynchronization
'#microsoft.graph.onPremisesSyncBehavior': '#/components/schemas/microsoft.graph.onPremisesSyncBehavior'
'#microsoft.graph.operation': '#/components/schemas/microsoft.graph.operation'
'#microsoft.graph.onenoteOperation': '#/components/schemas/microsoft.graph.onenoteOperation'
'#microsoft.graph.organizationalBrandingProperties': >-
#/components/schemas/microsoft.graph.organizationalBrandingProperties
'#microsoft.graph.organizationalBranding': '#/components/schemas/microsoft.graph.organizationalBranding'
'#microsoft.graph.organizationalBrandingLocalization': >-
#/components/schemas/microsoft.graph.organizationalBrandingLocalization
'#microsoft.graph.outlookCategory': '#/components/schemas/microsoft.graph.outlookCategory'
'#microsoft.graph.outlookItem': '#/components/schemas/microsoft.graph.outlookItem'
'#microsoft.graph.contact': '#/components/schemas/microsoft.graph.contact'
'#microsoft.graph.event': '#/components/schemas/microsoft.graph.event'
'#microsoft.graph.message': '#/components/schemas/microsoft.graph.message'
'#microsoft.graph.calendarSharingMessage': '#/components/schemas/microsoft.graph.calendarSharingMessage'
'#microsoft.graph.eventMessage': '#/components/schemas/microsoft.graph.eventMessage'
'#microsoft.graph.eventMessageRequest': '#/components/schemas/microsoft.graph.eventMessageRequest'
'#microsoft.graph.eventMessageResponse': '#/components/schemas/microsoft.graph.eventMessageResponse'
'#microsoft.graph.post': '#/components/schemas/microsoft.graph.post'
'#microsoft.graph.outlookUser': '#/components/schemas/microsoft.graph.outlookUser'
'#microsoft.graph.participant': '#/components/schemas/microsoft.graph.participant'
'#microsoft.graph.participantJoiningNotification': '#/components/schemas/microsoft.graph.participantJoiningNotification'
'#microsoft.graph.participantLeftNotification': '#/components/schemas/microsoft.graph.participantLeftNotification'
'#microsoft.graph.partners': '#/components/schemas/microsoft.graph.partners'
'#microsoft.graph.payload': '#/components/schemas/microsoft.graph.payload'
'#microsoft.graph.peopleAdminSettings': '#/components/schemas/microsoft.graph.peopleAdminSettings'
'#microsoft.graph.permission': '#/components/schemas/microsoft.graph.permission'
'#microsoft.graph.permissionGrantConditionSet': '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
'#microsoft.graph.person': '#/components/schemas/microsoft.graph.person'
'#microsoft.graph.pinnedChatMessageInfo': '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
'#microsoft.graph.place': '#/components/schemas/microsoft.graph.place'
'#microsoft.graph.building': '#/components/schemas/microsoft.graph.building'
'#microsoft.graph.desk': '#/components/schemas/microsoft.graph.desk'
'#microsoft.graph.floor': '#/components/schemas/microsoft.graph.floor'
'#microsoft.graph.room': '#/components/schemas/microsoft.graph.room'
'#microsoft.graph.roomList': '#/components/schemas/microsoft.graph.roomList'
'#microsoft.graph.section': '#/components/schemas/microsoft.graph.section'
'#microsoft.graph.workspace': '#/components/schemas/microsoft.graph.workspace'
'#microsoft.graph.planner': '#/components/schemas/microsoft.graph.planner'
'#microsoft.graph.plannerAssignedToTaskBoardTaskFormat': >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
'#microsoft.graph.plannerBucket': '#/components/schemas/microsoft.graph.plannerBucket'
'#microsoft.graph.plannerBucketTaskBoardTaskFormat': >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
'#microsoft.graph.plannerGroup': '#/components/schemas/microsoft.graph.plannerGroup'
'#microsoft.graph.plannerPlan': '#/components/schemas/microsoft.graph.plannerPlan'
'#microsoft.graph.plannerPlanDetails': '#/components/schemas/microsoft.graph.plannerPlanDetails'
'#microsoft.graph.plannerProgressTaskBoardTaskFormat': >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
'#microsoft.graph.plannerTask': '#/components/schemas/microsoft.graph.plannerTask'
'#microsoft.graph.plannerTaskDetails': '#/components/schemas/microsoft.graph.plannerTaskDetails'
'#microsoft.graph.plannerUser': '#/components/schemas/microsoft.graph.plannerUser'
'#microsoft.graph.policyRoot': '#/components/schemas/microsoft.graph.policyRoot'
'#microsoft.graph.policyTemplate': '#/components/schemas/microsoft.graph.policyTemplate'
'#microsoft.graph.presence': '#/components/schemas/microsoft.graph.presence'
'#microsoft.graph.printConnector': '#/components/schemas/microsoft.graph.printConnector'
'#microsoft.graph.printDocument': '#/components/schemas/microsoft.graph.printDocument'
'#microsoft.graph.printerBase': '#/components/schemas/microsoft.graph.printerBase'
'#microsoft.graph.printer': '#/components/schemas/microsoft.graph.printer'
'#microsoft.graph.printerShare': '#/components/schemas/microsoft.graph.printerShare'
'#microsoft.graph.printJob': '#/components/schemas/microsoft.graph.printJob'
'#microsoft.graph.printOperation': '#/components/schemas/microsoft.graph.printOperation'
'#microsoft.graph.printerCreateOperation': '#/components/schemas/microsoft.graph.printerCreateOperation'
'#microsoft.graph.printService': '#/components/schemas/microsoft.graph.printService'
'#microsoft.graph.printServiceEndpoint': '#/components/schemas/microsoft.graph.printServiceEndpoint'
'#microsoft.graph.printTask': '#/components/schemas/microsoft.graph.printTask'
'#microsoft.graph.printTaskDefinition': '#/components/schemas/microsoft.graph.printTaskDefinition'
'#microsoft.graph.printTaskTrigger': '#/components/schemas/microsoft.graph.printTaskTrigger'
'#microsoft.graph.printUsage': '#/components/schemas/microsoft.graph.printUsage'
'#microsoft.graph.printUsageByPrinter': '#/components/schemas/microsoft.graph.printUsageByPrinter'
'#microsoft.graph.printUsageByUser': '#/components/schemas/microsoft.graph.printUsageByUser'
'#microsoft.graph.privilegedAccessGroup': '#/components/schemas/microsoft.graph.privilegedAccessGroup'
'#microsoft.graph.privilegedAccessRoot': '#/components/schemas/microsoft.graph.privilegedAccessRoot'
'#microsoft.graph.privilegedAccessSchedule': '#/components/schemas/microsoft.graph.privilegedAccessSchedule'
'#microsoft.graph.privilegedAccessGroupAssignmentSchedule': >-
#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule
'#microsoft.graph.privilegedAccessGroupEligibilitySchedule': >-
#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule
'#microsoft.graph.privilegedAccessScheduleInstance': >-
#/components/schemas/microsoft.graph.privilegedAccessScheduleInstance
'#microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance': >-
#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance
'#microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance': >-
#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance
'#microsoft.graph.profileCardProperty': '#/components/schemas/microsoft.graph.profileCardProperty'
'#microsoft.graph.profilePhoto': '#/components/schemas/microsoft.graph.profilePhoto'
'#microsoft.graph.pronounsSettings': '#/components/schemas/microsoft.graph.pronounsSettings'
'#microsoft.graph.protectionPolicyBase': '#/components/schemas/microsoft.graph.protectionPolicyBase'
'#microsoft.graph.exchangeProtectionPolicy': '#/components/schemas/microsoft.graph.exchangeProtectionPolicy'
'#microsoft.graph.oneDriveForBusinessProtectionPolicy': >-
#/components/schemas/microsoft.graph.oneDriveForBusinessProtectionPolicy
'#microsoft.graph.sharePointProtectionPolicy': '#/components/schemas/microsoft.graph.sharePointProtectionPolicy'
'#microsoft.graph.protectionRuleBase': '#/components/schemas/microsoft.graph.protectionRuleBase'
'#microsoft.graph.driveProtectionRule': '#/components/schemas/microsoft.graph.driveProtectionRule'
'#microsoft.graph.mailboxProtectionRule': '#/components/schemas/microsoft.graph.mailboxProtectionRule'
'#microsoft.graph.siteProtectionRule': '#/components/schemas/microsoft.graph.siteProtectionRule'
'#microsoft.graph.protectionUnitBase': '#/components/schemas/microsoft.graph.protectionUnitBase'
'#microsoft.graph.driveProtectionUnit': '#/components/schemas/microsoft.graph.driveProtectionUnit'
'#microsoft.graph.mailboxProtectionUnit': '#/components/schemas/microsoft.graph.mailboxProtectionUnit'
'#microsoft.graph.siteProtectionUnit': '#/components/schemas/microsoft.graph.siteProtectionUnit'
'#microsoft.graph.protectionUnitsBulkJobBase': '#/components/schemas/microsoft.graph.protectionUnitsBulkJobBase'
'#microsoft.graph.driveProtectionUnitsBulkAdditionJob': >-
#/components/schemas/microsoft.graph.driveProtectionUnitsBulkAdditionJob
'#microsoft.graph.mailboxProtectionUnitsBulkAdditionJob': >-
#/components/schemas/microsoft.graph.mailboxProtectionUnitsBulkAdditionJob
'#microsoft.graph.siteProtectionUnitsBulkAdditionJob': >-
#/components/schemas/microsoft.graph.siteProtectionUnitsBulkAdditionJob
'#microsoft.graph.provisioningObjectSummary': '#/components/schemas/microsoft.graph.provisioningObjectSummary'
'#microsoft.graph.publicKeyInfrastructureRoot': '#/components/schemas/microsoft.graph.publicKeyInfrastructureRoot'
'#microsoft.graph.rbacApplication': '#/components/schemas/microsoft.graph.rbacApplication'
'#microsoft.graph.readingAssignmentSubmission': '#/components/schemas/microsoft.graph.readingAssignmentSubmission'
'#microsoft.graph.readingCoachPassage': '#/components/schemas/microsoft.graph.readingCoachPassage'
'#microsoft.graph.reflectCheckInResponse': '#/components/schemas/microsoft.graph.reflectCheckInResponse'
'#microsoft.graph.relyingPartyDetailedSummary': '#/components/schemas/microsoft.graph.relyingPartyDetailedSummary'
'#microsoft.graph.remoteAssistancePartner': '#/components/schemas/microsoft.graph.remoteAssistancePartner'
'#microsoft.graph.remoteDesktopSecurityConfiguration': >-
#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration
'#microsoft.graph.reportsRoot': '#/components/schemas/microsoft.graph.reportsRoot'
'#microsoft.graph.request': '#/components/schemas/microsoft.graph.request'
'#microsoft.graph.privilegedAccessScheduleRequest': '#/components/schemas/microsoft.graph.privilegedAccessScheduleRequest'
'#microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest': >-
#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest
'#microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest': >-
#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest
'#microsoft.graph.unifiedRoleAssignmentScheduleRequest': >-
#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest
'#microsoft.graph.unifiedRoleEligibilityScheduleRequest': >-
#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest
'#microsoft.graph.userConsentRequest': '#/components/schemas/microsoft.graph.userConsentRequest'
'#microsoft.graph.resourceOperation': '#/components/schemas/microsoft.graph.resourceOperation'
'#microsoft.graph.restoreArtifactBase': '#/components/schemas/microsoft.graph.restoreArtifactBase'
'#microsoft.graph.driveRestoreArtifact': '#/components/schemas/microsoft.graph.driveRestoreArtifact'
'#microsoft.graph.mailboxRestoreArtifact': '#/components/schemas/microsoft.graph.mailboxRestoreArtifact'
'#microsoft.graph.granularMailboxRestoreArtifact': '#/components/schemas/microsoft.graph.granularMailboxRestoreArtifact'
'#microsoft.graph.siteRestoreArtifact': '#/components/schemas/microsoft.graph.siteRestoreArtifact'
'#microsoft.graph.restoreArtifactsBulkRequestBase': '#/components/schemas/microsoft.graph.restoreArtifactsBulkRequestBase'
'#microsoft.graph.driveRestoreArtifactsBulkAdditionRequest': >-
#/components/schemas/microsoft.graph.driveRestoreArtifactsBulkAdditionRequest
'#microsoft.graph.mailboxRestoreArtifactsBulkAdditionRequest': >-
#/components/schemas/microsoft.graph.mailboxRestoreArtifactsBulkAdditionRequest
'#microsoft.graph.siteRestoreArtifactsBulkAdditionRequest': >-
#/components/schemas/microsoft.graph.siteRestoreArtifactsBulkAdditionRequest
'#microsoft.graph.restorePoint': '#/components/schemas/microsoft.graph.restorePoint'
'#microsoft.graph.restoreSessionBase': '#/components/schemas/microsoft.graph.restoreSessionBase'
'#microsoft.graph.exchangeRestoreSession': '#/components/schemas/microsoft.graph.exchangeRestoreSession'
'#microsoft.graph.oneDriveForBusinessRestoreSession': >-
#/components/schemas/microsoft.graph.oneDriveForBusinessRestoreSession
'#microsoft.graph.sharePointRestoreSession': '#/components/schemas/microsoft.graph.sharePointRestoreSession'
'#microsoft.graph.riskDetection': '#/components/schemas/microsoft.graph.riskDetection'
'#microsoft.graph.riskyServicePrincipal': '#/components/schemas/microsoft.graph.riskyServicePrincipal'
'#microsoft.graph.riskyServicePrincipalHistoryItem': >-
#/components/schemas/microsoft.graph.riskyServicePrincipalHistoryItem
'#microsoft.graph.riskyUser': '#/components/schemas/microsoft.graph.riskyUser'
'#microsoft.graph.riskyUserHistoryItem': '#/components/schemas/microsoft.graph.riskyUserHistoryItem'
'#microsoft.graph.roleAssignment': '#/components/schemas/microsoft.graph.roleAssignment'
'#microsoft.graph.deviceAndAppManagementRoleAssignment': >-
#/components/schemas/microsoft.graph.deviceAndAppManagementRoleAssignment
'#microsoft.graph.roleDefinition': '#/components/schemas/microsoft.graph.roleDefinition'
'#microsoft.graph.deviceAndAppManagementRoleDefinition': >-
#/components/schemas/microsoft.graph.deviceAndAppManagementRoleDefinition
'#microsoft.graph.schedule': '#/components/schemas/microsoft.graph.schedule'
'#microsoft.graph.schemaExtension': '#/components/schemas/microsoft.graph.schemaExtension'
'#microsoft.graph.scopedRoleMembership': '#/components/schemas/microsoft.graph.scopedRoleMembership'
'#microsoft.graph.searchEntity': '#/components/schemas/microsoft.graph.searchEntity'
'#microsoft.graph.secureScore': '#/components/schemas/microsoft.graph.secureScore'
'#microsoft.graph.secureScoreControlProfile': '#/components/schemas/microsoft.graph.secureScoreControlProfile'
'#microsoft.graph.security': '#/components/schemas/microsoft.graph.security'
'#microsoft.graph.securityReportsRoot': '#/components/schemas/microsoft.graph.securityReportsRoot'
'#microsoft.graph.sensitivityLabel': '#/components/schemas/microsoft.graph.sensitivityLabel'
'#microsoft.graph.serviceAnnouncement': '#/components/schemas/microsoft.graph.serviceAnnouncement'
'#microsoft.graph.serviceAnnouncementAttachment': '#/components/schemas/microsoft.graph.serviceAnnouncementAttachment'
'#microsoft.graph.serviceAnnouncementBase': '#/components/schemas/microsoft.graph.serviceAnnouncementBase'
'#microsoft.graph.serviceHealthIssue': '#/components/schemas/microsoft.graph.serviceHealthIssue'
'#microsoft.graph.serviceUpdateMessage': '#/components/schemas/microsoft.graph.serviceUpdateMessage'
'#microsoft.graph.serviceApp': '#/components/schemas/microsoft.graph.serviceApp'
'#microsoft.graph.serviceHealth': '#/components/schemas/microsoft.graph.serviceHealth'
'#microsoft.graph.servicePrincipalRiskDetection': '#/components/schemas/microsoft.graph.servicePrincipalRiskDetection'
'#microsoft.graph.settingStateDeviceSummary': '#/components/schemas/microsoft.graph.settingStateDeviceSummary'
'#microsoft.graph.sharedInsight': '#/components/schemas/microsoft.graph.sharedInsight'
'#microsoft.graph.sharepoint': '#/components/schemas/microsoft.graph.sharepoint'
'#microsoft.graph.sharePointMigrationEvent': '#/components/schemas/microsoft.graph.sharePointMigrationEvent'
'#microsoft.graph.sharePointMigrationFinishManifestFileUploadEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationFinishManifestFileUploadEvent
'#microsoft.graph.sharePointMigrationJobCancelledEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationJobCancelledEvent
'#microsoft.graph.sharePointMigrationJobDeletedEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationJobDeletedEvent
'#microsoft.graph.sharePointMigrationJobErrorEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationJobErrorEvent
'#microsoft.graph.sharePointMigrationJobPostponedEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationJobPostponedEvent
'#microsoft.graph.sharePointMigrationJobProgressEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationJobProgressEvent
'#microsoft.graph.sharePointMigrationJobQueuedEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationJobQueuedEvent
'#microsoft.graph.sharePointMigrationJobStartEvent': >-
#/components/schemas/microsoft.graph.sharePointMigrationJobStartEvent
'#microsoft.graph.sharePointMigrationJob': '#/components/schemas/microsoft.graph.sharePointMigrationJob'
'#microsoft.graph.sharepointSettings': '#/components/schemas/microsoft.graph.sharepointSettings'
'#microsoft.graph.signIn': '#/components/schemas/microsoft.graph.signIn'
'#microsoft.graph.simulation': '#/components/schemas/microsoft.graph.simulation'
'#microsoft.graph.simulationAutomation': '#/components/schemas/microsoft.graph.simulationAutomation'
'#microsoft.graph.simulationAutomationRun': '#/components/schemas/microsoft.graph.simulationAutomationRun'
'#microsoft.graph.singleValueLegacyExtendedProperty': >-
#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty
'#microsoft.graph.softwareUpdateStatusSummary': '#/components/schemas/microsoft.graph.softwareUpdateStatusSummary'
'#microsoft.graph.speakerAssignmentSubmission': '#/components/schemas/microsoft.graph.speakerAssignmentSubmission'
'#microsoft.graph.storageQuotaBreakdown': '#/components/schemas/microsoft.graph.storageQuotaBreakdown'
'#microsoft.graph.serviceStorageQuotaBreakdown': '#/components/schemas/microsoft.graph.serviceStorageQuotaBreakdown'
'#microsoft.graph.storageSettings': '#/components/schemas/microsoft.graph.storageSettings'
'#microsoft.graph.subjectRightsRequest': '#/components/schemas/microsoft.graph.subjectRightsRequest'
'#microsoft.graph.subscribedSku': '#/components/schemas/microsoft.graph.subscribedSku'
'#microsoft.graph.subscription': '#/components/schemas/microsoft.graph.subscription'
'#microsoft.graph.synchronization': '#/components/schemas/microsoft.graph.synchronization'
'#microsoft.graph.synchronizationJob': '#/components/schemas/microsoft.graph.synchronizationJob'
'#microsoft.graph.synchronizationSchema': '#/components/schemas/microsoft.graph.synchronizationSchema'
'#microsoft.graph.synchronizationTemplate': '#/components/schemas/microsoft.graph.synchronizationTemplate'
'#microsoft.graph.targetDeviceGroup': '#/components/schemas/microsoft.graph.targetDeviceGroup'
'#microsoft.graph.targetedManagedAppPolicyAssignment': >-
#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment
'#microsoft.graph.team': '#/components/schemas/microsoft.graph.team'
'#microsoft.graph.teamInfo': '#/components/schemas/microsoft.graph.teamInfo'
'#microsoft.graph.associatedTeamInfo': '#/components/schemas/microsoft.graph.associatedTeamInfo'
'#microsoft.graph.sharedWithChannelTeamInfo': '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
'#microsoft.graph.teamsApp': '#/components/schemas/microsoft.graph.teamsApp'
'#microsoft.graph.teamsAppDefinition': '#/components/schemas/microsoft.graph.teamsAppDefinition'
'#microsoft.graph.teamsAppInstallation': '#/components/schemas/microsoft.graph.teamsAppInstallation'
'#microsoft.graph.userScopeTeamsAppInstallation': '#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation'
'#microsoft.graph.teamsAppSettings': '#/components/schemas/microsoft.graph.teamsAppSettings'
'#microsoft.graph.teamsAsyncOperation': '#/components/schemas/microsoft.graph.teamsAsyncOperation'
'#microsoft.graph.teamsTab': '#/components/schemas/microsoft.graph.teamsTab'
'#microsoft.graph.teamsTemplate': '#/components/schemas/microsoft.graph.teamsTemplate'
'#microsoft.graph.teamwork': '#/components/schemas/microsoft.graph.teamwork'
'#microsoft.graph.teamworkBot': '#/components/schemas/microsoft.graph.teamworkBot'
'#microsoft.graph.teamworkHostedContent': '#/components/schemas/microsoft.graph.teamworkHostedContent'
'#microsoft.graph.chatMessageHostedContent': '#/components/schemas/microsoft.graph.chatMessageHostedContent'
'#microsoft.graph.teamworkTag': '#/components/schemas/microsoft.graph.teamworkTag'
'#microsoft.graph.teamworkTagMember': '#/components/schemas/microsoft.graph.teamworkTagMember'
'#microsoft.graph.tenantProtectionScopeContainer': '#/components/schemas/microsoft.graph.tenantProtectionScopeContainer'
'#microsoft.graph.termsAndConditions': '#/components/schemas/microsoft.graph.termsAndConditions'
'#microsoft.graph.termsAndConditionsAcceptanceStatus': >-
#/components/schemas/microsoft.graph.termsAndConditionsAcceptanceStatus
'#microsoft.graph.termsAndConditionsAssignment': '#/components/schemas/microsoft.graph.termsAndConditionsAssignment'
'#microsoft.graph.termsOfUseContainer': '#/components/schemas/microsoft.graph.termsOfUseContainer'
'#microsoft.graph.threatAssessmentRequest': '#/components/schemas/microsoft.graph.threatAssessmentRequest'
'#microsoft.graph.emailFileAssessmentRequest': '#/components/schemas/microsoft.graph.emailFileAssessmentRequest'
'#microsoft.graph.fileAssessmentRequest': '#/components/schemas/microsoft.graph.fileAssessmentRequest'
'#microsoft.graph.mailAssessmentRequest': '#/components/schemas/microsoft.graph.mailAssessmentRequest'
'#microsoft.graph.urlAssessmentRequest': '#/components/schemas/microsoft.graph.urlAssessmentRequest'
'#microsoft.graph.threatAssessmentResult': '#/components/schemas/microsoft.graph.threatAssessmentResult'
'#microsoft.graph.thumbnailSet': '#/components/schemas/microsoft.graph.thumbnailSet'
'#microsoft.graph.todo': '#/components/schemas/microsoft.graph.todo'
'#microsoft.graph.todoTask': '#/components/schemas/microsoft.graph.todoTask'
'#microsoft.graph.todoTaskList': '#/components/schemas/microsoft.graph.todoTaskList'
'#microsoft.graph.training': '#/components/schemas/microsoft.graph.training'
'#microsoft.graph.trainingLanguageDetail': '#/components/schemas/microsoft.graph.trainingLanguageDetail'
'#microsoft.graph.trending': '#/components/schemas/microsoft.graph.trending'
'#microsoft.graph.unifiedRbacResourceAction': '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
'#microsoft.graph.unifiedRbacResourceNamespace': '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
'#microsoft.graph.unifiedRoleAssignment': '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
'#microsoft.graph.unifiedRoleDefinition': '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
'#microsoft.graph.unifiedRoleManagementPolicy': '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
'#microsoft.graph.unifiedRoleManagementPolicyAssignment': >-
#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAssignment
'#microsoft.graph.unifiedRoleManagementPolicyRule': '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
'#microsoft.graph.unifiedRoleManagementPolicyApprovalRule': >-
#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyApprovalRule
'#microsoft.graph.unifiedRoleManagementPolicyAuthenticationContextRule': >-
#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAuthenticationContextRule
'#microsoft.graph.unifiedRoleManagementPolicyEnablementRule': >-
#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyEnablementRule
'#microsoft.graph.unifiedRoleManagementPolicyExpirationRule': >-
#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyExpirationRule
'#microsoft.graph.unifiedRoleManagementPolicyNotificationRule': >-
#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyNotificationRule
'#microsoft.graph.unifiedRoleScheduleBase': '#/components/schemas/microsoft.graph.unifiedRoleScheduleBase'
'#microsoft.graph.unifiedRoleAssignmentSchedule': '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
'#microsoft.graph.unifiedRoleEligibilitySchedule': '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
'#microsoft.graph.unifiedRoleScheduleInstanceBase': '#/components/schemas/microsoft.graph.unifiedRoleScheduleInstanceBase'
'#microsoft.graph.unifiedRoleAssignmentScheduleInstance': >-
#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance
'#microsoft.graph.unifiedRoleEligibilityScheduleInstance': >-
#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance
'#microsoft.graph.unifiedStorageQuota': '#/components/schemas/microsoft.graph.unifiedStorageQuota'
'#microsoft.graph.usageRightsIncluded': '#/components/schemas/microsoft.graph.usageRightsIncluded'
'#microsoft.graph.usedInsight': '#/components/schemas/microsoft.graph.usedInsight'
'#microsoft.graph.userActivity': '#/components/schemas/microsoft.graph.userActivity'
'#microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance
'#microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails
'#microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId
'#microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByOSVersion': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByOSVersion
'#microsoft.graph.userExperienceAnalyticsAppHealthDeviceModelPerformance': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthDeviceModelPerformance
'#microsoft.graph.userExperienceAnalyticsAppHealthDevicePerformance': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthDevicePerformance
'#microsoft.graph.userExperienceAnalyticsAppHealthDevicePerformanceDetails': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthDevicePerformanceDetails
'#microsoft.graph.userExperienceAnalyticsAppHealthOSVersionPerformance': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthOSVersionPerformance
'#microsoft.graph.userExperienceAnalyticsBaseline': '#/components/schemas/microsoft.graph.userExperienceAnalyticsBaseline'
'#microsoft.graph.userExperienceAnalyticsCategory': '#/components/schemas/microsoft.graph.userExperienceAnalyticsCategory'
'#microsoft.graph.userExperienceAnalyticsDevicePerformance': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsDevicePerformance
'#microsoft.graph.userExperienceAnalyticsDeviceScores': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsDeviceScores
'#microsoft.graph.userExperienceAnalyticsDeviceStartupHistory': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsDeviceStartupHistory
'#microsoft.graph.userExperienceAnalyticsDeviceStartupProcess': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsDeviceStartupProcess
'#microsoft.graph.userExperienceAnalyticsDeviceStartupProcessPerformance': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsDeviceStartupProcessPerformance
'#microsoft.graph.userExperienceAnalyticsMetric': '#/components/schemas/microsoft.graph.userExperienceAnalyticsMetric'
'#microsoft.graph.userExperienceAnalyticsMetricHistory': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsMetricHistory
'#microsoft.graph.userExperienceAnalyticsModelScores': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsModelScores
'#microsoft.graph.userExperienceAnalyticsOverview': '#/components/schemas/microsoft.graph.userExperienceAnalyticsOverview'
'#microsoft.graph.userExperienceAnalyticsScoreHistory': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsScoreHistory
'#microsoft.graph.userExperienceAnalyticsWorkFromAnywhereDevice': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsWorkFromAnywhereDevice
'#microsoft.graph.userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric
'#microsoft.graph.userExperienceAnalyticsWorkFromAnywhereMetric': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsWorkFromAnywhereMetric
'#microsoft.graph.userExperienceAnalyticsWorkFromAnywhereModelPerformance': >-
#/components/schemas/microsoft.graph.userExperienceAnalyticsWorkFromAnywhereModelPerformance
'#microsoft.graph.userFlowLanguageConfiguration': '#/components/schemas/microsoft.graph.userFlowLanguageConfiguration'
'#microsoft.graph.userFlowLanguagePage': '#/components/schemas/microsoft.graph.userFlowLanguagePage'
'#microsoft.graph.userInsightsSettings': '#/components/schemas/microsoft.graph.userInsightsSettings'
'#microsoft.graph.userInstallStateSummary': '#/components/schemas/microsoft.graph.userInstallStateSummary'
'#microsoft.graph.userProtectionScopeContainer': '#/components/schemas/microsoft.graph.userProtectionScopeContainer'
'#microsoft.graph.userRegistrationDetails': '#/components/schemas/microsoft.graph.userRegistrationDetails'
'#microsoft.graph.userSettings': '#/components/schemas/microsoft.graph.userSettings'
'#microsoft.graph.userSolutionRoot': '#/components/schemas/microsoft.graph.userSolutionRoot'
'#microsoft.graph.userStorage': '#/components/schemas/microsoft.graph.userStorage'
'#microsoft.graph.userTeamwork': '#/components/schemas/microsoft.graph.userTeamwork'
'#microsoft.graph.verticalSection': '#/components/schemas/microsoft.graph.verticalSection'
'#microsoft.graph.virtualEndpoint': '#/components/schemas/microsoft.graph.virtualEndpoint'
'#microsoft.graph.virtualEvent': '#/components/schemas/microsoft.graph.virtualEvent'
'#microsoft.graph.virtualEventTownhall': '#/components/schemas/microsoft.graph.virtualEventTownhall'
'#microsoft.graph.virtualEventWebinar': '#/components/schemas/microsoft.graph.virtualEventWebinar'
'#microsoft.graph.virtualEventPresenter': '#/components/schemas/microsoft.graph.virtualEventPresenter'
'#microsoft.graph.virtualEventRegistration': '#/components/schemas/microsoft.graph.virtualEventRegistration'
'#microsoft.graph.virtualEventRegistrationConfiguration': >-
#/components/schemas/microsoft.graph.virtualEventRegistrationConfiguration
'#microsoft.graph.virtualEventWebinarRegistrationConfiguration': >-
#/components/schemas/microsoft.graph.virtualEventWebinarRegistrationConfiguration
'#microsoft.graph.virtualEventRegistrationQuestionBase': >-
#/components/schemas/microsoft.graph.virtualEventRegistrationQuestionBase
'#microsoft.graph.virtualEventRegistrationCustomQuestion': >-
#/components/schemas/microsoft.graph.virtualEventRegistrationCustomQuestion
'#microsoft.graph.virtualEventRegistrationPredefinedQuestion': >-
#/components/schemas/microsoft.graph.virtualEventRegistrationPredefinedQuestion
'#microsoft.graph.virtualEventsRoot': '#/components/schemas/microsoft.graph.virtualEventsRoot'
'#microsoft.graph.vppToken': '#/components/schemas/microsoft.graph.vppToken'
'#microsoft.graph.webApplicationFirewallProvider': '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
'#microsoft.graph.akamaiWebApplicationFirewallProvider': >-
#/components/schemas/microsoft.graph.akamaiWebApplicationFirewallProvider
'#microsoft.graph.cloudFlareWebApplicationFirewallProvider': >-
#/components/schemas/microsoft.graph.cloudFlareWebApplicationFirewallProvider
'#microsoft.graph.webApplicationFirewallVerificationModel': >-
#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel
'#microsoft.graph.webPart': '#/components/schemas/microsoft.graph.webPart'
'#microsoft.graph.standardWebPart': '#/components/schemas/microsoft.graph.standardWebPart'
'#microsoft.graph.textWebPart': '#/components/schemas/microsoft.graph.textWebPart'
'#microsoft.graph.windowsAutopilotDeploymentProfile': >-
#/components/schemas/microsoft.graph.windowsAutopilotDeploymentProfile
'#microsoft.graph.windowsAutopilotDeploymentProfileAssignment': >-
#/components/schemas/microsoft.graph.windowsAutopilotDeploymentProfileAssignment
'#microsoft.graph.windowsAutopilotDeviceIdentity': '#/components/schemas/microsoft.graph.windowsAutopilotDeviceIdentity'
'#microsoft.graph.windowsDeviceMalwareState': '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
'#microsoft.graph.windowsInformationProtectionAppLearningSummary': >-
#/components/schemas/microsoft.graph.windowsInformationProtectionAppLearningSummary
'#microsoft.graph.windowsInformationProtectionAppLockerFile': >-
#/components/schemas/microsoft.graph.windowsInformationProtectionAppLockerFile
'#microsoft.graph.windowsInformationProtectionNetworkLearningSummary': >-
#/components/schemas/microsoft.graph.windowsInformationProtectionNetworkLearningSummary
'#microsoft.graph.windowsMalwareInformation': '#/components/schemas/microsoft.graph.windowsMalwareInformation'
'#microsoft.graph.windowsProtectionState': '#/components/schemas/microsoft.graph.windowsProtectionState'
'#microsoft.graph.windowsSetting': '#/components/schemas/microsoft.graph.windowsSetting'
'#microsoft.graph.windowsSettingInstance': '#/components/schemas/microsoft.graph.windowsSettingInstance'
'#microsoft.graph.workbook': '#/components/schemas/microsoft.graph.workbook'
'#microsoft.graph.workbookApplication': '#/components/schemas/microsoft.graph.workbookApplication'
'#microsoft.graph.workbookChart': '#/components/schemas/microsoft.graph.workbookChart'
'#microsoft.graph.workbookChartAreaFormat': '#/components/schemas/microsoft.graph.workbookChartAreaFormat'
'#microsoft.graph.workbookChartAxes': '#/components/schemas/microsoft.graph.workbookChartAxes'
'#microsoft.graph.workbookChartAxis': '#/components/schemas/microsoft.graph.workbookChartAxis'
'#microsoft.graph.workbookChartAxisFormat': '#/components/schemas/microsoft.graph.workbookChartAxisFormat'
'#microsoft.graph.workbookChartAxisTitle': '#/components/schemas/microsoft.graph.workbookChartAxisTitle'
'#microsoft.graph.workbookChartAxisTitleFormat': '#/components/schemas/microsoft.graph.workbookChartAxisTitleFormat'
'#microsoft.graph.workbookChartDataLabelFormat': '#/components/schemas/microsoft.graph.workbookChartDataLabelFormat'
'#microsoft.graph.workbookChartDataLabels': '#/components/schemas/microsoft.graph.workbookChartDataLabels'
'#microsoft.graph.workbookChartFill': '#/components/schemas/microsoft.graph.workbookChartFill'
'#microsoft.graph.workbookChartFont': '#/components/schemas/microsoft.graph.workbookChartFont'
'#microsoft.graph.workbookChartGridlines': '#/components/schemas/microsoft.graph.workbookChartGridlines'
'#microsoft.graph.workbookChartGridlinesFormat': '#/components/schemas/microsoft.graph.workbookChartGridlinesFormat'
'#microsoft.graph.workbookChartLegend': '#/components/schemas/microsoft.graph.workbookChartLegend'
'#microsoft.graph.workbookChartLegendFormat': '#/components/schemas/microsoft.graph.workbookChartLegendFormat'
'#microsoft.graph.workbookChartLineFormat': '#/components/schemas/microsoft.graph.workbookChartLineFormat'
'#microsoft.graph.workbookChartPoint': '#/components/schemas/microsoft.graph.workbookChartPoint'
'#microsoft.graph.workbookChartPointFormat': '#/components/schemas/microsoft.graph.workbookChartPointFormat'
'#microsoft.graph.workbookChartSeries': '#/components/schemas/microsoft.graph.workbookChartSeries'
'#microsoft.graph.workbookChartSeriesFormat': '#/components/schemas/microsoft.graph.workbookChartSeriesFormat'
'#microsoft.graph.workbookChartTitle': '#/components/schemas/microsoft.graph.workbookChartTitle'
'#microsoft.graph.workbookChartTitleFormat': '#/components/schemas/microsoft.graph.workbookChartTitleFormat'
'#microsoft.graph.workbookComment': '#/components/schemas/microsoft.graph.workbookComment'
'#microsoft.graph.workbookCommentReply': '#/components/schemas/microsoft.graph.workbookCommentReply'
'#microsoft.graph.workbookFilter': '#/components/schemas/microsoft.graph.workbookFilter'
'#microsoft.graph.workbookFormatProtection': '#/components/schemas/microsoft.graph.workbookFormatProtection'
'#microsoft.graph.workbookFunctionResult': '#/components/schemas/microsoft.graph.workbookFunctionResult'
'#microsoft.graph.workbookFunctions': '#/components/schemas/microsoft.graph.workbookFunctions'
'#microsoft.graph.workbookNamedItem': '#/components/schemas/microsoft.graph.workbookNamedItem'
'#microsoft.graph.workbookOperation': '#/components/schemas/microsoft.graph.workbookOperation'
'#microsoft.graph.workbookPivotTable': '#/components/schemas/microsoft.graph.workbookPivotTable'
'#microsoft.graph.workbookRange': '#/components/schemas/microsoft.graph.workbookRange'
'#microsoft.graph.workbookRangeBorder': '#/components/schemas/microsoft.graph.workbookRangeBorder'
'#microsoft.graph.workbookRangeFill': '#/components/schemas/microsoft.graph.workbookRangeFill'
'#microsoft.graph.workbookRangeFont': '#/components/schemas/microsoft.graph.workbookRangeFont'
'#microsoft.graph.workbookRangeFormat': '#/components/schemas/microsoft.graph.workbookRangeFormat'
'#microsoft.graph.workbookRangeSort': '#/components/schemas/microsoft.graph.workbookRangeSort'
'#microsoft.graph.workbookRangeView': '#/components/schemas/microsoft.graph.workbookRangeView'
'#microsoft.graph.workbookTable': '#/components/schemas/microsoft.graph.workbookTable'
'#microsoft.graph.workbookTableColumn': '#/components/schemas/microsoft.graph.workbookTableColumn'
'#microsoft.graph.workbookTableRow': '#/components/schemas/microsoft.graph.workbookTableRow'
'#microsoft.graph.workbookTableSort': '#/components/schemas/microsoft.graph.workbookTableSort'
'#microsoft.graph.workbookWorksheet': '#/components/schemas/microsoft.graph.workbookWorksheet'
'#microsoft.graph.workbookWorksheetProtection': '#/components/schemas/microsoft.graph.workbookWorksheetProtection'
'#microsoft.graph.workingTimeSchedule': '#/components/schemas/microsoft.graph.workingTimeSchedule'
'#microsoft.graph.callRecords.callRecord': '#/components/schemas/microsoft.graph.callRecords.callRecord'
'#microsoft.graph.callRecords.participantBase': '#/components/schemas/microsoft.graph.callRecords.participantBase'
'#microsoft.graph.callRecords.organizer': '#/components/schemas/microsoft.graph.callRecords.organizer'
'#microsoft.graph.callRecords.participant': '#/components/schemas/microsoft.graph.callRecords.participant'
'#microsoft.graph.callRecords.segment': '#/components/schemas/microsoft.graph.callRecords.segment'
'#microsoft.graph.callRecords.session': '#/components/schemas/microsoft.graph.callRecords.session'
'#microsoft.graph.externalConnectors.connectionOperation': >-
#/components/schemas/microsoft.graph.externalConnectors.connectionOperation
'#microsoft.graph.externalConnectors.externalActivity': >-
#/components/schemas/microsoft.graph.externalConnectors.externalActivity
'#microsoft.graph.externalConnectors.externalActivityResult': >-
#/components/schemas/microsoft.graph.externalConnectors.externalActivityResult
'#microsoft.graph.externalConnectors.externalConnection': >-
#/components/schemas/microsoft.graph.externalConnectors.externalConnection
'#microsoft.graph.externalConnectors.externalGroup': >-
#/components/schemas/microsoft.graph.externalConnectors.externalGroup
'#microsoft.graph.externalConnectors.externalItem': '#/components/schemas/microsoft.graph.externalConnectors.externalItem'
'#microsoft.graph.externalConnectors.identity': '#/components/schemas/microsoft.graph.externalConnectors.identity'
'#microsoft.graph.externalConnectors.schema': '#/components/schemas/microsoft.graph.externalConnectors.schema'
'#microsoft.graph.identityGovernance.insights': '#/components/schemas/microsoft.graph.identityGovernance.insights'
'#microsoft.graph.identityGovernance.lifecycleManagementSettings': >-
#/components/schemas/microsoft.graph.identityGovernance.lifecycleManagementSettings
'#microsoft.graph.identityGovernance.lifecycleWorkflowsContainer': >-
#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowsContainer
'#microsoft.graph.identityGovernance.run': '#/components/schemas/microsoft.graph.identityGovernance.run'
'#microsoft.graph.identityGovernance.task': '#/components/schemas/microsoft.graph.identityGovernance.task'
'#microsoft.graph.identityGovernance.taskDefinition': >-
#/components/schemas/microsoft.graph.identityGovernance.taskDefinition
'#microsoft.graph.identityGovernance.taskProcessingResult': >-
#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult
'#microsoft.graph.identityGovernance.taskReport': '#/components/schemas/microsoft.graph.identityGovernance.taskReport'
'#microsoft.graph.identityGovernance.userProcessingResult': >-
#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult
'#microsoft.graph.identityGovernance.workflowTemplate': >-
#/components/schemas/microsoft.graph.identityGovernance.workflowTemplate
'#microsoft.graph.partners.billing.azureUsage': '#/components/schemas/microsoft.graph.partners.billing.azureUsage'
'#microsoft.graph.partners.billing.billedReconciliation': >-
#/components/schemas/microsoft.graph.partners.billing.billedReconciliation
'#microsoft.graph.partners.billing.billedUsage': '#/components/schemas/microsoft.graph.partners.billing.billedUsage'
'#microsoft.graph.partners.billing.billing': '#/components/schemas/microsoft.graph.partners.billing.billing'
'#microsoft.graph.partners.billing.billingReconciliation': >-
#/components/schemas/microsoft.graph.partners.billing.billingReconciliation
'#microsoft.graph.partners.billing.manifest': '#/components/schemas/microsoft.graph.partners.billing.manifest'
'#microsoft.graph.partners.billing.operation': '#/components/schemas/microsoft.graph.partners.billing.operation'
'#microsoft.graph.partners.billing.exportSuccessOperation': >-
#/components/schemas/microsoft.graph.partners.billing.exportSuccessOperation
'#microsoft.graph.partners.billing.failedOperation': >-
#/components/schemas/microsoft.graph.partners.billing.failedOperation
'#microsoft.graph.partners.billing.runningOperation': >-
#/components/schemas/microsoft.graph.partners.billing.runningOperation
'#microsoft.graph.partners.billing.unbilledReconciliation': >-
#/components/schemas/microsoft.graph.partners.billing.unbilledReconciliation
'#microsoft.graph.partners.billing.unbilledUsage': '#/components/schemas/microsoft.graph.partners.billing.unbilledUsage'
'#microsoft.graph.search.searchAnswer': '#/components/schemas/microsoft.graph.search.searchAnswer'
'#microsoft.graph.search.acronym': '#/components/schemas/microsoft.graph.search.acronym'
'#microsoft.graph.search.bookmark': '#/components/schemas/microsoft.graph.search.bookmark'
'#microsoft.graph.search.qna': '#/components/schemas/microsoft.graph.search.qna'
'#microsoft.graph.security.alert': '#/components/schemas/microsoft.graph.security.alert'
'#microsoft.graph.security.article': '#/components/schemas/microsoft.graph.security.article'
'#microsoft.graph.security.artifact': '#/components/schemas/microsoft.graph.security.artifact'
'#microsoft.graph.security.host': '#/components/schemas/microsoft.graph.security.host'
'#microsoft.graph.security.hostname': '#/components/schemas/microsoft.graph.security.hostname'
'#microsoft.graph.security.ipAddress': '#/components/schemas/microsoft.graph.security.ipAddress'
'#microsoft.graph.security.hostComponent': '#/components/schemas/microsoft.graph.security.hostComponent'
'#microsoft.graph.security.hostCookie': '#/components/schemas/microsoft.graph.security.hostCookie'
'#microsoft.graph.security.hostSslCertificate': '#/components/schemas/microsoft.graph.security.hostSslCertificate'
'#microsoft.graph.security.hostTracker': '#/components/schemas/microsoft.graph.security.hostTracker'
'#microsoft.graph.security.passiveDnsRecord': '#/components/schemas/microsoft.graph.security.passiveDnsRecord'
'#microsoft.graph.security.sslCertificate': '#/components/schemas/microsoft.graph.security.sslCertificate'
'#microsoft.graph.security.unclassifiedArtifact': '#/components/schemas/microsoft.graph.security.unclassifiedArtifact'
'#microsoft.graph.security.case': '#/components/schemas/microsoft.graph.security.case'
'#microsoft.graph.security.ediscoveryCase': '#/components/schemas/microsoft.graph.security.ediscoveryCase'
'#microsoft.graph.security.caseOperation': '#/components/schemas/microsoft.graph.security.caseOperation'
'#microsoft.graph.security.ediscoveryAddToReviewSetOperation': >-
#/components/schemas/microsoft.graph.security.ediscoveryAddToReviewSetOperation
'#microsoft.graph.security.ediscoveryEstimateOperation': >-
#/components/schemas/microsoft.graph.security.ediscoveryEstimateOperation
'#microsoft.graph.security.ediscoveryExportOperation': >-
#/components/schemas/microsoft.graph.security.ediscoveryExportOperation
'#microsoft.graph.security.ediscoveryHoldOperation': >-
#/components/schemas/microsoft.graph.security.ediscoveryHoldOperation
'#microsoft.graph.security.ediscoveryHoldPolicySyncOperation': >-
#/components/schemas/microsoft.graph.security.ediscoveryHoldPolicySyncOperation
'#microsoft.graph.security.ediscoveryIndexOperation': >-
#/components/schemas/microsoft.graph.security.ediscoveryIndexOperation
'#microsoft.graph.security.ediscoveryPurgeDataOperation': >-
#/components/schemas/microsoft.graph.security.ediscoveryPurgeDataOperation
'#microsoft.graph.security.ediscoverySearchExportOperation': >-
#/components/schemas/microsoft.graph.security.ediscoverySearchExportOperation
'#microsoft.graph.security.ediscoveryTagOperation': '#/components/schemas/microsoft.graph.security.ediscoveryTagOperation'
'#microsoft.graph.security.casesRoot': '#/components/schemas/microsoft.graph.security.casesRoot'
'#microsoft.graph.security.dataSet': '#/components/schemas/microsoft.graph.security.dataSet'
'#microsoft.graph.security.ediscoveryReviewSet': '#/components/schemas/microsoft.graph.security.ediscoveryReviewSet'
'#microsoft.graph.security.dataSource': '#/components/schemas/microsoft.graph.security.dataSource'
'#microsoft.graph.security.siteSource': '#/components/schemas/microsoft.graph.security.siteSource'
'#microsoft.graph.security.unifiedGroupSource': '#/components/schemas/microsoft.graph.security.unifiedGroupSource'
'#microsoft.graph.security.userSource': '#/components/schemas/microsoft.graph.security.userSource'
'#microsoft.graph.security.dataSourceContainer': '#/components/schemas/microsoft.graph.security.dataSourceContainer'
'#microsoft.graph.security.ediscoveryCustodian': '#/components/schemas/microsoft.graph.security.ediscoveryCustodian'
'#microsoft.graph.security.ediscoveryNoncustodialDataSource': >-
#/components/schemas/microsoft.graph.security.ediscoveryNoncustodialDataSource
'#microsoft.graph.security.dispositionReviewStage': '#/components/schemas/microsoft.graph.security.dispositionReviewStage'
'#microsoft.graph.security.ediscoveryCaseSettings': '#/components/schemas/microsoft.graph.security.ediscoveryCaseSettings'
'#microsoft.graph.security.filePlanDescriptor': '#/components/schemas/microsoft.graph.security.filePlanDescriptor'
'#microsoft.graph.security.filePlanDescriptorTemplate': >-
#/components/schemas/microsoft.graph.security.filePlanDescriptorTemplate
'#microsoft.graph.security.authorityTemplate': '#/components/schemas/microsoft.graph.security.authorityTemplate'
'#microsoft.graph.security.categoryTemplate': '#/components/schemas/microsoft.graph.security.categoryTemplate'
'#microsoft.graph.security.citationTemplate': '#/components/schemas/microsoft.graph.security.citationTemplate'
'#microsoft.graph.security.departmentTemplate': '#/components/schemas/microsoft.graph.security.departmentTemplate'
'#microsoft.graph.security.filePlanReferenceTemplate': >-
#/components/schemas/microsoft.graph.security.filePlanReferenceTemplate
'#microsoft.graph.security.subcategoryTemplate': '#/components/schemas/microsoft.graph.security.subcategoryTemplate'
'#microsoft.graph.security.healthIssue': '#/components/schemas/microsoft.graph.security.healthIssue'
'#microsoft.graph.security.hostPair': '#/components/schemas/microsoft.graph.security.hostPair'
'#microsoft.graph.security.hostPort': '#/components/schemas/microsoft.graph.security.hostPort'
'#microsoft.graph.security.hostReputation': '#/components/schemas/microsoft.graph.security.hostReputation'
'#microsoft.graph.security.identityAccounts': '#/components/schemas/microsoft.graph.security.identityAccounts'
'#microsoft.graph.security.user': '#/components/schemas/microsoft.graph.security.user'
'#microsoft.graph.security.identityContainer': '#/components/schemas/microsoft.graph.security.identityContainer'
'#microsoft.graph.security.incident': '#/components/schemas/microsoft.graph.security.incident'
'#microsoft.graph.security.indicator': '#/components/schemas/microsoft.graph.security.indicator'
'#microsoft.graph.security.articleIndicator': '#/components/schemas/microsoft.graph.security.articleIndicator'
'#microsoft.graph.security.intelligenceProfileIndicator': >-
#/components/schemas/microsoft.graph.security.intelligenceProfileIndicator
'#microsoft.graph.security.intelligenceProfile': '#/components/schemas/microsoft.graph.security.intelligenceProfile'
'#microsoft.graph.security.labelsRoot': '#/components/schemas/microsoft.graph.security.labelsRoot'
'#microsoft.graph.security.networkAdapter': '#/components/schemas/microsoft.graph.security.networkAdapter'
'#microsoft.graph.security.retentionEvent': '#/components/schemas/microsoft.graph.security.retentionEvent'
'#microsoft.graph.security.retentionEventType': '#/components/schemas/microsoft.graph.security.retentionEventType'
'#microsoft.graph.security.retentionLabel': '#/components/schemas/microsoft.graph.security.retentionLabel'
'#microsoft.graph.security.search': '#/components/schemas/microsoft.graph.security.search'
'#microsoft.graph.security.ediscoveryReviewSetQuery': >-
#/components/schemas/microsoft.graph.security.ediscoveryReviewSetQuery
'#microsoft.graph.security.ediscoverySearch': '#/components/schemas/microsoft.graph.security.ediscoverySearch'
'#microsoft.graph.security.sensor': '#/components/schemas/microsoft.graph.security.sensor'
'#microsoft.graph.security.sensorCandidate': '#/components/schemas/microsoft.graph.security.sensorCandidate'
'#microsoft.graph.security.sensorCandidateActivationConfiguration': >-
#/components/schemas/microsoft.graph.security.sensorCandidateActivationConfiguration
'#microsoft.graph.security.subdomain': '#/components/schemas/microsoft.graph.security.subdomain'
'#microsoft.graph.security.tag': '#/components/schemas/microsoft.graph.security.tag'
'#microsoft.graph.security.ediscoveryReviewTag': '#/components/schemas/microsoft.graph.security.ediscoveryReviewTag'
'#microsoft.graph.security.threatIntelligence': '#/components/schemas/microsoft.graph.security.threatIntelligence'
'#microsoft.graph.security.triggersRoot': '#/components/schemas/microsoft.graph.security.triggersRoot'
'#microsoft.graph.security.triggerTypesRoot': '#/components/schemas/microsoft.graph.security.triggerTypesRoot'
'#microsoft.graph.security.vulnerability': '#/components/schemas/microsoft.graph.security.vulnerability'
'#microsoft.graph.security.vulnerabilityComponent': '#/components/schemas/microsoft.graph.security.vulnerabilityComponent'
'#microsoft.graph.security.whoisBaseRecord': '#/components/schemas/microsoft.graph.security.whoisBaseRecord'
'#microsoft.graph.security.whoisHistoryRecord': '#/components/schemas/microsoft.graph.security.whoisHistoryRecord'
'#microsoft.graph.security.whoisRecord': '#/components/schemas/microsoft.graph.security.whoisRecord'
'#microsoft.graph.termStore.group': '#/components/schemas/microsoft.graph.termStore.group'
'#microsoft.graph.termStore.relation': '#/components/schemas/microsoft.graph.termStore.relation'
'#microsoft.graph.termStore.set': '#/components/schemas/microsoft.graph.termStore.set'
'#microsoft.graph.termStore.store': '#/components/schemas/microsoft.graph.termStore.store'
'#microsoft.graph.termStore.term': '#/components/schemas/microsoft.graph.termStore.term'
microsoft.graph.trending:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: trending
required:
- '@odata.type'
type: object
properties:
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
resourceReference:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.resourceReference'
- type: object
nullable: true
description: >-
Reference properties of the trending document, such as the url
and type of the document.
readOnly: true
resourceVisualization:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.resourceVisualization'
- type: object
nullable: true
description: >-
Properties that you can use to visualize the document in your
experience.
readOnly: true
weight:
oneOf:
- type: number
format: double
nullable: true
- type: string
nullable: true
- $ref: '#/components/schemas/ReferenceNumeric'
description: >-
Value indicating how much the document is currently trending.
The larger the number, the more the document is currently
trending around the user (the more relevant it is). Returned
documents are sorted by this value.
resource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- type: object
nullable: true
description: Used for navigating to the trending document.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.trending'
microsoft.graph.usedInsight:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: usedInsight
required:
- '@odata.type'
type: object
properties:
lastUsed:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.usageDetails'
- type: object
nullable: true
description: >-
Information about when the item was last viewed or modified by
the user. Read-only.
resourceReference:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.resourceReference'
- type: object
nullable: true
description: >-
Reference properties of the used document, such as the URL and
type of the document. Read-only
readOnly: true
resourceVisualization:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.resourceVisualization'
- type: object
nullable: true
description: >-
Properties that you can use to visualize the document in your
experience. Read-only
readOnly: true
resource:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- type: object
nullable: true
description: >-
Used for navigating to the item that was used. For file
attachments, the type is fileAttachment. For linked attachments,
the type is driveItem.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.usedInsight'
microsoft.graph.team:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: team
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamFunSettings'
- type: object
nullable: true
description: >-
Settings to configure use of Giphy, memes, and stickers in the
team.
guestSettings:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamGuestSettings'
- type: object
nullable: true
description: >-
Settings to configure whether guests can create, update, or
delete channels in the team.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamMemberSettings'
- type: object
nullable: true
description: >-
Settings to configure whether members can perform certain
actions, for example, create channels and add bots, in the team.
messagingSettings:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamMessagingSettings'
- type: object
nullable: true
description: Settings to configure messaging and mentions in the team.
specialization:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamSpecialization'
- type: object
nullable: true
description: >-
Optional. Indicates whether the team is intended for a
particular use case. Each team specialization has access to
unique behaviors and experiences targeted to its use case.
summary:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamSummary'
- type: object
nullable: true
description: >-
Contains summary information about the team, including number of
owners, members, and guests.
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
visibility:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
- type: object
nullable: true
description: The visibility of the group and team. Defaults to Public.
webUrl:
type: string
description: >-
A hyperlink that goes to the team in the Microsoft Teams client.
You get this URL when you right-click a team in the Microsoft
Teams client and select Get link to team. This URL should be
treated as an opaque blob, and not parsed.
nullable: true
allChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: >-
List of channels either hosted in or shared with the team
(incoming channels).
x-ms-navigationProperty: true
channels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: >-
The collection of channels and messages associated with the
team.
x-ms-navigationProperty: true
group:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.group'
- type: object
nullable: true
x-ms-navigationProperty: true
incomingChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels shared with the team.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: The apps installed in this team.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: Members and owners of the team.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
description: The async operations that ran or are running on this team.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
description: A collection of permissions granted to apps to access the team.
x-ms-navigationProperty: true
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- type: object
nullable: true
description: The profile photo for the team.
x-ms-navigationProperty: true
primaryChannel:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.channel'
- type: object
nullable: true
description: The general channel for the team.
x-ms-navigationProperty: true
schedule:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.schedule'
- type: object
nullable: true
description: The schedule of shifts for this team.
x-ms-navigationProperty: true
tags:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
description: The tags associated with the team.
x-ms-navigationProperty: true
template:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamsTemplate'
- type: object
nullable: true
description: >-
The template this team was created from. See available
templates.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.team'
microsoft.graph.channel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: channel
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.channelMembershipType'
- type: object
nullable: true
description: >-
The type of the channel. Can be set during creation and can't be
changed. The possible values are: standard, private,
unknownFutureValue, shared. The default value is standard. Use
the Prefer: include-unknown-enum-members request header to get
the following members in this evolvable enum: shared.
summary:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.channelSummary'
- type: object
nullable: true
description: >-
Contains summary information about the channel, including number
of owners, members, guests, and an indicator for members from
other tenants. The summary property will only be returned if it
is specified in the $select clause of the Get channel method.
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
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: >-
A collection of membership records associated with the channel,
including both direct and indirect members of shared channels.
x-ms-navigationProperty: true
filesFolder:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
- type: object
nullable: true
description: Metadata for the location where the channel's files are stored.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of membership records associated with the channel.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: >-
A collection of all the messages in the channel. A navigation
property. Nullable.
x-ms-navigationProperty: true
sharedWithTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
description: A collection of teams with which a channel is shared.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: >-
A collection of all the tabs in the channel. A navigation
property.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.channel'
microsoft.graph.driveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: driveItem
required:
- '@odata.type'
type: object
properties:
audio:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.audio'
- type: object
nullable: true
description: >-
Audio metadata, if the item is an audio file. Read-only.
Read-only. Only on OneDrive Personal.
bundle:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.bundle'
- type: object
nullable: true
description: Bundle metadata, if the item is a bundle. Read-only.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.deleted'
- type: object
nullable: true
description: Information about the deleted state of the item. Read-only.
file:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.file'
- type: object
nullable: true
description: File metadata, if the item is a file. Read-only.
fileSystemInfo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
- type: object
nullable: true
description: File system information on client. Read-write.
folder:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.folder'
- type: object
nullable: true
description: Folder metadata, if the item is a folder. Read-only.
image:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.image'
- type: object
nullable: true
description: Image metadata, if the item is an image. Read-only.
location:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.geoCoordinates'
- type: object
nullable: true
description: Location metadata, if the item has location data. Read-only.
malware:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.malware'
- type: object
nullable: true
description: >-
Malware metadata, if the item was detected to contain malware.
Read-only.
package:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.package'
- type: object
nullable: true
description: >-
If present, indicates that this item is a package instead of a
folder or file. Packages are treated like files in some contexts
and folders in others. Read-only.
pendingOperations:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.pendingOperations'
- type: object
nullable: true
description: >-
If present, indicates that one or more operations that might
affect the state of the driveItem are pending completion.
Read-only.
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.photo'
- type: object
nullable: true
description: Photo metadata, if the item is a photo. Read-only.
publication:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.publicationFacet'
- type: object
nullable: true
description: >-
Provides information about the published or checked-out state of
an item, in locations that support such actions. This property
isn't returned by default. Read-only.
remoteItem:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.remoteItem'
- type: object
nullable: true
description: >-
Remote item data, if the item is shared from a drive other than
the one being accessed. Read-only.
root:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.root'
- type: object
nullable: true
description: >-
If this property is non-null, it indicates that the driveItem is
the top-most driveItem in the drive.
searchResult:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.searchResult'
- type: object
nullable: true
description: Search metadata, if the item is from a search result. Read-only.
shared:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.shared'
- type: object
nullable: true
description: >-
Indicates that the item was shared with others and provides
information about the shared state of the item. Read-only.
sharepointIds:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
- type: object
nullable: true
description: >-
Returns identifiers useful for SharePoint REST compatibility.
Read-only.
size:
type: number
description: Size of the item in bytes. Read-only.
format: int64
nullable: true
specialFolder:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.specialFolder'
- type: object
nullable: true
description: >-
If the current item is also available as a special folder, this
facet is returned. Read-only.
video:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.video'
- type: object
nullable: true
description: Video metadata, if the item is a video. Read-only.
webDavUrl:
type: string
description: WebDAV compatible URL for the item.
nullable: true
analytics:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemAnalytics'
- type: object
nullable: true
description: >-
Analytics about the view activities that took place on this
item.
x-ms-navigationProperty: true
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: >-
Collection containing Item objects for the immediate children of
Item. Only items representing folders have children. Read-only.
Nullable.
x-ms-navigationProperty: true
listItem:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.listItem'
- type: object
nullable: true
description: >-
For drives in SharePoint, the associated document library list
item. Read-only. Nullable.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
retentionLabel:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemRetentionLabel'
- type: object
nullable: true
description: >-
Information about retention label and settings enforced on the
driveItem. Read-write.
x-ms-navigationProperty: true
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: >-
The set of subscriptions on the item. Only supported on the root
of a drive.
x-ms-navigationProperty: true
thumbnails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.thumbnailSet'
description: >-
Collection of thumbnailSet objects associated with the item. For
more information, see getting thumbnails. Read-only. Nullable.
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItemVersion'
description: >-
The list of previous versions of the item. For more info, see
getting previous versions. Read-only. Nullable.
x-ms-navigationProperty: true
workbook:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbook'
- type: object
nullable: true
description: >-
For files that are Excel spreadsheets, access to the workbook
API to work with the spreadsheet's contents. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.driveItem'
x-ms-discriminator-value: '#microsoft.graph.driveItem'
microsoft.graph.sharedWithChannelTeamInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamInfo'
- title: sharedWithChannelTeamInfo
required:
- '@odata.type'
type: object
properties:
isHostTeam:
type: boolean
description: Indicates whether the team is the host of the channel.
nullable: true
allowedMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: >-
A collection of team members who have access to the shared
channel.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.sharedWithChannelTeamInfo'
microsoft.graph.group:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: group
required:
- '@odata.type'
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
items:
$ref: '#/components/schemas/microsoft.graph.assignedLabel'
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.
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: >-
The licenses that are assigned to the group. Returned only on
$select. Supports $filter (eq). Read-only.
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
items:
type: string
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).
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.licenseProcessingState'
- type: object
nullable: true
description: >-
Indicates the status of the group license assignment to all
group members. The default value is false. Read-only. Possible
values: QueuedForProcessing, ProcessingInProgress, and
ProcessingComplete.Returned only on $select. Read-only.
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
items:
$ref: >-
#/components/schemas/microsoft.graph.onPremisesProvisioningError
description: >-
Errors when using Microsoft synchronization product during
provisioning. Returned by default. Supports $filter (eq, not).
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
items:
type: string
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).
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
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: >-
Errors published by a federated service describing a
nontransient, service-specific error regarding the properties or
link from a group object. Supports $filter (eq, not, for
isResolved and serviceInstance).
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. The 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
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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.
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: >-
Represents the app roles granted to a group for an application.
Supports $expand.
x-ms-navigationProperty: true
calendar:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.calendar'
- type: object
nullable: true
description: The group's calendar. Read-only.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only.
x-ms-navigationProperty: true
conversations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversation'
description: The group's conversations.
x-ms-navigationProperty: true
createdOnBehalfOf:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- type: object
nullable: true
description: >-
The user (or application) that created the group. NOTE: This
property isn't set if the user is an administrator. Read-only.
x-ms-navigationProperty: true
drive:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.drive'
- type: object
nullable: true
description: The group's default drive. Read-only.
x-ms-navigationProperty: true
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The group's drives. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The group's calendar events.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the group.
Read-only. Nullable.
x-ms-navigationProperty: true
groupLifecyclePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
description: >-
The collection of lifecycle policies for this group. Read-only.
Nullable.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Groups that this group is a member of. HTTP Methods: GET
(supported for all groups). Read-only. Nullable. Supports
$expand.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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).
x-ms-navigationProperty: true
membersWithLicenseErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
A list of group members with license errors from this
group-based license assignment. Read-only.
x-ms-navigationProperty: true
onenote:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenote'
- type: object
nullable: true
x-ms-navigationProperty: true
onPremisesSyncBehavior:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onPremisesSyncBehavior'
- type: object
nullable: true
x-ms-navigationProperty: true
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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).
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant
x-ms-navigationProperty: true
photo:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- type: object
nullable: true
description: The group's profile photo
x-ms-navigationProperty: true
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: The profile photos owned by the group. Read-only. Nullable.
x-ms-navigationProperty: true
planner:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerGroup'
- type: object
nullable: true
description: >-
Entry-point to Planner resource that might exist for a Unified
Group.
x-ms-navigationProperty: true
rejectedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
The list of users or groups not allowed to create posts or
calendar events in this group. Nullable
x-ms-navigationProperty: true
settings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
description: >-
Settings that can govern this group's behavior, like whether
members can invite guests to the group. Nullable.
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: >-
The list of SharePoint sites in this group. Access the default
site with /sites/root.
x-ms-navigationProperty: true
team:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.team'
- type: object
nullable: true
description: The team associated with this group.
x-ms-navigationProperty: true
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
description: The group's conversation threads. Nullable.
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
The groups that a group is a member of, either directly or
through nested membership. Nullable.
x-ms-navigationProperty: true
transitiveMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The direct and transitive members of a group. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.group'
description: Represents a Microsoft Entra group.
x-ms-discriminator-value: '#microsoft.graph.group'
microsoft.graph.teamVisibilityType:
title: teamVisibilityType
enum:
- private
- public
- hiddenMembership
- unknownFutureValue
type: string
microsoft.graph.clonableTeamParts:
title: clonableTeamParts
enum:
- apps
- tabs
- settings
- channels
- members
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.teamsAsyncOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAsyncOperation
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.operationError'
- type: object
nullable: true
description: Any error that causes the async operation to fail.
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/microsoft.graph.teamsAsyncOperationType'
status:
$ref: '#/components/schemas/microsoft.graph.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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamsAsyncOperation'
microsoft.graph.schedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: schedule
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.operationStatus'
- type: object
nullable: true
description: >-
The status of the schedule provisioning. The possible values are
notStarted, running, completed, failed.
readOnly: true
provisionStatusCode:
type: string
description: Additional information about why schedule provisioning failed.
nullable: true
readOnly: true
startDayOfWeek:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dayOfWeek'
- type: object
nullable: true
description: >-
Indicates the start day of the week. The possible values are:
sunday, monday, tuesday, wednesday, thursday, friday, saturday.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeClockSettings'
- type: object
nullable: true
description: The time clock location settings for this schedule.
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
items:
type: string
nullable: true
description: >-
The IDs for the workforce integrations associated with this
schedule.
dayNotes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayNote'
description: The day notes in the schedule.
x-ms-navigationProperty: true
offerShiftRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
description: The offer requests for shifts in the schedule.
x-ms-navigationProperty: true
openShiftChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
description: The open shift requests in the schedule.
x-ms-navigationProperty: true
openShifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShift'
description: The set of open shifts in a scheduling group in the schedule.
x-ms-navigationProperty: true
schedulingGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
description: The logical grouping of users in the schedule (usually by role).
x-ms-navigationProperty: true
shifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shift'
description: The shifts in the schedule.
x-ms-navigationProperty: true
swapShiftsChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
description: The swap requests for shifts in the schedule.
x-ms-navigationProperty: true
timeCards:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeCard'
description: The time cards in the schedule.
x-ms-navigationProperty: true
timeOffReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
description: The set of reasons for a time off in the schedule.
x-ms-navigationProperty: true
timeOffRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
description: The time off requests in the schedule.
x-ms-navigationProperty: true
timesOff:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOff'
description: The instances of times off in the schedule.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.schedule'
microsoft.graph.dayNote:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: dayNote
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: >-
The draft version of this day note that is viewable by managers.
Only contentType text is supported.
sharedDayNote:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: >-
The shared version of this day note that is viewable by both
employees and managers. Only contentType text is supported.
'@odata.type':
type: string
default: '#microsoft.graph.dayNote'
x-ms-discriminator-value: '#microsoft.graph.dayNote'
microsoft.graph.offerShiftRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleChangeRequest'
- title: offerShiftRequest
required:
- '@odata.type'
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
'@odata.type':
type: string
default: '#microsoft.graph.offerShiftRequest'
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.swapShiftsChangeRequest': '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
microsoft.graph.openShiftChangeRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleChangeRequest'
- title: openShiftChangeRequest
required:
- '@odata.type'
type: object
properties:
openShiftId:
type: string
description: ID for the open shift.
nullable: true
'@odata.type':
type: string
default: '#microsoft.graph.openShiftChangeRequest'
x-ms-discriminator-value: '#microsoft.graph.openShiftChangeRequest'
microsoft.graph.openShift:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: openShift
required:
- '@odata.type'
type: object
properties:
draftOpenShift:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.openShiftItem'
- type: object
nullable: true
description: >-
Draft changes in the openShift are only visible to managers
until they're shared.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.openShiftItem'
- type: object
nullable: true
description: >-
The shared version of this openShift that is viewable by both
employees and managers.
'@odata.type':
type: string
default: '#microsoft.graph.openShift'
x-ms-discriminator-value: '#microsoft.graph.openShift'
microsoft.graph.schedulingGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: schedulingGroup
required:
- '@odata.type'
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
items:
type: string
nullable: true
description: >-
The list of user IDs that are a member of the schedulingGroup.
Required.
'@odata.type':
type: string
default: '#microsoft.graph.schedulingGroup'
x-ms-discriminator-value: '#microsoft.graph.schedulingGroup'
microsoft.graph.shift:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: shift
required:
- '@odata.type'
type: object
properties:
draftShift:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.shiftItem'
- type: object
nullable: true
description: >-
Draft changes in the shift. Draft changes are only visible to
managers. The changes are visible to employees when they're
shared, which copies the changes from the draftShift to the
sharedShift property.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.shiftItem'
- type: object
nullable: true
description: >-
The shared version of this shift that is viewable by both
employees and managers. Updates to the sharedShift property send
notifications to users in the Teams client.
userId:
type: string
description: ID of the user assigned to the shift. Required.
nullable: true
'@odata.type':
type: string
default: '#microsoft.graph.shift'
x-ms-discriminator-value: '#microsoft.graph.shift'
microsoft.graph.swapShiftsChangeRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
- title: swapShiftsChangeRequest
required:
- '@odata.type'
type: object
properties:
recipientShiftId:
type: string
description: The recipient's Shift ID
nullable: true
'@odata.type':
type: string
default: '#microsoft.graph.swapShiftsChangeRequest'
x-ms-discriminator-value: '#microsoft.graph.swapShiftsChangeRequest'
microsoft.graph.timeCard:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: timeCard
required:
- '@odata.type'
type: object
properties:
breaks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeCardBreak'
description: The list of breaks associated with the timeCard.
clockInEvent:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCardEvent'
- type: object
nullable: true
description: The clock-in event of the timeCard.
clockOutEvent:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCardEvent'
- type: object
nullable: true
description: The clock-out event of the timeCard.
confirmedBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.confirmedBy'
- type: object
nullable: true
description: >-
Indicates whether this timeCard entry is confirmed. The possible
values are: none, user, manager, unknownFutureValue.
notes:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: Notes about the timeCard.
originalEntry:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCardEntry'
- type: object
nullable: true
description: The original timeCardEntry of the timeCard before it was edited.
state:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeCardState'
- type: object
nullable: true
description: >-
The current state of the timeCard during its life cycle. The
possible values are: clockedIn, onBreak, clockedOut,
unknownFutureValue.
userId:
type: string
description: User ID to which the timeCard belongs.
nullable: true
'@odata.type':
type: string
default: '#microsoft.graph.timeCard'
x-ms-discriminator-value: '#microsoft.graph.timeCard'
microsoft.graph.timeOffReason:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: timeOffReason
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeOffReasonIconType'
- type: object
nullable: true
description: >-
Supported icon types are: none, car, calendar, running, plane,
firstAid, doctor, notWorking, clock, juryDuty, globe, cup,
phone, weather, umbrella, piggyBank, dog, cake, trafficCone,
pin, sunny. Required.
isActive:
type: boolean
description: >-
Indicates whether the timeOffReason can be used when creating
new entities or updating existing ones. Required.
nullable: true
'@odata.type':
type: string
default: '#microsoft.graph.timeOffReason'
x-ms-discriminator-value: '#microsoft.graph.timeOffReason'
microsoft.graph.timeOffRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleChangeRequest'
- title: timeOffRequest
required:
- '@odata.type'
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
'@odata.type':
type: string
default: '#microsoft.graph.timeOffRequest'
x-ms-discriminator-value: '#microsoft.graph.timeOffRequest'
microsoft.graph.timeOff:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: timeOff
required:
- '@odata.type'
type: object
properties:
draftTimeOff:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeOffItem'
- type: object
nullable: true
description: >-
The draft version of this timeOff item that is viewable by
managers. It must be shared before it's visible to team members.
Required.
isStagedForDeletion:
type: boolean
description: >-
The timeOff is marked for deletion, a process that is finalized
when the schedule is shared.
nullable: true
sharedTimeOff:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.timeOffItem'
- type: object
nullable: true
description: >-
The shared version of this timeOff that is viewable by both
employees and managers. Updates to the sharedTimeOff property
send notifications to users in the Teams client. Required.
userId:
type: string
description: ID of the user assigned to the timeOff. Required.
nullable: true
'@odata.type':
type: string
default: '#microsoft.graph.timeOff'
x-ms-discriminator-value: '#microsoft.graph.timeOff'
microsoft.graph.teamworkTag:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkTag
required:
- '@odata.type'
type: object
properties:
description:
type: string
description: >-
The description of the tag as it appears to the user in
Microsoft Teams. A teamworkTag can't have more than 200
teamworkTagMembers.
nullable: true
displayName:
type: string
description: >-
The name of the tag as it appears to the user in Microsoft
Teams.
nullable: true
memberCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of users assigned to the tag.
format: int32
nullable: true
tagType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.teamworkTagType'
- type: object
nullable: true
description: The type of the tag. Default is standard.
teamId:
type: string
description: ID of the team in which the tag is defined.
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
description: Users assigned to the tag.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamworkTag'
microsoft.graph.teamworkTagMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkTagMember
required:
- '@odata.type'
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamworkTagMember'
microsoft.graph.teamsTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTemplate
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamsTemplate'
microsoft.graph.licenseDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: licenseDetails
required:
- '@odata.type'
type: object
properties:
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePlanInfo'
description: >-
Information about the service plans assigned with the license.
Read-only. Not nullable.
skuId:
pattern: >-
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
type: string
description: >-
Unique identifier (GUID) for the service SKU. Equal to the skuId
property on the related subscribedSku object. Read-only.
format: uuid
nullable: true
skuPartNumber:
type: string
description: >-
Unique SKU display name. Equal to the skuPartNumber on the
related subscribedSku object; for example, AAD_Premium.
Read-only.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.licenseDetails'
microsoft.graph.teamsLicensingDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsLicensingDetails
required:
- '@odata.type'
type: object
properties:
hasTeamsLicense:
type: boolean
description: >-
Indicates whether the user has a valid license to use Microsoft
Teams.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.teamsLicensingDetails'
microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: mailFolder
required:
- '@odata.type'
type: object
properties:
childFolderCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: >-
The number of immediate child mailFolders in the current
mailFolder.
format: int32
nullable: true
displayName:
type: string
description: The mailFolder's display name.
nullable: true
isHidden:
type: boolean
description: >-
Indicates whether the mailFolder is hidden. This property can be
set only when creating the folder. Find more information in
Hidden mail folders.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the mailFolder's parent mailFolder.
nullable: true
totalItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder.
format: int32
nullable: true
unreadItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder marked as unread.
format: int32
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The collection of child folders in the mailFolder.
x-ms-navigationProperty: true
messageRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.messageRule'
description: The collection of rules that apply to the user's Inbox folder.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The collection of messages in the mailFolder.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty
description: >-
The collection of multi-value extended properties defined for
the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty
description: >-
The collection of single-value extended properties defined for
the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.mailSearchFolder': '#/components/schemas/microsoft.graph.mailSearchFolder'
microsoft.graph.messageRule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: messageRule
required:
- '@odata.type'
type: object
properties:
actions:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.messageRuleActions'
- type: object
nullable: true
description: >-
Actions to be taken on a message when the corresponding
conditions are fulfilled.
conditions:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
- type: object
nullable: true
description: >-
Conditions that when fulfilled trigger the corresponding actions
for that rule.
displayName:
type: string
description: The display name of the rule.
nullable: true
exceptions:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
- type: object
nullable: true
description: Exception conditions for the rule.
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.messageRule'
microsoft.graph.message:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: message
required:
- '@odata.type'
type: object
properties:
bccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Bcc: recipients for the message.'
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: >-
The body of the message. It can be in HTML or text format. Find
out about safe HTML in a message body.
bodyPreview:
type: string
description: >-
The first 255 characters of the message body. It is in text
format.
nullable: true
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the message.'
conversationId:
type: string
description: The ID of the conversation the email belongs to.
nullable: true
conversationIndex:
type: string
description: Indicates the position of the message within the conversation.
format: base64url
nullable: true
flag:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.followupFlag'
- type: object
nullable: true
description: >-
Indicates the status, start date, due date, or completion date
for the message.
from:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- type: object
nullable: true
description: >-
The owner of the mailbox from which the message is sent. In most
cases, this value is the same as the sender property, except for
sharing or delegation scenarios. The value must correspond to
the actual mailbox used. Find out more about setting the from
and sender properties of a message.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.importance'
- type: object
nullable: true
description: >-
The importance of the message. The possible values are: low,
normal, and high.
inferenceClassification:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.inferenceClassificationType
- type: object
nullable: true
description: >-
The classification of the message for the user, based on
inferred relevance or importance, or on an explicit override.
The possible values are: focused or other.
internetMessageHeaders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
description: >-
A collection of message headers defined by RFC5322. The set
includes message headers indicating the network path taken by a
message from the sender to the recipient. It can also contain
custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
internetMessageId:
type: string
description: The message ID in the format specified by RFC2822.
nullable: true
isDeliveryReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
isDraft:
type: boolean
description: >-
Indicates whether the message is a draft. A message is a draft
if it hasn't been sent yet.
nullable: true
isRead:
type: boolean
description: Indicates whether the message has been read.
nullable: true
isReadReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the message's parent mailFolder.
nullable: true
receivedDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The date and time the message was received. The date and time
information uses ISO 8601 format and is always in UTC time. For
example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
format: date-time
nullable: true
replyTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses to use when replying.
sender:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- type: object
nullable: true
description: >-
The account that is used to generate the message. In most cases,
this value is the same as the from property. You can set this
property to a different value when sending a message from a
shared mailbox, for a shared calendar, or as a delegate. In any
case, the value must correspond to the actual mailbox used. Find
out more about setting the from and sender properties of a
message.
sentDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The date and time the message was sent. The date and time
information uses ISO 8601 format and is always in UTC time. For
example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
format: date-time
nullable: true
subject:
type: string
description: The subject of the message.
nullable: true
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the message.'
uniqueBody:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: >-
The part of the body of the message that is unique to the
current message. uniqueBody is not returned by default but can
be retrieved for a given message by use of the
?$select=uniqueBody query. It can be in HTML or text format.
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.NOTE:
When using this URL to access a message from a mailbox with
delegate permissions, both the signed-in user and the target
mailbox must be in the same database region. For example, an
error is returned when a user with a mailbox in the EUR (Europe)
region attempts to access messages from a mailbox in the NAM
(North America) region.
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: >-
The fileAttachment and itemAttachment attachments for the
message.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the message.
Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty
description: >-
The collection of multi-value extended properties defined for
the message. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty
description: >-
The collection of single-value extended properties defined for
the message. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.message'
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.calendarSharingMessage': '#/components/schemas/microsoft.graph.calendarSharingMessage'
'#microsoft.graph.eventMessage': '#/components/schemas/microsoft.graph.eventMessage'
'#microsoft.graph.eventMessageRequest': '#/components/schemas/microsoft.graph.eventMessageRequest'
'#microsoft.graph.eventMessageResponse': '#/components/schemas/microsoft.graph.eventMessageResponse'
microsoft.graph.managedAppRegistration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppRegistration
required:
- '@odata.type'
type: object
properties:
appIdentifier:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
- type: object
nullable: true
description: The app package Identifier
applicationVersion:
type: string
description: App version
nullable: true
createdDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: Date and time of creation
format: date-time
deviceName:
type: string
description: Host device name
nullable: true
deviceTag:
type: string
description: >-
App management SDK generated tag, which helps relate apps hosted
on the same device. Not guaranteed to relate apps in all
conditions.
nullable: true
deviceType:
type: string
description: Host device type
nullable: true
flaggedReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppFlaggedReason'
description: >-
Zero or more reasons an app registration is flagged. E.g. app
running on rooted device
lastSyncDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: Date and time of last the app synced with management service.
format: date-time
managementSdkVersion:
type: string
description: App management SDK version
nullable: true
platformVersion:
type: string
description: Operating System version
nullable: true
userId:
type: string
description: The user Id to who this app registration belongs.
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
appliedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: >-
Zero or more policys already applied on the registered app when
it last synchronized with managment service.
x-ms-navigationProperty: true
intendedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policies admin intended for the app as of now.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppOperation'
description: >-
Zero or more long running operations triggered on the app
registration.
x-ms-navigationProperty: true
'@odata.type':
type: string
description: >-
The ManagedAppEntity is the base entity type for all other entity
types under app management workflow.
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.androidManagedAppRegistration': >-
#/components/schemas/microsoft.graph.androidManagedAppRegistration
'#microsoft.graph.iosManagedAppRegistration': '#/components/schemas/microsoft.graph.iosManagedAppRegistration'
microsoft.graph.managedDevice:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedDevice
required:
- '@odata.type'
type: object
properties:
activationLockBypassCode:
type: string
description: >-
The code that allows the Activation Lock on managed device to be
bypassed. Default, is Null (Non-Default property) for this
property when returned as part of managedDevice entity in LIST
call. To retrieve actual values GET call needs to be made, with
device id and included in select parameter. Supports: $select.
$Search is not supported. Read-only. This property is read-only.
nullable: true
readOnly: true
androidSecurityPatchLevel:
type: string
description: Android security patch level. This property is read-only.
nullable: true
readOnly: true
azureADDeviceId:
type: string
description: >-
The unique identifier for the Azure Active Directory device.
Read only. This property is read-only.
nullable: true
readOnly: true
azureADRegistered:
type: boolean
description: >-
Whether the device is Azure Active Directory registered. This
property is read-only.
nullable: true
readOnly: true
complianceGracePeriodExpirationDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The DateTime when device compliance grace period expires. This
property is read-only.
format: date-time
readOnly: true
complianceState:
$ref: '#/components/schemas/microsoft.graph.complianceState'
configurationManagerClientEnabledFeatures:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.configurationManagerClientEnabledFeatures
- type: object
nullable: true
description: ConfigrMgr client enabled features. This property is read-only.
readOnly: true
deviceActionResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceActionResult'
description: >-
List of ComplexType deviceActionResult objects. This property is
read-only.
readOnly: true
deviceCategoryDisplayName:
type: string
description: >-
Device category display name. Default is an empty string.
Supports $filter operator 'eq' and 'or'. This property is
read-only.
nullable: true
readOnly: true
deviceEnrollmentType:
$ref: '#/components/schemas/microsoft.graph.deviceEnrollmentType'
deviceHealthAttestationState:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.deviceHealthAttestationState
- type: object
nullable: true
description: The device health attestation state. This property is read-only.
readOnly: true
deviceName:
type: string
description: Name of the device. This property is read-only.
nullable: true
readOnly: true
deviceRegistrationState:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationState'
easActivated:
type: boolean
description: >-
Whether the device is Exchange ActiveSync activated. This
property is read-only.
readOnly: true
easActivationDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Exchange ActivationSync activation time of the device. This
property is read-only.
format: date-time
readOnly: true
easDeviceId:
type: string
description: >-
Exchange ActiveSync Id of the device. This property is
read-only.
nullable: true
readOnly: true
emailAddress:
type: string
description: >-
Email(s) for the user associated with the device. This property
is read-only.
nullable: true
readOnly: true
enrolledDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Enrollment time of the device. Supports $filter operator 'lt'
and 'gt'. This property is read-only.
format: date-time
readOnly: true
enrollmentProfileName:
type: string
description: >-
Name of the enrollment profile assigned to the device. Default
value is empty string, indicating no enrollment profile was
assgined. This property is read-only.
nullable: true
readOnly: true
ethernetMacAddress:
type: string
description: >-
Indicates Ethernet MAC Address of the device. Default, is Null
(Non-Default property) for this property when returned as part
of managedDevice entity. Individual get call with select query
options is needed to retrieve actual values. Example:
deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress
Supports: $select. $Search is not supported. Read-only. This
property is read-only.
nullable: true
readOnly: true
exchangeAccessState:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementExchangeAccessState
exchangeAccessStateReason:
$ref: >-
#/components/schemas/microsoft.graph.deviceManagementExchangeAccessStateReason
exchangeLastSuccessfulSyncDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Last time the device contacted Exchange. This property is
read-only.
format: date-time
readOnly: true
freeStorageSpaceInBytes:
type: number
description: >-
Free Storage in Bytes. Default value is 0. Read-only. This
property is read-only.
format: int64
readOnly: true
iccid:
type: string
description: >-
Integrated Circuit Card Identifier, it is A SIM card's unique
identification number. Default is an empty string. To retrieve
actual values GET call needs to be made, with device id and
included in select parameter. Supports: $select. $Search is not
supported. Read-only. This property is read-only.
nullable: true
readOnly: true
imei:
type: string
description: IMEI. This property is read-only.
nullable: true
readOnly: true
isEncrypted:
type: boolean
description: Device encryption status. This property is read-only.
readOnly: true
isSupervised:
type: boolean
description: Device supervised status. This property is read-only.
readOnly: true
jailBroken:
type: string
description: >-
Whether the device is jail broken or rooted. Default is an empty
string. Supports $filter operator 'eq' and 'or'. This property
is read-only.
nullable: true
readOnly: true
lastSyncDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The date and time that the device last completed a successful
sync with Intune. Supports $filter operator 'lt' and 'gt'. This
property is read-only.
format: date-time
readOnly: true
managedDeviceName:
type: string
description: >-
Automatically generated name to identify a device. Can be
overwritten to a user friendly name.
nullable: true
managedDeviceOwnerType:
$ref: '#/components/schemas/microsoft.graph.managedDeviceOwnerType'
managementAgent:
$ref: '#/components/schemas/microsoft.graph.managementAgentType'
managementCertificateExpirationDate:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
Reports device management certificate expiration date. This
property is read-only.
format: date-time
readOnly: true
managementState:
$ref: '#/components/schemas/microsoft.graph.managementState'
manufacturer:
type: string
description: Manufacturer of the device. This property is read-only.
nullable: true
readOnly: true
meid:
type: string
description: MEID. This property is read-only.
nullable: true
readOnly: true
model:
type: string
description: Model of the device. This property is read-only.
nullable: true
readOnly: true
notes:
type: string
description: >-
Notes on the device created by IT Admin. Default is null. To
retrieve actual values GET call needs to be made, with device id
and included in select parameter. Supports: $select. $Search is
not supported.
nullable: true
operatingSystem:
type: string
description: >-
Operating system of the device. Windows, iOS, etc. This property
is read-only.
nullable: true
readOnly: true
osVersion:
type: string
description: >-
Operating system version of the device. This property is
read-only.
nullable: true
readOnly: true
partnerReportedThreatState:
$ref: >-
#/components/schemas/microsoft.graph.managedDevicePartnerReportedHealthState
phoneNumber:
type: string
description: Phone number of the device. This property is read-only.
nullable: true
readOnly: true
physicalMemoryInBytes:
type: number
description: >-
Total Memory in Bytes. Default is 0. To retrieve actual values
GET call needs to be made, with device id and included in select
parameter. Supports: $select. Read-only. This property is
read-only.
format: int64
readOnly: true
remoteAssistanceSessionErrorDetails:
type: string
description: >-
An error string that identifies issues when creating Remote
Assistance session objects. This property is read-only.
nullable: true
readOnly: true
remoteAssistanceSessionUrl:
type: string
description: >-
Url that allows a Remote Assistance session to be established
with the device. Default is an empty string. To retrieve actual
values GET call needs to be made, with device id and included in
select parameter. This property is read-only.
nullable: true
readOnly: true
requireUserEnrollmentApproval:
type: boolean
description: >-
Reports if the managed iOS device is user approval enrollment.
This property is read-only.
nullable: true
readOnly: true
serialNumber:
type: string
description: SerialNumber. This property is read-only.
nullable: true
readOnly: true
subscriberCarrier:
type: string
description: Subscriber Carrier. This property is read-only.
nullable: true
readOnly: true
totalStorageSpaceInBytes:
type: number
description: Total Storage in Bytes. This property is read-only.
format: int64
readOnly: true
udid:
type: string
description: >-
Unique Device Identifier for iOS and macOS devices. Default is
an empty string. To retrieve actual values GET call needs to be
made, with device id and included in select parameter. Supports:
$select. $Search is not supported. Read-only. This property is
read-only.
nullable: true
readOnly: true
userDisplayName:
type: string
description: User display name. This property is read-only.
nullable: true
readOnly: true
userId:
type: string
description: >-
Unique Identifier for the user associated with the device. This
property is read-only.
nullable: true
readOnly: true
userPrincipalName:
type: string
description: Device user principal name. This property is read-only.
nullable: true
readOnly: true
wiFiMacAddress:
type: string
description: Wi-Fi MAC. This property is read-only.
nullable: true
readOnly: true
deviceCategory:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.deviceCategory'
- type: object
nullable: true
description: Device category
x-ms-navigationProperty: true
deviceCompliancePolicyStates:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.deviceCompliancePolicyState
description: Device compliance policy states for this device.
x-ms-navigationProperty: true
deviceConfigurationStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
description: Device configuration states for this device.
x-ms-navigationProperty: true
logCollectionRequests:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.deviceLogCollectionResponse
description: List of log collection requests
x-ms-navigationProperty: true
users:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
description: The primary users associated with the managed device.
x-ms-navigationProperty: true
windowsProtectionState:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.windowsProtectionState'
- type: object
nullable: true
description: The device protection status. This property is read-only.
x-ms-navigationProperty: true
'@odata.type':
type: string
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'.
x-ms-discriminator-value: '#microsoft.graph.managedDevice'
microsoft.graph.deviceCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCategory
required:
- '@odata.type'
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
'@odata.type':
type: string
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."
x-ms-discriminator-value: '#microsoft.graph.deviceCategory'
microsoft.graph.deviceCompliancePolicyState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCompliancePolicyState
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.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/microsoft.graph.deviceCompliancePolicySettingState
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the policy
format: int32
'@odata.type':
type: string
description: Device Compliance Policy State for a given device.
x-ms-discriminator-value: '#microsoft.graph.deviceCompliancePolicyState'
microsoft.graph.deviceConfigurationState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceConfigurationState
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.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/microsoft.graph.deviceConfigurationSettingState
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the policy
format: int32
'@odata.type':
type: string
description: >-
Support for this Entity is being deprecated starting May 2026 & will
no longer be supported.
x-ms-discriminator-value: '#microsoft.graph.deviceConfigurationState'
microsoft.graph.deviceLogCollectionResponse:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceLogCollectionResponse
required:
- '@odata.type'
type: object
properties:
enrolledByUser:
type: string
description: >-
The User Principal Name (UPN) of the user that enrolled the
device.
nullable: true
expirationDateTimeUTC:
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 of the expiration of the logs.
format: date-time
nullable: true
initiatedByUserPrincipalName:
type: string
description: The UPN for who initiated the request.
nullable: true
managedDeviceId:
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: Indicates Intune device unique identifier.
format: uuid
receivedDateTimeUTC:
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 the request was received.
format: date-time
nullable: true
requestedDateTimeUTC:
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 of the request.
format: date-time
nullable: true
sizeInKB:
oneOf:
- type: number
format: double
nullable: true
- type: string
nullable: true
- $ref: '#/components/schemas/ReferenceNumeric'
description: >-
The size of the logs in KB. Valid values -1.79769313486232E+308
to 1.79769313486232E+308
status:
$ref: '#/components/schemas/microsoft.graph.appLogUploadState'
'@odata.type':
type: string
description: Windows Log Collection request entity.
x-ms-discriminator-value: '#microsoft.graph.deviceLogCollectionResponse'
microsoft.graph.windowsProtectionState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsProtectionState
required:
- '@odata.type'
type: object
properties:
antiMalwareVersion:
type: string
description: Current anti malware version
nullable: true
deviceState:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.windowsDeviceHealthState
- type: object
nullable: true
description: >-
Indicates device's health state. The possible values are: clean,
fullScanPending, rebootPending, manualStepsPending,
offlineScanPending, critical. The possible values are: clean,
fullScanPending, rebootPending, manualStepsPending,
offlineScanPending, critical.
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.windowsDefenderProductStatus
- type: object
nullable: true
description: >-
Product Status of Windows Defender Antivirus. The possible
values are: noStatus, serviceNotRunning,
serviceStartedWithoutMalwareProtection,
pendingFullScanDueToThreatAction,
pendingRebootDueToThreatAction,
pendingManualStepsDueToThreatAction, avSignaturesOutOfDate,
asSignaturesOutOfDate, noQuickScanHappenedForSpecifiedPeriod,
noFullScanHappenedForSpecifiedPeriod,
systemInitiatedScanInProgress, systemInitiatedCleanInProgress,
samplesPendingSubmission, productRunningInEvaluationMode,
productRunningInNonGenuineMode, productExpired,
offlineScanRequired, serviceShutdownAsPartOfSystemShutdown,
threatRemediationFailedCritically,
threatRemediationFailedNonCritically, noStatusFlagsSet,
platformOutOfDate, platformUpdateInProgress,
platformAboutToBeOutdated,
signatureOrPlatformEndOfLifeIsPastOrIsImpending,
windowsSModeSignaturesInUseOnNonWin10SInstall. The possible
values are: noStatus, serviceNotRunning,
serviceStartedWithoutMalwareProtection,
pendingFullScanDueToThreatAction,
pendingRebootDueToThreatAction,
pendingManualStepsDueToThreatAction, avSignaturesOutOfDate,
asSignaturesOutOfDate, noQuickScanHappenedForSpecifiedPeriod,
noFullScanHappenedForSpecifiedPeriod,
systemInitiatedScanInProgress, systemInitiatedCleanInProgress,
samplesPendingSubmission, productRunningInEvaluationMode,
productRunningInNonGenuineMode, productExpired,
offlineScanRequired, serviceShutdownAsPartOfSystemShutdown,
threatRemediationFailedCritically,
threatRemediationFailedNonCritically, noStatusFlagsSet,
platformOutOfDate, platformUpdateInProgress,
platformAboutToBeOutdated,
signatureOrPlatformEndOfLifeIsPastOrIsImpending,
windowsSModeSignaturesInUseOnNonWin10SInstall.
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
items:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
description: Device malware list
x-ms-navigationProperty: true
'@odata.type':
type: string
description: Device protection status entity.
x-ms-discriminator-value: '#microsoft.graph.windowsProtectionState'
microsoft.graph.windowsDeviceMalwareState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsDeviceMalwareState
required:
- '@odata.type'
type: object
properties:
additionalInformationUrl:
type: string
description: Information URL to learn more about the malware
nullable: true
category:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.windowsMalwareCategory'
- type: object
nullable: true
description: >-
Category of the malware. The possible values are: 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, remoteControlSoftware,
tool, trojanDenialOfService, trojanDropper, trojanMassMailer,
trojanMonitoringSoftware, trojanProxyServer, virus, known,
unknown, spp, behavior, vulnerability, policy,
enterpriseUnwantedSoftware, ransom, hipsRule.
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.windowsMalwareExecutionState
- type: object
nullable: true
description: >-
Execution status of the malware like blocked/executing etc. The
possible values are: unknown, blocked, allowed, running,
notRunning.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.windowsMalwareSeverity'
- type: object
nullable: true
description: >-
Severity of the malware. The possible values are: unknown, low,
moderate, high, severe.
state:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.windowsMalwareState'
- type: object
nullable: true
description: >-
Current status of the malware like cleaned/quarantined/allowed
etc. The possible values are: unknown, detected, cleaned,
quarantined, removed, allowed, blocked, cleanFailed,
quarantineFailed, removeFailed, allowFailed, abandoned,
blockFailed.
threatState:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.windowsMalwareThreatState
- type: object
nullable: true
description: >-
Current status of the malware like cleaned/quarantined/allowed
etc. The possible values are: active, actionFailed,
manualStepsRequired, fullScanRequired, rebootRequired,
remediatedWithNonCriticalFailures, quarantined, removed,
cleaned, allowed, noStatusCleared.
'@odata.type':
type: string
description: Malware detection entity.
x-ms-discriminator-value: '#microsoft.graph.windowsDeviceMalwareState'
microsoft.graph.administrativeUnit:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: administrativeUnit
required:
- '@odata.type'
type: object
properties:
description:
type: string
description: >-
An optional description for the administrative unit. Supports
$filter (eq, ne, in, startsWith), $search.
nullable: true
displayName:
type: string
description: >-
Display name for the administrative unit. Maximum length is 256
characters. Supports $filter (eq, ne, not, ge, le, in,
startsWith, and eq on null values), $search, and $orderby.
nullable: true
isMemberManagementRestricted:
type: boolean
description: >-
true if members of this administrative unit should be treated as
sensitive, which requires specific permissions to manage. If not
set, the default value is null and the default behavior is
false. Use this property to define administrative units with
roles that don't inherit from tenant-level administrators, and
where the management of individual member objects is limited to
administrators scoped to a restricted management administrative
unit. This property is immutable and can't be changed later. For more information on how to work with restricted management
administrative units, see Restricted management administrative
units in Microsoft Entra ID.
nullable: true
membershipRule:
type: string
description: >-
The dynamic membership rule for the administrative unit. For
more information about the rules you can use for dynamic
administrative units and dynamic groups, see Manage rules for
dynamic membership groups in Microsoft Entra ID.
nullable: true
membershipRuleProcessingState:
type: string
description: >-
Controls whether the dynamic membership rule is actively
processed. Set to On to activate the dynamic membership rule, or
Paused to stop updating membership dynamically.
nullable: true
membershipType:
type: string
description: >-
Indicates the membership type for the administrative unit. The
possible values are: dynamic, assigned. If not set, the default
value is null and the default behavior is assigned.
nullable: true
visibility:
type: string
description: >-
Controls whether the administrative unit and its members are
hidden or public. Can be set to HiddenMembership. If not set,
the default value is null and the default behavior is public.
When set to HiddenMembership, only members of the administrative
unit can list other members of the administrative unit.
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for this
administrative unit. Nullable.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Users and groups that are members of this administrative unit.
Supports $expand.
x-ms-navigationProperty: true
scopedRoleMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
description: Scoped-role members of this administrative unit.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.administrativeUnit'
x-ms-discriminator-value: '#microsoft.graph.administrativeUnit'
microsoft.graph.directoryRole:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: directoryRole
required:
- '@odata.type'
type: object
properties:
description:
type: string
description: >-
The description for the directory role. Read-only. Supports
$filter (eq), $search, $select.
nullable: true
displayName:
type: string
description: >-
The display name for the directory role. Read-only. Supports
$filter (eq), $search, $select.
nullable: true
roleTemplateId:
type: string
description: >-
The id of the directoryRoleTemplate that this role is based on.
The property must be specified when activating a directory role
in a tenant with a POST operation. After the directory role has
been activated, the property is read only. Supports $filter
(eq), $select.
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Users that are members of this directory role. HTTP Methods:
GET, POST, DELETE. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
scopedMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
description: >-
Members of this directory role that are scoped to administrative
units. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.directoryRole'
x-ms-discriminator-value: '#microsoft.graph.directoryRole'
microsoft.graph.oAuth2PermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: oAuth2PermissionGrant
required:
- '@odata.type'
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.oAuth2PermissionGrant'
microsoft.graph.onenote:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenote
required:
- '@odata.type'
type: object
properties:
notebooks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.notebook'
description: >-
The collection of OneNote notebooks that are owned by the user
or group. Read-only. Nullable.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
description: >-
The status of OneNote operations. Getting an operations
collection isn't supported, but you can get the status of
long-running operations if the Operation-Location header is
returned in the response. Read-only. Nullable.
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: >-
The pages in all OneNote notebooks that are owned by the user or
group. Read-only. Nullable.
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
description: >-
The image and other file resources in OneNote pages. Getting a
resources collection isn't supported, but you can get the binary
content of a specific resource. Read-only. Nullable.
x-ms-navigationProperty: true
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: >-
The section groups in all OneNote notebooks that are owned by
the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: >-
The sections in all OneNote notebooks that are owned by the user
or group. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.onenote'
microsoft.graph.notebook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: notebook
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebookLinks'
- type: object
nullable: true
description: >-
Links for opening the notebook. The oneNoteClientURL link opens
the notebook in the OneNote native client if it's installed. The
oneNoteWebURL link opens the notebook in OneNote on the web.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
- type: object
nullable: true
description: >-
The possible values are: Owner, Contributor, Reader, None. Owner
represents owner-level access to the notebook. Contributor
represents read/write access to the notebook. Reader represents
read-only access to the notebook. Read-only.
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.notebook'
x-ms-discriminator-value: '#microsoft.graph.notebook'
microsoft.graph.onenoteOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.operation'
- title: onenoteOperation
required:
- '@odata.type'
type: object
properties:
error:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperationError'
- type: object
nullable: true
description: The error returned by the operation.
percentComplete:
type: string
description: >-
The operation percent complete if the operation is still in
running status.
nullable: true
resourceId:
type: string
description: The resource id.
nullable: true
resourceLocation:
type: string
description: >-
The resource URI for the object. For example, the resource URI
for a copied page or section.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.onenoteOperation'
microsoft.graph.sectionGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: sectionGroup
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebook'
- type: object
nullable: true
description: The notebook that contains the section group. Read-only.
x-ms-navigationProperty: true
parentSectionGroup:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
- type: object
nullable: true
description: The section group that contains the section group. Read-only.
x-ms-navigationProperty: true
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the section. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the section group. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.sectionGroup'
x-ms-discriminator-value: '#microsoft.graph.sectionGroup'
microsoft.graph.onenoteSection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: onenoteSection
required:
- '@odata.type'
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default section. Read-only.
nullable: true
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sectionLinks'
- type: object
nullable: true
description: >-
Links for opening the section. The oneNoteClientURL link opens
the section in the OneNote native client if it's installed. The
oneNoteWebURL link opens the section in OneNote on the web.
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
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The collection of pages in the section. Read-only. Nullable.
x-ms-navigationProperty: true
parentNotebook:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebook'
- type: object
nullable: true
description: The notebook that contains the section. Read-only.
x-ms-navigationProperty: true
parentSectionGroup:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
- type: object
nullable: true
description: The section group that contains the section. Read-only.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.onenoteSection'
x-ms-discriminator-value: '#microsoft.graph.onenoteSection'
microsoft.graph.onenotePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- title: onenotePage
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.pageLinks'
- type: object
nullable: true
description: >-
Links for opening the page. The oneNoteClientURL link opens the
page in the OneNote native client if it 's installed. The
oneNoteWebUrl link opens the page in OneNote on the web.
Read-only.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebook'
- type: object
nullable: true
description: The notebook that contains the page. Read-only.
x-ms-navigationProperty: true
parentSection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteSection'
- type: object
nullable: true
description: The section that contains the page. Read-only.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.onenotePage'
x-ms-discriminator-value: '#microsoft.graph.onenotePage'
microsoft.graph.onenotePagePreview:
title: onenotePagePreview
required:
- '@odata.type'
type: object
properties:
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenotePagePreviewLinks'
- type: object
nullable: true
previewText:
type: string
nullable: true
'@odata.type':
type: string
microsoft.graph.CopyNotebookModel:
title: CopyNotebookModel
required:
- '@odata.type'
type: object
properties:
createdBy:
type: string
nullable: true
createdByIdentity:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
createdTime:
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
id:
type: string
nullable: true
isDefault:
type: boolean
nullable: true
isShared:
type: boolean
nullable: true
lastModifiedBy:
type: string
nullable: true
lastModifiedByIdentity:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
lastModifiedTime:
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
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.notebookLinks'
- type: object
nullable: true
name:
type: string
nullable: true
sectionGroupsUrl:
type: string
nullable: true
sectionsUrl:
type: string
nullable: true
self:
type: string
nullable: true
userRole:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
- type: object
nullable: true
'@odata.type':
type: string
microsoft.graph.recentNotebook:
title: recentNotebook
required:
- '@odata.type'
type: object
properties:
displayName:
type: string
description: The name of the notebook.
nullable: true
lastAccessedTime:
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
links:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.recentNotebookLinks'
- type: object
nullable: true
description: >-
Links for opening the notebook. The oneNoteClientURL link opens the
notebook in the OneNote client, if it's installed. The oneNoteWebURL
link opens the notebook in OneNote on the web.
sourceService:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteSourceService'
- type: object
nullable: true
description: >-
The backend store where the Notebook resides, either
OneDriveForBusiness or OneDrive.
'@odata.type':
type: string
microsoft.graph.onenoteResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- title: onenoteResource
required:
- '@odata.type'
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
'@odata.type':
type: string
default: '#microsoft.graph.onenoteResource'
x-ms-discriminator-value: '#microsoft.graph.onenoteResource'
microsoft.graph.onlineMeeting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingBase'
- title: onlineMeeting
required:
- '@odata.type'
type: object
properties:
attendeeReport:
type: string
description: >-
The content stream of the attendee report of a Microsoft Teams
live event. Read-only.
format: base64url
nullable: true
broadcastSettings:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.broadcastMeetingSettings
- type: object
nullable: true
description: Settings related to a live event.
creationDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: The meeting creation time in UTC. Read-only.
format: date-time
nullable: true
endDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The meeting end time in UTC. Required when you create an online
meeting.
format: date-time
nullable: true
externalId:
type: string
description: The external ID that is a custom identifier. Optional.
nullable: true
isBroadcast:
type: boolean
description: Indicates whether this meeting is a Teams live event.
nullable: true
meetingTemplateId:
type: string
description: The ID of the meeting template.
nullable: true
participants:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.meetingParticipants'
- type: object
nullable: true
description: >-
The participants associated with the online meeting, including
the organizer and the attendees.
startDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: The meeting start time in UTC.
format: date-time
nullable: true
recordings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
description: The recordings of an online meeting. Read-only.
x-ms-navigationProperty: true
transcripts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
description: The transcripts of an online meeting. Read-only.
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.onlineMeeting'
description: Represents a Microsoft online meeting.
x-ms-discriminator-value: '#microsoft.graph.onlineMeeting'
microsoft.graph.meetingAttendanceReport:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: meetingAttendanceReport
required:
- '@odata.type'
type: object
properties:
externalEventInformation:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.virtualEventExternalInformation
description: >-
The external information of a virtual event. Returned only for
event organizers or coorganizers. Read-only.
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
items:
$ref: '#/components/schemas/microsoft.graph.attendanceRecord'
description: List of attendance records of an attendance report. Read-only.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.meetingAttendanceReport'
microsoft.graph.attendanceRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attendanceRecord
required:
- '@odata.type'
type: object
properties:
attendanceIntervals:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendanceInterval'
description: List of time periods between joining and leaving a meeting.
emailAddress:
type: string
description: >-
Email address of the user associated with this attendance
record.
nullable: true
externalRegistrationInformation:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.virtualEventExternalRegistrationInformation
- type: object
nullable: true
description: The external information for a virtualEventRegistration.
identity:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- type: object
nullable: true
description: >-
The identity of the user associated with this attendance record.
The specific type is one of the following derived types of
identity, depending on the user type:
communicationsUserIdentity,
azureCommunicationServicesUserIdentity.
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. The 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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.attendanceRecord'
microsoft.graph.callRecording:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: callRecording
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: >-
The identity information of the organizer of the onlineMeeting
related to this recording. Read-only.
recordingContentUrl:
type: string
description: >-
The URL that can be used to access the content of the recording.
Read-only.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.callRecording'
microsoft.graph.callTranscript:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: callTranscript
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: >-
The identity information of the organizer of the onlineMeeting
related to this transcript. Read-only.
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.callTranscript'
microsoft.graph.chatInfo:
title: chatInfo
required:
- '@odata.type'
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
'@odata.type':
type: string
microsoft.graph.meetingParticipants:
title: meetingParticipants
required:
- '@odata.type'
type: object
properties:
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
description: Information about the meeting attendees.
organizer:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
- type: object
nullable: true
description: Information about the meeting organizer.
'@odata.type':
type: string
microsoft.graph.outlookUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookUser
required:
- '@odata.type'
type: object
properties:
masterCategories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
description: A list of categories defined for the user.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.outlookUser'
microsoft.graph.outlookCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookCategory
required:
- '@odata.type'
type: object
properties:
color:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.categoryColor'
- type: object
nullable: true
description: >-
A pre-set color constant that characterizes a category, and that
is mapped to one of 25 predefined colors. For more details, see
the following note.
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.outlookCategory'
microsoft.graph.localeInfo:
title: localeInfo
required:
- '@odata.type'
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
'@odata.type':
type: string
microsoft.graph.timeZoneStandard:
title: timeZoneStandard
enum:
- windows
- iana
type: string
microsoft.graph.endpoint:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: endpoint
required:
- '@odata.type'
type: object
properties:
capability:
type: string
providerId:
type: string
nullable: true
providerName:
type: string
nullable: true
providerResourceId:
type: string
nullable: true
uri:
type: string
'@odata.type':
type: string
default: '#microsoft.graph.endpoint'
x-ms-discriminator-value: '#microsoft.graph.endpoint'
microsoft.graph.application:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: application
required:
- '@odata.type'
type: object
properties:
addIns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.addIn'
description: >-
Defines custom behavior that a consuming service can use to call
an app in specific contexts. For example, applications that can
render file streams can set the addIns property for its
'FileHandler' functionality. This lets services like Microsoft
365 call the application in the context of a document the user
is working on.
api:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.apiApplication'
- type: object
nullable: true
description: Specifies settings for an application that implements a web API.
appId:
type: string
description: >-
The unique identifier for the application that is assigned to an
application by Microsoft Entra ID. Not nullable. Read-only.
Alternate key. Supports $filter (eq).
nullable: true
applicationTemplateId:
type: string
description: >-
Unique identifier of the applicationTemplate. Supports $filter
(eq, not, ne). Read-only. null if the app wasn't created from an
application template.
nullable: true
appRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRole'
description: >-
The collection of roles defined for the application. With app
role assignments, these roles can be assigned to users, groups,
or service principals associated with other applications. Not
nullable.
authenticationBehaviors:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationBehaviors'
- type: object
nullable: true
certification:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.certification'
- type: object
nullable: true
description: Specifies the certification status of the application.
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 application was registered. The
DateTimeOffset 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, and eq on null values) and
$orderby.
format: date-time
nullable: true
defaultRedirectUri:
type: string
nullable: true
description:
type: string
description: >-
Free text field to provide a description of the application
object to end users. The maximum allowed size is 1,024
characters. Supports $filter (eq, ne, not, ge, le, startsWith)
and $search.
nullable: true
disabledByMicrosoftStatus:
type: string
description: >-
Specifies whether Microsoft has disabled the registered
application. The possible values are: null (default value),
NotDisabled, and DisabledDueToViolationOfServicesAgreement
(reasons include suspicious, abusive, or malicious activity, or
a violation of the Microsoft Services Agreement). Supports
$filter (eq, ne, not).
nullable: true
displayName:
type: string
description: >-
The display name for the application. Maximum length is 256
characters. Supports $filter (eq, ne, not, ge, le, in,
startsWith, and eq on null values), $search, and $orderby.
nullable: true
groupMembershipClaims:
type: string
description: >-
Configures the groups claim issued in a user or OAuth 2.0 access
token that the application expects. To set this attribute, use
one of the following valid string values: None, SecurityGroup
(for security groups and Microsoft Entra roles), All (this gets
all of the security groups, distribution groups, and Microsoft
Entra directory roles that the signed-in user is a member of).
nullable: true
identifierUris:
type: array
items:
type: string
description: >-
Also known as App ID URI, this value is set when an application
is used as a resource app. The identifierUris acts as the prefix
for the scopes you reference in your API's code, and it must be
globally unique across Microsoft Entra ID. For more information
on valid identifierUris patterns and best practices, see
Microsoft Entra application registration security best
practices. Not nullable. Supports $filter (eq, ne, ge, le,
startsWith).
info:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.informationalUrl'
- type: object
nullable: true
description: >-
Basic profile information of the application such as app's
marketing, support, terms of service and privacy statement URLs.
The terms of service and privacy statement are surfaced to users
through the user consent experience. For more info, see How to:
Add Terms of service and privacy statement for registered
Microsoft Entra apps. Supports $filter (eq, ne, not, ge, le, and
eq on null values).
isDeviceOnlyAuthSupported:
type: boolean
description: >-
Specifies whether this application supports device
authentication without a user. The default is false.
nullable: true
isFallbackPublicClient:
type: boolean
description: >-
Specifies the fallback application type as public client, such
as an installed application running on a mobile device. The
default value is false, which means the fallback application
type is confidential client such as a web app. There are certain
scenarios where Microsoft Entra ID can't determine the client
application type. For example, the ROPC flow where it's
configured without specifying a redirect URI. In those cases,
Microsoft Entra ID interprets the application type based on the
value of this property.
nullable: true
keyCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
description: >-
The collection of key credentials associated with the
application. Not nullable. Supports $filter (eq, not, ge, le).
logo:
type: string
description: The main logo for the application. Not nullable.
format: base64url
nativeAuthenticationApisEnabled:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.nativeAuthenticationApisEnabled
- type: object
nullable: true
description: >-
Specifies whether the Native Authentication APIs are enabled for
the application. The possible values are: none and all. Default
is none. For more information, see Native Authentication.
notes:
type: string
description: Notes relevant for the management of the application.
nullable: true
oauth2RequirePostResponse:
type: boolean
optionalClaims:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.optionalClaims'
- type: object
nullable: true
description: >-
Application developers can configure optional claims in their
Microsoft Entra applications to specify the claims that are sent
to their application by the Microsoft security token service.
For more information, see How to: Provide optional claims to
your app.
parentalControlSettings:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.parentalControlSettings'
- type: object
nullable: true
description: Specifies parental control settings for an application.
passwordCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
description: >-
The collection of password credentials associated with the
application. Not nullable.
publicClient:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.publicClientApplication'
- type: object
nullable: true
description: >-
Specifies settings for installed clients such as desktop or
mobile devices.
publisherDomain:
type: string
description: >-
The verified publisher domain for the application. Read-only.
For more information, see How to: Configure an application's
publisher domain. Supports $filter (eq, ne, ge, le, startsWith).
nullable: true
requestSignatureVerification:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.requestSignatureVerification
- type: object
nullable: true
description: >-
Specifies whether this application requires Microsoft Entra ID
to verify the signed authentication requests.
requiredResourceAccess:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.requiredResourceAccess'
description: >-
Specifies the resources that the application needs to access.
This property also specifies the set of delegated permissions
and application roles that it needs for each of those resources.
This configuration of access to the required resources drives
the consent experience. No more than 50 resource services (APIs)
can be configured. Beginning mid-October 2021, the total number
of required permissions must not exceed 400. For more
information, see Limits on requested permissions per app. Not
nullable. Supports $filter (eq, not, ge, le).
samlMetadataUrl:
type: string
description: >-
The URL where the service exposes SAML metadata for federation.
This property is valid only for single-tenant applications.
Nullable.
nullable: true
serviceManagementReference:
type: string
description: >-
References application or service contact information from a
Service or Asset Management database. Nullable.
nullable: true
servicePrincipalLockConfiguration:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.servicePrincipalLockConfiguration
- type: object
nullable: true
description: >-
Specifies whether sensitive properties of a multitenant
application should be locked for editing after the application
is provisioned in a tenant. Nullable. null by default.
signInAudience:
type: string
description: >-
Specifies the Microsoft accounts that are supported for the
current application. The possible values are: AzureADMyOrg
(default), AzureADMultipleOrgs,
AzureADandPersonalMicrosoftAccount, and
PersonalMicrosoftAccount. See more in the table. The value of
this object also limits the number of permissions an app can
request. For more information, see Limits on requested
permissions per app. The value for this property has
implications on other app object properties. As a result, if you
change this property, you might need to change other properties
first. For more information, see Validation differences for
signInAudience.Supports $filter (eq, ne, not).
nullable: true
spa:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.spaApplication'
- type: object
nullable: true
description: >-
Specifies settings for a single-page application, including sign
out URLs and redirect URIs for authorization codes and access
tokens.
tags:
type: array
items:
type: string
description: >-
Custom strings that can be used to categorize and identify the
application. Not nullable. Strings added here will also appear
in the tags property of any associated service
principals.Supports $filter (eq, not, ge, le, startsWith) and
$search.
tokenEncryptionKeyId:
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: >-
Specifies the keyId of a public key from the keyCredentials
collection. When configured, Microsoft Entra ID encrypts all the
tokens it emits by using the key this property points to. The
application code that receives the encrypted token must use the
matching private key to decrypt the token before it can be used
for the signed-in user.
format: uuid
nullable: true
uniqueName:
type: string
description: >-
The unique identifier that can be assigned to an application and
used as an alternate key. Immutable. Read-only.
nullable: true
verifiedPublisher:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.verifiedPublisher'
- type: object
nullable: true
description: >-
Specifies the verified publisher of the application. For more
information about how publisher verification helps support
application security, trustworthiness, and compliance, see
Publisher verification.
web:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.webApplication'
- type: object
nullable: true
description: Specifies settings for a web application.
appManagementPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
description: The appManagementPolicy applied to this application.
x-ms-navigationProperty: true
createdOnBehalfOf:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- type: object
nullable: true
description: Supports $filter (/$count eq 0, /$count ne 0). Read-only.
x-ms-navigationProperty: true
extensionProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
description: >-
Read-only. Nullable. Supports $expand and $filter (/$count eq 0,
/$count ne 0).
x-ms-navigationProperty: true
federatedIdentityCredentials:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.federatedIdentityCredential
description: >-
Federated identities for applications. Supports $expand and
$filter (startsWith, /$count eq 0, /$count ne 0).
x-ms-navigationProperty: true
homeRealmDiscoveryPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
x-ms-navigationProperty: true
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: >-
Directory objects that are owners of this application. The
owners are a set of nonadmin users or service principals who are
allowed to modify this object. Supports $expand, $filter
(/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and
$select nested in $expand.
x-ms-navigationProperty: true
synchronization:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.synchronization'
- type: object
nullable: true
description: >-
Represents the capability for Microsoft Entra identity
synchronization through the Microsoft Graph API.
x-ms-navigationProperty: true
tokenIssuancePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
x-ms-navigationProperty: true
tokenLifetimePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.application'
x-ms-discriminator-value: '#microsoft.graph.application'
microsoft.graph.person:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: person
required:
- '@odata.type'
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.personType'
- type: object
nullable: true
description: The type of person.
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: The person's phone numbers.
postalAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: The person's addresses.
profession:
type: string
description: The person's profession.
nullable: true
scoredEmailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scoredEmailAddress'
description: The person's email addresses.
surname:
type: string
description: The person's surname.
nullable: true
userPrincipalName:
type: string
description: >-
The user principal name (UPN) of the person. The UPN is an
Internet-style login name for the person based on the Internet
standard RFC 822. By convention, this should map to the person's
email name. The general format is alias@domain.
nullable: true
websites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.website'
description: The person's websites.
yomiCompany:
type: string
description: The phonetic Japanese name of the person's company.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.person'
microsoft.graph.plannerUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerUser
required:
- '@odata.type'
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: >-
Read-only. Nullable. Returns the plannerTasks assigned to the
user.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: >-
Read-only. Nullable. Returns the plannerPlans shared with the
user.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.plannerUser'
microsoft.graph.plannerPlan:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlan
required:
- '@odata.type'
type: object
properties:
container:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerPlanContainer'
- type: object
nullable: true
description: >-
Identifies the container of the plan. Specify only the url, the
containerId and type, or all properties. After it's set, this
property can’t be updated. Required.
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Read-only. The user who created the plan.
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
items:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
description: Read-only. Nullable. Collection of buckets in the plan.
x-ms-navigationProperty: true
details:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
- type: object
nullable: true
description: Read-only. Nullable. Extra details about the plan.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Collection of tasks in the plan.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.plannerPlan'
microsoft.graph.plannerBucket:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerBucket
required:
- '@odata.type'
type: object
properties:
name:
type: string
description: Name of the bucket.
orderHint:
type: string
description: >-
Hint used to order items of this type in a list view. For
details about the supported format, see Using order hints in
Planner.
nullable: true
planId:
type: string
description: Plan ID to which the bucket belongs.
nullable: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. The collection of tasks in the bucket.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.plannerBucket'
microsoft.graph.plannerTask:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTask
required:
- '@odata.type'
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.plannerAppliedCategories
- type: object
nullable: true
description: >-
The categories to which the task has been applied. See applied
Categories for possible values.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerAssignments'
- type: object
nullable: true
description: The set of assignees the task is assigned to.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Identity of the user that completed the task.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: Identity of the user that created the task.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
- type: object
nullable: true
description: >-
This sets the type of preview that shows up on the task. The
possible values are: automatic, noPreview, checklist,
description, reference.
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:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat
- type: object
nullable: true
description: >-
Read-only. Nullable. Used to render the task correctly in the
task board view when grouped by assignedTo.
x-ms-navigationProperty: true
bucketTaskBoardFormat:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat
- type: object
nullable: true
description: >-
Read-only. Nullable. Used to render the task correctly in the
task board view when grouped by bucket.
x-ms-navigationProperty: true
details:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
- type: object
nullable: true
description: Read-only. Nullable. More details about the task.
x-ms-navigationProperty: true
progressTaskBoardFormat:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat
- type: object
nullable: true
description: >-
Read-only. Nullable. Used to render the task correctly in the
task board view when grouped by progress.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.plannerTask'
microsoft.graph.plannerTaskDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTaskDetails
required:
- '@odata.type'
type: object
properties:
checklist:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerChecklistItems'
- type: object
nullable: true
description: The collection of checklist items on the task.
description:
type: string
description: Description of the task.
nullable: true
previewType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
- type: object
nullable: true
description: >-
This sets the type of preview that shows up on the task. The
possible values are: automatic, noPreview, checklist,
description, reference. When set to automatic the displayed
preview is chosen by the app viewing the task.
references:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.plannerExternalReferences
- type: object
nullable: true
description: The collection of references on the task.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.plannerTaskDetails'
microsoft.graph.plannerPlanDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlanDetails
required:
- '@odata.type'
type: object
properties:
categoryDescriptions:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.plannerCategoryDescriptions
- type: object
nullable: true
description: >-
An object that specifies the descriptions of the 25 categories
that can be associated with tasks in the plan.
sharedWith:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.plannerUserIds'
- type: object
nullable: true
description: >-
Set of user IDs that this plan is shared with. If you're using
Microsoft 365 groups, use the Groups API to manage group
membership to share the group's plan. You can also add existing
members of the group to this collection, although it isn't
required for them to access the plan owned by the group.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.plannerPlanDetails'
microsoft.graph.presence:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: presence
required:
- '@odata.type'
type: object
properties:
activity:
type: string
description: >-
The supplemental information to a user's availability. Possible
values are available, away, beRightBack, busy, doNotDisturb,
offline, outOfOffice, presenceUnknown.
nullable: true
availability:
type: string
description: >-
The base presence information for a user. Possible values are
available, away, beRightBack, busy, doNotDisturb, focusing,
inACall, inAMeeting, offline, presenting, presenceUnknown.
nullable: true
outOfOfficeSettings:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.outOfOfficeSettings'
- type: object
nullable: true
description: The out of office settings for a user.
sequenceNumber:
type: string
description: >-
The lexicographically sortable String stamp that represents the
version of a presence object.
nullable: true
readOnly: true
statusMessage:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.presenceStatusMessage'
- type: object
nullable: true
description: The presence status message of a user.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.presence'
microsoft.graph.scopedRoleMembership:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: scopedRoleMembership
required:
- '@odata.type'
type: object
properties:
administrativeUnitId:
type: string
description: >-
Unique identifier for the administrative unit that the directory
role is scoped to
roleId:
type: string
description: Unique identifier for the directory role that the member is in.
roleMemberInfo:
$ref: '#/components/schemas/microsoft.graph.identity'
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.scopedRoleMembership'
microsoft.graph.userSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSettings
required:
- '@odata.type'
type: object
properties:
contributionToContentDiscoveryAsOrganizationDisabled:
type: boolean
description: >-
Reflects the organization level setting controlling delegate
access to the trending API. When set to true, the organization
doesn't have access to Office Delve. The relevancy of the
content displayed in Microsoft 365, for example in Suggested
sites in SharePoint Home and the Discover view in OneDrive for
work or school is affected for the whole organization. This
setting is read-only and can only be changed by administrators
in the SharePoint admin center.
contributionToContentDiscoveryDisabled:
type: boolean
description: >-
When set to true, the delegate access to the user's trending API
is disabled. When set to true, documents in the user's Office
Delve are disabled. When set to true, the relevancy of the
content displayed in Microsoft 365, for example in Suggested
sites in SharePoint Home and the Discover view in OneDrive for
work or school is affected. Users can control this setting in
Office Delve.
itemInsights:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
- type: object
nullable: true
description: >-
The user's settings for the visibility of meeting hour insights,
and insights derived between a user and other items in Microsoft
365, such as documents or sites. Get userInsightsSettings
through this navigation property.
x-ms-navigationProperty: true
shiftPreferences:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.shiftPreferences'
- type: object
nullable: true
x-ms-navigationProperty: true
storage:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.userStorage'
- type: object
nullable: true
x-ms-navigationProperty: true
windows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.userSettings'
microsoft.graph.userInsightsSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userInsightsSettings
required:
- '@odata.type'
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.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.userInsightsSettings'
microsoft.graph.shiftPreferences:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: shiftPreferences
required:
- '@odata.type'
type: object
properties:
availability:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shiftAvailability'
description: >-
Availability of the user to be scheduled for work and its
recurrence pattern.
'@odata.type':
type: string
default: '#microsoft.graph.shiftPreferences'
x-ms-discriminator-value: '#microsoft.graph.shiftPreferences'
microsoft.graph.userStorage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userStorage
required:
- '@odata.type'
type: object
properties:
quota:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedStorageQuota'
- type: object
nullable: true
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.userStorage'
microsoft.graph.unifiedStorageQuota:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedStorageQuota
required:
- '@odata.type'
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/microsoft.graph.serviceStorageQuotaBreakdown
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.unifiedStorageQuota'
microsoft.graph.windowsSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsSetting
required:
- '@odata.type'
type: object
properties:
payloadType:
type: string
description: >-
The type of setting payloads contained in the instances
navigation property.
nullable: true
settingType:
$ref: '#/components/schemas/microsoft.graph.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
items:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
description: A collection of setting values for a given windowsSetting.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.windowsSetting'
microsoft.graph.windowsSettingInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsSettingInstance
required:
- '@odata.type'
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.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.windowsSettingInstance'
microsoft.graph.userSolutionRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSolutionRoot
required:
- '@odata.type'
type: object
properties:
workingTimeSchedule:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workingTimeSchedule'
- type: object
nullable: true
description: The working time schedule entity associated with the solution.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.userSolutionRoot'
microsoft.graph.workingTimeSchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workingTimeSchedule
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.workingTimeSchedule'
microsoft.graph.userTeamwork:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userTeamwork
required:
- '@odata.type'
type: object
properties:
locale:
type: string
description: >-
Represents the location that a user selected in Microsoft Teams
and doesn't follow the Office's locale setting. A user's locale
is represented by their preferred language and country or
region. For example, en-us. The language component follows
two-letter codes as defined in ISO 639-1, and the country
component follows two-letter codes as defined in ISO 3166-1
alpha-2.
nullable: true
region:
type: string
description: >-
Represents the region of the organization or the user. For users
with multigeo licenses, the property contains the user's region
(if available). For users without multigeo licenses, the
property contains the organization's region.The region value can
be any region supported by the Teams payload. The possible
values are: Americas, Europe and MiddleEast, Asia Pacific, UAE,
Australia, Brazil, Canada, Switzerland, Germany, France, India,
Japan, South Korea, Norway, Singapore, United Kingdom, South
Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico,
USGov Community Cloud, USGov Community Cloud High, USGov
Department of Defense, and China.
nullable: true
associatedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
description: >-
The list of associatedTeamInfo objects that a user is associated
with.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation
description: The apps installed in the personal scope of this user.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.userTeamwork'
microsoft.graph.associatedTeamInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamInfo'
- title: associatedTeamInfo
required:
- '@odata.type'
type: object
properties:
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.associatedTeamInfo'
microsoft.graph.todo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todo
required:
- '@odata.type'
type: object
properties:
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
description: The task lists in the users mailbox.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.todo'
microsoft.graph.todoTaskList:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todoTaskList
required:
- '@odata.type'
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/microsoft.graph.wellknownListName'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the task list.
Nullable.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTask'
description: The tasks in this task list. Read-only. Nullable.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.todoTaskList'
microsoft.graph.todoTask:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todoTask
required:
- '@odata.type'
type: object
properties:
body:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- type: object
nullable: true
description: >-
The task body that typically contains information about the
task.
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
items:
type: string
nullable: true
description: >-
The categories associated with the task. Each category
corresponds to the displayName property of an outlookCategory
that the user has defined.
completedDateTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
description: >-
The date and time in the specified time zone that the task was
finished.
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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
description: >-
The date and time in the specified time zone that the task is to
be finished.
hasAttachments:
type: boolean
description: Indicates whether the task has attachments.
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.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:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
- type: object
nullable: true
description: The recurrence pattern for the task.
reminderDateTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
description: >-
The date and time in the specified time zone for a reminder
alert of the task to occur.
startDateTime:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- type: object
nullable: true
description: >-
The date and time in the specified time zone at which the task
is scheduled to start.
status:
$ref: '#/components/schemas/microsoft.graph.taskStatus'
title:
type: string
description: A brief description of the task.
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachmentBase'
description: A collection of file attachments for the task.
x-ms-navigationProperty: true
attachmentSessions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachmentSession'
x-ms-navigationProperty: true
checklistItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.checklistItem'
description: A collection of checklistItems linked to a task.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: >-
The collection of open extensions defined for the task.
Nullable.
x-ms-navigationProperty: true
linkedResources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.linkedResource'
description: A collection of resources linked to the task.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.todoTask'
microsoft.graph.attachmentBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachmentBase
required:
- '@odata.type'
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
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.taskFileAttachment': '#/components/schemas/microsoft.graph.taskFileAttachment'
microsoft.graph.attachmentInfo:
title: attachmentInfo
required:
- '@odata.type'
type: object
properties:
attachmentType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.attachmentType'
- type: object
nullable: true
description: >-
The type of the attachment. The possible values are: file, item,
reference. Required.
contentType:
type: string
description: The nature of the data in the attachment. Optional.
nullable: true
name:
type: string
description: >-
The display name of the attachment. This can be a descriptive string
and doesn't have to be the actual file name. Required.
nullable: true
size:
type: number
description: The length of the attachment in bytes. Required.
format: int64
nullable: true
'@odata.type':
type: string
microsoft.graph.attachmentSession:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachmentSession
required:
- '@odata.type'
type: object
properties:
content:
type: string
description: The content streams that are uploaded.
format: base64url
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 date and time in UTC when the upload session will expire.
The complete file must be uploaded before this expiration time
is reached.
format: date-time
nullable: true
nextExpectedRanges:
type: array
items:
type: string
nullable: true
description: >-
Indicates a single value {start} that represents the location in
the file where the next upload should begin.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.attachmentSession'
microsoft.graph.checklistItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: checklistItem
required:
- '@odata.type'
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.checklistItem'
microsoft.graph.linkedResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: linkedResource
required:
- '@odata.type'
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
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.linkedResource'
parameters:
top:
name: $top
in: query
description: Show only the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
search:
name: $search
in: query
description: Search items by search phrases
style: form
explode: false
schema:
type: string
filter:
name: $filter
in: query
description: Filter items by property values
style: form
explode: false
schema:
type: string
count:
name: $count
in: query
description: Include count of items
style: form
explode: false
schema:
type: boolean
examples: {}
responses:
microsoft.graph.aiUserCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.aiUserCollectionResponse'
error:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
ODataCountResponse:
description: The count of the resource
content:
text/plain:
schema:
$ref: '#/components/schemas/ODataCountResponse'
microsoft.graph.userCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userCollectionResponse'
StringCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/StringCollectionResponse'
microsoft.graph.eventCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.eventCollectionResponse'
microsoft.graph.attachmentCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.attachmentCollectionResponse'
microsoft.graph.extensionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extensionCollectionResponse'
microsoft.graph.calendarCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.calendarCollectionResponse'
microsoft.graph.chatCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatCollectionResponse'
microsoft.graph.chatMessageCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.chatMessageCollectionResponse'
microsoft.graph.teamsTabCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamsTabCollectionResponse'
microsoft.graph.cloudPCCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudPCCollectionResponse'
microsoft.graph.contactCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.contactCollectionResponse'
microsoft.graph.orgContactCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.orgContactCollectionResponse'
microsoft.graph.driveCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.driveCollectionResponse'
microsoft.graph.siteCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.siteCollectionResponse'
microsoft.graph.trendingCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.trendingCollectionResponse'
microsoft.graph.usedInsightCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.usedInsightCollectionResponse'
microsoft.graph.teamCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamCollectionResponse'
microsoft.graph.channelCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.channelCollectionResponse'
microsoft.graph.dayNoteCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dayNoteCollectionResponse'
microsoft.graph.openShiftCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.openShiftCollectionResponse'
microsoft.graph.shiftCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.shiftCollectionResponse'
microsoft.graph.timeCardCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeCardCollectionResponse'
microsoft.graph.timeOffCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.timeOffCollectionResponse'
microsoft.graph.teamworkTagCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.teamworkTagCollectionResponse'
microsoft.graph.mailFolderCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailFolderCollectionResponse'
microsoft.graph.messageRuleCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageRuleCollectionResponse'
microsoft.graph.messageCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.messageCollectionResponse'
microsoft.graph.groupCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupCollectionResponse'
assignLicenseResponse:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
- type: object
nullable: true
exportDeviceAndAppManagementDataResponse:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.deviceAndAppManagementData
- type: object
nullable: true
findMeetingTimesResponse:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.meetingTimeSuggestionsResult
- type: object
nullable: true
getMailTipsResponse:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailTips'
getManagedAppDiagnosticStatusesResponse:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: >-
#/components/schemas/microsoft.graph.managedAppDiagnosticStatus
getManagedAppPoliciesResponse:
description: Success
content:
application/json:
schema:
title: Collection of managedAppPolicy
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
getManagedDevicesWithAppFailuresResponse:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
type: string
nullable: true
reminderViewResponse:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.reminder'
reprocessLicenseAssignmentResponse:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.user'
- type: object
nullable: true
revokeSignInSessionsResponse:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: boolean
default: false
nullable: true
translateExchangeIdsResponse:
description: Success
content:
application/json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.convertIdResult'
microsoft.graph.notebookCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.notebookCollectionResponse'
microsoft.graph.onenotePageCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onenotePageCollectionResponse'
microsoft.graph.deviceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceCollectionResponse'
microsoft.graph.endpointCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpointCollectionResponse'
microsoft.graph.applicationCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.applicationCollectionResponse'
microsoft.graph.personCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.personCollectionResponse'
microsoft.graph.plannerPlanCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerPlanCollectionResponse'
microsoft.graph.plannerTaskCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.plannerTaskCollectionResponse'
microsoft.graph.todoTaskCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.todoTaskCollectionResponse'
tags:
- name: copilot.aiUser
- name: deviceManagement.managedDevice
- name: education.educationSchool
- name: education.educationUser
- name: me.managedDevice
- name: reports.authenticationMethodsRoot
- name: users.agreementAcceptance
- name: users.appRoleAssignment
- name: Users.authentication
- name: Users.calendar
- name: users.calendarGroup
- name: Users.chat
- name: users.cloudClipboardRoot
- name: users.cloudPC
- name: Users.contact
- name: users.contactFolder
- name: users.deviceManagementTroubleshootingEvent
- name: users.directoryObject
- name: Users.drive
- name: users.employeeExperienceUser
- name: Users.event
- name: Users.extension
- name: users.inferenceClassification
- name: users.itemInsights
- name: users.licenseDetails
- name: users.mailboxSettings
- name: users.mailFolder
- name: users.managedAppRegistration
- name: users.managedDevice
- name: Users.message
- name: users.oAuth2PermissionGrant
- name: Users.onenote
- name: users.onlineMeeting
- name: users.outlookUser
- name: Users.person
- name: users.plannerUser
- name: Users.presence
- name: users.profilePhoto
- name: users.resourceSpecificPermissionGrant
- name: users.scopedRoleMembership
- name: users.serviceProvisioningError
- name: Users.site
- name: Users.team
- name: Users.todo
- name: Users.user
- name: users.user.Actions
- name: users.user.Functions
- name: users.userActivity
- name: users.userDataSecurityAndGovernance
- name: users.userSettings
- name: users.userSolutionRoot
- name: users.userTeamwork