openapi: 3.0.1 info: title: OData Service for namespace microsoft.graph description: This OData service is located at https://graph.microsoft.com/v1.0 version: v1.0 x-ms-generated-by: toolName: Microsoft.OpenApi.OData toolVersion: 1.0.9.0 servers: - url: https://graph.microsoft.com/v1.0 paths: /admin: description: Provides operations to manage the admin singleton. get: tags: - admin.admin summary: Get admin operationId: admin.admin.GetAdmin parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.admin' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.admin summary: Update admin operationId: admin.admin.UpdateAdmin requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.admin' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.admin' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /admin/edge: description: Provides operations to manage the edge property of the microsoft.graph.admin entity. get: tags: - admin.edge summary: Get edge from admin description: A container for Microsoft Edge resources. Read-only. operationId: admin.GetEdge parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.edge' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.edge summary: Update the navigation property edge in admin operationId: admin.UpdateEdge requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.edge' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.edge' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.edge summary: Delete navigation property edge for admin operationId: admin.DeleteEdge 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 /admin/edge/internetExplorerMode: description: Provides operations to manage the internetExplorerMode property of the microsoft.graph.edge entity. get: tags: - admin.edge summary: Get internetExplorerMode from admin description: A container for Internet Explorer mode resources. operationId: admin.edge.GetInternetExplorerMode parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internetExplorerMode' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.edge summary: Update the navigation property internetExplorerMode in admin operationId: admin.edge.UpdateInternetExplorerMode requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internetExplorerMode' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.internetExplorerMode' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.edge summary: Delete navigation property internetExplorerMode for admin operationId: admin.edge.DeleteInternetExplorerMode 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 /admin/edge/internetExplorerMode/siteLists: description: Provides operations to manage the siteLists property of the microsoft.graph.internetExplorerMode entity. get: tags: - admin.edge summary: List browserSiteLists description: Get a list of the browserSiteList objects and their properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/internetexplorermode-list-sitelists?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.ListSiteLists 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.browserSiteListCollectionResponse' 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: - admin.edge summary: Create browserSiteList description: Create a new browserSiteList object to support Internet Explorer mode. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/internetexplorermode-post-sitelists?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.CreateSiteLists requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSiteList' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSiteList' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}': description: Provides operations to manage the siteLists property of the microsoft.graph.internetExplorerMode entity. get: tags: - admin.edge summary: Get browserSiteList description: Get a browserSiteList that contains browserSite and browserSharedCookie resources. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-get?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.GetSiteLists parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSiteList' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.edge summary: Update browserSiteList description: Update the properties of a browserSiteList object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-update?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.UpdateSiteLists requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSiteList' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSiteList' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.edge summary: Delete browserSiteList description: Delete a browserSiteList object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/internetexplorermode-delete-sitelists?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.DeleteSiteLists 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: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}/publish': description: Provides operations to call the publish method. post: tags: - admin.Actions summary: Invoke action publish description: Publish the specified browserSiteList for devices to download. operationId: admin.edge.internetExplorerMode.siteLists.browserSiteList.publish requestBody: description: Action parameters content: application/json: schema: type: object properties: revision: type: string sites: type: array items: $ref: '#/components/schemas/microsoft.graph.browserSite' sharedCookies: type: array items: $ref: '#/components/schemas/microsoft.graph.browserSharedCookie' required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.browserSiteList' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}/sharedCookies': description: Provides operations to manage the sharedCookies property of the microsoft.graph.browserSiteList entity. get: tags: - admin.edge summary: List browserSharedCookies description: Get a list of the browserSharedCookie objects and their properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-list-sharedcookies?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.ListSharedCookies 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.browserSharedCookieCollectionResponse' 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: - admin.edge summary: Create browserSharedCookie description: Create a new browserSharedCookie object in a browserSiteList. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-post-sharedcookies?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.CreateSharedCookies requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSharedCookie' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSharedCookie' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}/sharedCookies/{browserSharedCookie-id}': description: Provides operations to manage the sharedCookies property of the microsoft.graph.browserSiteList entity. get: tags: - admin.edge summary: Get browserSharedCookie description: 'Get a session cookie that can be shared between a Microsoft Edge process and an Internet Explorer process, while using Internet Explorer mode.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersharedcookie-get?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.GetSharedCookies parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSharedCookie' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.edge summary: Update browserSharedCookie description: Update the properties of a browserSharedCookie object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersharedcookie-update?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.UpdateSharedCookies requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSharedCookie' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSharedCookie' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.edge summary: Delete browserSharedCookie description: Delete a browserSharedCookie from a browserSiteList. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-delete-sharedcookies?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.DeleteSharedCookies 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: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList - name: browserSharedCookie-id in: path description: The unique identifier of browserSharedCookie required: true schema: type: string x-ms-docs-key-type: browserSharedCookie '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}/sharedCookies/$count': description: Provides operations to count the resources in the collection. get: tags: - admin.edge summary: Get the number of the resource operationId: admin.edge.internetExplorerMode.siteLists.sharedCookies.GetCount-0de2 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: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}/sites': description: Provides operations to manage the sites property of the microsoft.graph.browserSiteList entity. get: tags: - admin.edge summary: List browserSites description: Get a list of the browserSite objects and their properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-list-sites?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.ListSites 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.browserSiteCollectionResponse' 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: - admin.edge summary: Create browserSite description: Create a new browserSite object in a browserSiteList. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-post-sites?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.CreateSites requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSite' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSite' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}/sites/{browserSite-id}': description: Provides operations to manage the sites property of the microsoft.graph.browserSiteList entity. get: tags: - admin.edge summary: Get browserSite description: Get a browserSite that resides on a browserSiteList. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersite-get?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.GetSites parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSite' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.edge summary: Update browserSite description: Update the properties of a browserSite object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersite-update?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.UpdateSites requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSite' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.browserSite' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.edge summary: Delete browserSite description: Delete a browserSite from a browserSiteList. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/browsersitelist-delete-sites?view=graph-rest-1.0 operationId: admin.edge.internetExplorerMode.siteLists.DeleteSites 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: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList - name: browserSite-id in: path description: The unique identifier of browserSite required: true schema: type: string x-ms-docs-key-type: browserSite '/admin/edge/internetExplorerMode/siteLists/{browserSiteList-id}/sites/$count': description: Provides operations to count the resources in the collection. get: tags: - admin.edge summary: Get the number of the resource operationId: admin.edge.internetExplorerMode.siteLists.sites.GetCount-da97 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: browserSiteList-id in: path description: The unique identifier of browserSiteList required: true schema: type: string x-ms-docs-key-type: browserSiteList /admin/edge/internetExplorerMode/siteLists/$count: description: Provides operations to count the resources in the collection. get: tags: - admin.edge summary: Get the number of the resource operationId: admin.edge.internetExplorerMode.siteLists.GetCount-d3d6 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' /admin/microsoft365Apps: description: Provides operations to manage the microsoft365Apps property of the microsoft.graph.admin entity. get: tags: - admin.adminMicrosoft365Apps summary: Get microsoft365Apps from admin description: A container for the Microsoft 365 apps admin functionality. operationId: admin.GetMicrosoft365Apps parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.adminMicrosoft365Apps' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.adminMicrosoft365Apps summary: Update the navigation property microsoft365Apps in admin operationId: admin.UpdateMicrosoft365Apps requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.adminMicrosoft365Apps' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.adminMicrosoft365Apps' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.adminMicrosoft365Apps summary: Delete navigation property microsoft365Apps for admin operationId: admin.DeleteMicrosoft365Apps 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 /admin/microsoft365Apps/installationOptions: description: Provides operations to manage the installationOptions property of the microsoft.graph.adminMicrosoft365Apps entity. get: tags: - admin.adminMicrosoft365Apps summary: Get m365AppsInstallationOptions description: Read the properties and relationships of an m365AppsInstallationOptions object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/m365appsinstallationoptions-get?view=graph-rest-1.0 operationId: admin.microsoft365Apps.GetInstallationOptions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.m365AppsInstallationOptions' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.adminMicrosoft365Apps summary: Update m365AppsInstallationOptions description: Update the properties of an m365AppsInstallationOptions object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/m365appsinstallationoptions-update?view=graph-rest-1.0 operationId: admin.microsoft365Apps.UpdateInstallationOptions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.m365AppsInstallationOptions' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.m365AppsInstallationOptions' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.adminMicrosoft365Apps summary: Delete navigation property installationOptions for admin operationId: admin.microsoft365Apps.DeleteInstallationOptions 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 /admin/people: description: Provides operations to manage the people property of the microsoft.graph.admin entity. get: tags: - admin.peopleAdminSettings summary: Get peopleAdminSettings description: Retrieve the properties and relationships of a peopleAdminSettings object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/peopleadminsettings-get?view=graph-rest-1.0 operationId: admin.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.peopleAdminSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /admin/people/itemInsights: description: Provides operations to manage the itemInsights property of the microsoft.graph.peopleAdminSettings entity. get: tags: - admin.peopleAdminSettings summary: List itemInsights description: 'Get the properties of an insightsSettings object to display or return item insights in an organization. To learn how to customize the privacy of item insights in an organization, see Customize item insights privacy in Microsoft Graph.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/peopleadminsettings-list-iteminsights?view=graph-rest-1.0 operationId: admin.people.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.insightsSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.peopleAdminSettings summary: Update insightsSettings description: 'Update privacy settings to display or return the specified type of insights in an organization. Currently, itemInsights is the only supported type of settings. To learn more about customizing insights privacy for your organization, see Customize item insights privacy in Microsoft Graph.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/insightssettings-update?view=graph-rest-1.0 operationId: admin.people.UpdateItemInsights requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.insightsSettings' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.insightsSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.peopleAdminSettings summary: Delete navigation property itemInsights for admin operationId: admin.people.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 /admin/people/profileCardProperties: description: Provides operations to manage the profileCardProperties property of the microsoft.graph.peopleAdminSettings entity. get: tags: - admin.peopleAdminSettings summary: List profileCardProperties description: Get a collection of profileCardProperty resources for an organization. Each resource is identified by its directoryPropertyName property. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/peopleadminsettings-list-profilecardproperties?view=graph-rest-1.0 operationId: admin.people.ListProfileCardProperties 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.profileCardPropertyCollectionResponse' 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: - admin.peopleAdminSettings summary: Create profileCardProperty description: 'Create a new profileCardProperty for an organization. The new property is identified by its directoryPropertyName property. For more information about how to add properties to the profile card for an organization, see Add or remove custom attributes on a profile card using the profile card API.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/peopleadminsettings-post-profilecardproperties?view=graph-rest-1.0 operationId: admin.people.CreateProfileCardProperties requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.profileCardProperty' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.profileCardProperty' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/admin/people/profileCardProperties/{profileCardProperty-id}': description: Provides operations to manage the profileCardProperties property of the microsoft.graph.peopleAdminSettings entity. get: tags: - admin.peopleAdminSettings summary: Get profileCardProperty description: Retrieve the properties of a profileCardProperty entity. The profileCardProperty is identified by its directoryPropertyName property. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/profilecardproperty-get?view=graph-rest-1.0 operationId: admin.people.GetProfileCardProperties parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.profileCardProperty' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.peopleAdminSettings summary: Update profileCardProperty description: 'Update the properties of a profileCardProperty object, identified by its directoryPropertyName property.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/profilecardproperty-update?view=graph-rest-1.0 operationId: admin.people.UpdateProfileCardProperties requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.profileCardProperty' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.profileCardProperty' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.peopleAdminSettings summary: Delete profileCardProperty description: 'Delete the profileCardProperty object specified by its directoryPropertyName from the organization''s profile card, and remove any localized customizations for that property.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/profilecardproperty-delete?view=graph-rest-1.0 operationId: admin.people.DeleteProfileCardProperties 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: profileCardProperty-id in: path description: The unique identifier of profileCardProperty required: true schema: type: string x-ms-docs-key-type: profileCardProperty /admin/people/profileCardProperties/$count: description: Provides operations to count the resources in the collection. get: tags: - admin.peopleAdminSettings summary: Get the number of the resource operationId: admin.people.profileCardProperties.GetCount-9f88 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' /admin/people/pronouns: description: Provides operations to manage the pronouns property of the microsoft.graph.peopleAdminSettings entity. get: tags: - admin.peopleAdminSettings summary: List pronounsSettings description: 'Get the properties of the pronounsSettings resource for an organization. For more information on settings to manage pronouns support, see Manage pronouns settings for an organization using the Microsoft Graph API.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/peopleadminsettings-list-pronouns?view=graph-rest-1.0 operationId: admin.people.GetPronouns parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.pronounsSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.peopleAdminSettings summary: Update pronounsSettings description: 'Update the properties of a pronounsSettings object in an organization. For more information on settings to manage pronouns support, see Manage pronouns settings for an organization using the Microsoft Graph API.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/pronounssettings-update?view=graph-rest-1.0 operationId: admin.people.UpdatePronouns requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.pronounsSettings' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.pronounsSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /admin/reportSettings: description: Provides operations to manage the reportSettings property of the microsoft.graph.admin entity. get: tags: - admin.adminReportSettings summary: Get adminReportSettings description: Get the tenant-level settings for Microsoft 365 reports. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/adminreportsettings-get?view=graph-rest-1.0 operationId: admin.GetReportSettings parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.adminReportSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.adminReportSettings summary: Update adminReportSettings description: Update tenant-level settings for Microsoft 365 reports. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/adminreportsettings-update?view=graph-rest-1.0 operationId: admin.UpdateReportSettings requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.adminReportSettings' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.adminReportSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.adminReportSettings summary: Delete navigation property reportSettings for admin operationId: admin.DeleteReportSettings 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 /admin/serviceAnnouncement: description: Provides operations to manage the serviceAnnouncement property of the microsoft.graph.admin entity. get: tags: - admin.serviceAnnouncement summary: Get serviceAnnouncement from admin description: A container for service communications resources. Read-only. operationId: admin.GetServiceAnnouncement parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceAnnouncement' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.serviceAnnouncement summary: Update the navigation property serviceAnnouncement in admin operationId: admin.UpdateServiceAnnouncement requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceAnnouncement' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceAnnouncement' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.serviceAnnouncement summary: Delete navigation property serviceAnnouncement for admin operationId: admin.DeleteServiceAnnouncement 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 /admin/serviceAnnouncement/healthOverviews: description: Provides operations to manage the healthOverviews property of the microsoft.graph.serviceAnnouncement entity. get: tags: - admin.serviceAnnouncement summary: List healthOverviews description: Retrieve the serviceHealth resources from the healthOverviews navigation property. This operation provides the health report of all subscribed services for a tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceannouncement-list-healthoverviews?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.ListHealthOverviews 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.serviceHealthCollectionResponse' 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: - admin.serviceAnnouncement summary: Create new navigation property to healthOverviews for admin operationId: admin.serviceAnnouncement.CreateHealthOverviews requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealth' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealth' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/admin/serviceAnnouncement/healthOverviews/{serviceHealth-id}': description: Provides operations to manage the healthOverviews property of the microsoft.graph.serviceAnnouncement entity. get: tags: - admin.serviceAnnouncement summary: Get serviceHealth description: Retrieve the properties and relationships of a serviceHealth object. This operation provides the health information of a specified service for a tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/servicehealth-get?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.GetHealthOverviews parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealth' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.serviceAnnouncement summary: Update the navigation property healthOverviews in admin operationId: admin.serviceAnnouncement.UpdateHealthOverviews requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealth' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealth' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.serviceAnnouncement summary: Delete navigation property healthOverviews for admin operationId: admin.serviceAnnouncement.DeleteHealthOverviews 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: serviceHealth-id in: path description: The unique identifier of serviceHealth required: true schema: type: string x-ms-docs-key-type: serviceHealth '/admin/serviceAnnouncement/healthOverviews/{serviceHealth-id}/issues': description: Provides operations to manage the issues property of the microsoft.graph.serviceHealth entity. get: tags: - admin.serviceAnnouncement summary: Get issues from admin description: 'A collection of issues that happened on the service, with detailed information for each issue.' operationId: admin.serviceAnnouncement.healthOverviews.ListIssues 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.serviceHealthIssueCollectionResponse' 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: - admin.serviceAnnouncement summary: Create new navigation property to issues for admin operationId: admin.serviceAnnouncement.healthOverviews.CreateIssues requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: serviceHealth-id in: path description: The unique identifier of serviceHealth required: true schema: type: string x-ms-docs-key-type: serviceHealth '/admin/serviceAnnouncement/healthOverviews/{serviceHealth-id}/issues/{serviceHealthIssue-id}': description: Provides operations to manage the issues property of the microsoft.graph.serviceHealth entity. get: tags: - admin.serviceAnnouncement summary: Get issues from admin description: 'A collection of issues that happened on the service, with detailed information for each issue.' operationId: admin.serviceAnnouncement.healthOverviews.GetIssues parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.serviceAnnouncement summary: Update the navigation property issues in admin operationId: admin.serviceAnnouncement.healthOverviews.UpdateIssues requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.serviceAnnouncement summary: Delete navigation property issues for admin operationId: admin.serviceAnnouncement.healthOverviews.DeleteIssues 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: serviceHealth-id in: path description: The unique identifier of serviceHealth required: true schema: type: string x-ms-docs-key-type: serviceHealth - name: serviceHealthIssue-id in: path description: The unique identifier of serviceHealthIssue required: true schema: type: string x-ms-docs-key-type: serviceHealthIssue '/admin/serviceAnnouncement/healthOverviews/{serviceHealth-id}/issues/{serviceHealthIssue-id}/incidentReport()': description: Provides operations to call the incidentReport method. get: tags: - admin.Functions summary: Invoke function incidentReport description: Provide the Post-Incident Review (PIR) document of a specified service issue for tenant. An issue only with status of PostIncidentReviewPublished indicates that the PIR document exists for the issue. The operation returns an error if the specified issue doesn't exist for the tenant or if PIR document does not exist for the issue. operationId: admin.serviceAnnouncement.healthOverviews.serviceHealth.issues.serviceHealthIssue.incidentReport responses: 2XX: description: Success content: application/octet-stream: schema: type: object properties: value: type: string format: base64url nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: function parameters: - name: serviceHealth-id in: path description: The unique identifier of serviceHealth required: true schema: type: string x-ms-docs-key-type: serviceHealth - name: serviceHealthIssue-id in: path description: The unique identifier of serviceHealthIssue required: true schema: type: string x-ms-docs-key-type: serviceHealthIssue x-ms-docs-grouped-path: - '/admin/serviceAnnouncement/issues/{serviceHealthIssue-id}/incidentReport()' '/admin/serviceAnnouncement/healthOverviews/{serviceHealth-id}/issues/$count': description: Provides operations to count the resources in the collection. get: tags: - admin.serviceAnnouncement summary: Get the number of the resource operationId: admin.serviceAnnouncement.healthOverviews.issues.GetCount-fd80 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: serviceHealth-id in: path description: The unique identifier of serviceHealth required: true schema: type: string x-ms-docs-key-type: serviceHealth /admin/serviceAnnouncement/healthOverviews/$count: description: Provides operations to count the resources in the collection. get: tags: - admin.serviceAnnouncement summary: Get the number of the resource operationId: admin.serviceAnnouncement.healthOverviews.GetCount-51c2 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' /admin/serviceAnnouncement/issues: description: Provides operations to manage the issues property of the microsoft.graph.serviceAnnouncement entity. get: tags: - admin.serviceAnnouncement summary: List issues description: Retrieve serviceHealthIssue resources from the issues navigation property. This operation retrieves information about all service health issues that exist for the tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceannouncement-list-issues?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.ListIssues 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.serviceHealthIssueCollectionResponse' 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: - admin.serviceAnnouncement summary: Create new navigation property to issues for admin operationId: admin.serviceAnnouncement.CreateIssues requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/admin/serviceAnnouncement/issues/{serviceHealthIssue-id}': description: Provides operations to manage the issues property of the microsoft.graph.serviceAnnouncement entity. get: tags: - admin.serviceAnnouncement summary: Get serviceHealthIssue description: Retrieve the properties and relationships of a serviceHealthIssue object. This operation retrieves a specified service health issue for tenant. The operation returns an error if the issue does not exist for the tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/servicehealthissue-get?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.GetIssues parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.serviceAnnouncement summary: Update the navigation property issues in admin operationId: admin.serviceAnnouncement.UpdateIssues requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceHealthIssue' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.serviceAnnouncement summary: Delete navigation property issues for admin operationId: admin.serviceAnnouncement.DeleteIssues 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: serviceHealthIssue-id in: path description: The unique identifier of serviceHealthIssue required: true schema: type: string x-ms-docs-key-type: serviceHealthIssue '/admin/serviceAnnouncement/issues/{serviceHealthIssue-id}/incidentReport()': description: Provides operations to call the incidentReport method. get: tags: - admin.Functions summary: Invoke function incidentReport description: Provide the Post-Incident Review (PIR) document of a specified service issue for tenant. An issue only with status of PostIncidentReviewPublished indicates that the PIR document exists for the issue. The operation returns an error if the specified issue doesn't exist for the tenant or if PIR document does not exist for the issue. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/servicehealthissue-incidentreport?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.issues.serviceHealthIssue.incidentReport responses: 2XX: description: Success content: application/octet-stream: schema: type: object properties: value: type: string format: base64url nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: function parameters: - name: serviceHealthIssue-id in: path description: The unique identifier of serviceHealthIssue required: true schema: type: string x-ms-docs-key-type: serviceHealthIssue x-ms-docs-grouped-path: - '/admin/serviceAnnouncement/healthOverviews/{serviceHealth-id}/issues/{serviceHealthIssue-id}/incidentReport()' /admin/serviceAnnouncement/issues/$count: description: Provides operations to count the resources in the collection. get: tags: - admin.serviceAnnouncement summary: Get the number of the resource operationId: admin.serviceAnnouncement.issues.GetCount-e140 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' /admin/serviceAnnouncement/messages: description: Provides operations to manage the messages property of the microsoft.graph.serviceAnnouncement entity. get: tags: - admin.serviceAnnouncement summary: List serviceAnnouncement messages description: Retrieve the serviceUpdateMessage resources from the messages navigation property. This operation retrieves all service update messages that exist for the tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceannouncement-list-messages?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.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.serviceUpdateMessageCollectionResponse' 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: - admin.serviceAnnouncement summary: Create new navigation property to messages for admin operationId: admin.serviceAnnouncement.CreateMessages requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceUpdateMessage' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceUpdateMessage' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/admin/serviceAnnouncement/messages/{serviceUpdateMessage-id}': description: Provides operations to manage the messages property of the microsoft.graph.serviceAnnouncement entity. get: tags: - admin.serviceAnnouncement summary: Get serviceUpdateMessage description: Retrieve the properties and relationships of a serviceUpdateMessage object. This operation retrieves a specified service update message for the tenant. The operation returns an error if the message does not exist for the tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-get?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.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.serviceUpdateMessage' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.serviceAnnouncement summary: Update the navigation property messages in admin operationId: admin.serviceAnnouncement.UpdateMessages requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceUpdateMessage' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceUpdateMessage' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.serviceAnnouncement summary: Delete navigation property messages for admin operationId: admin.serviceAnnouncement.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: serviceUpdateMessage-id in: path description: The unique identifier of serviceUpdateMessage required: true schema: type: string x-ms-docs-key-type: serviceUpdateMessage '/admin/serviceAnnouncement/messages/{serviceUpdateMessage-id}/attachments': description: Provides operations to manage the attachments property of the microsoft.graph.serviceUpdateMessage entity. get: tags: - admin.serviceAnnouncement summary: List attachments description: Get the list of attachments associated with a service message. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-list-attachments?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.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.serviceAnnouncementAttachmentCollectionResponse' 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: - admin.serviceAnnouncement summary: Create new navigation property to attachments for admin operationId: admin.serviceAnnouncement.messages.CreateAttachments requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceAnnouncementAttachment' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceAnnouncementAttachment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: serviceUpdateMessage-id in: path description: The unique identifier of serviceUpdateMessage required: true schema: type: string x-ms-docs-key-type: serviceUpdateMessage '/admin/serviceAnnouncement/messages/{serviceUpdateMessage-id}/attachments/{serviceAnnouncementAttachment-id}': description: Provides operations to manage the attachments property of the microsoft.graph.serviceUpdateMessage entity. get: tags: - admin.serviceAnnouncement summary: Get serviceAnnouncementAttachment description: Read the properties and relationships of a serviceAnnouncementAttachment object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceannouncementattachment-get?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.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.serviceAnnouncementAttachment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.serviceAnnouncement summary: Update the navigation property attachments in admin operationId: admin.serviceAnnouncement.messages.UpdateAttachments requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceAnnouncementAttachment' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.serviceAnnouncementAttachment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.serviceAnnouncement summary: Delete navigation property attachments for admin operationId: admin.serviceAnnouncement.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: serviceUpdateMessage-id in: path description: The unique identifier of serviceUpdateMessage required: true schema: type: string x-ms-docs-key-type: serviceUpdateMessage - name: serviceAnnouncementAttachment-id in: path description: The unique identifier of serviceAnnouncementAttachment required: true schema: type: string x-ms-docs-key-type: serviceAnnouncementAttachment '/admin/serviceAnnouncement/messages/{serviceUpdateMessage-id}/attachments/{serviceAnnouncementAttachment-id}/content': description: Provides operations to manage the media for the admin entity. get: tags: - admin.serviceAnnouncement summary: Get serviceAnnouncementAttachment description: Read the properties and relationships of a serviceAnnouncementAttachment object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceannouncementattachment-get?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.messages.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: - admin.serviceAnnouncement summary: Update content for the navigation property attachments in admin description: The attachment content. operationId: admin.serviceAnnouncement.messages.UpdateAttachmentsContent 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.serviceAnnouncementAttachment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' delete: tags: - admin.serviceAnnouncement summary: Delete content for the navigation property attachments in admin description: The attachment content. operationId: admin.serviceAnnouncement.messages.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: serviceUpdateMessage-id in: path description: The unique identifier of serviceUpdateMessage required: true schema: type: string x-ms-docs-key-type: serviceUpdateMessage - name: serviceAnnouncementAttachment-id in: path description: The unique identifier of serviceAnnouncementAttachment required: true schema: type: string x-ms-docs-key-type: serviceAnnouncementAttachment '/admin/serviceAnnouncement/messages/{serviceUpdateMessage-id}/attachments/$count': description: Provides operations to count the resources in the collection. get: tags: - admin.serviceAnnouncement summary: Get the number of the resource operationId: admin.serviceAnnouncement.messages.attachments.GetCount-e0ef 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: serviceUpdateMessage-id in: path description: The unique identifier of serviceUpdateMessage required: true schema: type: string x-ms-docs-key-type: serviceUpdateMessage '/admin/serviceAnnouncement/messages/{serviceUpdateMessage-id}/attachmentsArchive': description: Provides operations to manage the media for the admin entity. get: tags: - admin.serviceAnnouncement summary: List attachments description: Get the list of attachments associated with a service message. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-list-attachments?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.GetMessagesAttachmentsArchive 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: - admin.serviceAnnouncement summary: Update attachmentsArchive for the navigation property messages in admin description: The zip file that contains all attachments for a message. operationId: admin.serviceAnnouncement.UpdateMessagesAttachmentsArchive 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: - admin.serviceAnnouncement summary: Delete attachmentsArchive for the navigation property messages in admin description: The zip file that contains all attachments for a message. operationId: admin.serviceAnnouncement.DeleteMessagesAttachmentsArchive 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: serviceUpdateMessage-id in: path description: The unique identifier of serviceUpdateMessage required: true schema: type: string x-ms-docs-key-type: serviceUpdateMessage /admin/serviceAnnouncement/messages/$count: description: Provides operations to count the resources in the collection. get: tags: - admin.serviceAnnouncement summary: Get the number of the resource operationId: admin.serviceAnnouncement.messages.GetCount-0cc9 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' /admin/serviceAnnouncement/messages/archive: description: Provides operations to call the archive method. post: tags: - admin.Actions summary: Invoke action archive description: Archive a list of serviceUpdateMessages for the signed in user. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-archive?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.messages.archive requestBody: description: Action parameters content: application/json: schema: type: object properties: messageIds: type: array items: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /admin/serviceAnnouncement/messages/favorite: description: Provides operations to call the favorite method. post: tags: - admin.Actions summary: Invoke action favorite description: Change the status of a list of serviceUpdateMessages to favorite for the signed in user. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-favorite?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.messages.favorite requestBody: description: Action parameters content: application/json: schema: type: object properties: messageIds: type: array items: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /admin/serviceAnnouncement/messages/markRead: description: Provides operations to call the markRead method. post: tags: - admin.Actions summary: Invoke action markRead description: Mark a list of serviceUpdateMessages as read for the signed in user. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-markread?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.messages.markRead requestBody: description: Action parameters content: application/json: schema: type: object properties: messageIds: type: array items: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /admin/serviceAnnouncement/messages/markUnread: description: Provides operations to call the markUnread method. post: tags: - admin.Actions summary: Invoke action markUnread description: Mark a list of serviceUpdateMessages as unread for the signed in user. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-markunread?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.messages.markUnread requestBody: description: Action parameters content: application/json: schema: type: object properties: messageIds: type: array items: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /admin/serviceAnnouncement/messages/unarchive: description: Provides operations to call the unarchive method. post: tags: - admin.Actions summary: Invoke action unarchive description: Unarchive a list of serviceUpdateMessages for the signed in user. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-unarchive?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.messages.unarchive requestBody: description: Action parameters content: application/json: schema: type: object properties: messageIds: type: array items: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /admin/serviceAnnouncement/messages/unfavorite: description: Provides operations to call the unfavorite method. post: tags: - admin.Actions summary: Invoke action unfavorite description: Remove the favorite status of serviceUpdateMessages for the signed in user. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceupdatemessage-unfavorite?view=graph-rest-1.0 operationId: admin.serviceAnnouncement.messages.unfavorite requestBody: description: Action parameters content: application/json: schema: type: object properties: messageIds: type: array items: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /admin/sharepoint: description: Provides operations to manage the sharepoint property of the microsoft.graph.admin entity. get: tags: - admin.sharepoint summary: Get sharepoint from admin operationId: admin.GetSharepoint parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.sharepoint' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.sharepoint summary: Update the navigation property sharepoint in admin operationId: admin.UpdateSharepoint requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.sharepoint' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.sharepoint' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.sharepoint summary: Delete navigation property sharepoint for admin operationId: admin.DeleteSharepoint 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 /admin/sharepoint/settings: description: Provides operations to manage the settings property of the microsoft.graph.sharepoint entity. get: tags: - admin.sharepoint summary: Get settings description: Get the tenant-level settings for SharePoint and OneDrive. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/sharepointsettings-get?view=graph-rest-1.0 operationId: admin.sharepoint.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.sharepointSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - admin.sharepoint summary: Update settings description: Update one or more tenant-level settings for SharePoint and OneDrive. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/sharepointsettings-update?view=graph-rest-1.0 operationId: admin.sharepoint.UpdateSettings requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.sharepointSettings' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.sharepointSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - admin.sharepoint summary: Delete navigation property settings for admin operationId: admin.sharepoint.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 /agreementAcceptances: description: Provides operations to manage the collection of agreementAcceptance entities. get: tags: - agreementAcceptances.agreementAcceptance summary: Get entities from agreementAcceptances operationId: agreementAcceptances.agreementAcceptance.ListAgreementAcceptance 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 post: tags: - agreementAcceptances.agreementAcceptance summary: Add new entity to agreementAcceptances operationId: agreementAcceptances.agreementAcceptance.CreateAgreementAcceptance requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' required: true responses: 2XX: description: Created entity 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 '/agreementAcceptances/{agreementAcceptance-id}': description: Provides operations to manage the collection of agreementAcceptance entities. get: tags: - agreementAcceptances.agreementAcceptance summary: Get entity from agreementAcceptances by key operationId: agreementAcceptances.agreementAcceptance.GetAgreementAcceptance parameters: - name: $select in: query description: Select properties to be returned 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.agreementAcceptance' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - agreementAcceptances.agreementAcceptance summary: Update entity in agreementAcceptances operationId: agreementAcceptances.agreementAcceptance.UpdateAgreementAcceptance requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' required: true responses: 2XX: description: Success 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 delete: tags: - agreementAcceptances.agreementAcceptance summary: Delete entity from agreementAcceptances operationId: agreementAcceptances.agreementAcceptance.DeleteAgreementAcceptance 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: agreementAcceptance-id in: path description: The unique identifier of agreementAcceptance required: true schema: type: string x-ms-docs-key-type: agreementAcceptance /agreements: description: Provides operations to manage the collection of agreement entities. get: tags: - agreements.agreement summary: Get entities from agreements operationId: agreements.agreement.ListAgreement 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.agreementCollectionResponse' 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: - agreements.agreement summary: Add new entity to agreements operationId: agreements.agreement.CreateAgreement requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreement' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreement' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/agreements/{agreement-id}': description: Provides operations to manage the collection of agreement entities. get: tags: - agreements.agreement summary: Get entity from agreements by key operationId: agreements.agreement.GetAgreement parameters: - name: $select in: query description: Select properties to be returned 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.agreement' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - agreements.agreement summary: Update entity in agreements operationId: agreements.agreement.UpdateAgreement requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreement' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreement' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - agreements.agreement summary: Delete entity from agreements operationId: agreements.agreement.DeleteAgreement 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement '/agreements/{agreement-id}/acceptances': description: Provides operations to manage the acceptances property of the microsoft.graph.agreement entity. get: tags: - agreements.agreementAcceptance summary: Get acceptances from agreements description: Read-only. Information about acceptances of this agreement. operationId: agreements.ListAcceptances 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 post: tags: - agreements.agreementAcceptance summary: Create new navigation property to acceptances for agreements operationId: agreements.CreateAcceptances requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' required: true responses: 2XX: description: Created 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement '/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}': description: Provides operations to manage the acceptances property of the microsoft.graph.agreement entity. get: tags: - agreements.agreementAcceptance summary: Get acceptances from agreements description: Read-only. Information about acceptances of this agreement. operationId: agreements.GetAcceptances parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: 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 patch: tags: - agreements.agreementAcceptance summary: Update the navigation property acceptances in agreements operationId: agreements.UpdateAcceptances requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' required: true responses: 2XX: description: Success 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 delete: tags: - agreements.agreementAcceptance summary: Delete navigation property acceptances for agreements operationId: agreements.DeleteAcceptances 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementAcceptance-id in: path description: The unique identifier of agreementAcceptance required: true schema: type: string x-ms-docs-key-type: agreementAcceptance '/agreements/{agreement-id}/acceptances/$count': description: Provides operations to count the resources in the collection. get: tags: - agreements.agreementAcceptance summary: Get the number of the resource operationId: agreements.acceptances.GetCount-9ff2 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement '/agreements/{agreement-id}/file': description: Provides operations to manage the file property of the microsoft.graph.agreement entity. get: tags: - agreements.agreementFile summary: Get agreementFile description: 'Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the Accept-Language header.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/agreementfile-get?view=graph-rest-1.0 operationId: agreements.GetFile parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFile' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - agreements.agreementFile summary: Update the navigation property file in agreements operationId: agreements.UpdateFile requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFile' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFile' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - agreements.agreementFile summary: Delete navigation property file for agreements operationId: agreements.DeleteFile 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement '/agreements/{agreement-id}/file/localizations': description: Provides operations to manage the localizations property of the microsoft.graph.agreementFile entity. get: tags: - agreements.agreementFile summary: List agreementFileLocalizations description: Get a list of the default and localized agreement files. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/agreementfile-list-localizations?view=graph-rest-1.0 operationId: agreements.file.ListLocalizations 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.agreementFileLocalizationCollectionResponse' 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: - agreements.agreementFile summary: Create new navigation property to localizations for agreements operationId: agreements.file.CreateLocalizations requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement '/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}': description: Provides operations to manage the localizations property of the microsoft.graph.agreementFile entity. get: tags: - agreements.agreementFile summary: Get localizations from agreements description: The localized version of the terms of use agreement files attached to the agreement. operationId: agreements.file.GetLocalizations parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - agreements.agreementFile summary: Update the navigation property localizations in agreements operationId: agreements.file.UpdateLocalizations requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - agreements.agreementFile summary: Delete navigation property localizations for agreements operationId: agreements.file.DeleteLocalizations 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization '/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions': description: Provides operations to manage the versions property of the microsoft.graph.agreementFileLocalization entity. get: tags: - agreements.agreementFile summary: Get versions from agreements description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant. operationId: agreements.file.localizations.ListVersions 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.agreementFileVersionCollectionResponse' 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: - agreements.agreementFile summary: Create new navigation property to versions for agreements operationId: agreements.file.localizations.CreateVersions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization x-ms-docs-grouped-path: - '/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions' '/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}': description: Provides operations to manage the versions property of the microsoft.graph.agreementFileLocalization entity. get: tags: - agreements.agreementFile summary: Get versions from agreements description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant. operationId: agreements.file.localizations.GetVersions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - agreements.agreementFile summary: Update the navigation property versions in agreements operationId: agreements.file.localizations.UpdateVersions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - agreements.agreementFile summary: Delete navigation property versions for agreements operationId: agreements.file.localizations.DeleteVersions 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization - name: agreementFileVersion-id in: path description: The unique identifier of agreementFileVersion required: true schema: type: string x-ms-docs-key-type: agreementFileVersion x-ms-docs-grouped-path: - '/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}' '/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/$count': description: Provides operations to count the resources in the collection. get: tags: - agreements.agreementFile summary: Get the number of the resource operationId: agreements.file.localizations.versions.GetCount-c405 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization '/agreements/{agreement-id}/file/localizations/$count': description: Provides operations to count the resources in the collection. get: tags: - agreements.agreementFile summary: Get the number of the resource operationId: agreements.file.localizations.GetCount-37c2 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement '/agreements/{agreement-id}/files': description: Provides operations to manage the files property of the microsoft.graph.agreement entity. get: tags: - agreements.agreementFileLocalization summary: Get files from agreements description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. operationId: agreements.ListFiles 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.agreementFileLocalizationCollectionResponse' 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: - agreements.agreementFileLocalization summary: Create new navigation property to files for agreements operationId: agreements.CreateFiles requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement '/agreements/{agreement-id}/files/{agreementFileLocalization-id}': description: Provides operations to manage the files property of the microsoft.graph.agreement entity. get: tags: - agreements.agreementFileLocalization summary: Get files from agreements description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. operationId: agreements.GetFiles parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - agreements.agreementFileLocalization summary: Update the navigation property files in agreements operationId: agreements.UpdateFiles requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - agreements.agreementFileLocalization summary: Delete navigation property files for agreements operationId: agreements.DeleteFiles 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization '/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions': description: Provides operations to manage the versions property of the microsoft.graph.agreementFileLocalization entity. get: tags: - agreements.agreementFileLocalization summary: Get versions from agreements description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant. operationId: agreements.files.ListVersions 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.agreementFileVersionCollectionResponse' 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: - agreements.agreementFileLocalization summary: Create new navigation property to versions for agreements operationId: agreements.files.CreateVersions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization x-ms-docs-grouped-path: - '/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions' '/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}': description: Provides operations to manage the versions property of the microsoft.graph.agreementFileLocalization entity. get: tags: - agreements.agreementFileLocalization summary: Get versions from agreements description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant. operationId: agreements.files.GetVersions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - agreements.agreementFileLocalization summary: Update the navigation property versions in agreements operationId: agreements.files.UpdateVersions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - agreements.agreementFileLocalization summary: Delete navigation property versions for agreements operationId: agreements.files.DeleteVersions 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization - name: agreementFileVersion-id in: path description: The unique identifier of agreementFileVersion required: true schema: type: string x-ms-docs-key-type: agreementFileVersion x-ms-docs-grouped-path: - '/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}' '/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/$count': description: Provides operations to count the resources in the collection. get: tags: - agreements.agreementFileLocalization summary: Get the number of the resource operationId: agreements.files.versions.GetCount-8216 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement - name: agreementFileLocalization-id in: path description: The unique identifier of agreementFileLocalization required: true schema: type: string x-ms-docs-key-type: agreementFileLocalization '/agreements/{agreement-id}/files/$count': description: Provides operations to count the resources in the collection. get: tags: - agreements.agreementFileLocalization summary: Get the number of the resource operationId: agreements.files.GetCount-b229 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: agreement-id in: path description: The unique identifier of agreement required: true schema: type: string x-ms-docs-key-type: agreement /appCatalogs: description: Provides operations to manage the appCatalogs singleton. get: tags: - appCatalogs.appCatalogs summary: Get appCatalogs operationId: appCatalogs.appCatalogs.GetAppCatalogs parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.appCatalogs' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - appCatalogs.appCatalogs summary: Update appCatalogs operationId: appCatalogs.appCatalogs.UpdateAppCatalogs requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.appCatalogs' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.appCatalogs' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /appCatalogs/teamsApps: description: Provides operations to manage the teamsApps property of the microsoft.graph.appCatalogs entity. get: tags: - appCatalogs.teamsApp summary: List teamsApp description: "List apps from the Microsoft Teams app catalog.\nThis includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify organization as the distributionMethod in the request." externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/appcatalogs-list-teamsapps?view=graph-rest-1.0 operationId: appCatalogs.ListTeamsApps 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.teamsAppCollectionResponse' 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: - appCatalogs.teamsApp summary: Publish teamsApp description: "Publish an app to the Microsoft Teams app catalog.\nSpecifically, this API publishes the app to your organization's catalog (the tenant app catalog);\nthe created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center." externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/teamsapp-publish?view=graph-rest-1.0 operationId: appCatalogs.CreateTeamsApps requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.teamsApp' required: true responses: 2XX: description: Created 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 '/appCatalogs/teamsApps/{teamsApp-id}': description: Provides operations to manage the teamsApps property of the microsoft.graph.appCatalogs entity. get: tags: - appCatalogs.teamsApp summary: Get teamsApps from appCatalogs operationId: appCatalogs.GetTeamsApps parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: 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 patch: tags: - appCatalogs.teamsApp summary: Update the navigation property teamsApps in appCatalogs operationId: appCatalogs.UpdateTeamsApps requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.teamsApp' required: true responses: 2XX: description: Success 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 delete: tags: - appCatalogs.teamsApp summary: Delete teamsApp description: 'Delete an app from an organization''s app catalog (the tenant app catalog). To delete an app, the distributionMethod property for the app must be set to organization. You can also use this API to remove a submitted app from the review process.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/teamsapp-delete?view=graph-rest-1.0 operationId: appCatalogs.DeleteTeamsApps 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: teamsApp-id in: path description: The unique identifier of teamsApp required: true schema: type: string x-ms-docs-key-type: teamsApp '/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions': description: Provides operations to manage the appDefinitions property of the microsoft.graph.teamsApp entity. get: tags: - appCatalogs.teamsApp summary: Get appDefinitions from appCatalogs description: The details for each version of the app. operationId: appCatalogs.teamsApps.ListAppDefinitions 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.teamsAppDefinitionCollectionResponse' 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: - appCatalogs.teamsApp summary: Update teamsApp description: 'Update an app previously published to the Microsoft Teams app catalog. To update an app, the distributionMethod property for the app must be set to organization. This API specifically updates an app published to your organization''s app catalog (the tenant app catalog).' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/teamsapp-update?view=graph-rest-1.0 operationId: appCatalogs.teamsApps.CreateAppDefinitions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition' required: true responses: 2XX: description: Created 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: teamsApp-id in: path description: The unique identifier of teamsApp required: true schema: type: string x-ms-docs-key-type: teamsApp '/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions/{teamsAppDefinition-id}': description: Provides operations to manage the appDefinitions property of the microsoft.graph.teamsApp entity. get: tags: - appCatalogs.teamsApp summary: Get appDefinitions from appCatalogs description: The details for each version of the app. operationId: appCatalogs.teamsApps.GetAppDefinitions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: 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 patch: tags: - appCatalogs.teamsApp summary: Publish teamsApp description: "Publish an app to the Microsoft Teams app catalog.\nSpecifically, this API publishes the app to your organization's catalog (the tenant app catalog);\nthe created resource has a distributionMethod property value of organization. The requiresReview property allows any user to submit an app for review by an administrator. Admins can approve or reject these apps via this API or the Microsoft Teams admin center." externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/teamsapp-publish?view=graph-rest-1.0 operationId: appCatalogs.teamsApps.UpdateAppDefinitions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition' required: true responses: 2XX: description: Success 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 delete: tags: - appCatalogs.teamsApp summary: Delete navigation property appDefinitions for appCatalogs operationId: appCatalogs.teamsApps.DeleteAppDefinitions 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: teamsApp-id in: path description: The unique identifier of teamsApp required: true schema: type: string x-ms-docs-key-type: teamsApp - name: teamsAppDefinition-id in: path description: The unique identifier of teamsAppDefinition required: true schema: type: string x-ms-docs-key-type: teamsAppDefinition '/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions/{teamsAppDefinition-id}/bot': description: Provides operations to manage the bot property of the microsoft.graph.teamsAppDefinition entity. get: tags: - appCatalogs.teamsApp summary: Get teamworkBot description: Get the bot associated with a specific definition of the TeamsApp. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/teamworkbot-get?view=graph-rest-1.0 operationId: appCatalogs.teamsApps.appDefinitions.GetBot parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.teamworkBot' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - appCatalogs.teamsApp summary: Update the navigation property bot in appCatalogs operationId: appCatalogs.teamsApps.appDefinitions.UpdateBot requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.teamworkBot' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.teamworkBot' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - appCatalogs.teamsApp summary: Delete navigation property bot for appCatalogs operationId: appCatalogs.teamsApps.appDefinitions.DeleteBot 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: teamsApp-id in: path description: The unique identifier of teamsApp required: true schema: type: string x-ms-docs-key-type: teamsApp - name: teamsAppDefinition-id in: path description: The unique identifier of teamsAppDefinition required: true schema: type: string x-ms-docs-key-type: teamsAppDefinition '/appCatalogs/teamsApps/{teamsApp-id}/appDefinitions/$count': description: Provides operations to count the resources in the collection. get: tags: - appCatalogs.teamsApp summary: Get the number of the resource operationId: appCatalogs.teamsApps.appDefinitions.GetCount-ad4f 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: teamsApp-id in: path description: The unique identifier of teamsApp required: true schema: type: string x-ms-docs-key-type: teamsApp /appCatalogs/teamsApps/$count: description: Provides operations to count the resources in the collection. get: tags: - appCatalogs.teamsApp summary: Get the number of the resource operationId: appCatalogs.teamsApps.GetCount-d4ad 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' /applications: description: Provides operations to manage the collection of application entities. get: tags: - applications.application summary: List applications description: Get the list of applications in this organization. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list?view=graph-rest-1.0 operationId: applications.application.ListApplication 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 x-ms-docs-operation-type: operation post: tags: - applications.application summary: Create application description: Create a new application object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-applications?view=graph-rest-1.0 operationId: applications.application.CreateApplication requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/applications/{application-id}': description: Provides operations to manage the collection of application entities. get: tags: - applications.application summary: Get application description: Get the properties and relationships of an application object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0 operationId: applications.application.GetApplication parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.application summary: Upsert application description: 'Create a new application object if it doesn''t exist, or update the properties of an existing application object.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0 operationId: applications.application.UpdateApplication requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.application summary: Delete application description: 'Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0 operationId: applications.application.DeleteApplication 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/appManagementPolicies': description: Provides operations to manage the appManagementPolicies property of the microsoft.graph.application entity. get: tags: - applications.appManagementPolicy summary: Get appManagementPolicies from applications description: The appManagementPolicy applied to this application. operationId: applications.ListAppManagementPolicies 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.appManagementPolicyCollectionResponse' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/appManagementPolicies/{appManagementPolicy-id}/$ref': description: Provides operations to manage the collection of application entities. delete: tags: - applications.appManagementPolicy summary: Remove appliesTo description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0 operationId: applications.appManagementPolicies.DeleteRefAppManagementPolicy 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: appManagementPolicy-id in: path description: The unique identifier of appManagementPolicy required: true schema: type: string x-ms-docs-key-type: appManagementPolicy '/applications/{application-id}/appManagementPolicies/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.appManagementPolicy summary: Get the number of the resource operationId: applications.appManagementPolicies.GetCount-3aad 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/appManagementPolicies/$ref': description: Provides operations to manage the collection of application entities. get: tags: - applications.appManagementPolicy summary: Get ref of appManagementPolicies from applications description: The appManagementPolicy applied to this application. operationId: applications.ListRefAppManagementPolicies 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: - applications.appManagementPolicy summary: Assign appliesTo description: Assign an appManagementPolicy policy object to an application or service principal object. The application or service principal adopts this policy over the tenant-wide tenantAppManagementPolicy setting. Only one policy object can be assigned to an application or service principal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/appmanagementpolicy-post-appliesto?view=graph-rest-1.0 operationId: applications.CreateRefAppManagementPolicies 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: - applications.appManagementPolicy summary: Remove appliesTo description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0 operationId: applications.DeleteRefAppManagementPolicies 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/createdOnBehalfOf': description: Provides operations to manage the createdOnBehalfOf property of the microsoft.graph.application entity. get: tags: - applications.directoryObject summary: Get createdOnBehalfOf from applications description: 'Supports $filter (/$count eq 0, /$count ne 0). Read-only.' operationId: applications.GetCreatedOnBehalfOf parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/extensionProperties': description: Provides operations to manage the extensionProperties property of the microsoft.graph.application entity. get: tags: - applications.extensionProperty summary: List extensionProperties (directory extensions) description: 'Retrieve the list of directory extension definitions, represented by extensionProperty objects on an application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-extensionproperty?view=graph-rest-1.0 operationId: applications.ListExtensionProperties 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.extensionPropertyCollectionResponse' 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: - applications.extensionProperty summary: Create extensionProperty (directory extension) description: 'Create a new directory extension definition, represented by an extensionProperty object.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-extensionproperty?view=graph-rest-1.0 operationId: applications.CreateExtensionProperties requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.extensionProperty' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.extensionProperty' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/extensionProperties/{extensionProperty-id}': description: Provides operations to manage the extensionProperties property of the microsoft.graph.application entity. get: tags: - applications.extensionProperty summary: Get extensionProperty (directory extension) description: Read a directory extension definition represented by an extensionProperty object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/extensionproperty-get?view=graph-rest-1.0 operationId: applications.GetExtensionProperties parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.extensionProperty' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.extensionProperty summary: Update the navigation property extensionProperties in applications operationId: applications.UpdateExtensionProperties requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.extensionProperty' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.extensionProperty' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.extensionProperty summary: Delete extensionProperty (directory extension) description: Delete a directory extension definition represented by an extensionProperty object. You can delete only directory extensions that aren't synced from on-premises active directory (AD). externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/extensionproperty-delete?view=graph-rest-1.0 operationId: applications.DeleteExtensionProperties 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: extensionProperty-id in: path description: The unique identifier of extensionProperty required: true schema: type: string x-ms-docs-key-type: extensionProperty '/applications/{application-id}/extensionProperties/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.extensionProperty summary: Get the number of the resource operationId: applications.extensionProperties.GetCount-3535 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/federatedIdentityCredentials': description: Provides operations to manage the federatedIdentityCredentials property of the microsoft.graph.application entity. get: tags: - applications.federatedIdentityCredential summary: List federatedIdentityCredentials description: Get a list of the federatedIdentityCredential objects and their properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-federatedidentitycredentials?view=graph-rest-1.0 operationId: applications.ListFederatedIdentityCredentials 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.federatedIdentityCredentialCollectionResponse' 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: - applications.federatedIdentityCredential summary: Create federatedIdentityCredential description: 'Create a new federatedIdentityCredential object for an application. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-federatedidentitycredentials?view=graph-rest-1.0 operationId: applications.CreateFederatedIdentityCredentials requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}': description: Provides operations to manage the federatedIdentityCredentials property of the microsoft.graph.application entity. get: tags: - applications.federatedIdentityCredential summary: Get federatedIdentityCredential description: Read the properties and relationships of a federatedIdentityCredential object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-1.0 operationId: applications.GetFederatedIdentityCredentials parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.federatedIdentityCredential summary: Upsert federatedIdentityCredential description: 'Create a new federatedIdentityCredential object for an application if it doesn''t exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-1.0 operationId: applications.UpdateFederatedIdentityCredentials requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.federatedIdentityCredential summary: Delete federatedIdentityCredential description: Delete a federatedIdentityCredential object from an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-1.0 operationId: applications.DeleteFederatedIdentityCredentials 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: federatedIdentityCredential-id in: path description: The unique identifier of federatedIdentityCredential required: true schema: type: string x-ms-docs-key-type: federatedIdentityCredential x-ms-docs-grouped-path: - '/applications/{application-id}/federatedIdentityCredentials(name=''{name}'')' '/applications/{application-id}/federatedIdentityCredentials(name=''{name}'')': description: Provides operations to manage the federatedIdentityCredentials property of the microsoft.graph.application entity. get: tags: - applications.federatedIdentityCredential summary: Get federatedIdentityCredential description: Read the properties and relationships of a federatedIdentityCredential object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-1.0 operationId: applications.federatedIdentityCredentials.GetByName parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.federatedIdentityCredential summary: Upsert federatedIdentityCredential description: 'Create a new federatedIdentityCredential object for an application if it doesn''t exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-1.0 operationId: applications.federatedIdentityCredentials.UpdateByName requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.federatedIdentityCredential summary: Delete federatedIdentityCredential description: Delete a federatedIdentityCredential object from an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-1.0 operationId: applications.federatedIdentityCredentials.DeleteByName 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: name in: path description: Alternate key of federatedIdentityCredential required: true schema: type: string x-ms-docs-grouped-path: - '/applications/{application-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}' '/applications/{application-id}/federatedIdentityCredentials/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.federatedIdentityCredential summary: Get the number of the resource operationId: applications.federatedIdentityCredentials.GetCount-d653 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/homeRealmDiscoveryPolicies': description: Provides operations to manage the homeRealmDiscoveryPolicies property of the microsoft.graph.application entity. get: tags: - applications.homeRealmDiscoveryPolicy summary: Get homeRealmDiscoveryPolicies from applications operationId: applications.ListHomeRealmDiscoveryPolicies 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.homeRealmDiscoveryPolicyCollectionResponse' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}': description: Provides operations to manage the homeRealmDiscoveryPolicies property of the microsoft.graph.application entity. get: tags: - applications.homeRealmDiscoveryPolicy summary: Get homeRealmDiscoveryPolicies from applications operationId: applications.GetHomeRealmDiscoveryPolicies parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: homeRealmDiscoveryPolicy-id in: path description: The unique identifier of homeRealmDiscoveryPolicy required: true schema: type: string x-ms-docs-key-type: homeRealmDiscoveryPolicy '/applications/{application-id}/homeRealmDiscoveryPolicies/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.homeRealmDiscoveryPolicy summary: Get the number of the resource operationId: applications.homeRealmDiscoveryPolicies.GetCount-1662 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/logo': description: Provides operations to manage the media for the application entity. get: tags: - applications.application summary: Get logo for application from applications description: The main logo for the application. Not nullable. operationId: applications.application.GetLogo 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: - applications.application summary: Update logo for application in applications description: The main logo for the application. Not nullable. operationId: applications.application.UpdateLogo 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: - applications.application summary: Delete logo for application in applications description: The main logo for the application. Not nullable. operationId: applications.application.DeleteLogo 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/addKey': description: Provides operations to call the addKey method. post: tags: - applications.Actions summary: Invoke action addKey description: 'Add a key credential to an application. This method, along with removeKey can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. Applications that don’t have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won’t be able to use this service action. You can use the Update application operation to perform an update instead.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-addkey?view=graph-rest-1.0 operationId: applications.application.addKey requestBody: description: Action parameters content: application/json: schema: type: object properties: keyCredential: $ref: '#/components/schemas/microsoft.graph.keyCredential' passwordCredential: anyOf: - $ref: '#/components/schemas/microsoft.graph.passwordCredential' - type: object nullable: true proof: type: string required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.keyCredential' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/addPassword': description: Provides operations to call the addPassword method. post: tags: - applications.Actions summary: Invoke action addPassword description: Adds a strong password or secret to an application. You can also add passwords while creating the application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-addpassword?view=graph-rest-1.0 operationId: applications.application.addPassword requestBody: description: Action parameters content: application/json: schema: type: object properties: passwordCredential: anyOf: - $ref: '#/components/schemas/microsoft.graph.passwordCredential' - type: object nullable: true required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.passwordCredential' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/checkMemberGroups': description: Provides operations to call the checkMemberGroups method. post: tags: - applications.Actions summary: Invoke action checkMemberGroups description: 'Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. 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: applications.application.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/checkMemberObjects': description: Provides operations to call the checkMemberObjects method. post: tags: - applications.Actions summary: Invoke action checkMemberObjects operationId: applications.application.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/getMemberGroups': description: Provides operations to call the getMemberGroups method. post: tags: - applications.Actions summary: 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: applications.application.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/getMemberObjects': description: Provides operations to call the getMemberObjects method. post: tags: - applications.Actions summary: Invoke action getMemberObjects description: 'Return all IDs for the groups, administrative units, and directory roles that a user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. Note: 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: applications.application.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/removeKey': description: Provides operations to call the removeKey method. post: tags: - applications.Actions summary: Invoke action removeKey description: 'Remove a key credential from an application. This method along with addKey can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-removekey?view=graph-rest-1.0 operationId: applications.application.removeKey requestBody: description: Action parameters content: application/json: schema: type: object properties: keyId: 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 proof: type: string required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/removePassword': description: Provides operations to call the removePassword method. post: tags: - applications.Actions summary: Invoke action removePassword description: Remove a password from an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-removepassword?view=graph-rest-1.0 operationId: applications.application.removePassword requestBody: description: Action parameters content: application/json: schema: type: object properties: keyId: 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 required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/restore': description: Provides operations to call the restore method. post: tags: - applications.Actions summary: Invoke action restore description: 'Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. However, security groups cannot be restored. Also, restoring an application doesn''t 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: applications.application.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/setVerifiedPublisher': description: Provides operations to call the setVerifiedPublisher method. post: tags: - applications.Actions summary: Invoke action setVerifiedPublisher description: 'Set the verifiedPublisher on an application. For more information, including prerequisites to setting a verified publisher, see Publisher verification.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-setverifiedpublisher?view=graph-rest-1.0 operationId: applications.application.setVerifiedPublisher requestBody: description: Action parameters content: application/json: schema: type: object properties: verifiedPublisherId: type: string required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/unsetVerifiedPublisher': description: Provides operations to call the unsetVerifiedPublisher method. post: tags: - applications.Actions summary: Invoke action unsetVerifiedPublisher description: 'Unset the verifiedPublisher previously set on an application, removing all verified publisher properties. For more information, see Publisher verification.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-unsetverifiedpublisher?view=graph-rest-1.0 operationId: applications.application.unsetVerifiedPublisher responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners': description: Provides operations to manage the owners property of the microsoft.graph.application entity. get: tags: - applications.directoryObject summary: List owners of an application description: Retrieve a list of owners for an application that are directoryObject types. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-owners?view=graph-rest-1.0 operationId: applications.ListOwners 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/{directoryObject-id}/$ref': description: Provides operations to manage the collection of application entities. delete: tags: - applications.directoryObject summary: Remove application owner description: 'Remove an owner from an application. As a recommended best practice, apps should have at least two owners.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-owners?view=graph-rest-1.0 operationId: applications.owners.DeleteRefDirectoryObject 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/applications/{application-id}/owners/{directoryObject-id}/graph.appRoleAssignment': description: Casts the previous resource to appRoleAssignment. get: tags: - applications.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.appRoleAssignment operationId: applications.GetOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/applications/{application-id}/owners/{directoryObject-id}/graph.endpoint': description: Casts the previous resource to endpoint. get: tags: - applications.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.endpoint operationId: applications.GetOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/applications/{application-id}/owners/{directoryObject-id}/graph.servicePrincipal': description: Casts the previous resource to servicePrincipal. get: tags: - applications.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal operationId: applications.GetOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/applications/{application-id}/owners/{directoryObject-id}/graph.user': description: Casts the previous resource to user. get: tags: - applications.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.user operationId: applications.GetOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/applications/{application-id}/owners/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.directoryObject summary: Get the number of the resource operationId: applications.owners.GetCount-2b88 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/$ref': description: Provides operations to manage the collection of application entities. get: tags: - applications.directoryObject summary: List owners of an application description: Retrieve a list of owners for an application that are directoryObject types. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-owners?view=graph-rest-1.0 operationId: applications.ListRefOwners 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 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: - applications.directoryObject summary: Add owner description: 'Add an owner to an application. Currently, only individual users are supported as owners of applications.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-owners?view=graph-rest-1.0 operationId: applications.CreateRefOwners 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: - applications.directoryObject summary: Remove application owner description: 'Remove an owner from an application. As a recommended best practice, apps should have at least two owners.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-owners?view=graph-rest-1.0 operationId: applications.DeleteRefOwners 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.appRoleAssignment': description: Casts the previous resource to appRoleAssignment. get: tags: - applications.directoryObject summary: Get the items of type microsoft.graph.appRoleAssignment in the microsoft.graph.directoryObject collection operationId: applications.ListOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.appRoleAssignment/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.directoryObject summary: Get the number of the resource operationId: applications.Owners.GetCount.AsAppRoleAssignment-eb25 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.endpoint': description: Casts the previous resource to endpoint. get: tags: - applications.directoryObject summary: Get the items of type microsoft.graph.endpoint in the microsoft.graph.directoryObject collection operationId: applications.ListOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.endpoint/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.directoryObject summary: Get the number of the resource operationId: applications.Owners.GetCount.AsEndpoint-0426 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.servicePrincipal': description: Casts the previous resource to servicePrincipal. get: tags: - applications.directoryObject summary: Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection operationId: applications.ListOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.servicePrincipal/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.directoryObject summary: Get the number of the resource operationId: applications.Owners.GetCount.AsServicePrincipal-0959 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.user': description: Casts the previous resource to user. get: tags: - applications.directoryObject summary: Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection operationId: applications.ListOwners.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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/owners/graph.user/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.directoryObject summary: Get the number of the resource operationId: applications.Owners.GetCount.AsUser-c674 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization': description: Provides operations to manage the synchronization property of the microsoft.graph.application entity. get: tags: - applications.synchronization summary: Get synchronization from applications description: Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API. operationId: applications.GetSynchronization parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation put: tags: - applications.synchronization summary: Update the navigation property synchronization in applications operationId: applications.UpdateSynchronization requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronization' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronization' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property synchronization for applications operationId: applications.DeleteSynchronization 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization/jobs': description: Provides operations to manage the jobs property of the microsoft.graph.synchronization entity. get: tags: - applications.synchronization summary: Get jobs from applications description: 'Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.' operationId: applications.synchronization.ListJobs 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.synchronizationJobCollectionResponse' 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: - applications.synchronization summary: Create new navigation property to jobs for applications operationId: applications.synchronization.CreateJobs requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationJob' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationJob' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}': description: Provides operations to manage the jobs property of the microsoft.graph.synchronization entity. get: tags: - applications.synchronization summary: Get jobs from applications description: 'Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.' operationId: applications.synchronization.GetJobs parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationJob' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.synchronization summary: Update the navigation property jobs in applications operationId: applications.synchronization.UpdateJobs requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationJob' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationJob' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property jobs for applications operationId: applications.synchronization.DeleteJobs 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload': description: Provides operations to manage the bulkUpload property of the microsoft.graph.synchronizationJob entity. get: tags: - applications.synchronization summary: Get bulkUpload from applications description: The bulk upload operation for the job. operationId: applications.synchronization.jobs.GetBulkUpload parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.bulkUpload' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.synchronization summary: Update the navigation property bulkUpload in applications operationId: applications.synchronization.jobs.UpdateBulkUpload requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.bulkUpload' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.bulkUpload' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property bulkUpload for applications operationId: applications.synchronization.jobs.DeleteBulkUpload 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload/$value': description: Provides operations to manage the media for the application entity. get: tags: - applications.synchronization summary: Get media content for the navigation property bulkUpload from applications description: The bulk upload operation for the job. operationId: applications.synchronization.jobs.GetBulkUploadContent 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: - applications.synchronization summary: Update media content for the navigation property bulkUpload in applications description: The bulk upload operation for the job. operationId: applications.synchronization.jobs.UpdateBulkUploadContent 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: - applications.synchronization summary: Delete media content for the navigation property bulkUpload in applications description: The bulk upload operation for the job. operationId: applications.synchronization.jobs.DeleteBulkUploadContent 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/pause': description: Provides operations to call the pause method. post: tags: - applications.Actions summary: Invoke action pause description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.pause responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/provisionOnDemand': description: Provides operations to call the provisionOnDemand method. post: tags: - applications.Actions summary: Invoke action provisionOnDemand description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.provisionOnDemand requestBody: description: Action parameters content: application/json: schema: type: object properties: parameters: type: array items: $ref: '#/components/schemas/microsoft.graph.synchronizationJobApplicationParameters' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.stringKeyStringValuePair' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/restart': description: Provides operations to call the restart method. post: tags: - applications.Actions summary: Invoke action restart description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.restart requestBody: description: Action parameters content: application/json: schema: type: object properties: criteria: anyOf: - $ref: '#/components/schemas/microsoft.graph.synchronizationJobRestartCriteria' - 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/start': description: Provides operations to call the start method. post: tags: - applications.Actions summary: Invoke action start description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.start responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/validateCredentials': description: Provides operations to call the validateCredentials method. post: tags: - applications.Actions summary: Invoke action validateCredentials description: Validate that the credentials are valid in the tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.validateCredentials requestBody: description: Action parameters content: application/json: schema: type: object properties: applicationIdentifier: type: string nullable: true templateId: type: string nullable: true useSavedCredentials: type: boolean default: false nullable: true credentials: type: array items: $ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/validateCredentials' '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema': description: Provides operations to manage the schema property of the microsoft.graph.synchronizationJob entity. get: tags: - applications.synchronization summary: Get schema from applications description: The synchronization schema configured for the job. operationId: applications.synchronization.jobs.GetSchema parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.synchronization summary: Update the navigation property schema in applications operationId: applications.synchronization.jobs.UpdateSchema requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationSchema' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property schema for applications operationId: applications.synchronization.jobs.DeleteSchema 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories': description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - applications.synchronization summary: Get directories from applications description: Contains the collection of directories and all of their objects. operationId: applications.synchronization.jobs.schema.ListDirectories 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.directoryDefinitionCollectionResponse' 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: - applications.synchronization summary: Create new navigation property to directories for applications operationId: applications.synchronization.jobs.schema.CreateDirectories requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories' '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}': description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - applications.synchronization summary: Get directories from applications description: Contains the collection of directories and all of their objects. operationId: applications.synchronization.jobs.schema.GetDirectories parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.synchronization summary: Update the navigation property directories in applications operationId: applications.synchronization.jobs.schema.UpdateDirectories requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property directories for applications operationId: applications.synchronization.jobs.schema.DeleteDirectories 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}' '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}/discover': description: Provides operations to call the discover method. post: tags: - applications.Actions summary: Invoke action discover description: 'Discover the latest schema definition for provisioning to an application. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.schema.directories.directoryDefinition.discover responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.directoryDefinition' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}/discover' '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.synchronization summary: Get the number of the resource operationId: applications.synchronization.jobs.schema.directories.GetCount-03bf 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/filterOperators()': description: Provides operations to call the filterOperators method. get: tags: - applications.Functions summary: Invoke function filterOperators description: List all operators supported in the scoping filters. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.schema.filterOperators 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 filterOperatorSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.filterOperatorSchema' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/filterOperators()' '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/functions()': description: Provides operations to call the functions method. get: tags: - applications.Functions summary: Invoke function functions description: List all the functions currently supported in the attributeMappingSource. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.schema.functions 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 attributeMappingFunctionSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.attributeMappingFunctionSchema' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/functions()' '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/parseExpression': description: Provides operations to call the parseExpression method. post: tags: - applications.Actions summary: Invoke action parseExpression description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 operationId: applications.application.synchronization.jobs.synchronizationJob.schema.parseExpression requestBody: description: Action parameters content: application/json: schema: type: object properties: expression: type: string nullable: true testInputObject: anyOf: - $ref: '#/components/schemas/microsoft.graph.expressionInputObject' - type: object nullable: true targetAttributeDefinition: anyOf: - $ref: '#/components/schemas/microsoft.graph.attributeDefinition' - type: object nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.parseExpressionResponse' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/parseExpression' '/applications/{application-id}/synchronization/jobs/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.synchronization summary: Get the number of the resource operationId: applications.synchronization.jobs.GetCount-30ed 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization/jobs/validateCredentials': description: Provides operations to call the validateCredentials method. post: tags: - applications.Actions summary: Invoke action validateCredentials operationId: applications.application.synchronization.jobs.validateCredentials requestBody: description: Action parameters content: application/json: schema: type: object properties: applicationIdentifier: type: string nullable: true templateId: type: string nullable: true useSavedCredentials: type: boolean default: false nullable: true credentials: type: array items: $ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/validateCredentials' '/applications/{application-id}/synchronization/acquireAccessToken': description: Provides operations to call the acquireAccessToken method. post: tags: - applications.Actions summary: Invoke action acquireAccessToken description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 operationId: applications.application.synchronization.acquireAccessToken requestBody: description: Action parameters content: application/json: schema: type: object properties: credentials: type: array items: $ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization/secrets': put: tags: - applications.synchronization summary: Update property secrets value. operationId: applications.synchronization.UpdateSecrets requestBody: description: New property values content: application/json: schema: type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair' required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization/secrets/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.synchronization summary: Get the number of the resource operationId: applications.synchronization.Secrets.GetCount-26f1 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization/templates': description: Provides operations to manage the templates property of the microsoft.graph.synchronization entity. get: tags: - applications.synchronization summary: Get templates from applications description: Preconfigured synchronization settings for a particular application. operationId: applications.synchronization.ListTemplates 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.synchronizationTemplateCollectionResponse' 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: - applications.synchronization summary: Create new navigation property to templates for applications operationId: applications.synchronization.CreateTemplates requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationTemplate' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationTemplate' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}': description: Provides operations to manage the templates property of the microsoft.graph.synchronization entity. get: tags: - applications.synchronization summary: Get templates from applications description: Preconfigured synchronization settings for a particular application. operationId: applications.synchronization.GetTemplates parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationTemplate' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.synchronization summary: Update synchronizationTemplate description: Update (override) the synchronization template associated with a given application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0 operationId: applications.synchronization.UpdateTemplates requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationTemplate' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationTemplate' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property templates for applications operationId: applications.synchronization.DeleteTemplates 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema': description: Provides operations to manage the schema property of the microsoft.graph.synchronizationTemplate entity. get: tags: - applications.synchronization summary: Get schema from applications description: Default synchronization schema for the jobs based on this template. operationId: applications.synchronization.templates.GetSchema parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.synchronization summary: Update the navigation property schema in applications operationId: applications.synchronization.templates.UpdateSchema requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationSchema' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.synchronizationSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property schema for applications operationId: applications.synchronization.templates.DeleteSchema 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories': description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - applications.synchronization summary: Get directories from applications description: Contains the collection of directories and all of their objects. operationId: applications.synchronization.templates.schema.ListDirectories 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.directoryDefinitionCollectionResponse' 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: - applications.synchronization summary: Create new navigation property to directories for applications operationId: applications.synchronization.templates.schema.CreateDirectories requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories' '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}': description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - applications.synchronization summary: Get directories from applications description: Contains the collection of directories and all of their objects. operationId: applications.synchronization.templates.schema.GetDirectories parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.synchronization summary: Update the navigation property directories in applications operationId: applications.synchronization.templates.schema.UpdateDirectories requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryDefinition' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.synchronization summary: Delete navigation property directories for applications operationId: applications.synchronization.templates.schema.DeleteDirectories 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}' '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}/discover': description: Provides operations to call the discover method. post: tags: - applications.Actions summary: Invoke action discover description: 'Discover the latest schema definition for provisioning to an application. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 operationId: applications.application.synchronization.templates.synchronizationTemplate.schema.directories.directoryDefinition.discover responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.directoryDefinition' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}/discover' '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.synchronization summary: Get the number of the resource operationId: applications.synchronization.templates.schema.directories.GetCount-27bc 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/filterOperators()': description: Provides operations to call the filterOperators method. get: tags: - applications.Functions summary: Invoke function filterOperators description: List all operators supported in the scoping filters. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 operationId: applications.application.synchronization.templates.synchronizationTemplate.schema.filterOperators 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 filterOperatorSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.filterOperatorSchema' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/filterOperators()' '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/functions()': description: Provides operations to call the functions method. get: tags: - applications.Functions summary: Invoke function functions description: List all the functions currently supported in the attributeMappingSource. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 operationId: applications.application.synchronization.templates.synchronizationTemplate.schema.functions 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 attributeMappingFunctionSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.attributeMappingFunctionSchema' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/functions()' '/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/parseExpression': description: Provides operations to call the parseExpression method. post: tags: - applications.Actions summary: Invoke action parseExpression description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 operationId: applications.application.synchronization.templates.synchronizationTemplate.schema.parseExpression requestBody: description: Action parameters content: application/json: schema: type: object properties: expression: type: string nullable: true testInputObject: anyOf: - $ref: '#/components/schemas/microsoft.graph.expressionInputObject' - type: object nullable: true targetAttributeDefinition: anyOf: - $ref: '#/components/schemas/microsoft.graph.attributeDefinition' - type: object nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.parseExpressionResponse' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate x-ms-docs-grouped-path: - '/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/parseExpression' '/applications/{application-id}/synchronization/templates/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.synchronization summary: Get the number of the resource operationId: applications.synchronization.templates.GetCount-738a 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/tokenIssuancePolicies': description: Provides operations to manage the tokenIssuancePolicies property of the microsoft.graph.application entity. get: tags: - applications.tokenIssuancePolicy summary: List assigned tokenIssuancePolicies description: List the tokenIssuancePolicy objects that are assigned to an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0 operationId: applications.ListTokenIssuancePolicies 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.tokenIssuancePolicyCollectionResponse' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/tokenIssuancePolicies/{tokenIssuancePolicy-id}/$ref': description: Provides operations to manage the collection of application entities. delete: tags: - applications.tokenIssuancePolicy summary: Remove tokenIssuancePolicy description: Remove a tokenIssuancePolicy from an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenissuancepolicies?view=graph-rest-1.0 operationId: applications.tokenIssuancePolicies.DeleteRefTokenIssuancePolicy 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: tokenIssuancePolicy-id in: path description: The unique identifier of tokenIssuancePolicy required: true schema: type: string x-ms-docs-key-type: tokenIssuancePolicy '/applications/{application-id}/tokenIssuancePolicies/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.tokenIssuancePolicy summary: Get the number of the resource operationId: applications.tokenIssuancePolicies.GetCount-4be5 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/tokenIssuancePolicies/$ref': description: Provides operations to manage the collection of application entities. get: tags: - applications.tokenIssuancePolicy summary: List assigned tokenIssuancePolicies description: List the tokenIssuancePolicy objects that are assigned to an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0 operationId: applications.ListRefTokenIssuancePolicies 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: - applications.tokenIssuancePolicy summary: Assign tokenIssuancePolicy description: Assign a tokenIssuancePolicy to an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-tokenissuancepolicies?view=graph-rest-1.0 operationId: applications.CreateRefTokenIssuancePolicies 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: - applications.tokenIssuancePolicy summary: Remove tokenIssuancePolicy description: Remove a tokenIssuancePolicy from an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenissuancepolicies?view=graph-rest-1.0 operationId: applications.DeleteRefTokenIssuancePolicies 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/tokenLifetimePolicies': description: Provides operations to manage the tokenLifetimePolicies property of the microsoft.graph.application entity. get: tags: - applications.tokenLifetimePolicy summary: List assigned tokenLifetimePolicies description: List the tokenLifetimePolicy objects that are assigned to an application. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0 operationId: applications.ListTokenLifetimePolicies 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.tokenLifetimePolicyCollectionResponse' 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/tokenLifetimePolicies/{tokenLifetimePolicy-id}/$ref': description: Provides operations to manage the collection of application entities. delete: tags: - applications.tokenLifetimePolicy summary: Remove tokenLifetimePolicy description: Remove a tokenLifetimePolicy from an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenlifetimepolicies?view=graph-rest-1.0 operationId: applications.tokenLifetimePolicies.DeleteRefTokenLifetimePolicy 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: tokenLifetimePolicy-id in: path description: The unique identifier of tokenLifetimePolicy required: true schema: type: string x-ms-docs-key-type: tokenLifetimePolicy '/applications/{application-id}/tokenLifetimePolicies/$count': description: Provides operations to count the resources in the collection. get: tags: - applications.tokenLifetimePolicy summary: Get the number of the resource operationId: applications.tokenLifetimePolicies.GetCount-5de4 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications/{application-id}/tokenLifetimePolicies/$ref': description: Provides operations to manage the collection of application entities. get: tags: - applications.tokenLifetimePolicy summary: List assigned tokenLifetimePolicies description: List the tokenLifetimePolicy objects that are assigned to an application. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0 operationId: applications.ListRefTokenLifetimePolicies 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: - applications.tokenLifetimePolicy summary: Assign tokenLifetimePolicy description: Assign a tokenLifetimePolicy to an application. You can have multiple tokenLifetimePolicy policies in a tenant but can assign only one tokenLifetimePolicy per application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-tokenlifetimepolicies?view=graph-rest-1.0 operationId: applications.CreateRefTokenLifetimePolicies 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: - applications.tokenLifetimePolicy summary: Remove tokenLifetimePolicy description: Remove a tokenLifetimePolicy from an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenlifetimepolicies?view=graph-rest-1.0 operationId: applications.DeleteRefTokenLifetimePolicies 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: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application '/applications(appId=''{appId}'')': description: Provides operations to manage the collection of application entities. get: tags: - applications.application summary: Get application description: Get the properties and relationships of an application object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0 operationId: applications.application.GetApplicationByAppId parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.application summary: Upsert application description: 'Create a new application object if it doesn''t exist, or update the properties of an existing application object.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0 operationId: applications.application.UpdateApplicationByAppId requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.application summary: Delete application description: 'Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0 operationId: applications.application.DeleteApplicationByAppId 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: appId in: path description: Alternate key of application required: true schema: type: string nullable: true '/applications(uniqueName=''{uniqueName}'')': description: Provides operations to manage the collection of application entities. get: tags: - applications.application summary: Get application description: Get the properties and relationships of an application object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0 operationId: applications.application.GetApplicationByUniqueName parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - applications.application summary: Upsert application description: 'Create a new application object if it doesn''t exist, or update the properties of an existing application object.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0 operationId: applications.application.UpdateApplicationByUniqueName requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - applications.application summary: Delete application description: 'Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0 operationId: applications.application.DeleteApplicationByUniqueName 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: uniqueName in: path description: Alternate key of application required: true schema: type: string nullable: true /applications/$count: description: Provides operations to count the resources in the collection. get: tags: - applications.application summary: Get the number of the resource operationId: applications.GetCount-8398 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' /applications/delta(): description: Provides operations to call the delta method. get: tags: - applications.Functions summary: Invoke function delta description: 'Get newly created, updated, or deleted applications without performing a full read of the entire resource collection. For details, see Using delta query.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delta?view=graph-rest-1.0 operationId: applications.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 application type: object allOf: - $ref: '#/components/schemas/BaseDeltaFunctionResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.application' 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: - /applications/delta() /applications/getAvailableExtensionProperties: description: Provides operations to call the getAvailableExtensionProperties method. post: tags: - applications.Actions summary: Invoke action getAvailableExtensionProperties description: 'Return all directory extension definitions that have been registered in a directory, including through multi-tenant 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: applications.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 /applications/getByIds: description: Provides operations to call the getByIds method. post: tags: - applications.Actions summary: 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: applications.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 /applications/validateProperties: description: Provides operations to call the validateProperties method. post: tags: - applications.Actions summary: 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:\n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\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 are 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: applications.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 /applicationTemplates: description: Provides operations to manage the collection of applicationTemplate entities. get: tags: - applicationTemplates.applicationTemplate summary: List applicationTemplates description: Retrieve a list of applicationTemplate objects from the Microsoft Entra application gallery. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/applicationtemplate-list?view=graph-rest-1.0 operationId: applicationTemplates.applicationTemplate.ListApplicationTemplate 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.applicationTemplateCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation '/applicationTemplates/{applicationTemplate-id}': description: Provides operations to manage the collection of applicationTemplate entities. get: tags: - applicationTemplates.applicationTemplate summary: Get applicationTemplate description: Retrieve the properties of an applicationTemplate object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/applicationtemplate-get?view=graph-rest-1.0 operationId: applicationTemplates.applicationTemplate.GetApplicationTemplate parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.applicationTemplate' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: applicationTemplate-id in: path description: The unique identifier of applicationTemplate required: true schema: type: string x-ms-docs-key-type: applicationTemplate '/applicationTemplates/{applicationTemplate-id}/instantiate': description: Provides operations to call the instantiate method. post: tags: - applicationTemplates.Actions summary: Invoke action instantiate description: Add an instance of an application from the Microsoft Entra application gallery into your directory. The application template with ID 8adf8e6e-67b2-4cf2-a259-e3dc5476c621 can be used to add a non-gallery app that you can configure different single-sign on (SSO) modes like SAML SSO and password-based SSO. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/applicationtemplate-instantiate?view=graph-rest-1.0 operationId: applicationTemplates.applicationTemplate.instantiate requestBody: description: Action parameters content: application/json: schema: type: object properties: displayName: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.applicationServicePrincipal' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: applicationTemplate-id in: path description: The unique identifier of applicationTemplate required: true schema: type: string x-ms-docs-key-type: applicationTemplate /applicationTemplates/$count: description: Provides operations to count the resources in the collection. get: tags: - applicationTemplates.applicationTemplate summary: Get the number of the resource operationId: applicationTemplates.GetCount-d1a3 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' /auditLogs: description: Provides operations to manage the auditLogRoot singleton. get: tags: - auditLogs.auditLogRoot summary: Get auditLogs operationId: auditLogs.auditLogRoot.GetAuditLogRoot parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.auditLogRoot' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - auditLogs.auditLogRoot summary: Update auditLogs operationId: auditLogs.auditLogRoot.UpdateAuditLogRoot requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.auditLogRoot' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.auditLogRoot' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /auditLogs/directoryAudits: description: Provides operations to manage the directoryAudits property of the microsoft.graph.auditLogRoot entity. get: tags: - auditLogs.directoryAudit summary: List directoryAudits description: 'Get the list of audit logs generated by Microsoft Entra ID. This includes audit logs generated by various services within Microsoft Entra ID, including user, app, device and group Management, privileged identity management (PIM), access reviews, terms of use, identity protection, password management (self-service and admin password resets), and self- service group management, and so on.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryaudit-list?view=graph-rest-1.0 operationId: auditLogs.ListDirectoryAudits 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.directoryAuditCollectionResponse' 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: - auditLogs.directoryAudit summary: Create new navigation property to directoryAudits for auditLogs operationId: auditLogs.CreateDirectoryAudits requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryAudit' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryAudit' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/auditLogs/directoryAudits/{directoryAudit-id}': description: Provides operations to manage the directoryAudits property of the microsoft.graph.auditLogRoot entity. get: tags: - auditLogs.directoryAudit summary: Get directoryAudit description: 'Get a specific Microsoft Entra audit log item. This includes an audit log item generated by various services within Microsoft Entra ID like user, application, device and group management, privileged identity management (PIM), access reviews, terms of use, identity protection, password management (self-service and admin password resets), self-service group management, and so on.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryaudit-get?view=graph-rest-1.0 operationId: auditLogs.GetDirectoryAudits parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryAudit' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - auditLogs.directoryAudit summary: Update the navigation property directoryAudits in auditLogs operationId: auditLogs.UpdateDirectoryAudits requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryAudit' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.directoryAudit' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - auditLogs.directoryAudit summary: Delete navigation property directoryAudits for auditLogs operationId: auditLogs.DeleteDirectoryAudits 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: directoryAudit-id in: path description: The unique identifier of directoryAudit required: true schema: type: string x-ms-docs-key-type: directoryAudit /auditLogs/directoryAudits/$count: description: Provides operations to count the resources in the collection. get: tags: - auditLogs.directoryAudit summary: Get the number of the resource operationId: auditLogs.directoryAudits.GetCount-fedb 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' /auditLogs/provisioning: description: Provides operations to manage the provisioning property of the microsoft.graph.auditLogRoot entity. get: tags: - auditLogs.provisioningObjectSummary summary: List provisioningObjectSummary description: 'Get all provisioning events that occurred in your tenant, such as the deletion of a group in a target application or the creation of a user when provisioning user accounts from your HR system. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/provisioningobjectsummary-list?view=graph-rest-1.0 operationId: auditLogs.ListProvisioning 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.provisioningObjectSummaryCollectionResponse' 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: - auditLogs.provisioningObjectSummary summary: Create new navigation property to provisioning for auditLogs operationId: auditLogs.CreateProvisioning requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.provisioningObjectSummary' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.provisioningObjectSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/auditLogs/provisioning/{provisioningObjectSummary-id}': description: Provides operations to manage the provisioning property of the microsoft.graph.auditLogRoot entity. get: tags: - auditLogs.provisioningObjectSummary summary: Get provisioning from auditLogs operationId: auditLogs.GetProvisioning parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.provisioningObjectSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - auditLogs.provisioningObjectSummary summary: Update the navigation property provisioning in auditLogs operationId: auditLogs.UpdateProvisioning requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.provisioningObjectSummary' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.provisioningObjectSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - auditLogs.provisioningObjectSummary summary: Delete navigation property provisioning for auditLogs operationId: auditLogs.DeleteProvisioning 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: provisioningObjectSummary-id in: path description: The unique identifier of provisioningObjectSummary required: true schema: type: string x-ms-docs-key-type: provisioningObjectSummary /auditLogs/provisioning/$count: description: Provides operations to count the resources in the collection. get: tags: - auditLogs.provisioningObjectSummary summary: Get the number of the resource operationId: auditLogs.provisioning.GetCount-2f99 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' /auditLogs/signIns: description: Provides operations to manage the signIns property of the microsoft.graph.auditLogRoot entity. get: tags: - auditLogs.signIn summary: List signIns description: 'Retrieve the Microsoft Entra user sign-ins for your tenant. Sign-ins that are interactive in nature (where a username/password is passed as part of auth token) and successful federated sign-ins are currently included in the sign-in logs. The maximum and default page size is 1,000 objects and by default, the most recent sign-ins are returned first. Only sign-in events that occurred within the Microsoft Entra ID default retention period are available.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/signin-list?view=graph-rest-1.0 operationId: auditLogs.ListSignIns 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.signInCollectionResponse' 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: - auditLogs.signIn summary: Create new navigation property to signIns for auditLogs operationId: auditLogs.CreateSignIns requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.signIn' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.signIn' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/auditLogs/signIns/{signIn-id}': description: Provides operations to manage the signIns property of the microsoft.graph.auditLogRoot entity. get: tags: - auditLogs.signIn summary: Get signIn description: Retrieve a specific Microsoft Entra user sign-in event for your tenant. Sign-ins that are interactive in nature (where a username/password is passed as part of auth token) and successful federated sign-ins are currently included in the sign-in logs. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/signin-get?view=graph-rest-1.0 operationId: auditLogs.GetSignIns parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.signIn' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - auditLogs.signIn summary: Update the navigation property signIns in auditLogs operationId: auditLogs.UpdateSignIns requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.signIn' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.signIn' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - auditLogs.signIn summary: Delete navigation property signIns for auditLogs operationId: auditLogs.DeleteSignIns 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: signIn-id in: path description: The unique identifier of signIn required: true schema: type: string x-ms-docs-key-type: signIn /auditLogs/signIns/$count: description: Provides operations to count the resources in the collection. get: tags: - auditLogs.signIn summary: Get the number of the resource operationId: auditLogs.signIns.GetCount-9ee4 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' /authenticationMethodConfigurations: description: Provides operations to manage the collection of authenticationMethodConfiguration entities. get: tags: - authenticationMethodConfigurations.authenticationMethodConfiguration summary: Get entities from authenticationMethodConfigurations operationId: authenticationMethodConfigurations.authenticationMethodConfiguration.ListAuthenticationMethodConfiguration 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.authenticationMethodConfigurationCollectionResponse' 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: - authenticationMethodConfigurations.authenticationMethodConfiguration summary: Add new entity to authenticationMethodConfigurations operationId: authenticationMethodConfigurations.authenticationMethodConfiguration.CreateAuthenticationMethodConfiguration requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}': description: Provides operations to manage the collection of authenticationMethodConfiguration entities. get: tags: - authenticationMethodConfigurations.authenticationMethodConfiguration summary: Get entity from authenticationMethodConfigurations by key operationId: authenticationMethodConfigurations.authenticationMethodConfiguration.GetAuthenticationMethodConfiguration parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.authenticationMethodConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - authenticationMethodConfigurations.authenticationMethodConfiguration summary: Update entity in authenticationMethodConfigurations operationId: authenticationMethodConfigurations.authenticationMethodConfiguration.UpdateAuthenticationMethodConfiguration requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - authenticationMethodConfigurations.authenticationMethodConfiguration summary: Delete entity from authenticationMethodConfigurations operationId: authenticationMethodConfigurations.authenticationMethodConfiguration.DeleteAuthenticationMethodConfiguration 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: authenticationMethodConfiguration-id in: path description: The unique identifier of authenticationMethodConfiguration required: true schema: type: string x-ms-docs-key-type: authenticationMethodConfiguration /authenticationMethodConfigurations/$count: description: Provides operations to count the resources in the collection. get: tags: - authenticationMethodConfigurations.authenticationMethodConfiguration summary: Get the number of the resource operationId: authenticationMethodConfigurations.GetCount-6d53 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' /authenticationMethodsPolicy: description: Provides operations to manage the authenticationMethodsPolicy singleton. get: tags: - authenticationMethodsPolicy.authenticationMethodsPolicy summary: Get authenticationMethodsPolicy operationId: authenticationMethodsPolicy.authenticationMethodsPolicy.GetAuthenticationMethodsPolicy parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.authenticationMethodsPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - authenticationMethodsPolicy.authenticationMethodsPolicy summary: Update authenticationMethodsPolicy operationId: authenticationMethodsPolicy.authenticationMethodsPolicy.UpdateAuthenticationMethodsPolicy requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /authenticationMethodsPolicy/authenticationMethodConfigurations: description: Provides operations to manage the authenticationMethodConfigurations property of the microsoft.graph.authenticationMethodsPolicy entity. get: tags: - authenticationMethodsPolicy.authenticationMethodConfiguration summary: Get authenticationMethodConfigurations from authenticationMethodsPolicy description: Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy. operationId: authenticationMethodsPolicy.ListAuthenticationMethodConfigurations 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.authenticationMethodConfigurationCollectionResponse' 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: - authenticationMethodsPolicy.authenticationMethodConfiguration summary: Create new navigation property to authenticationMethodConfigurations for authenticationMethodsPolicy operationId: authenticationMethodsPolicy.CreateAuthenticationMethodConfigurations requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}': description: Provides operations to manage the authenticationMethodConfigurations property of the microsoft.graph.authenticationMethodsPolicy entity. get: tags: - authenticationMethodsPolicy.authenticationMethodConfiguration summary: Get authenticationMethodConfigurations from authenticationMethodsPolicy description: Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy. operationId: authenticationMethodsPolicy.GetAuthenticationMethodConfigurations parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - authenticationMethodsPolicy.authenticationMethodConfiguration summary: Update the navigation property authenticationMethodConfigurations in authenticationMethodsPolicy operationId: authenticationMethodsPolicy.UpdateAuthenticationMethodConfigurations requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - authenticationMethodsPolicy.authenticationMethodConfiguration summary: Delete navigation property authenticationMethodConfigurations for authenticationMethodsPolicy operationId: authenticationMethodsPolicy.DeleteAuthenticationMethodConfigurations 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: authenticationMethodConfiguration-id in: path description: The unique identifier of authenticationMethodConfiguration required: true schema: type: string x-ms-docs-key-type: authenticationMethodConfiguration /authenticationMethodsPolicy/authenticationMethodConfigurations/$count: description: Provides operations to count the resources in the collection. get: tags: - authenticationMethodsPolicy.authenticationMethodConfiguration summary: Get the number of the resource operationId: authenticationMethodsPolicy.authenticationMethodConfigurations.GetCount-e7d5 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' /certificateBasedAuthConfiguration: description: Provides operations to manage the collection of certificateBasedAuthConfiguration entities. get: tags: - certificateBasedAuthConfiguration.certificateBasedAuthConfiguration summary: Get entities from certificateBasedAuthConfiguration operationId: certificateBasedAuthConfiguration.certificateBasedAuthConfiguration.ListCertificateBasedAuthConfiguration 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.certificateBasedAuthConfigurationCollectionResponse' 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: - certificateBasedAuthConfiguration.certificateBasedAuthConfiguration summary: Add new entity to certificateBasedAuthConfiguration operationId: certificateBasedAuthConfiguration.certificateBasedAuthConfiguration.CreateCertificateBasedAuthConfiguration requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/certificateBasedAuthConfiguration/{certificateBasedAuthConfiguration-id}': description: Provides operations to manage the collection of certificateBasedAuthConfiguration entities. get: tags: - certificateBasedAuthConfiguration.certificateBasedAuthConfiguration summary: Get entity from certificateBasedAuthConfiguration by key operationId: certificateBasedAuthConfiguration.certificateBasedAuthConfiguration.GetCertificateBasedAuthConfiguration parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.certificateBasedAuthConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - certificateBasedAuthConfiguration.certificateBasedAuthConfiguration summary: Update entity in certificateBasedAuthConfiguration operationId: certificateBasedAuthConfiguration.certificateBasedAuthConfiguration.UpdateCertificateBasedAuthConfiguration requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - certificateBasedAuthConfiguration.certificateBasedAuthConfiguration summary: Delete entity from certificateBasedAuthConfiguration operationId: certificateBasedAuthConfiguration.certificateBasedAuthConfiguration.DeleteCertificateBasedAuthConfiguration 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: certificateBasedAuthConfiguration-id in: path description: The unique identifier of certificateBasedAuthConfiguration required: true schema: type: string x-ms-docs-key-type: certificateBasedAuthConfiguration /certificateBasedAuthConfiguration/$count: description: Provides operations to count the resources in the collection. get: tags: - certificateBasedAuthConfiguration.certificateBasedAuthConfiguration summary: Get the number of the resource operationId: certificateBasedAuthConfiguration.GetCount-e291 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' /chats: description: Provides operations to manage the collection of chat entities. get: tags: - chats.chat summary: 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: chats.chat.ListChat 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: - chats.chat summary: Create chat description: Create a new chat object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-post?view=graph-rest-1.0 operationId: chats.chat.CreateChat requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.chat' required: true responses: 2XX: description: Created entity 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 '/chats/{chat-id}': description: Provides operations to manage the collection of chat entities. get: tags: - chats.chat summary: 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: chats.chat.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 entity 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: - chats.chat summary: Update chat description: Update the properties of a chat object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-patch?view=graph-rest-1.0 operationId: chats.chat.UpdateChat requestBody: description: New 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: - chats.chat summary: Delete chat description: 'Soft-delete a chat. When invoked with delegated permissions, this operation only works for tenant admins and Teams service admins.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-delete?view=graph-rest-1.0 operationId: chats.chat.DeleteChat 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/installedApps': description: Provides operations to manage the installedApps property of the microsoft.graph.chat entity. get: tags: - chats.teamsAppInstallation summary: List apps in chat description: List all app installations within a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-list-installedapps?view=graph-rest-1.0 operationId: 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: - chats.teamsAppInstallation summary: Add app to chat description: Install a teamsApp to the specified chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-post-installedapps?view=graph-rest-1.0 operationId: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/installedApps/{teamsAppInstallation-id}': description: Provides operations to manage the installedApps property of the microsoft.graph.chat entity. get: tags: - chats.teamsAppInstallation summary: Get installed app in chat description: Get an app installed in a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-get-installedapps?view=graph-rest-1.0 operationId: 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: - chats.teamsAppInstallation summary: Update the navigation property installedApps in chats operationId: 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: - chats.teamsAppInstallation summary: Uninstall app in a chat description: Uninstall an app installed within a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-delete-installedapps?view=graph-rest-1.0 operationId: 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: 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 '/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/upgrade': description: Provides operations to call the upgrade method. post: tags: - chats.Actions summary: 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: 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: 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 '/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsApp': description: Provides operations to manage the teamsApp property of the microsoft.graph.teamsAppInstallation entity. get: tags: - chats.teamsAppInstallation summary: Get teamsApp from chats description: The app that is installed. operationId: 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: 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 '/chats/{chat-id}/installedApps/{teamsAppInstallation-id}/teamsAppDefinition': description: Provides operations to manage the teamsAppDefinition property of the microsoft.graph.teamsAppInstallation entity. get: tags: - chats.teamsAppInstallation summary: Get teamsAppDefinition from chats description: The details of this version of the app. operationId: 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: 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 '/chats/{chat-id}/installedApps/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.teamsAppInstallation summary: Get the number of the resource operationId: chats.installedApps.GetCount-3987 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/lastMessagePreview': description: Provides operations to manage the lastMessagePreview property of the microsoft.graph.chat entity. get: tags: - chats.chatMessageInfo summary: Get lastMessagePreview from chats 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: 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: - chats.chatMessageInfo summary: Update the navigation property lastMessagePreview in chats operationId: 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: - chats.chatMessageInfo summary: Delete navigation property lastMessagePreview for chats operationId: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/members': description: Provides operations to manage the members property of the microsoft.graph.chat entity. get: tags: - chats.conversationMember summary: List conversationMembers description: List all conversation members in a chat or channel. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/conversationmember-list?view=graph-rest-1.0 operationId: 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: - chats.conversationMember summary: Add member to a chat description: Add a conversationMember to a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-post-members?view=graph-rest-1.0 operationId: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/members/{conversationMember-id}': description: Provides operations to manage the members property of the microsoft.graph.chat entity. get: tags: - chats.conversationMember summary: Get conversationMember description: Retrieve a conversationMember from a chat or channel. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/conversationmember-get?view=graph-rest-1.0 operationId: 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: - chats.conversationMember summary: Update the navigation property members in chats operationId: 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: - chats.conversationMember summary: Remove member from chat description: Remove a conversationMember from a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-delete-members?view=graph-rest-1.0 operationId: 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: 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 '/chats/{chat-id}/members/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.conversationMember summary: Get the number of the resource operationId: chats.members.GetCount-9627 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/members/add': description: Provides operations to call the add method. post: tags: - chats.Actions summary: 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: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/messages': description: Provides operations to manage the messages property of the microsoft.graph.chat entity. get: tags: - chats.chatMessage summary: List messages in a chat description: 'Retrieve the list of messages in a chat. This method supports federation. To list chat messages in application context, the request must be made from the tenant that the channel owner belongs to (represented by the tenantId property on the channel).' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-list-messages?view=graph-rest-1.0 operationId: 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: - chats.chatMessage summary: Send chatMessage in a channel or a chat description: Send a new chatMessage in the specified channel or a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chatmessage-post?view=graph-rest-1.0 operationId: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/messages/{chatMessage-id}': description: Provides operations to manage the messages property of the microsoft.graph.chat entity. get: tags: - chats.chatMessage summary: Get chatMessage in a channel or chat description: Retrieve a single message or a message reply in a channel or a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chatmessage-get?view=graph-rest-1.0 operationId: 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: - chats.chatMessage summary: Update the navigation property messages in chats operationId: 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: - chats.chatMessage summary: Delete navigation property messages for chats operationId: 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: 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 '/chats/{chat-id}/messages/{chatMessage-id}/hostedContents': description: Provides operations to manage the hostedContents property of the microsoft.graph.chatMessage entity. get: tags: - chats.chatMessage summary: List hostedContents description: 'Retrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chatmessage-list-hostedcontents?view=graph-rest-1.0 operationId: 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: - chats.chatMessage summary: Create new navigation property to hostedContents for chats operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents' '/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: - chats.chatMessage summary: Get chatMessageHostedContent description: Retrieve the properties and relationships of chatMessageHostedContent object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chatmessagehostedcontent-get?view=graph-rest-1.0 operationId: 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: - chats.chatMessage summary: Update the navigation property hostedContents in chats operationId: 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: - chats.chatMessage summary: Delete navigation property hostedContents for chats operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}' '/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}/$value': description: Provides operations to manage the media for the chat entity. get: tags: - chats.chatMessage summary: List hostedContents description: 'Retrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chatmessage-list-hostedcontents?view=graph-rest-1.0 operationId: 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: - chats.chatMessage summary: Update media content for the navigation property hostedContents in chats description: The unique identifier for an entity. Read-only. operationId: 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: - chats.chatMessage summary: Delete media content for the navigation property hostedContents in chats description: The unique identifier for an entity. Read-only. operationId: 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: 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 '/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.chatMessage summary: Get the number of the resource operationId: chats.messages.hostedContents.GetCount-a167 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: 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 '/chats/{chat-id}/messages/{chatMessage-id}/setReaction': description: Provides operations to call the setReaction method. post: tags: - chats.Actions summary: Invoke action setReaction operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction' '/chats/{chat-id}/messages/{chatMessage-id}/softDelete': description: Provides operations to call the softDelete method. post: tags: - chats.Actions summary: 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: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete' '/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete': description: Provides operations to call the undoSoftDelete method. post: tags: - chats.Actions summary: 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: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete' '/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction': description: Provides operations to call the unsetReaction method. post: tags: - chats.Actions summary: Invoke action unsetReaction operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction' '/chats/{chat-id}/messages/{chatMessage-id}/replies': description: Provides operations to manage the replies property of the microsoft.graph.chatMessage entity. get: tags: - chats.chatMessage summary: Get replies from chats description: Replies for a specified message. Supports $expand for channel messages. operationId: 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: - chats.chatMessage summary: Create new navigation property to replies for chats operationId: 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: 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 '/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: - chats.chatMessage summary: Get replies from chats description: Replies for a specified message. Supports $expand for channel messages. operationId: 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: - chats.chatMessage summary: Update the navigation property replies in chats operationId: 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: - chats.chatMessage summary: Delete navigation property replies for chats operationId: 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: 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 '/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: - chats.chatMessage summary: Get hostedContents from chats description: 'Content in a message hosted by Microsoft Teams - for example, images or code snippets.' operationId: 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: - chats.chatMessage summary: Create new navigation property to hostedContents for chats operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/hostedContents' '/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: - chats.chatMessage summary: Get hostedContents from chats description: 'Content in a message hosted by Microsoft Teams - for example, images or code snippets.' operationId: 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: - chats.chatMessage summary: Update the navigation property hostedContents in chats operationId: 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: - chats.chatMessage summary: Delete navigation property hostedContents for chats operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/hostedContents/{chatMessageHostedContent-id}' '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/{chatMessageHostedContent-id}/$value': description: Provides operations to manage the media for the chat entity. get: tags: - chats.chatMessage summary: Get media content for the navigation property hostedContents from chats description: The unique identifier for an entity. Read-only. operationId: 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: - chats.chatMessage summary: Update media content for the navigation property hostedContents in chats description: The unique identifier for an entity. Read-only. operationId: 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: - chats.chatMessage summary: Delete media content for the navigation property hostedContents in chats description: The unique identifier for an entity. Read-only. operationId: 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: 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 '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/hostedContents/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.chatMessage summary: Get the number of the resource operationId: chats.messages.replies.hostedContents.GetCount-ccd3 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: 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 '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/setReaction': description: Provides operations to call the setReaction method. post: tags: - chats.Actions summary: Invoke action setReaction operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/setReaction' '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/softDelete': description: Provides operations to call the softDelete method. post: tags: - chats.Actions summary: 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: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/softDelete' '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/undoSoftDelete': description: Provides operations to call the undoSoftDelete method. post: tags: - chats.Actions summary: 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: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/undoSoftDelete' '/chats/{chat-id}/messages/{chatMessage-id}/replies/{chatMessage-id1}/unsetReaction': description: Provides operations to call the unsetReaction method. post: tags: - chats.Actions summary: Invoke action unsetReaction operationId: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/unsetReaction' '/chats/{chat-id}/messages/{chatMessage-id}/replies/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.chatMessage summary: Get the number of the resource operationId: chats.messages.replies.GetCount-10ad 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: 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 '/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()': description: Provides operations to call the delta method. get: tags: - chats.Functions summary: Invoke function delta description: 'Retrieve the list of messages (without the replies) in a channel of a team. By using delta query, you can get new or updated messages in a channel. Delta query supports both full synchronization that retrieves all the messages in the specified channel, and incremental synchronization that retrieves those messages that have been added or changed in the channel since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that messages view periodically. To get the replies for a message, use the list message replies or the get message reply operation. A GET request with the delta function returns either: 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 for that same calendar view. A @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 acquiring @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: 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: 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: - '/chats/{chat-id}/messages/delta()' '/chats/{chat-id}/messages/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.chatMessage summary: Get the number of the resource operationId: chats.messages.GetCount-3dde 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/messages/delta()': description: Provides operations to call the delta method. get: tags: - chats.Functions summary: Invoke function delta description: 'Retrieve the list of messages (without the replies) in a channel of a team. By using delta query, you can get new or updated messages in a channel. Delta query supports both full synchronization that retrieves all the messages in the specified channel, and incremental synchronization that retrieves those messages that have been added or changed in the channel since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that messages view periodically. To get the replies for a message, use the list message replies or the get message reply operation. A GET request with the delta function returns either: 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 for that same calendar view. A @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 acquiring @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: 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: 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: - '/chats/{chat-id}/messages/{chatMessage-id}/replies/delta()' '/chats/{chat-id}/hideForUser': description: Provides operations to call the hideForUser method. post: tags: - chats.Actions summary: 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: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/markChatReadForUser': description: Provides operations to call the markChatReadForUser method. post: tags: - chats.Actions summary: 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: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/markChatUnreadForUser': description: Provides operations to call the markChatUnreadForUser method. post: tags: - chats.Actions summary: 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: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/sendActivityNotification': description: Provides operations to call the sendActivityNotification method. post: tags: - chats.Actions summary: 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: 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: integer 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 required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/unhideForUser': description: Provides operations to call the unhideForUser method. post: tags: - chats.Actions summary: 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: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/permissionGrants': description: Provides operations to manage the permissionGrants property of the microsoft.graph.chat entity. get: tags: - chats.resourceSpecificPermissionGrant summary: List permissionGrants of a chat description: 'List all resource-specific permission grants on the chat. This list specifies the Microsoft Entra apps that have access to the chat, along with the corresponding resource-specific access that each app has.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-list-permissiongrants?view=graph-rest-1.0 operationId: 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: - chats.resourceSpecificPermissionGrant summary: Create new navigation property to permissionGrants for chats operationId: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/permissionGrants/{resourceSpecificPermissionGrant-id}': description: Provides operations to manage the permissionGrants property of the microsoft.graph.chat entity. get: tags: - chats.resourceSpecificPermissionGrant summary: Get permissionGrants from chats description: A collection of permissions granted to apps for the chat. operationId: 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: - chats.resourceSpecificPermissionGrant summary: Update the navigation property permissionGrants in chats operationId: 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: - chats.resourceSpecificPermissionGrant summary: Delete navigation property permissionGrants for chats operationId: 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: 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 '/chats/{chat-id}/permissionGrants/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.resourceSpecificPermissionGrant summary: Get the number of the resource operationId: chats.permissionGrants.GetCount-7597 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/pinnedMessages': description: Provides operations to manage the pinnedMessages property of the microsoft.graph.chat entity. get: tags: - chats.pinnedChatMessageInfo summary: List pinnedChatMessages in a chat description: Get a list of pinnedChatMessages in a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-list-pinnedmessages?view=graph-rest-1.0 operationId: 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: - chats.pinnedChatMessageInfo summary: Pin a message in a chat description: Pin a chat message in the specified chat. This API cannot create a new chat; you must use the list chats method to retrieve the ID of an existing chat before you can pin a chat message. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-post-pinnedmessages?view=graph-rest-1.0 operationId: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/pinnedMessages/{pinnedChatMessageInfo-id}': description: Provides operations to manage the pinnedMessages property of the microsoft.graph.chat entity. get: tags: - chats.pinnedChatMessageInfo summary: Get pinnedMessages from chats description: A collection of all the pinned messages in the chat. Nullable. operationId: 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: - chats.pinnedChatMessageInfo summary: Update the navigation property pinnedMessages in chats operationId: 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: - chats.pinnedChatMessageInfo summary: Unpin a message from a chat description: Unpin a message from a chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-delete-pinnedmessages?view=graph-rest-1.0 operationId: 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: 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 '/chats/{chat-id}/pinnedMessages/{pinnedChatMessageInfo-id}/message': description: Provides operations to manage the message property of the microsoft.graph.pinnedChatMessageInfo entity. get: tags: - chats.pinnedChatMessageInfo summary: Get message from chats description: Represents details about the chat message that is pinned. operationId: 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: 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 '/chats/{chat-id}/pinnedMessages/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.pinnedChatMessageInfo summary: Get the number of the resource operationId: chats.pinnedMessages.GetCount-ad15 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/tabs': description: Provides operations to manage the tabs property of the microsoft.graph.chat entity. get: tags: - chats.teamsTab summary: List tabs in chat description: Retrieve the list of tabs in the specified chat. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-list-tabs?view=graph-rest-1.0 operationId: 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: - chats.teamsTab summary: Add tab to chat description: "Add (pin) a tab to the specified chat. \nThe corresponding app must already be installed in the chat." externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-post-tabs?view=graph-rest-1.0 operationId: 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat '/chats/{chat-id}/tabs/{teamsTab-id}': description: Provides operations to manage the tabs property of the microsoft.graph.chat entity. get: tags: - chats.teamsTab summary: Get tab in chat description: 'Retrieve the properties and relationships of the specified tab in a chat. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-get-tabs?view=graph-rest-1.0 operationId: 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: - chats.teamsTab summary: Update tab in chat description: "Update the properties of the specified tab in a chat. \nThis can be used to configure the content of the tab." externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-patch-tabs?view=graph-rest-1.0 operationId: 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: - chats.teamsTab summary: Delete tab from chat description: 'Remove (unpin) a tab from the specified chat. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chat-delete-tabs?view=graph-rest-1.0 operationId: 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: 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 '/chats/{chat-id}/tabs/{teamsTab-id}/teamsApp': description: Provides operations to manage the teamsApp property of the microsoft.graph.teamsTab entity. get: tags: - chats.teamsTab summary: Get teamsApp from chats description: The application that is linked to the tab. This can't be changed after tab creation. operationId: 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: 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 '/chats/{chat-id}/tabs/$count': description: Provides operations to count the resources in the collection. get: tags: - chats.teamsTab summary: Get the number of the resource operationId: chats.tabs.GetCount-b645 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: chat-id in: path description: The unique identifier of chat required: true schema: type: string x-ms-docs-key-type: chat /chats/$count: description: Provides operations to count the resources in the collection. get: tags: - chats.chat summary: Get the number of the resource operationId: chats.GetCount-61c7 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' /chats/getAllMessages(): description: Provides operations to call the getAllMessages method. get: tags: - chats.Functions summary: Invoke function getAllMessages description: 'Get all messages from all chats that a user is a participant in, including one-on-one chats, group chats, and meeting chats.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/chats-getallmessages?view=graph-rest-1.0 operationId: 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 /chats/getAllRetainedMessages(): description: Provides operations to call the getAllRetainedMessages method. get: tags: - chats.Functions summary: Invoke function getAllRetainedMessages operationId: 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 /communications: description: Provides operations to manage the cloudCommunications singleton. get: tags: - communications.cloudCommunications summary: Get communications operationId: communications.cloudCommunications.GetCloudCommunications parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.cloudCommunications' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.cloudCommunications summary: Update communications operationId: communications.cloudCommunications.UpdateCloudCommunications requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.cloudCommunications' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.cloudCommunications' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /communications/callRecords: description: Provides operations to manage the callRecords property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.callRecord summary: List callRecords description: Get the list of callRecord objects and their properties. The results can be optionally filtered using the $filter query parameter on the startDateTime and participant id properties. Note that the listed call records don't include expandable relationships such as sessions and participants_v2. You can expand these relationships using Get callRecord for a specific record. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/callrecords-cloudcommunications-list-callrecords?view=graph-rest-1.0 operationId: communications.ListCallRecords 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.callRecords.callRecordCollectionResponse' 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: - communications.callRecord summary: Create new navigation property to callRecords for communications operationId: communications.CreateCallRecords requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.callRecord' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.callRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/communications/callRecords/{callRecord-id}': description: Provides operations to manage the callRecords property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.callRecord summary: Get callRecord description: "Retrieve the properties and relationships of a callRecord object. You can get the id of a callRecord in two ways:\n* Subscribe to change notifications to the /communications/callRecords endpoint.\n* Use the callChainId property of a call. The call record is available only after the associated call is completed." externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/callrecords-callrecord-get?view=graph-rest-1.0 operationId: communications.GetCallRecords parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.callRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.callRecord summary: Update the navigation property callRecords in communications operationId: communications.UpdateCallRecords requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.callRecord' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.callRecord' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.callRecord summary: Delete navigation property callRecords for communications operationId: communications.DeleteCallRecords 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord '/communications/callRecords/{callRecord-id}/organizer_v2': description: Provides operations to manage the organizer_v2 property of the microsoft.graph.callRecords.callRecord entity. get: tags: - communications.callRecord summary: Get organizer_v2 from communications description: Identity of the organizer of the call. This relationship is expanded by default in callRecord methods. operationId: communications.callRecords.GetOrganizer_v2 parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.organizer' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.callRecord summary: Update the navigation property organizer_v2 in communications operationId: communications.callRecords.UpdateOrganizer_v2 requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.organizer' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.organizer' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.callRecord summary: Delete navigation property organizer_v2 for communications operationId: communications.callRecords.DeleteOrganizer_v2 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord '/communications/callRecords/{callRecord-id}/participants_v2': description: Provides operations to manage the participants_v2 property of the microsoft.graph.callRecords.callRecord entity. get: tags: - communications.callRecord summary: List participants_v2 description: Get the list of participant objects associated with a callRecord. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/callrecords-callrecord-list-participants_v2?view=graph-rest-1.0 operationId: communications.callRecords.ListParticipants_v2 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.callRecords.participantCollectionResponse' 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: - communications.callRecord summary: Create new navigation property to participants_v2 for communications operationId: communications.callRecords.CreateParticipants_v2 requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.participant' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.participant' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord '/communications/callRecords/{callRecord-id}/participants_v2/{participant-id}': description: Provides operations to manage the participants_v2 property of the microsoft.graph.callRecords.callRecord entity. get: tags: - communications.callRecord summary: Get participants_v2 from communications description: List of distinct participants in the call. operationId: communications.callRecords.GetParticipants_v2 parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.participant' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.callRecord summary: Update the navigation property participants_v2 in communications operationId: communications.callRecords.UpdateParticipants_v2 requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.participant' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.participant' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.callRecord summary: Delete navigation property participants_v2 for communications operationId: communications.callRecords.DeleteParticipants_v2 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord - name: participant-id in: path description: The unique identifier of participant required: true schema: type: string x-ms-docs-key-type: participant '/communications/callRecords/{callRecord-id}/participants_v2/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.callRecord summary: Get the number of the resource operationId: communications.callRecords.participants_v2.GetCount-ecf7 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord '/communications/callRecords/{callRecord-id}/sessions': description: Provides operations to manage the sessions property of the microsoft.graph.callRecords.callRecord entity. get: tags: - communications.callRecord summary: List sessions description: 'Retrieve the list of sessions associated with a callRecord object. If the sessions list is truncated, a sessions@odata.nextLink value will be provided to retrieve the next page of sessions. The maximum page size for sessions is 60 entries.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/callrecords-callrecord-list-sessions?view=graph-rest-1.0 operationId: communications.callRecords.ListSessions 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.callRecords.sessionCollectionResponse' 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: - communications.callRecord summary: Create new navigation property to sessions for communications operationId: communications.callRecords.CreateSessions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.session' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.session' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord '/communications/callRecords/{callRecord-id}/sessions/{session-id}': description: Provides operations to manage the sessions property of the microsoft.graph.callRecords.callRecord entity. get: tags: - communications.callRecord summary: Get sessions from communications description: 'List of sessions involved in the call. Peer-to-peer calls typically only have one session, whereas group calls typically have at least one session per participant. Read-only. Nullable.' operationId: communications.callRecords.GetSessions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.session' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.callRecord summary: Update the navigation property sessions in communications operationId: communications.callRecords.UpdateSessions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.session' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.session' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.callRecord summary: Delete navigation property sessions for communications operationId: communications.callRecords.DeleteSessions 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord - name: session-id in: path description: The unique identifier of session required: true schema: type: string x-ms-docs-key-type: session '/communications/callRecords/{callRecord-id}/sessions/{session-id}/segments': description: Provides operations to manage the segments property of the microsoft.graph.callRecords.session entity. get: tags: - communications.callRecord summary: Get segments from communications description: The list of segments involved in the session. Read-only. Nullable. operationId: communications.callRecords.sessions.ListSegments 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.callRecords.segmentCollectionResponse' 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: - communications.callRecord summary: Create new navigation property to segments for communications operationId: communications.callRecords.sessions.CreateSegments requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.segment' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.segment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord - name: session-id in: path description: The unique identifier of session required: true schema: type: string x-ms-docs-key-type: session '/communications/callRecords/{callRecord-id}/sessions/{session-id}/segments/{segment-id}': description: Provides operations to manage the segments property of the microsoft.graph.callRecords.session entity. get: tags: - communications.callRecord summary: Get segments from communications description: The list of segments involved in the session. Read-only. Nullable. operationId: communications.callRecords.sessions.GetSegments parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.segment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.callRecord summary: Update the navigation property segments in communications operationId: communications.callRecords.sessions.UpdateSegments requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.segment' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.callRecords.segment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.callRecord summary: Delete navigation property segments for communications operationId: communications.callRecords.sessions.DeleteSegments 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord - name: session-id in: path description: The unique identifier of session required: true schema: type: string x-ms-docs-key-type: session - name: segment-id in: path description: The unique identifier of segment required: true schema: type: string x-ms-docs-key-type: segment '/communications/callRecords/{callRecord-id}/sessions/{session-id}/segments/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.callRecord summary: Get the number of the resource operationId: communications.callRecords.sessions.segments.GetCount-4fed 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord - name: session-id in: path description: The unique identifier of session required: true schema: type: string x-ms-docs-key-type: session '/communications/callRecords/{callRecord-id}/sessions/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.callRecord summary: Get the number of the resource operationId: communications.callRecords.sessions.GetCount-c743 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: callRecord-id in: path description: The unique identifier of callRecord required: true schema: type: string x-ms-docs-key-type: callRecord /communications/callRecords/$count: description: Provides operations to count the resources in the collection. get: tags: - communications.callRecord summary: Get the number of the resource operationId: communications.callRecords.GetCount-e558 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' '/communications/callRecords/microsoft.graph.callRecords.getDirectRoutingCalls(fromDateTime={fromDateTime},toDateTime={toDateTime})': description: Provides operations to call the getDirectRoutingCalls method. get: tags: - communications.Functions summary: Invoke function getDirectRoutingCalls description: Get a log of direct routing calls as a collection of directRoutingLogRow entries. operationId: communications.callRecords.getDirectRoutingCalls 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.callRecords.directRoutingLogRow' 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: fromDateTime in: path description: 'Usage: fromDateTime={fromDateTime}' required: true 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: toDateTime in: path description: 'Usage: toDateTime={toDateTime}' required: true 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 '/communications/callRecords/microsoft.graph.callRecords.getPstnCalls(fromDateTime={fromDateTime},toDateTime={toDateTime})': description: Provides operations to call the getPstnCalls method. get: tags: - communications.Functions summary: Invoke function getPstnCalls description: Get log of PSTN calls as a collection of pstnCallLogRow entries. operationId: communications.callRecords.getPstnCalls 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.callRecords.pstnCallLogRow' 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: fromDateTime in: path description: 'Usage: fromDateTime={fromDateTime}' required: true 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: toDateTime in: path description: 'Usage: toDateTime={toDateTime}' required: true 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 /communications/calls: description: Provides operations to manage the calls property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.call summary: Get call description: Retrieve the properties and relationships of a call object. operationId: communications.ListCalls 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.callCollectionResponse' 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: - communications.call summary: Create call description: 'Create call enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. You will need to register the calling bot and go through the list of permissions needed as mentioned below. This API supports the following PSTN scenarios:' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-calls?view=graph-rest-1.0 operationId: communications.CreateCalls requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.call' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.call' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/communications/calls/{call-id}': description: Provides operations to manage the calls property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.call summary: Get call description: Retrieve the properties and relationships of a call object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-get?view=graph-rest-1.0 operationId: communications.GetCalls parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.call' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.call summary: Update the navigation property calls in communications operationId: communications.UpdateCalls requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.call' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.call' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.call summary: Delete call description: 'Delete or hang up an active call. For group calls, this will only delete your call leg and the underlying group call will still continue.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-delete?view=graph-rest-1.0 operationId: communications.DeleteCalls 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/audioRoutingGroups': description: Provides operations to manage the audioRoutingGroups property of the microsoft.graph.call entity. get: tags: - communications.call summary: List audioRoutingGroups description: Retrieve a list of audioRoutingGroup objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-list-audioroutinggroups?view=graph-rest-1.0 operationId: communications.calls.ListAudioRoutingGroups 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.audioRoutingGroupCollectionResponse' 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: - communications.call summary: Create audioRoutingGroup description: Create a new audioRoutingGroup. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-post-audioroutinggroups?view=graph-rest-1.0 operationId: communications.calls.CreateAudioRoutingGroups requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.audioRoutingGroup' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.audioRoutingGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/audioRoutingGroups/{audioRoutingGroup-id}': description: Provides operations to manage the audioRoutingGroups property of the microsoft.graph.call entity. get: tags: - communications.call summary: Get audioRoutingGroup description: Retrieve the properties and relationships of an audioRoutingGroup object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/audioroutinggroup-get?view=graph-rest-1.0 operationId: communications.calls.GetAudioRoutingGroups parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.audioRoutingGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.call summary: Update audioRoutingGroup description: Modify sources and receivers of an audioRoutingGroup. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/audioroutinggroup-update?view=graph-rest-1.0 operationId: communications.calls.UpdateAudioRoutingGroups requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.audioRoutingGroup' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.audioRoutingGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.call summary: Delete audioRoutingGroup description: Delete the specified audioRoutingGroup. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/audioroutinggroup-delete?view=graph-rest-1.0 operationId: communications.calls.DeleteAudioRoutingGroups 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call - name: audioRoutingGroup-id in: path description: The unique identifier of audioRoutingGroup required: true schema: type: string x-ms-docs-key-type: audioRoutingGroup '/communications/calls/{call-id}/audioRoutingGroups/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.call summary: Get the number of the resource operationId: communications.calls.audioRoutingGroups.GetCount-157e 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/contentSharingSessions': description: Provides operations to manage the contentSharingSessions property of the microsoft.graph.call entity. get: tags: - communications.call summary: List contentSharingSessions description: Retrieve a list of contentSharingSession objects in a call. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-list-contentsharingsessions?view=graph-rest-1.0 operationId: communications.calls.ListContentSharingSessions 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.contentSharingSessionCollectionResponse' 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: - communications.call summary: Create new navigation property to contentSharingSessions for communications operationId: communications.calls.CreateContentSharingSessions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contentSharingSession' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contentSharingSession' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/contentSharingSessions/{contentSharingSession-id}': description: Provides operations to manage the contentSharingSessions property of the microsoft.graph.call entity. get: tags: - communications.call summary: Get contentSharingSession description: Retrieve the properties of a contentSharingSession object in a call. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/contentsharingsession-get?view=graph-rest-1.0 operationId: communications.calls.GetContentSharingSessions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contentSharingSession' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.call summary: Update the navigation property contentSharingSessions in communications operationId: communications.calls.UpdateContentSharingSessions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contentSharingSession' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contentSharingSession' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.call summary: Delete navigation property contentSharingSessions for communications operationId: communications.calls.DeleteContentSharingSessions 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call - name: contentSharingSession-id in: path description: The unique identifier of contentSharingSession required: true schema: type: string x-ms-docs-key-type: contentSharingSession '/communications/calls/{call-id}/contentSharingSessions/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.call summary: Get the number of the resource operationId: communications.calls.contentSharingSessions.GetCount-a2b2 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/addLargeGalleryView': description: Provides operations to call the addLargeGalleryView method. post: tags: - communications.Actions summary: Invoke action addLargeGalleryView description: 'Add the large gallery view to a call. For details about how to identify a large gallery view participant in a roster so that you can retrieve the relevant data to subscribe to the video feed, see Identify large gallery view participants in a roster.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-addlargegalleryview?view=graph-rest-1.0 operationId: communications.calls.call.addLargeGalleryView requestBody: description: Action parameters content: application/json: schema: type: object properties: clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.addLargeGalleryViewOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/answer': description: Provides operations to call the answer method. post: tags: - communications.Actions summary: Invoke action answer description: 'Enable a bot to answer an incoming call. The incoming call request can be an invitation from a participant in a group call or a peer-to-peer call. If an invitation to a group call is received, the notification will contain the chatInfo and meetingInfo parameters. The bot is expected to answer, reject, or redirect the call before the call times out. The current timeout value is 15 seconds for regular scenarios, and 5 seconds for policy-based recording scenarios. This API supports the following PSTN scenarios:' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-answer?view=graph-rest-1.0 operationId: communications.calls.call.answer requestBody: description: Action parameters content: application/json: schema: type: object properties: callbackUri: type: string mediaConfig: $ref: '#/components/schemas/microsoft.graph.mediaConfig' acceptedModalities: type: array items: anyOf: - $ref: '#/components/schemas/microsoft.graph.modality' - type: object nullable: true participantCapacity: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 nullable: true callOptions: anyOf: - $ref: '#/components/schemas/microsoft.graph.incomingCallOptions' - 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/cancelMediaProcessing': description: Provides operations to call the cancelMediaProcessing method. post: tags: - communications.Actions summary: Invoke action cancelMediaProcessing description: 'Cancels processing for any in-progress media operations. Media operations refer to the IVR operations playPrompt and recordResponse, which are by default queued to process in order. The cancelMediaProcessing method cancels any operation that is in-process as well as operations that are queued. For example, this method can be used to clean up the IVR operation queue for a new media operation. However, it will not cancel a subscribeToTone operation because it operates independent of any operation queue.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-cancelmediaprocessing?view=graph-rest-1.0 operationId: communications.calls.call.cancelMediaProcessing requestBody: description: Action parameters content: application/json: schema: type: object properties: clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.cancelMediaProcessingOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/changeScreenSharingRole': description: Provides operations to call the changeScreenSharingRole method. post: tags: - communications.Actions summary: Invoke action changeScreenSharingRole description: Allow applications to share screen content with the participants of a group call. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-changescreensharingrole?view=graph-rest-1.0 operationId: communications.calls.call.changeScreenSharingRole requestBody: description: Action parameters content: application/json: schema: type: object properties: role: $ref: '#/components/schemas/microsoft.graph.screenSharingRole' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/keepAlive': description: Provides operations to call the keepAlive method. post: tags: - communications.Actions summary: Invoke action keepAlive description: 'Make a request to this API every 15 to 45 minutes to ensure that an ongoing call remains active. A call that does not receive this request within 45 minutes is considered inactive and will subsequently end. At least one successful request must be made within 45 minutes of the previous request, or the start of the call. We recommend that you send a request in shorter time intervals (every 15 minutes). Make sure that these requests are successful to prevent the call from timing out and ending. Attempting to send a request to a call that has already ended will result in a 404 Not-Found error. The resources related to the call should be cleaned up on the application side.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-keepalive?view=graph-rest-1.0 operationId: communications.calls.call.keepAlive responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/mute': description: Provides operations to call the mute method. post: tags: - communications.Actions summary: Invoke action mute description: 'Allows the application to mute itself. This is a server mute, meaning that the server will drop all audio packets for this participant, even if the participant continues to stream audio. For more details about how to handle mute operations, see muteParticipantOperation' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-mute?view=graph-rest-1.0 operationId: communications.calls.call.mute requestBody: description: Action parameters content: application/json: schema: type: object properties: clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.muteParticipantOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call x-ms-docs-grouped-path: - '/communications/calls/{call-id}/participants/{participant-id}/mute' '/communications/calls/{call-id}/playPrompt': description: Provides operations to call the playPrompt method. post: tags: - communications.Actions summary: Invoke action playPrompt description: 'Play a prompt in the call. For more information about how to handle operations, see commsOperation' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-playprompt?view=graph-rest-1.0 operationId: communications.calls.call.playPrompt requestBody: description: Action parameters content: application/json: schema: type: object properties: prompts: type: array items: $ref: '#/components/schemas/microsoft.graph.prompt' clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.playPromptOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/recordResponse': description: Provides operations to call the recordResponse method. post: tags: - communications.Actions summary: Invoke action recordResponse description: "Records a short audio response from the caller.\nA bot can utilize this to capture a voice response from a caller after they are prompted for a response. For further information on how to handle operations, please review commsOperation This action is not intended to record the entire call. The maximum length of recording is 2 minutes. The recording is not saved permanently by the Cloud Communications Platform and is discarded shortly after the call ends. The bot must download the recording promptly after the recording operation finishes by using the recordingLocation value that's given in the completed notification." externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-record?view=graph-rest-1.0 operationId: communications.calls.call.recordResponse requestBody: description: Action parameters content: application/json: schema: type: object properties: prompts: type: array items: $ref: '#/components/schemas/microsoft.graph.prompt' bargeInAllowed: type: boolean default: false nullable: true initialSilenceTimeoutInSeconds: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 nullable: true maxSilenceTimeoutInSeconds: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 nullable: true maxRecordDurationInSeconds: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 nullable: true playBeep: type: boolean default: false nullable: true stopTones: type: array items: type: string nullable: true clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.recordOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/redirect': description: Provides operations to call the redirect method. post: tags: - communications.Actions summary: Invoke action redirect description: Redirect an incoming call that hasn't been answered or rejected yet. The terms 'redirecting' and 'forwarding' a call are used interchangeably. The bot is expected to redirect the call before the call times out. The current timeout value is 15 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-redirect?view=graph-rest-1.0 operationId: communications.calls.call.redirect requestBody: description: Action parameters content: application/json: schema: type: object properties: targets: type: array items: $ref: '#/components/schemas/microsoft.graph.invitationParticipantInfo' timeout: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 nullable: true callbackUri: 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/reject': description: Provides operations to call the reject method. post: tags: - communications.Actions summary: Invoke action reject description: 'Enable a bot to reject an incoming call. The incoming call request can be an invite from a participant in a group call or a peer-to-peer call. If an invite to a group call is received, the notification will contain the chatInfo and meetingInfo parameters. The bot is expected to answer or reject the call before the call times out. The current timeout value is 15 seconds. This API does not end existing calls that have already been answered. Use delete call to end a call.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-reject?view=graph-rest-1.0 operationId: communications.calls.call.reject requestBody: description: Action parameters content: application/json: schema: type: object properties: reason: anyOf: - $ref: '#/components/schemas/microsoft.graph.rejectReason' - type: object nullable: true callbackUri: 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/sendDtmfTones': description: Provides operations to call the sendDtmfTones method. post: tags: - communications.Actions summary: Invoke action sendDtmfTones operationId: communications.calls.call.sendDtmfTones requestBody: description: Action parameters content: application/json: schema: type: object properties: tones: type: array items: $ref: '#/components/schemas/microsoft.graph.tone' delayBetweenTonesMs: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 nullable: true clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.sendDtmfTonesOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/subscribeToTone': description: Provides operations to call the subscribeToTone method. post: tags: - communications.Actions summary: Invoke action subscribeToTone description: Subscribe to DTMF (dual-tone multi-frequency signaling) which allows you to be notified when the user presses keys on a 'dialpad'. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-subscribetotone?view=graph-rest-1.0 operationId: communications.calls.call.subscribeToTone requestBody: description: Action parameters content: application/json: schema: type: object properties: clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.subscribeToToneOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/transfer': description: Provides operations to call the transfer method. post: tags: - communications.Actions summary: Invoke action transfer description: 'Transfer an active peer-to-peer call or group call. A consultative transfer means that the transferor can inform the person they want to transfer the call to (the transferee), before the transfer is made. This is opposed to transfering the call directly.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-transfer?view=graph-rest-1.0 operationId: communications.calls.call.transfer requestBody: description: Action parameters content: application/json: schema: type: object properties: transferTarget: $ref: '#/components/schemas/microsoft.graph.invitationParticipantInfo' transferee: anyOf: - $ref: '#/components/schemas/microsoft.graph.participantInfo' - 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/unmute': description: Provides operations to call the unmute method. post: tags: - communications.Actions summary: Invoke action unmute description: 'Allow the application to unmute itself. This is a server unmute, meaning that the server will start sending audio packets for this participant to other participants again. For more information about how to handle unmute operations, see unmuteParticipantOperation.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-unmute?view=graph-rest-1.0 operationId: communications.calls.call.unmute requestBody: description: Action parameters content: application/json: schema: type: object properties: clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.unmuteParticipantOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/updateRecordingStatus': description: Provides operations to call the updateRecordingStatus method. post: tags: - communications.Actions summary: Invoke action updateRecordingStatus description: Update the application's recording status associated with a call. This requires the use of the Teams policy-based recording solution. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-updaterecordingstatus?view=graph-rest-1.0 operationId: communications.calls.call.updateRecordingStatus requestBody: description: Action parameters content: application/json: schema: type: object properties: status: $ref: '#/components/schemas/microsoft.graph.recordingStatus' clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.updateRecordingStatusOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/operations': description: Provides operations to manage the operations property of the microsoft.graph.call entity. get: tags: - communications.call summary: Get addLargeGalleryViewOperation description: Get the status of an operation that adds the large gallery view to a call. operationId: communications.calls.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.commsOperationCollectionResponse' 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: - communications.call summary: Create new navigation property to operations for communications operationId: communications.calls.CreateOperations requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.commsOperation' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.commsOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/operations/{commsOperation-id}': description: Provides operations to manage the operations property of the microsoft.graph.call entity. get: tags: - communications.call summary: Get addLargeGalleryViewOperation description: Get the status of an operation that adds the large gallery view to a call. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/addlargegalleryviewoperation-get?view=graph-rest-1.0 operationId: communications.calls.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.commsOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.call summary: Update the navigation property operations in communications operationId: communications.calls.UpdateOperations requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.commsOperation' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.commsOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.call summary: Delete navigation property operations for communications operationId: communications.calls.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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call - name: commsOperation-id in: path description: The unique identifier of commsOperation required: true schema: type: string x-ms-docs-key-type: commsOperation '/communications/calls/{call-id}/operations/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.call summary: Get the number of the resource operationId: communications.calls.operations.GetCount-3444 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/participants': description: Provides operations to manage the participants property of the microsoft.graph.call entity. get: tags: - communications.call summary: List participants description: Retrieve a list of participant objects in the call. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-list-participants?view=graph-rest-1.0 operationId: communications.calls.ListParticipants 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.participantCollectionResponse' 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: - communications.call summary: Create new navigation property to participants for communications operationId: communications.calls.CreateParticipants requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.participant' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.participant' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/participants/{participant-id}': description: Provides operations to manage the participants property of the microsoft.graph.call entity. get: tags: - communications.call summary: Get participant description: Retrieve the properties and relationships of a participant object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/participant-get?view=graph-rest-1.0 operationId: communications.calls.GetParticipants parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.participant' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - communications.call summary: Update the navigation property participants in communications operationId: communications.calls.UpdateParticipants requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.participant' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.participant' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - communications.call summary: Delete participant description: 'Delete a specific participant in a call. In some situations, it is appropriate for an application to remove a participant from an active call. This action can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call with no pre- or post-removal notification. When an invited participant is removed, any outstanding add participant request is canceled. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/participant-delete?view=graph-rest-1.0 operationId: communications.calls.DeleteParticipants 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call - name: participant-id in: path description: The unique identifier of participant required: true schema: type: string x-ms-docs-key-type: participant '/communications/calls/{call-id}/participants/{participant-id}/mute': description: Provides operations to call the mute method. post: tags: - communications.Actions summary: Invoke action mute description: 'Mute a specific participant in the call. This is a server mute, meaning that the server will drop all audio packets for this participant, even if the participant continues to stream audio. For more information about how to handle mute operations, see muteParticipantOperation.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/participant-mute?view=graph-rest-1.0 operationId: communications.calls.call.participants.participant.mute requestBody: description: Action parameters content: application/json: schema: type: object properties: clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.muteParticipantOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call - name: participant-id in: path description: The unique identifier of participant required: true schema: type: string x-ms-docs-key-type: participant x-ms-docs-grouped-path: - '/communications/calls/{call-id}/mute' '/communications/calls/{call-id}/participants/{participant-id}/startHoldMusic': description: Provides operations to call the startHoldMusic method. post: tags: - communications.Actions summary: Invoke action startHoldMusic description: Put a participant on hold and play music in the background. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/participant-startholdmusic?view=graph-rest-1.0 operationId: communications.calls.call.participants.participant.startHoldMusic requestBody: description: Action parameters content: application/json: schema: type: object properties: customPrompt: anyOf: - $ref: '#/components/schemas/microsoft.graph.prompt' - type: object nullable: true clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.startHoldMusicOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call - name: participant-id in: path description: The unique identifier of participant required: true schema: type: string x-ms-docs-key-type: participant '/communications/calls/{call-id}/participants/{participant-id}/stopHoldMusic': description: Provides operations to call the stopHoldMusic method. post: tags: - communications.Actions summary: Invoke action stopHoldMusic description: Reincorporate a participant previously put on hold to the call. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/participant-stopholdmusic?view=graph-rest-1.0 operationId: communications.calls.call.participants.participant.stopHoldMusic requestBody: description: Action parameters content: application/json: schema: type: object properties: clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.stopHoldMusicOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call - name: participant-id in: path description: The unique identifier of participant required: true schema: type: string x-ms-docs-key-type: participant '/communications/calls/{call-id}/participants/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.call summary: Get the number of the resource operationId: communications.calls.participants.GetCount-4efe 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: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call '/communications/calls/{call-id}/participants/invite': description: Provides operations to call the invite method. post: tags: - communications.Actions summary: Invoke action invite description: 'Delete a specific participant in a call. In some situations, it is appropriate for an application to remove a participant from an active call. This action can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call with no pre- or post-removal notification. When an invited participant is removed, any outstanding add participant request is canceled. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/participant-delete?view=graph-rest-1.0 operationId: communications.calls.call.participants.invite requestBody: description: Action parameters content: application/json: schema: type: object properties: participants: type: array items: $ref: '#/components/schemas/microsoft.graph.invitationParticipantInfo' clientContext: type: string nullable: true required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/microsoft.graph.inviteParticipantsOperation' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: call-id in: path description: The unique identifier of call required: true schema: type: string x-ms-docs-key-type: call /communications/calls/$count: description: Provides operations to count the resources in the collection. get: tags: - communications.call summary: Get the number of the resource operationId: communications.calls.GetCount-5d04 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' /communications/calls/logTeleconferenceDeviceQuality: description: Provides operations to call the logTeleconferenceDeviceQuality method. post: tags: - communications.Actions summary: Invoke action logTeleconferenceDeviceQuality description: 'Log video teleconferencing device quality data. The Cloud Video Interop (CVI) bot represents video teleconferencing (VTC) devices and acts as a back-to-back agent for a VTC device in a conference call. Because a CVI bot is in the middle of the VTC and Microsoft Teams infrastructure as a VTC proxy, it has two media legs. One media leg is between the CVI bot and Teams infrastructure, such as Teams conference server or a Teams client. The other media leg is between the CVI bot and the VTC device. The third-party partners own the VTC media leg and the Teams infrastructure cannot access the quality data of the third-party call leg. This method is only for the CVI partners to provide their media quality data.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/call-logteleconferencedevicequality?view=graph-rest-1.0 operationId: communications.calls.logTeleconferenceDeviceQuality requestBody: description: Action parameters content: application/json: schema: type: object properties: quality: $ref: '#/components/schemas/microsoft.graph.teleconferenceDeviceQuality' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /communications/getPresencesByUserId: description: Provides operations to call the getPresencesByUserId method. post: tags: - communications.Actions summary: Invoke action getPresencesByUserId description: Get the presence information for multiple users. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/cloudcommunications-getpresencesbyuserid?view=graph-rest-1.0 operationId: communications.getPresencesByUserId 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: title: Collection of presence type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.presence' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore /communications/onlineMeetings: description: Provides operations to manage the onlineMeetings property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.onlineMeeting summary: Get onlineMeeting description: 'Retrieve the properties and relationships of an onlineMeeting object. For example, you can: Teams live event attendee report (deprecated) is an online meeting artifact. For details, see Online meeting artifacts and permissions.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/onlinemeeting-get?view=graph-rest-1.0 operationId: communications.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: - communications.onlineMeeting summary: Create new navigation property to onlineMeetings for communications operationId: communications.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 '/communications/onlineMeetings/{onlineMeeting-id}': description: Provides operations to manage the onlineMeetings property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.onlineMeeting summary: Get onlineMeetings from communications operationId: communications.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: - communications.onlineMeeting summary: Update the navigation property onlineMeetings in communications operationId: communications.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: - communications.onlineMeeting summary: Delete navigation property onlineMeetings for communications operationId: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/attendanceReports': description: Provides operations to manage the attendanceReports property of the microsoft.graph.onlineMeetingBase entity. get: tags: - communications.onlineMeeting summary: Get attendanceReports from communications description: The attendance reports of an online meeting. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Create new navigation property to attendanceReports for communications operationId: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/attendanceReports/{meetingAttendanceReport-id}': description: Provides operations to manage the attendanceReports property of the microsoft.graph.onlineMeetingBase entity. get: tags: - communications.onlineMeeting summary: Get attendanceReports from communications description: The attendance reports of an online meeting. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update the navigation property attendanceReports in communications operationId: communications.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: - communications.onlineMeeting summary: Delete navigation property attendanceReports for communications operationId: communications.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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/attendanceReports/{meetingAttendanceReport-id}/attendanceRecords': description: Provides operations to manage the attendanceRecords property of the microsoft.graph.meetingAttendanceReport entity. get: tags: - communications.onlineMeeting summary: Get attendanceRecords from communications description: List of attendance records of an attendance report. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Create new navigation property to attendanceRecords for communications operationId: communications.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: 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 '/communications/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: - communications.onlineMeeting summary: Get attendanceRecords from communications description: List of attendance records of an attendance report. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update the navigation property attendanceRecords in communications operationId: communications.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: - communications.onlineMeeting summary: Delete navigation property attendanceRecords for communications operationId: communications.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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/attendanceReports/{meetingAttendanceReport-id}/attendanceRecords/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.onlineMeeting summary: Get the number of the resource operationId: communications.onlineMeetings.attendanceReports.attendanceRecords.GetCount-73e4 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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/attendanceReports/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.onlineMeeting summary: Get the number of the resource operationId: communications.onlineMeetings.attendanceReports.GetCount-c621 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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/attendeeReport': description: Provides operations to manage the media for the cloudCommunications entity. get: tags: - communications.onlineMeeting summary: Get attendeeReport for the navigation property onlineMeetings from communications description: The content stream of the attendee report of a Microsoft Teams live event. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update attendeeReport for the navigation property onlineMeetings in communications description: The content stream of the attendee report of a Microsoft Teams live event. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Delete attendeeReport for the navigation property onlineMeetings in communications description: The content stream of the attendee report of a Microsoft Teams live event. Read-only. operationId: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/getVirtualAppointmentJoinWebUrl()': description: Provides operations to call the getVirtualAppointmentJoinWebUrl method. get: tags: - communications.Functions summary: 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: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/sendVirtualAppointmentReminderSms': description: Provides operations to call the sendVirtualAppointmentReminderSms method. post: tags: - communications.Actions summary: 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: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/sendVirtualAppointmentSms': description: Provides operations to call the sendVirtualAppointmentSms method. post: tags: - communications.Actions summary: 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: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/recordings': description: Provides operations to manage the recordings property of the microsoft.graph.onlineMeeting entity. get: tags: - communications.onlineMeeting summary: Get recordings from communications description: The recordings of an online meeting. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Create new navigation property to recordings for communications operationId: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/recordings/{callRecording-id}': description: Provides operations to manage the recordings property of the microsoft.graph.onlineMeeting entity. get: tags: - communications.onlineMeeting summary: Get recordings from communications description: The recordings of an online meeting. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update the navigation property recordings in communications operationId: communications.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: - communications.onlineMeeting summary: Delete navigation property recordings for communications operationId: communications.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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/recordings/{callRecording-id}/content': description: Provides operations to manage the media for the cloudCommunications entity. get: tags: - communications.onlineMeeting summary: Get content for the navigation property recordings from communications description: The content of the recording. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update content for the navigation property recordings in communications description: The content of the recording. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Delete content for the navigation property recordings in communications description: The content of the recording. Read-only. operationId: communications.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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/recordings/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.onlineMeeting summary: Get the number of the resource operationId: communications.onlineMeetings.recordings.GetCount-0fd0 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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/recordings/delta()': description: Provides operations to call the delta method. get: tags: - communications.Functions summary: Invoke function delta operationId: communications.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: 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: - '/communications/onlineMeetings/{onlineMeeting-id}/transcripts/delta()' '/communications/onlineMeetings/{onlineMeeting-id}/transcripts': description: Provides operations to manage the transcripts property of the microsoft.graph.onlineMeeting entity. get: tags: - communications.onlineMeeting summary: Get transcripts from communications description: The transcripts of an online meeting. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Create new navigation property to transcripts for communications operationId: communications.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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/transcripts/{callTranscript-id}': description: Provides operations to manage the transcripts property of the microsoft.graph.onlineMeeting entity. get: tags: - communications.onlineMeeting summary: Get transcripts from communications description: The transcripts of an online meeting. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update the navigation property transcripts in communications operationId: communications.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: - communications.onlineMeeting summary: Delete navigation property transcripts for communications operationId: communications.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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/transcripts/{callTranscript-id}/content': description: Provides operations to manage the media for the cloudCommunications entity. get: tags: - communications.onlineMeeting summary: Get content for the navigation property transcripts from communications description: The content of the transcript. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update content for the navigation property transcripts in communications description: The content of the transcript. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Delete content for the navigation property transcripts in communications description: The content of the transcript. Read-only. operationId: communications.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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/transcripts/{callTranscript-id}/metadataContent': description: Provides operations to manage the media for the cloudCommunications entity. get: tags: - communications.onlineMeeting summary: Get metadataContent for the navigation property transcripts from communications description: The time-aligned metadata of the utterances in the transcript. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Update metadataContent for the navigation property transcripts in communications description: The time-aligned metadata of the utterances in the transcript. Read-only. operationId: communications.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: - communications.onlineMeeting summary: Delete metadataContent for the navigation property transcripts in communications description: The time-aligned metadata of the utterances in the transcript. Read-only. operationId: communications.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: 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 '/communications/onlineMeetings/{onlineMeeting-id}/transcripts/$count': description: Provides operations to count the resources in the collection. get: tags: - communications.onlineMeeting summary: Get the number of the resource operationId: communications.onlineMeetings.transcripts.GetCount-7670 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: onlineMeeting-id in: path description: The unique identifier of onlineMeeting required: true schema: type: string x-ms-docs-key-type: onlineMeeting '/communications/onlineMeetings/{onlineMeeting-id}/transcripts/delta()': description: Provides operations to call the delta method. get: tags: - communications.Functions summary: Invoke function delta operationId: communications.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: 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: - '/communications/onlineMeetings/{onlineMeeting-id}/recordings/delta()' /communications/onlineMeetings/$count: description: Provides operations to count the resources in the collection. get: tags: - communications.onlineMeeting summary: Get the number of the resource operationId: communications.onlineMeetings.GetCount-91a5 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' /communications/onlineMeetings/createOrGet: description: Provides operations to call the createOrGet method. post: tags: - communications.Actions summary: 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: communications.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 '/communications/onlineMeetings/getAllRecordings(meetingOrganizerUserId=''@meetingOrganizerUserId'',startDateTime=@startDateTime,endDateTime=@endDateTime)': description: Provides operations to call the getAllRecordings method. get: tags: - communications.Functions summary: 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: communications.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: 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 '/communications/onlineMeetings/getAllTranscripts(meetingOrganizerUserId=''@meetingOrganizerUserId'',startDateTime=@startDateTime,endDateTime=@endDateTime)': description: Provides operations to call the getAllTranscripts method. get: tags: - communications.Functions summary: 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: communications.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: 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 /communications/presences: description: Provides operations to manage the presences property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.presence summary: Get presence description: Get a user's presence information. operationId: communications.ListPresences 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.presenceCollectionResponse' 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: - communications.presence summary: Create new navigation property to presences for communications operationId: communications.CreatePresences requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.presence' required: true responses: 2XX: description: Created 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 '/communications/presences/{presence-id}': description: Provides operations to manage the presences property of the microsoft.graph.cloudCommunications entity. get: tags: - communications.presence summary: 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: communications.GetPresences parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: 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: - communications.presence summary: Update the navigation property presences in communications operationId: communications.UpdatePresences 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: - communications.presence summary: Delete navigation property presences for communications operationId: communications.DeletePresences 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: presence-id in: path description: The unique identifier of presence required: true schema: type: string x-ms-docs-key-type: presence '/communications/presences/{presence-id}/clearPresence': description: Provides operations to call the clearPresence method. post: tags: - communications.Actions summary: 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: communications.presences.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: presence-id in: path description: The unique identifier of presence required: true schema: type: string x-ms-docs-key-type: presence '/communications/presences/{presence-id}/clearUserPreferredPresence': description: Provides operations to call the clearUserPreferredPresence method. post: tags: - communications.Actions summary: 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: communications.presences.presence.clearUserPreferredPresence responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: presence-id in: path description: The unique identifier of presence required: true schema: type: string x-ms-docs-key-type: presence '/communications/presences/{presence-id}/setPresence': description: Provides operations to call the setPresence method. post: tags: - communications.Actions summary: Invoke action setPresence description: Set the state of a user's presence session as an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/presence-setpresence?view=graph-rest-1.0 operationId: communications.presences.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: presence-id in: path description: The unique identifier of presence required: true schema: type: string x-ms-docs-key-type: presence '/communications/presences/{presence-id}/setStatusMessage': description: Provides operations to call the setStatusMessage method. post: tags: - communications.Actions summary: 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: communications.presences.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: presence-id in: path description: The unique identifier of presence required: true schema: type: string x-ms-docs-key-type: presence '/communications/presences/{presence-id}/setUserPreferredPresence': description: Provides operations to call the setUserPreferredPresence method. post: tags: - communications.Actions summary: 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: communications.presences.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: presence-id in: path description: The unique identifier of presence required: true schema: type: string x-ms-docs-key-type: presence /communications/presences/$count: description: Provides operations to count the resources in the collection. get: tags: - communications.presence summary: Get the number of the resource operationId: communications.presences.GetCount-e4ed 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' /compliance: description: Provides operations to manage the compliance singleton. get: tags: - compliance.compliance summary: Get compliance operationId: compliance.compliance.GetCompliance parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.compliance' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - compliance.compliance summary: Update compliance operationId: compliance.compliance.UpdateCompliance requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.compliance' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.compliance' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /connections: description: Provides operations to manage the collection of externalConnection entities. get: tags: - connections.externalConnection summary: Get entities from connections operationId: connections.externalConnection.ListExternalConnection 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.externalConnectors.externalConnectionCollectionResponse' 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: - connections.externalConnection summary: Add new entity to connections operationId: connections.externalConnection.CreateExternalConnection requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalConnection' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalConnection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/connections/{externalConnection-id}': description: Provides operations to manage the collection of externalConnection entities. get: tags: - connections.externalConnection summary: Get entity from connections by key operationId: connections.externalConnection.GetExternalConnection parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.externalConnectors.externalConnection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - connections.externalConnection summary: Update entity in connections operationId: connections.externalConnection.UpdateExternalConnection requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalConnection' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalConnection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - connections.externalConnection summary: Delete entity from connections operationId: connections.externalConnection.DeleteExternalConnection 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection '/connections/{externalConnection-id}/groups': description: Provides operations to manage the groups property of the microsoft.graph.externalConnectors.externalConnection entity. get: tags: - connections.externalGroup summary: Get groups from connections operationId: connections.ListGroups 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.externalConnectors.externalGroupCollectionResponse' 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: - connections.externalGroup summary: Create new navigation property to groups for connections operationId: connections.CreateGroups requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalGroup' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection '/connections/{externalConnection-id}/groups/{externalGroup-id}': description: Provides operations to manage the groups property of the microsoft.graph.externalConnectors.externalConnection entity. get: tags: - connections.externalGroup summary: Get groups from connections operationId: connections.GetGroups parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - connections.externalGroup summary: Update the navigation property groups in connections operationId: connections.UpdateGroups requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalGroup' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - connections.externalGroup summary: Delete navigation property groups for connections operationId: connections.DeleteGroups 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalGroup-id in: path description: The unique identifier of externalGroup required: true schema: type: string x-ms-docs-key-type: externalGroup '/connections/{externalConnection-id}/groups/{externalGroup-id}/members': description: Provides operations to manage the members property of the microsoft.graph.externalConnectors.externalGroup entity. get: tags: - connections.externalGroup summary: Get members from connections description: 'A member added to an externalGroup. You can add Microsoft Entra users, Microsoft Entra groups, or an externalGroup as members.' operationId: connections.groups.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.externalConnectors.identityCollectionResponse' 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: - connections.externalGroup summary: Create new navigation property to members for connections operationId: connections.groups.CreateMembers requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.identity' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.identity' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalGroup-id in: path description: The unique identifier of externalGroup required: true schema: type: string x-ms-docs-key-type: externalGroup '/connections/{externalConnection-id}/groups/{externalGroup-id}/members/{identity-id}': description: Provides operations to manage the members property of the microsoft.graph.externalConnectors.externalGroup entity. get: tags: - connections.externalGroup summary: Get members from connections description: 'A member added to an externalGroup. You can add Microsoft Entra users, Microsoft Entra groups, or an externalGroup as members.' operationId: connections.groups.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.externalConnectors.identity' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - connections.externalGroup summary: Update the navigation property members in connections operationId: connections.groups.UpdateMembers requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.identity' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.identity' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - connections.externalGroup summary: Delete navigation property members for connections operationId: connections.groups.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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalGroup-id in: path description: The unique identifier of externalGroup required: true schema: type: string x-ms-docs-key-type: externalGroup - name: identity-id in: path description: The unique identifier of identity required: true schema: type: string x-ms-docs-key-type: identity '/connections/{externalConnection-id}/groups/{externalGroup-id}/members/$count': description: Provides operations to count the resources in the collection. get: tags: - connections.externalGroup summary: Get the number of the resource operationId: connections.groups.members.GetCount-d49a 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalGroup-id in: path description: The unique identifier of externalGroup required: true schema: type: string x-ms-docs-key-type: externalGroup '/connections/{externalConnection-id}/groups/$count': description: Provides operations to count the resources in the collection. get: tags: - connections.externalGroup summary: Get the number of the resource operationId: connections.groups.GetCount-6035 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection '/connections/{externalConnection-id}/items': description: Provides operations to manage the items property of the microsoft.graph.externalConnectors.externalConnection entity. get: tags: - connections.externalItem summary: Get items from connections operationId: connections.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.externalConnectors.externalItemCollectionResponse' 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: - connections.externalItem summary: Create new navigation property to items for connections operationId: connections.CreateItems requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalItem' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalItem' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection '/connections/{externalConnection-id}/items/{externalItem-id}': description: Provides operations to manage the items property of the microsoft.graph.externalConnectors.externalConnection entity. get: tags: - connections.externalItem summary: Get items from connections operationId: connections.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.externalConnectors.externalItem' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation put: tags: - connections.externalItem summary: Update the navigation property items in connections operationId: connections.UpdateItems requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalItem' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalItem' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - connections.externalItem summary: Delete navigation property items for connections operationId: connections.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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalItem-id in: path description: The unique identifier of externalItem required: true schema: type: string x-ms-docs-key-type: externalItem '/connections/{externalConnection-id}/items/{externalItem-id}/activities': description: Provides operations to manage the activities property of the microsoft.graph.externalConnectors.externalItem entity. get: tags: - connections.externalItem summary: Get activities from connections description: Returns a list of activities performed on the item. Write-only. operationId: connections.items.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.externalConnectors.externalActivityCollectionResponse' 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: - connections.externalItem summary: Create new navigation property to activities for connections operationId: connections.items.CreateActivities requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalActivity' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalActivity' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalItem-id in: path description: The unique identifier of externalItem required: true schema: type: string x-ms-docs-key-type: externalItem '/connections/{externalConnection-id}/items/{externalItem-id}/activities/{externalActivity-id}': description: Provides operations to manage the activities property of the microsoft.graph.externalConnectors.externalItem entity. get: tags: - connections.externalItem summary: Get activities from connections description: Returns a list of activities performed on the item. Write-only. operationId: connections.items.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.externalConnectors.externalActivity' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - connections.externalItem summary: Update the navigation property activities in connections operationId: connections.items.UpdateActivities requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalActivity' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalActivity' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - connections.externalItem summary: Delete navigation property activities for connections operationId: connections.items.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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalItem-id in: path description: The unique identifier of externalItem required: true schema: type: string x-ms-docs-key-type: externalItem - name: externalActivity-id in: path description: The unique identifier of externalActivity required: true schema: type: string x-ms-docs-key-type: externalActivity '/connections/{externalConnection-id}/items/{externalItem-id}/activities/{externalActivity-id}/performedBy': description: Provides operations to manage the performedBy property of the microsoft.graph.externalConnectors.externalActivity entity. get: tags: - connections.externalItem summary: Get performedBy from connections description: Represents an identity used to identify who is responsible for the activity. operationId: connections.items.activities.GetPerformedBy parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.identity' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalItem-id in: path description: The unique identifier of externalItem required: true schema: type: string x-ms-docs-key-type: externalItem - name: externalActivity-id in: path description: The unique identifier of externalActivity required: true schema: type: string x-ms-docs-key-type: externalActivity '/connections/{externalConnection-id}/items/{externalItem-id}/activities/$count': description: Provides operations to count the resources in the collection. get: tags: - connections.externalItem summary: Get the number of the resource operationId: connections.items.activities.GetCount-5552 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalItem-id in: path description: The unique identifier of externalItem required: true schema: type: string x-ms-docs-key-type: externalItem '/connections/{externalConnection-id}/items/{externalItem-id}/microsoft.graph.externalConnectors.addActivities': description: Provides operations to call the addActivities method. post: tags: - connections.Actions summary: Invoke action addActivities operationId: connections.externalConnection.items.externalItem.addActivities requestBody: description: Action parameters content: application/json: schema: type: object properties: activities: type: array items: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalActivity' required: true responses: 2XX: description: Success content: application/json: schema: title: Collection of externalActivityResult type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.externalConnectors.externalActivityResult' 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: externalItem-id in: path description: The unique identifier of externalItem required: true schema: type: string x-ms-docs-key-type: externalItem '/connections/{externalConnection-id}/items/$count': description: Provides operations to count the resources in the collection. get: tags: - connections.externalItem summary: Get the number of the resource operationId: connections.items.GetCount-eebb 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection '/connections/{externalConnection-id}/operations': description: Provides operations to manage the operations property of the microsoft.graph.externalConnectors.externalConnection entity. get: tags: - connections.connectionOperation summary: Get operations from connections operationId: connections.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.externalConnectors.connectionOperationCollectionResponse' 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: - connections.connectionOperation summary: Create new navigation property to operations for connections operationId: connections.CreateOperations requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.connectionOperation' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.connectionOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection '/connections/{externalConnection-id}/operations/{connectionOperation-id}': description: Provides operations to manage the operations property of the microsoft.graph.externalConnectors.externalConnection entity. get: tags: - connections.connectionOperation summary: Get operations from connections operationId: connections.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.externalConnectors.connectionOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - connections.connectionOperation summary: Update the navigation property operations in connections operationId: connections.UpdateOperations requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.connectionOperation' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.connectionOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - connections.connectionOperation summary: Delete navigation property operations for connections operationId: connections.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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection - name: connectionOperation-id in: path description: The unique identifier of connectionOperation required: true schema: type: string x-ms-docs-key-type: connectionOperation '/connections/{externalConnection-id}/operations/$count': description: Provides operations to count the resources in the collection. get: tags: - connections.connectionOperation summary: Get the number of the resource operationId: connections.operations.GetCount-57e0 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: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection '/connections/{externalConnection-id}/schema': description: Provides operations to manage the schema property of the microsoft.graph.externalConnectors.externalConnection entity. get: tags: - connections.schema summary: Get schema from connections operationId: connections.GetSchema parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.schema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - connections.schema summary: Update the navigation property schema in connections operationId: connections.UpdateSchema requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.schema' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.externalConnectors.schema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: externalConnection-id in: path description: The unique identifier of externalConnection required: true schema: type: string x-ms-docs-key-type: externalConnection /connections/$count: description: Provides operations to count the resources in the collection. get: tags: - connections.externalConnection summary: Get the number of the resource operationId: connections.GetCount-7f4b 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' /contacts: description: Provides operations to manage the collection of orgContact entities. get: tags: - contacts.orgContact summary: List orgContacts description: Get the list of organizational contacts for this organization. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/orgcontact-list?view=graph-rest-1.0 operationId: contacts.orgContact.ListOrgContact 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 x-ms-docs-operation-type: operation post: tags: - contacts.orgContact summary: Add new entity to contacts operationId: contacts.orgContact.CreateOrgContact requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.orgContact' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.orgContact' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/contacts/{orgContact-id}': description: Provides operations to manage the collection of orgContact entities. get: tags: - contacts.orgContact summary: Get orgContact description: Get the properties and relationships of an organizational contact. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/orgcontact-get?view=graph-rest-1.0 operationId: contacts.orgContact.GetOrgContact parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.orgContact' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - contacts.orgContact summary: Update entity in contacts operationId: contacts.orgContact.UpdateOrgContact requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.orgContact' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.orgContact' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - contacts.orgContact summary: Delete entity from contacts operationId: contacts.orgContact.DeleteOrgContact 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/directReports': description: Provides operations to manage the directReports property of the microsoft.graph.orgContact entity. get: tags: - contacts.directoryObject summary: List directReports description: Get the direct reports for this organizational contact. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/orgcontact-list-directreports?view=graph-rest-1.0 operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/directReports/{directoryObject-id}': description: Provides operations to manage the directReports property of the microsoft.graph.orgContact entity. get: tags: - contacts.directoryObject summary: Get directReports from contacts description: The contact's direct reports. (The users and contacts that have their manager property set to this contact.) Read-only. Nullable. Supports $expand. operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/directReports/{directoryObject-id}/graph.orgContact': description: Casts the previous resource to orgContact. get: tags: - contacts.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.orgContact operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/directReports/{directoryObject-id}/graph.user': description: Casts the previous resource to user. get: tags: - contacts.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.user operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/directReports/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.directReports.GetCount-94c4 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/directReports/graph.orgContact': description: Casts the previous resource to orgContact. get: tags: - contacts.directoryObject summary: Get the items of type microsoft.graph.orgContact in the microsoft.graph.directoryObject collection operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/directReports/graph.orgContact/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.DirectReports.GetCount.AsOrgContact-315a 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/directReports/graph.user': description: Casts the previous resource to user. get: tags: - contacts.directoryObject summary: Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/directReports/graph.user/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.DirectReports.GetCount.AsUser-5746 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/manager': description: Provides operations to manage the manager property of the microsoft.graph.orgContact entity. get: tags: - contacts.directoryObject summary: Get manager description: Get this organizational contact's manager. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/orgcontact-get-manager?view=graph-rest-1.0 operationId: contacts.GetManager parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/memberOf': description: Provides operations to manage the memberOf property of the microsoft.graph.orgContact entity. get: tags: - contacts.directoryObject summary: List memberOf description: List the groups that this organizational contact is a member of. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/orgcontact-list-memberof?view=graph-rest-1.0 operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/memberOf/{directoryObject-id}': description: Provides operations to manage the memberOf property of the microsoft.graph.orgContact entity. get: tags: - contacts.directoryObject summary: Get memberOf from contacts description: Groups that this contact is a member of. Read-only. Nullable. Supports $expand. operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/memberOf/{directoryObject-id}/graph.administrativeUnit': description: Casts the previous resource to administrativeUnit. get: tags: - contacts.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/memberOf/{directoryObject-id}/graph.group': description: Casts the previous resource to group. get: tags: - contacts.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.group operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/memberOf/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.memberOf.GetCount-46e4 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/memberOf/graph.administrativeUnit': description: Casts the previous resource to administrativeUnit. get: tags: - contacts.directoryObject summary: Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/memberOf/graph.administrativeUnit/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.MemberOf.GetCount.AsAdministrativeUnit-db20 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/memberOf/graph.group': description: Casts the previous resource to group. get: tags: - contacts.directoryObject summary: Get the items of type microsoft.graph.group in the microsoft.graph.directoryObject collection operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/memberOf/graph.group/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.MemberOf.GetCount.AsGroup-df93 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/checkMemberGroups': description: Provides operations to call the checkMemberGroups method. post: tags: - contacts.Actions summary: Invoke action checkMemberGroups description: 'Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. 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: contacts.orgContact.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/checkMemberObjects': description: Provides operations to call the checkMemberObjects method. post: tags: - contacts.Actions summary: Invoke action checkMemberObjects operationId: contacts.orgContact.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/getMemberGroups': description: Provides operations to call the getMemberGroups method. post: tags: - contacts.Actions summary: 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: contacts.orgContact.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/getMemberObjects': description: Provides operations to call the getMemberObjects method. post: tags: - contacts.Actions summary: Invoke action getMemberObjects description: 'Return all IDs for the groups, administrative units, and directory roles that a user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. Note: 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: contacts.orgContact.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/restore': description: Provides operations to call the restore method. post: tags: - contacts.Actions summary: Invoke action restore description: 'Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. However, security groups cannot be restored. Also, restoring an application doesn''t 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: contacts.orgContact.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/retryServiceProvisioning': description: Provides operations to call the retryServiceProvisioning method. post: tags: - contacts.Actions summary: Invoke action retryServiceProvisioning operationId: contacts.orgContact.retryServiceProvisioning responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/serviceProvisioningErrors': get: tags: - contacts.serviceProvisioningError summary: Get serviceProvisioningErrors property value 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).' operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/serviceProvisioningErrors/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.serviceProvisioningError summary: Get the number of the resource operationId: contacts.ServiceProvisioningErrors.GetCount-33c2 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/transitiveMemberOf': description: Provides operations to manage the transitiveMemberOf property of the microsoft.graph.orgContact entity. get: tags: - contacts.directoryObject summary: List transitiveMemberOf description: 'Get groups that this organizational contact is a member of. The API request is transitive, and returns all groups the organizational contact is a nested member of.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/orgcontact-list-transitivememberof?view=graph-rest-1.0 operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/transitiveMemberOf/{directoryObject-id}': description: Provides operations to manage the transitiveMemberOf property of the microsoft.graph.orgContact entity. get: tags: - contacts.directoryObject summary: Get transitiveMemberOf from contacts description: 'Groups that this contact is a member of, including groups that the contact is nested under. Read-only. Nullable.' operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/transitiveMemberOf/{directoryObject-id}/graph.administrativeUnit': description: Casts the previous resource to administrativeUnit. get: tags: - contacts.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/transitiveMemberOf/{directoryObject-id}/graph.group': description: Casts the previous resource to group. get: tags: - contacts.directoryObject summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.group operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject '/contacts/{orgContact-id}/transitiveMemberOf/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.transitiveMemberOf.GetCount-d749 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/transitiveMemberOf/graph.administrativeUnit': description: Casts the previous resource to administrativeUnit. get: tags: - contacts.directoryObject summary: Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/transitiveMemberOf/graph.administrativeUnit/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.TransitiveMemberOf.GetCount.AsAdministrativeUnit-d6cb 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/transitiveMemberOf/graph.group': description: Casts the previous resource to group. get: tags: - contacts.directoryObject summary: Get the items of type microsoft.graph.group in the microsoft.graph.directoryObject collection operationId: contacts.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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact '/contacts/{orgContact-id}/transitiveMemberOf/graph.group/$count': description: Provides operations to count the resources in the collection. get: tags: - contacts.directoryObject summary: Get the number of the resource operationId: contacts.TransitiveMemberOf.GetCount.AsGroup-e1a5 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: orgContact-id in: path description: The unique identifier of orgContact required: true schema: type: string x-ms-docs-key-type: orgContact /contacts/$count: description: Provides operations to count the resources in the collection. get: tags: - contacts.orgContact summary: Get the number of the resource operationId: contacts.GetCount-60f9 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' /contacts/delta(): description: Provides operations to call the delta method. get: tags: - contacts.Functions summary: Invoke function delta description: 'Get newly created, updated, or deleted organizational contacts without having to perform a full read of the entire collection. See change tracking for details.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/orgcontact-delta?view=graph-rest-1.0 operationId: 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 orgContact type: object allOf: - $ref: '#/components/schemas/BaseDeltaFunctionResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/microsoft.graph.orgContact' 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: - /contacts/delta() /contacts/getAvailableExtensionProperties: description: Provides operations to call the getAvailableExtensionProperties method. post: tags: - contacts.Actions summary: Invoke action getAvailableExtensionProperties description: 'Return all directory extension definitions that have been registered in a directory, including through multi-tenant 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: contacts.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 /contacts/getByIds: description: Provides operations to call the getByIds method. post: tags: - contacts.Actions summary: 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: contacts.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 /contacts/validateProperties: description: Provides operations to call the validateProperties method. post: tags: - contacts.Actions summary: 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:\n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\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 are 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: contacts.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 /contracts: description: Provides operations to manage the collection of contract entities. get: tags: - contracts.contract summary: List contracts description: Retrieve a list of contract objects associated to a partner tenant. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/contract-list?view=graph-rest-1.0 operationId: contracts.contract.ListContract 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.contractCollectionResponse' 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: - contracts.contract summary: Add new entity to contracts operationId: contracts.contract.CreateContract requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contract' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contract' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/contracts/{contract-id}': description: Provides operations to manage the collection of contract entities. get: tags: - contracts.contract summary: Get Contract description: Retrieve the properties and relationships of contract object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/contract-get?view=graph-rest-1.0 operationId: contracts.contract.GetContract parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.contract' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - contracts.contract summary: Update entity in contracts operationId: contracts.contract.UpdateContract requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contract' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.contract' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - contracts.contract summary: Delete entity from contracts operationId: contracts.contract.DeleteContract 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: contract-id in: path description: The unique identifier of contract required: true schema: type: string x-ms-docs-key-type: contract '/contracts/{contract-id}/checkMemberGroups': description: Provides operations to call the checkMemberGroups method. post: tags: - contracts.Actions summary: Invoke action checkMemberGroups description: 'Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. 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: contracts.contract.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: contract-id in: path description: The unique identifier of contract required: true schema: type: string x-ms-docs-key-type: contract '/contracts/{contract-id}/checkMemberObjects': description: Provides operations to call the checkMemberObjects method. post: tags: - contracts.Actions summary: Invoke action checkMemberObjects operationId: contracts.contract.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: contract-id in: path description: The unique identifier of contract required: true schema: type: string x-ms-docs-key-type: contract '/contracts/{contract-id}/getMemberGroups': description: Provides operations to call the getMemberGroups method. post: tags: - contracts.Actions summary: 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: contracts.contract.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: contract-id in: path description: The unique identifier of contract required: true schema: type: string x-ms-docs-key-type: contract '/contracts/{contract-id}/getMemberObjects': description: Provides operations to call the getMemberObjects method. post: tags: - contracts.Actions summary: Invoke action getMemberObjects description: 'Return all IDs for the groups, administrative units, and directory roles that a user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. Note: 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: contracts.contract.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: contract-id in: path description: The unique identifier of contract required: true schema: type: string x-ms-docs-key-type: contract '/contracts/{contract-id}/restore': description: Provides operations to call the restore method. post: tags: - contracts.Actions summary: Invoke action restore description: 'Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. However, security groups cannot be restored. Also, restoring an application doesn''t 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: contracts.contract.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: contract-id in: path description: The unique identifier of contract required: true schema: type: string x-ms-docs-key-type: contract /contracts/$count: description: Provides operations to count the resources in the collection. get: tags: - contracts.contract summary: Get the number of the resource operationId: contracts.GetCount-8092 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' /contracts/delta(): description: Provides operations to call the delta method. get: tags: - contracts.Functions summary: Invoke function delta description: 'Get newly created, updated, or deleted directory objects without performing a full read of the entire directoryObject collection. For more information about the delta function, 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/directoryobject-delta?view=graph-rest-1.0 operationId: contracts.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 directoryObject type: object allOf: - $ref: '#/components/schemas/BaseDeltaFunctionResponse' - 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: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore /contracts/getAvailableExtensionProperties: description: Provides operations to call the getAvailableExtensionProperties method. post: tags: - contracts.Actions summary: Invoke action getAvailableExtensionProperties description: 'Return all directory extension definitions that have been registered in a directory, including through multi-tenant 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: contracts.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 /contracts/getByIds: description: Provides operations to call the getByIds method. post: tags: - contracts.Actions summary: 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: contracts.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 /contracts/validateProperties: description: Provides operations to call the validateProperties method. post: tags: - contracts.Actions summary: 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:\n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\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 are 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: contracts.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 /dataPolicyOperations: description: Provides operations to manage the collection of dataPolicyOperation entities. get: tags: - dataPolicyOperations.dataPolicyOperation summary: Get dataPolicyOperation description: Retrieve the properties of a dataPolicyOperation object. operationId: dataPolicyOperations.dataPolicyOperation.ListDataPolicyOperation 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.dataPolicyOperationCollectionResponse' 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: - dataPolicyOperations.dataPolicyOperation summary: Add new entity to dataPolicyOperations operationId: dataPolicyOperations.dataPolicyOperation.CreateDataPolicyOperation requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.dataPolicyOperation' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.dataPolicyOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/dataPolicyOperations/{dataPolicyOperation-id}': description: Provides operations to manage the collection of dataPolicyOperation entities. get: tags: - dataPolicyOperations.dataPolicyOperation summary: Get dataPolicyOperation description: Retrieve the properties of a dataPolicyOperation object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/datapolicyoperation-get?view=graph-rest-1.0 operationId: dataPolicyOperations.dataPolicyOperation.GetDataPolicyOperation parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.dataPolicyOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - dataPolicyOperations.dataPolicyOperation summary: Update entity in dataPolicyOperations operationId: dataPolicyOperations.dataPolicyOperation.UpdateDataPolicyOperation requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.dataPolicyOperation' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.dataPolicyOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - dataPolicyOperations.dataPolicyOperation summary: Delete entity from dataPolicyOperations operationId: dataPolicyOperations.dataPolicyOperation.DeleteDataPolicyOperation 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: dataPolicyOperation-id in: path description: The unique identifier of dataPolicyOperation required: true schema: type: string x-ms-docs-key-type: dataPolicyOperation /dataPolicyOperations/$count: description: Provides operations to count the resources in the collection. get: tags: - dataPolicyOperations.dataPolicyOperation summary: Get the number of the resource operationId: dataPolicyOperations.GetCount-b129 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' /deviceAppManagement: description: Provides operations to manage the deviceAppManagement singleton. get: tags: - deviceAppManagement.deviceAppManagement summary: Get deviceAppManagement description: Read properties and relationships of the deviceAppManagement object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-partnerintegration-deviceappmanagement-get?view=graph-rest-1.0 operationId: deviceAppManagement.deviceAppManagement.GetDeviceAppManagement parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - 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.deviceAppManagement' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.deviceAppManagement summary: Update deviceAppManagement description: Update the properties of a deviceAppManagement object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-partnerintegration-deviceappmanagement-update?view=graph-rest-1.0 operationId: deviceAppManagement.deviceAppManagement.UpdateDeviceAppManagement requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.deviceAppManagement' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.deviceAppManagement' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /deviceAppManagement/androidManagedAppProtections: description: Provides operations to manage the androidManagedAppProtections property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.androidManagedAppProtection summary: List androidManagedAppProtections description: List properties and relationships of the androidManagedAppProtection objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-androidmanagedappprotection-list?view=graph-rest-1.0 operationId: deviceAppManagement.ListAndroidManagedAppProtections 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.androidManagedAppProtectionCollectionResponse' 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: - deviceAppManagement.androidManagedAppProtection summary: Create androidManagedAppProtection description: Create a new androidManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-androidmanagedappprotection-create?view=graph-rest-1.0 operationId: deviceAppManagement.CreateAndroidManagedAppProtections requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.androidManagedAppProtection' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.androidManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}': description: Provides operations to manage the androidManagedAppProtections property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get androidManagedAppProtection description: Read properties and relationships of the androidManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-androidmanagedappprotection-get?view=graph-rest-1.0 operationId: deviceAppManagement.GetAndroidManagedAppProtections parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.androidManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.androidManagedAppProtection summary: Update androidManagedAppProtection description: Update the properties of a androidManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-androidmanagedappprotection-update?view=graph-rest-1.0 operationId: deviceAppManagement.UpdateAndroidManagedAppProtections requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.androidManagedAppProtection' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.androidManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.androidManagedAppProtection summary: Delete androidManagedAppProtection description: Deletes a androidManagedAppProtection. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-androidmanagedappprotection-delete?view=graph-rest-1.0 operationId: deviceAppManagement.DeleteAndroidManagedAppProtections 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: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/apps': description: Provides operations to manage the apps property of the microsoft.graph.androidManagedAppProtection entity. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get apps from deviceAppManagement description: List of apps to which the policy is deployed. operationId: deviceAppManagement.androidManagedAppProtections.ListApps 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.managedMobileAppCollectionResponse' 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: - deviceAppManagement.androidManagedAppProtection summary: Create new navigation property to apps for deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.CreateApps requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/apps/{managedMobileApp-id}': description: Provides operations to manage the apps property of the microsoft.graph.androidManagedAppProtection entity. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get apps from deviceAppManagement description: List of apps to which the policy is deployed. operationId: deviceAppManagement.androidManagedAppProtections.GetApps parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.androidManagedAppProtection summary: Update the navigation property apps in deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.UpdateApps requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.androidManagedAppProtection summary: Delete navigation property apps for deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.DeleteApps 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: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection - name: managedMobileApp-id in: path description: The unique identifier of managedMobileApp required: true schema: type: string x-ms-docs-key-type: managedMobileApp '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/apps/$count': description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.androidManagedAppProtections.apps.GetCount-6de4 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: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/assignments': description: Provides operations to manage the assignments property of the microsoft.graph.targetedManagedAppProtection entity. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get assignments from deviceAppManagement description: Navigation property to list of inclusion and exclusion groups to which the policy is deployed. operationId: deviceAppManagement.androidManagedAppProtections.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.targetedManagedAppPolicyAssignmentCollectionResponse' 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: - deviceAppManagement.androidManagedAppProtection summary: Create new navigation property to assignments for deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.CreateAssignments requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection x-ms-docs-grouped-path: - '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/assignments' '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/assignments/{targetedManagedAppPolicyAssignment-id}': description: Provides operations to manage the assignments property of the microsoft.graph.targetedManagedAppProtection entity. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get assignments from deviceAppManagement description: Navigation property to list of inclusion and exclusion groups to which the policy is deployed. operationId: deviceAppManagement.androidManagedAppProtections.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.targetedManagedAppPolicyAssignment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.androidManagedAppProtection summary: Update the navigation property assignments in deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.UpdateAssignments requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.androidManagedAppProtection summary: Delete navigation property assignments for deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.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: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection - name: targetedManagedAppPolicyAssignment-id in: path description: The unique identifier of targetedManagedAppPolicyAssignment required: true schema: type: string x-ms-docs-key-type: targetedManagedAppPolicyAssignment x-ms-docs-grouped-path: - '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/assignments/{targetedManagedAppPolicyAssignment-id}' '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/assignments/$count': description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.androidManagedAppProtections.assignments.GetCount-574a 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: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/deploymentSummary': description: Provides operations to manage the deploymentSummary property of the microsoft.graph.androidManagedAppProtection entity. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get deploymentSummary from deviceAppManagement description: Navigation property to deployment summary of the configuration. operationId: deviceAppManagement.androidManagedAppProtections.GetDeploymentSummary parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.androidManagedAppProtection summary: Update the navigation property deploymentSummary in deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.UpdateDeploymentSummary requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.androidManagedAppProtection summary: Delete navigation property deploymentSummary for deviceAppManagement operationId: deviceAppManagement.androidManagedAppProtections.DeleteDeploymentSummary 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: androidManagedAppProtection-id in: path description: The unique identifier of androidManagedAppProtection required: true schema: type: string x-ms-docs-key-type: androidManagedAppProtection /deviceAppManagement/androidManagedAppProtections/$count: description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.androidManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.androidManagedAppProtections.GetCount-dc72 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' /deviceAppManagement/defaultManagedAppProtections: description: Provides operations to manage the defaultManagedAppProtections property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.defaultManagedAppProtection summary: List defaultManagedAppProtections description: List properties and relationships of the defaultManagedAppProtection objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-defaultmanagedappprotection-list?view=graph-rest-1.0 operationId: deviceAppManagement.ListDefaultManagedAppProtections 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.defaultManagedAppProtectionCollectionResponse' 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: - deviceAppManagement.defaultManagedAppProtection summary: Create defaultManagedAppProtection description: Create a new defaultManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-defaultmanagedappprotection-create?view=graph-rest-1.0 operationId: deviceAppManagement.CreateDefaultManagedAppProtections requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.defaultManagedAppProtection' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.defaultManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/deviceAppManagement/defaultManagedAppProtections/{defaultManagedAppProtection-id}': description: Provides operations to manage the defaultManagedAppProtections property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.defaultManagedAppProtection summary: Get defaultManagedAppProtection description: Read properties and relationships of the defaultManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-defaultmanagedappprotection-get?view=graph-rest-1.0 operationId: deviceAppManagement.GetDefaultManagedAppProtections parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.defaultManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.defaultManagedAppProtection summary: Update defaultManagedAppProtection description: Update the properties of a defaultManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-defaultmanagedappprotection-update?view=graph-rest-1.0 operationId: deviceAppManagement.UpdateDefaultManagedAppProtections requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.defaultManagedAppProtection' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.defaultManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.defaultManagedAppProtection summary: Delete defaultManagedAppProtection description: Deletes a defaultManagedAppProtection. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-defaultmanagedappprotection-delete?view=graph-rest-1.0 operationId: deviceAppManagement.DeleteDefaultManagedAppProtections 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: defaultManagedAppProtection-id in: path description: The unique identifier of defaultManagedAppProtection required: true schema: type: string x-ms-docs-key-type: defaultManagedAppProtection '/deviceAppManagement/defaultManagedAppProtections/{defaultManagedAppProtection-id}/apps': description: Provides operations to manage the apps property of the microsoft.graph.defaultManagedAppProtection entity. get: tags: - deviceAppManagement.defaultManagedAppProtection summary: Get apps from deviceAppManagement description: List of apps to which the policy is deployed. operationId: deviceAppManagement.defaultManagedAppProtections.ListApps 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.managedMobileAppCollectionResponse' 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: - deviceAppManagement.defaultManagedAppProtection summary: Create new navigation property to apps for deviceAppManagement operationId: deviceAppManagement.defaultManagedAppProtections.CreateApps requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: defaultManagedAppProtection-id in: path description: The unique identifier of defaultManagedAppProtection required: true schema: type: string x-ms-docs-key-type: defaultManagedAppProtection '/deviceAppManagement/defaultManagedAppProtections/{defaultManagedAppProtection-id}/apps/{managedMobileApp-id}': description: Provides operations to manage the apps property of the microsoft.graph.defaultManagedAppProtection entity. get: tags: - deviceAppManagement.defaultManagedAppProtection summary: Get apps from deviceAppManagement description: List of apps to which the policy is deployed. operationId: deviceAppManagement.defaultManagedAppProtections.GetApps parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.defaultManagedAppProtection summary: Update the navigation property apps in deviceAppManagement operationId: deviceAppManagement.defaultManagedAppProtections.UpdateApps requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.defaultManagedAppProtection summary: Delete navigation property apps for deviceAppManagement operationId: deviceAppManagement.defaultManagedAppProtections.DeleteApps 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: defaultManagedAppProtection-id in: path description: The unique identifier of defaultManagedAppProtection required: true schema: type: string x-ms-docs-key-type: defaultManagedAppProtection - name: managedMobileApp-id in: path description: The unique identifier of managedMobileApp required: true schema: type: string x-ms-docs-key-type: managedMobileApp '/deviceAppManagement/defaultManagedAppProtections/{defaultManagedAppProtection-id}/apps/$count': description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.defaultManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.defaultManagedAppProtections.apps.GetCount-9a28 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: defaultManagedAppProtection-id in: path description: The unique identifier of defaultManagedAppProtection required: true schema: type: string x-ms-docs-key-type: defaultManagedAppProtection '/deviceAppManagement/defaultManagedAppProtections/{defaultManagedAppProtection-id}/deploymentSummary': description: Provides operations to manage the deploymentSummary property of the microsoft.graph.defaultManagedAppProtection entity. get: tags: - deviceAppManagement.defaultManagedAppProtection summary: Get deploymentSummary from deviceAppManagement description: Navigation property to deployment summary of the configuration. operationId: deviceAppManagement.defaultManagedAppProtections.GetDeploymentSummary parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.defaultManagedAppProtection summary: Update the navigation property deploymentSummary in deviceAppManagement operationId: deviceAppManagement.defaultManagedAppProtections.UpdateDeploymentSummary requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.defaultManagedAppProtection summary: Delete navigation property deploymentSummary for deviceAppManagement operationId: deviceAppManagement.defaultManagedAppProtections.DeleteDeploymentSummary 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: defaultManagedAppProtection-id in: path description: The unique identifier of defaultManagedAppProtection required: true schema: type: string x-ms-docs-key-type: defaultManagedAppProtection /deviceAppManagement/defaultManagedAppProtections/$count: description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.defaultManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.defaultManagedAppProtections.GetCount-9b85 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' /deviceAppManagement/iosManagedAppProtections: description: Provides operations to manage the iosManagedAppProtections property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.iosManagedAppProtection summary: List iosManagedAppProtections description: List properties and relationships of the iosManagedAppProtection objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-iosmanagedappprotection-list?view=graph-rest-1.0 operationId: deviceAppManagement.ListIosManagedAppProtections 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.iosManagedAppProtectionCollectionResponse' 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: - deviceAppManagement.iosManagedAppProtection summary: Create iosManagedAppProtection description: Create a new iosManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-iosmanagedappprotection-create?view=graph-rest-1.0 operationId: deviceAppManagement.CreateIosManagedAppProtections requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.iosManagedAppProtection' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.iosManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}': description: Provides operations to manage the iosManagedAppProtections property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.iosManagedAppProtection summary: Get iosManagedAppProtection description: Read properties and relationships of the iosManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-iosmanagedappprotection-get?view=graph-rest-1.0 operationId: deviceAppManagement.GetIosManagedAppProtections parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.iosManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.iosManagedAppProtection summary: Update iosManagedAppProtection description: Update the properties of a iosManagedAppProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-iosmanagedappprotection-update?view=graph-rest-1.0 operationId: deviceAppManagement.UpdateIosManagedAppProtections requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.iosManagedAppProtection' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.iosManagedAppProtection' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.iosManagedAppProtection summary: Delete iosManagedAppProtection description: Deletes a iosManagedAppProtection. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-iosmanagedappprotection-delete?view=graph-rest-1.0 operationId: deviceAppManagement.DeleteIosManagedAppProtections 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: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/apps': description: Provides operations to manage the apps property of the microsoft.graph.iosManagedAppProtection entity. get: tags: - deviceAppManagement.iosManagedAppProtection summary: List managedMobileApps description: List properties and relationships of the managedMobileApp objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedmobileapp-list?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.ListApps 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.managedMobileAppCollectionResponse' 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: - deviceAppManagement.iosManagedAppProtection summary: Create managedMobileApp description: Create a new managedMobileApp object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedmobileapp-create?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.CreateApps requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/apps/{managedMobileApp-id}': description: Provides operations to manage the apps property of the microsoft.graph.iosManagedAppProtection entity. get: tags: - deviceAppManagement.iosManagedAppProtection summary: Get managedMobileApp description: Read properties and relationships of the managedMobileApp object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedmobileapp-get?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.GetApps parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.iosManagedAppProtection summary: Update managedMobileApp description: Update the properties of a managedMobileApp object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedmobileapp-update?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.UpdateApps requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.iosManagedAppProtection summary: Delete managedMobileApp description: Deletes a managedMobileApp. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedmobileapp-delete?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.DeleteApps 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: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection - name: managedMobileApp-id in: path description: The unique identifier of managedMobileApp required: true schema: type: string x-ms-docs-key-type: managedMobileApp '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/apps/$count': description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.iosManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.iosManagedAppProtections.apps.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: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/assignments': description: Provides operations to manage the assignments property of the microsoft.graph.targetedManagedAppProtection entity. get: tags: - deviceAppManagement.iosManagedAppProtection summary: List targetedManagedAppPolicyAssignments description: List properties and relationships of the targetedManagedAppPolicyAssignment objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-targetedmanagedapppolicyassignment-list?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.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.targetedManagedAppPolicyAssignmentCollectionResponse' 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: - deviceAppManagement.iosManagedAppProtection summary: Create new navigation property to assignments for deviceAppManagement operationId: deviceAppManagement.iosManagedAppProtections.CreateAssignments requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection x-ms-docs-grouped-path: - '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/assignments' '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/assignments/{targetedManagedAppPolicyAssignment-id}': description: Provides operations to manage the assignments property of the microsoft.graph.targetedManagedAppProtection entity. get: tags: - deviceAppManagement.iosManagedAppProtection summary: Get targetedManagedAppPolicyAssignment description: Read properties and relationships of the targetedManagedAppPolicyAssignment object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-targetedmanagedapppolicyassignment-get?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.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.targetedManagedAppPolicyAssignment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.iosManagedAppProtection summary: Update targetedManagedAppPolicyAssignment description: Update the properties of a targetedManagedAppPolicyAssignment object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-targetedmanagedapppolicyassignment-update?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.UpdateAssignments requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.iosManagedAppProtection summary: Delete targetedManagedAppPolicyAssignment description: Deletes a targetedManagedAppPolicyAssignment. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-targetedmanagedapppolicyassignment-delete?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.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: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection - name: targetedManagedAppPolicyAssignment-id in: path description: The unique identifier of targetedManagedAppPolicyAssignment required: true schema: type: string x-ms-docs-key-type: targetedManagedAppPolicyAssignment x-ms-docs-grouped-path: - '/deviceAppManagement/androidManagedAppProtections/{androidManagedAppProtection-id}/assignments/{targetedManagedAppPolicyAssignment-id}' '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/assignments/$count': description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.iosManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.iosManagedAppProtections.assignments.GetCount-619f 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: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection '/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtection-id}/deploymentSummary': description: Provides operations to manage the deploymentSummary property of the microsoft.graph.iosManagedAppProtection entity. get: tags: - deviceAppManagement.iosManagedAppProtection summary: Get managedAppPolicyDeploymentSummary description: Read properties and relationships of the managedAppPolicyDeploymentSummary object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedapppolicydeploymentsummary-get?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.GetDeploymentSummary parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.iosManagedAppProtection summary: Update managedAppPolicyDeploymentSummary description: Update the properties of a managedAppPolicyDeploymentSummary object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedapppolicydeploymentsummary-update?view=graph-rest-1.0 operationId: deviceAppManagement.iosManagedAppProtections.UpdateDeploymentSummary requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.iosManagedAppProtection summary: Delete navigation property deploymentSummary for deviceAppManagement operationId: deviceAppManagement.iosManagedAppProtections.DeleteDeploymentSummary 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: iosManagedAppProtection-id in: path description: The unique identifier of iosManagedAppProtection required: true schema: type: string x-ms-docs-key-type: iosManagedAppProtection /deviceAppManagement/iosManagedAppProtections/$count: description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.iosManagedAppProtection summary: Get the number of the resource operationId: deviceAppManagement.iosManagedAppProtections.GetCount-dcdc 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' /deviceAppManagement/managedAppPolicies: description: Provides operations to manage the managedAppPolicies property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.managedAppPolicy summary: List managedAppPolicies description: List properties and relationships of the managedAppPolicy objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedapppolicy-list?view=graph-rest-1.0 operationId: deviceAppManagement.ListManagedAppPolicies 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.managedAppPolicyCollectionResponse' 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: - deviceAppManagement.managedAppPolicy summary: Create new navigation property to managedAppPolicies for deviceAppManagement operationId: deviceAppManagement.CreateManagedAppPolicies requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/deviceAppManagement/managedAppPolicies/{managedAppPolicy-id}': description: Provides operations to manage the managedAppPolicies property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.managedAppPolicy summary: Get windowsInformationProtection description: Read properties and relationships of the windowsInformationProtection object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-windowsinformationprotection-get?view=graph-rest-1.0 operationId: deviceAppManagement.GetManagedAppPolicies parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.managedAppPolicy summary: Update the navigation property managedAppPolicies in deviceAppManagement operationId: deviceAppManagement.UpdateManagedAppPolicies requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.managedAppPolicy summary: Delete navigation property managedAppPolicies for deviceAppManagement operationId: deviceAppManagement.DeleteManagedAppPolicies 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: managedAppPolicy-id in: path description: The unique identifier of managedAppPolicy required: true schema: type: string x-ms-docs-key-type: managedAppPolicy '/deviceAppManagement/managedAppPolicies/{managedAppPolicy-id}/targetApps': description: Provides operations to call the targetApps method. post: tags: - deviceAppManagement.Actions summary: Invoke action targetApps description: Not yet documented externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedapppolicy-targetapps?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppPolicies.managedAppPolicy.targetApps requestBody: description: Action parameters content: application/json: schema: type: object properties: apps: type: array items: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: managedAppPolicy-id in: path description: The unique identifier of managedAppPolicy required: true schema: type: string x-ms-docs-key-type: managedAppPolicy x-ms-docs-grouped-path: - '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/appliedPolicies/{managedAppPolicy-id}/targetApps' - '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/intendedPolicies/{managedAppPolicy-id}/targetApps' - '/deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfiguration-id}/targetApps' /deviceAppManagement/managedAppPolicies/$count: description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.managedAppPolicy summary: Get the number of the resource operationId: deviceAppManagement.managedAppPolicies.GetCount-b24d 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' /deviceAppManagement/managedAppRegistrations: description: Provides operations to manage the managedAppRegistrations property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.managedAppRegistration summary: List androidManagedAppRegistrations description: List properties and relationships of the androidManagedAppRegistration objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-androidmanagedappregistration-list?view=graph-rest-1.0 operationId: deviceAppManagement.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 post: tags: - deviceAppManagement.managedAppRegistration summary: Create androidManagedAppRegistration description: Create a new androidManagedAppRegistration object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-androidmanagedappregistration-create?view=graph-rest-1.0 operationId: deviceAppManagement.CreateManagedAppRegistrations requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppRegistration' required: true responses: 2XX: description: Created 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 '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}': description: Provides operations to manage the managedAppRegistrations property of the microsoft.graph.deviceAppManagement entity. get: tags: - deviceAppManagement.managedAppRegistration summary: Get iosManagedAppRegistration description: Read properties and relationships of the iosManagedAppRegistration object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-iosmanagedappregistration-get?view=graph-rest-1.0 operationId: deviceAppManagement.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 patch: tags: - deviceAppManagement.managedAppRegistration summary: Update the navigation property managedAppRegistrations in deviceAppManagement operationId: deviceAppManagement.UpdateManagedAppRegistrations requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppRegistration' required: true responses: 2XX: description: Success 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 delete: tags: - deviceAppManagement.managedAppRegistration summary: Delete navigation property managedAppRegistrations for deviceAppManagement operationId: deviceAppManagement.DeleteManagedAppRegistrations 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: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/appliedPolicies': description: Provides operations to manage the appliedPolicies property of the microsoft.graph.managedAppRegistration entity. get: tags: - deviceAppManagement.managedAppRegistration summary: Get appliedPolicies from deviceAppManagement description: Zero or more policys already applied on the registered app when it last synchronized with managment service. operationId: deviceAppManagement.managedAppRegistrations.ListAppliedPolicies 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.managedAppPolicyCollectionResponse' 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: - deviceAppManagement.managedAppRegistration summary: Create new navigation property to appliedPolicies for deviceAppManagement operationId: deviceAppManagement.managedAppRegistrations.CreateAppliedPolicies requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/appliedPolicies/{managedAppPolicy-id}': description: Provides operations to manage the appliedPolicies property of the microsoft.graph.managedAppRegistration entity. get: tags: - deviceAppManagement.managedAppRegistration summary: Get appliedPolicies from deviceAppManagement description: Zero or more policys already applied on the registered app when it last synchronized with managment service. operationId: deviceAppManagement.managedAppRegistrations.GetAppliedPolicies parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.managedAppRegistration summary: Update the navigation property appliedPolicies in deviceAppManagement operationId: deviceAppManagement.managedAppRegistrations.UpdateAppliedPolicies requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.managedAppRegistration summary: Delete navigation property appliedPolicies for deviceAppManagement operationId: deviceAppManagement.managedAppRegistrations.DeleteAppliedPolicies 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: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration - name: managedAppPolicy-id in: path description: The unique identifier of managedAppPolicy required: true schema: type: string x-ms-docs-key-type: managedAppPolicy '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/appliedPolicies/{managedAppPolicy-id}/targetApps': description: Provides operations to call the targetApps method. post: tags: - deviceAppManagement.Actions summary: Invoke action targetApps description: Not yet documented externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedapppolicy-targetapps?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppRegistrations.managedAppRegistration.appliedPolicies.managedAppPolicy.targetApps requestBody: description: Action parameters content: application/json: schema: type: object properties: apps: type: array items: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration - name: managedAppPolicy-id in: path description: The unique identifier of managedAppPolicy required: true schema: type: string x-ms-docs-key-type: managedAppPolicy x-ms-docs-grouped-path: - '/deviceAppManagement/managedAppPolicies/{managedAppPolicy-id}/targetApps' - '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/intendedPolicies/{managedAppPolicy-id}/targetApps' - '/deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfiguration-id}/targetApps' '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/appliedPolicies/$count': description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.managedAppRegistration summary: Get the number of the resource operationId: deviceAppManagement.managedAppRegistrations.appliedPolicies.GetCount-91f5 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: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/intendedPolicies': description: Provides operations to manage the intendedPolicies property of the microsoft.graph.managedAppRegistration entity. get: tags: - deviceAppManagement.managedAppRegistration summary: Get intendedPolicies from deviceAppManagement description: Zero or more policies admin intended for the app as of now. operationId: deviceAppManagement.managedAppRegistrations.ListIntendedPolicies 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.managedAppPolicyCollectionResponse' 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: - deviceAppManagement.managedAppRegistration summary: Create new navigation property to intendedPolicies for deviceAppManagement operationId: deviceAppManagement.managedAppRegistrations.CreateIntendedPolicies requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/intendedPolicies/{managedAppPolicy-id}': description: Provides operations to manage the intendedPolicies property of the microsoft.graph.managedAppRegistration entity. get: tags: - deviceAppManagement.managedAppRegistration summary: Get intendedPolicies from deviceAppManagement description: Zero or more policies admin intended for the app as of now. operationId: deviceAppManagement.managedAppRegistrations.GetIntendedPolicies parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.managedAppRegistration summary: Update the navigation property intendedPolicies in deviceAppManagement operationId: deviceAppManagement.managedAppRegistrations.UpdateIntendedPolicies requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppPolicy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.managedAppRegistration summary: Delete navigation property intendedPolicies for deviceAppManagement operationId: deviceAppManagement.managedAppRegistrations.DeleteIntendedPolicies 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: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration - name: managedAppPolicy-id in: path description: The unique identifier of managedAppPolicy required: true schema: type: string x-ms-docs-key-type: managedAppPolicy '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/intendedPolicies/{managedAppPolicy-id}/targetApps': description: Provides operations to call the targetApps method. post: tags: - deviceAppManagement.Actions summary: Invoke action targetApps description: Not yet documented externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedapppolicy-targetapps?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppRegistrations.managedAppRegistration.intendedPolicies.managedAppPolicy.targetApps requestBody: description: Action parameters content: application/json: schema: type: object properties: apps: type: array items: $ref: '#/components/schemas/microsoft.graph.managedMobileApp' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration - name: managedAppPolicy-id in: path description: The unique identifier of managedAppPolicy required: true schema: type: string x-ms-docs-key-type: managedAppPolicy x-ms-docs-grouped-path: - '/deviceAppManagement/managedAppPolicies/{managedAppPolicy-id}/targetApps' - '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/appliedPolicies/{managedAppPolicy-id}/targetApps' - '/deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfiguration-id}/targetApps' '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/intendedPolicies/$count': description: Provides operations to count the resources in the collection. get: tags: - deviceAppManagement.managedAppRegistration summary: Get the number of the resource operationId: deviceAppManagement.managedAppRegistrations.intendedPolicies.GetCount-edb3 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: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/operations': description: Provides operations to manage the operations property of the microsoft.graph.managedAppRegistration entity. get: tags: - deviceAppManagement.managedAppRegistration summary: List managedAppOperations description: List properties and relationships of the managedAppOperation objects. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedappoperation-list?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppRegistrations.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.managedAppOperationCollectionResponse' 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: - deviceAppManagement.managedAppRegistration summary: Create managedAppOperation description: Create a new managedAppOperation object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedappoperation-create?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppRegistrations.CreateOperations requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppOperation' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: managedAppRegistration-id in: path description: The unique identifier of managedAppRegistration required: true schema: type: string x-ms-docs-key-type: managedAppRegistration '/deviceAppManagement/managedAppRegistrations/{managedAppRegistration-id}/operations/{managedAppOperation-id}': description: Provides operations to manage the operations property of the microsoft.graph.managedAppRegistration entity. get: tags: - deviceAppManagement.managedAppRegistration summary: Get managedAppOperation description: Read properties and relationships of the managedAppOperation object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedappoperation-get?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppRegistrations.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.managedAppOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - deviceAppManagement.managedAppRegistration summary: Update managedAppOperation description: Update the properties of a managedAppOperation object. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedappoperation-update?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppRegistrations.UpdateOperations requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppOperation' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.managedAppOperation' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - deviceAppManagement.managedAppRegistration summary: Delete managedAppOperation description: Deletes a managedAppOperation. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/intune-mam-managedappoperation-delete?view=graph-rest-1.0 operationId: deviceAppManagement.managedAppRegistrations.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: op