openapi: 3.1.0 info: title: Microsoft Graph Subscriptions description: Needs a description. paths: /directory/subscriptions: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.directory entity. get: tags: - directory.companySubscription summary: Microsoft Graph List subscriptions description: Get the list of commercial subscriptions that an organization acquired. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/directory-list-subscriptions?view=graph-rest-1.0 operationId: directory.ListSubscriptions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.companySubscriptionCollectionResponse 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: - directory.companySubscription summary: Microsoft Graph Create new navigation property to subscriptions for directory operationId: directory.CreateSubscriptions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /directory/subscriptions/{companySubscription-id}: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.directory entity. get: tags: - directory.companySubscription summary: Microsoft Graph Get companySubscription description: Get a specific commercial subscription that an organization acquired. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/companysubscription-get?view=graph-rest-1.0 operationId: directory.GetSubscriptions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - directory.companySubscription summary: Microsoft Graph Update the navigation property subscriptions in directory operationId: directory.UpdateSubscriptions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - directory.companySubscription summary: Microsoft Graph Delete navigation property subscriptions for directory operationId: directory.DeleteSubscriptions parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: companySubscription-id in: path description: The unique identifier of companySubscription required: true schema: type: string x-ms-docs-key-type: companySubscription x-ms-docs-grouped-path: - >- /directory/subscriptions(commerceSubscriptionId='{commerceSubscriptionId}') /directory/subscriptions(commerceSubscriptionId='{commerceSubscriptionId}'): description: >- Provides operations to manage the subscriptions property of the microsoft.graph.directory entity. get: tags: - directory.companySubscription summary: Microsoft Graph Get companySubscription description: Get a specific commercial subscription that an organization acquired. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/companysubscription-get?view=graph-rest-1.0 operationId: directory.subscriptions.GetByCommerceSubscriptionId parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - directory.companySubscription summary: Microsoft Graph Update the navigation property subscriptions in directory operationId: directory.subscriptions.UpdateByCommerceSubscriptionId requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.companySubscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - directory.companySubscription summary: Microsoft Graph Delete navigation property subscriptions for directory operationId: directory.subscriptions.DeleteByCommerceSubscriptionId parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: commerceSubscriptionId in: path description: Alternate key of companySubscription required: true schema: type: string nullable: true x-ms-docs-grouped-path: - /directory/subscriptions/{companySubscription-id} /directory/subscriptions/$count: description: Provides operations to count the resources in the collection. get: tags: - directory.companySubscription summary: Microsoft Graph Get the number of the resource operationId: directory.subscriptions.GetCount-06e4 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' /drives/{drive-id}/items/{driveItem-id}/subscriptions: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.driveItem entity. get: tags: - drives.driveItem summary: Microsoft Graph Get subscriptions from drives description: >- The set of subscriptions on the item. Only supported on the root of a drive. operationId: drives.items.ListSubscriptions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.subscriptionCollectionResponse 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: - drives.driveItem summary: Microsoft Graph Create new navigation property to subscriptions for drives operationId: drives.items.CreateSubscriptions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive - name: driveItem-id in: path description: The unique identifier of driveItem required: true schema: type: string x-ms-docs-key-type: driveItem /drives/{drive-id}/items/{driveItem-id}/subscriptions/{subscription-id}: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.driveItem entity. get: tags: - drives.driveItem summary: Microsoft Graph Get subscriptions from drives description: >- The set of subscriptions on the item. Only supported on the root of a drive. operationId: drives.items.GetSubscriptions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - drives.driveItem summary: Microsoft Graph Update the navigation property subscriptions in drives operationId: drives.items.UpdateSubscriptions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - drives.driveItem summary: Microsoft Graph Delete navigation property subscriptions for drives operationId: drives.items.DeleteSubscriptions parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive - name: driveItem-id in: path description: The unique identifier of driveItem required: true schema: type: string x-ms-docs-key-type: driveItem - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /drives/{drive-id}/items/{driveItem-id}/subscriptions/{subscription-id}/reauthorize: description: Provides operations to call the reauthorize method. post: tags: - drives.driveItem summary: Microsoft Graph Invoke action reauthorize description: >- Reauthorize a subscription when you receive a reauthorizationRequired challenge. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-reauthorize?view=graph-rest-1.0 operationId: drives.drive.items.driveItem.subscriptions.subscription.reauthorize responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive - name: driveItem-id in: path description: The unique identifier of driveItem required: true schema: type: string x-ms-docs-key-type: driveItem - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription x-ms-docs-grouped-path: - /drives/{drive-id}/list/subscriptions/{subscription-id}/reauthorize /drives/{drive-id}/items/{driveItem-id}/subscriptions/$count: description: Provides operations to count the resources in the collection. get: tags: - drives.driveItem summary: Microsoft Graph Get the number of the resource operationId: drives.items.subscriptions.GetCount-f848 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive - name: driveItem-id in: path description: The unique identifier of driveItem required: true schema: type: string x-ms-docs-key-type: driveItem /drives/{drive-id}/list/subscriptions: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Drives.list summary: Microsoft Graph Get subscriptions from drives description: The set of subscriptions on the list. operationId: drives.list.ListSubscriptions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.subscriptionCollectionResponse 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: - Drives.list summary: Microsoft Graph Create new navigation property to subscriptions for drives operationId: drives.list.CreateSubscriptions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive /drives/{drive-id}/list/subscriptions/{subscription-id}: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Drives.list summary: Microsoft Graph Get subscriptions from drives description: The set of subscriptions on the list. operationId: drives.list.GetSubscriptions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Drives.list summary: Microsoft Graph Update the navigation property subscriptions in drives operationId: drives.list.UpdateSubscriptions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Drives.list summary: Microsoft Graph Delete navigation property subscriptions for drives operationId: drives.list.DeleteSubscriptions parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /drives/{drive-id}/list/subscriptions/{subscription-id}/reauthorize: description: Provides operations to call the reauthorize method. post: tags: - Drives.list summary: Microsoft Graph Invoke action reauthorize description: >- Reauthorize a subscription when you receive a reauthorizationRequired challenge. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-reauthorize?view=graph-rest-1.0 operationId: drives.drive.list.subscriptions.subscription.reauthorize responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription x-ms-docs-grouped-path: - >- /drives/{drive-id}/items/{driveItem-id}/subscriptions/{subscription-id}/reauthorize /drives/{drive-id}/list/subscriptions/$count: description: Provides operations to count the resources in the collection. get: tags: - Drives.list summary: Microsoft Graph Get the number of the resource operationId: drives.list.subscriptions.GetCount-59f5 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: drive-id in: path description: The unique identifier of drive required: true schema: type: string x-ms-docs-key-type: drive /groups/{group-id}/sites/{site-id}/lists/{list-id}/subscriptions: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Groups.site summary: Microsoft Graph Get subscriptions from groups description: The set of subscriptions on the list. operationId: groups.sites.lists.ListSubscriptions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.subscriptionCollectionResponse 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: - Groups.site summary: Microsoft Graph Create new navigation property to subscriptions for groups operationId: groups.sites.lists.CreateSubscriptions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: group-id in: path description: The unique identifier of group required: true schema: type: string x-ms-docs-key-type: group - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list /groups/{group-id}/sites/{site-id}/lists/{list-id}/subscriptions/{subscription-id}: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Groups.site summary: Microsoft Graph Get subscriptions from groups description: The set of subscriptions on the list. operationId: groups.sites.lists.GetSubscriptions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Groups.site summary: Microsoft Graph Update the navigation property subscriptions in groups operationId: groups.sites.lists.UpdateSubscriptions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Groups.site summary: Microsoft Graph Delete navigation property subscriptions for groups operationId: groups.sites.lists.DeleteSubscriptions parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: group-id in: path description: The unique identifier of group required: true schema: type: string x-ms-docs-key-type: group - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /groups/{group-id}/sites/{site-id}/lists/{list-id}/subscriptions/{subscription-id}/reauthorize: description: Provides operations to call the reauthorize method. post: tags: - Groups.site summary: Microsoft Graph Invoke action reauthorize description: >- Reauthorize a subscription when you receive a reauthorizationRequired challenge. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-reauthorize?view=graph-rest-1.0 operationId: >- groups.group.sites.site.lists.list.subscriptions.subscription.reauthorize responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: group-id in: path description: The unique identifier of group required: true schema: type: string x-ms-docs-key-type: group - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /groups/{group-id}/sites/{site-id}/lists/{list-id}/subscriptions/$count: description: Provides operations to count the resources in the collection. get: tags: - Groups.site summary: Microsoft Graph Get the number of the resource operationId: groups.sites.lists.subscriptions.GetCount-5f55 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: group-id in: path description: The unique identifier of group required: true schema: type: string x-ms-docs-key-type: group - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list /shares/{sharedDriveItem-id}/list/subscriptions: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Shares.list summary: Microsoft Graph Get subscriptions from shares description: The set of subscriptions on the list. operationId: shares.list.ListSubscriptions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.subscriptionCollectionResponse 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: - Shares.list summary: Microsoft Graph Create new navigation property to subscriptions for shares operationId: shares.list.CreateSubscriptions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: sharedDriveItem-id in: path description: The unique identifier of sharedDriveItem required: true schema: type: string x-ms-docs-key-type: sharedDriveItem /shares/{sharedDriveItem-id}/list/subscriptions/{subscription-id}: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Shares.list summary: Microsoft Graph Get subscriptions from shares description: The set of subscriptions on the list. operationId: shares.list.GetSubscriptions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Shares.list summary: Microsoft Graph Update the navigation property subscriptions in shares operationId: shares.list.UpdateSubscriptions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Shares.list summary: Microsoft Graph Delete navigation property subscriptions for shares operationId: shares.list.DeleteSubscriptions parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: sharedDriveItem-id in: path description: The unique identifier of sharedDriveItem required: true schema: type: string x-ms-docs-key-type: sharedDriveItem - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /shares/{sharedDriveItem-id}/list/subscriptions/{subscription-id}/reauthorize: description: Provides operations to call the reauthorize method. post: tags: - Shares.list summary: Microsoft Graph Invoke action reauthorize description: >- Reauthorize a subscription when you receive a reauthorizationRequired challenge. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-reauthorize?view=graph-rest-1.0 operationId: shares.sharedDriveItem.list.subscriptions.subscription.reauthorize responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: sharedDriveItem-id in: path description: The unique identifier of sharedDriveItem required: true schema: type: string x-ms-docs-key-type: sharedDriveItem - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /shares/{sharedDriveItem-id}/list/subscriptions/$count: description: Provides operations to count the resources in the collection. get: tags: - Shares.list summary: Microsoft Graph Get the number of the resource operationId: shares.list.subscriptions.GetCount-4363 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: sharedDriveItem-id in: path description: The unique identifier of sharedDriveItem required: true schema: type: string x-ms-docs-key-type: sharedDriveItem /sites/{site-id}/lists/{list-id}/subscriptions: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Sites.list summary: Microsoft Graph Get subscriptions from sites description: The set of subscriptions on the list. operationId: sites.lists.ListSubscriptions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.subscriptionCollectionResponse 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: - Sites.list summary: Microsoft Graph Create new navigation property to subscriptions for sites operationId: sites.lists.CreateSubscriptions requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list /sites/{site-id}/lists/{list-id}/subscriptions/{subscription-id}: description: >- Provides operations to manage the subscriptions property of the microsoft.graph.list entity. get: tags: - Sites.list summary: Microsoft Graph Get subscriptions from sites description: The set of subscriptions on the list. operationId: sites.lists.GetSubscriptions parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Sites.list summary: Microsoft Graph Update the navigation property subscriptions in sites operationId: sites.lists.UpdateSubscriptions requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Sites.list summary: Microsoft Graph Delete navigation property subscriptions for sites operationId: sites.lists.DeleteSubscriptions parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /sites/{site-id}/lists/{list-id}/subscriptions/{subscription-id}/reauthorize: description: Provides operations to call the reauthorize method. post: tags: - Sites.list summary: Microsoft Graph Invoke action reauthorize description: >- Reauthorize a subscription when you receive a reauthorizationRequired challenge. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-reauthorize?view=graph-rest-1.0 operationId: sites.site.lists.list.subscriptions.subscription.reauthorize responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /sites/{site-id}/lists/{list-id}/subscriptions/$count: description: Provides operations to count the resources in the collection. get: tags: - Sites.list summary: Microsoft Graph Get the number of the resource operationId: sites.lists.subscriptions.GetCount-77bf parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' parameters: - name: site-id in: path description: The unique identifier of site required: true schema: type: string x-ms-docs-key-type: site - name: list-id in: path description: The unique identifier of list required: true schema: type: string x-ms-docs-key-type: list /subscriptions: description: Provides operations to manage the collection of subscription entities. get: tags: - Subscriptions.subscription summary: Microsoft Graph List subscriptions description: >- Retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-list?view=graph-rest-1.0 operationId: subscriptions.subscription.ListSubscription parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.subscriptionCollectionResponse 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: - Subscriptions.subscription summary: Microsoft Graph Create subscription description: >- Subscribes a listener application to receive change notifications when the requested type of changes occur to the specified resource in Microsoft Graph. To identify the resources for which you can create subscriptions and the limitations on subscriptions, see Set up notifications for changes in resource data: Supported resources. Some resources support rich notifications, that is, notifications that include resource data. For more information about these resources, see Set up change notifications that include resource data: Supported resources. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-post-subscriptions?view=graph-rest-1.0 operationId: subscriptions.subscription.CreateSubscription requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /subscriptions/{subscription-id}: description: Provides operations to manage the collection of subscription entities. get: tags: - Subscriptions.subscription summary: Microsoft Graph Get subscription description: >- Retrieve the properties and relationships of a subscription. See the table in the Permissions section for the list of resources that support subscribing to change notifications. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-get?view=graph-rest-1.0 operationId: subscriptions.subscription.GetSubscription 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.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Subscriptions.subscription summary: Microsoft Graph Update subscription description: >- Renew a subscription by extending its expiry time. The table in the Permissions section lists the resources that support subscribing to change notifications. Subscriptions expire after a length of time that varies by resource type. In order to avoid missing change notifications, an app should renew its subscriptions well in advance of their expiry date. See subscription for maximum length of a subscription for each resource type. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-update?view=graph-rest-1.0 operationId: subscriptions.subscription.UpdateSubscription requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subscription' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Subscriptions.subscription summary: Microsoft Graph Delete subscription description: >- Delete a subscription. For the list of resources that support subscribing to change notifications, see the table in the Permissions section. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-delete?view=graph-rest-1.0 operationId: subscriptions.subscription.DeleteSubscription parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation parameters: - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription /subscriptions/{subscription-id}/reauthorize: description: Provides operations to call the reauthorize method. post: tags: - subscriptions.subscription.Actions summary: Microsoft Graph Invoke action reauthorize description: >- Reauthorize a subscription when you receive a reauthorizationRequired challenge. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subscription-reauthorize?view=graph-rest-1.0 operationId: subscriptions.subscription.reauthorize responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: action parameters: - name: subscription-id in: path description: The unique identifier of subscription required: true schema: type: string x-ms-docs-key-type: subscription components: schemas: microsoft.graph.companySubscription: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: companySubscription required: - '@odata.type' type: object properties: commerceSubscriptionId: type: string description: >- The ID of this subscription in the commerce system. Alternate key. nullable: true createdDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when this subscription was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true isTrial: type: boolean description: Whether the subscription is a free trial or purchased. nullable: true nextLifecycleDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when the subscription will move to the next state (as defined by the status property) if not renewed by the tenant. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true ownerId: type: string description: The object ID of the account admin. nullable: true ownerTenantId: type: string description: >- The unique identifier for the Microsoft partner tenant that created the subscription on a customer tenant. nullable: true ownerType: type: string description: >- Indicates the entity that ownerId belongs to, for example, 'User'. nullable: true serviceStatus: type: array items: $ref: '#/components/schemas/microsoft.graph.servicePlanInfo' description: >- The provisioning status of each service included in this subscription. skuId: type: string description: The object ID of the SKU associated with this subscription. nullable: true skuPartNumber: type: string description: The SKU associated with this subscription. nullable: true status: type: string description: >- The status of this subscription. The possible values are: Enabled, Deleted, Suspended, Warning, LockedOut. nullable: true totalLicenses: maximum: 2147483647 minimum: -2147483648 type: number description: The number of licenses included in this subscription. format: int32 nullable: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.companySubscription' microsoft.graph.subscription: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: subscription required: - '@odata.type' type: object properties: applicationId: type: string description: >- Optional. Identifier of the application used to create the subscription. Read-only. nullable: true changeType: type: string description: >- Required. Indicates the type of change in the subscribed resource that raises a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType. Use updated to receive notifications when user or group is created, updated, or soft deleted. Use deleted to receive notifications when user or group is permanently deleted. clientState: type: string description: >- Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification. nullable: true creatorId: type: string description: >- Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the ID of the service principal corresponding to the app. Read-only. nullable: true encryptionCertificate: type: string description: >- Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true. nullable: true encryptionCertificateId: type: string description: >- Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. nullable: true expirationDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time. For the maximum supported subscription length of time, see Subscription lifetime. format: date-time includeResourceData: type: boolean description: >- Optional. When set to true, change notifications include resource data (such as content of a chat message). nullable: true latestSupportedTlsVersion: type: string description: >- Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v10, v11, v12, v13. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2. nullable: true lifecycleNotificationUrl: type: string description: >- Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol. For more information, see Reduce missing subscriptions and change notifications. nullable: true notificationQueryOptions: type: string description: >- Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph. nullable: true notificationUrl: type: string description: >- Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications. notificationUrlAppId: type: string description: >- Optional. The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received. nullable: true resource: type: string description: >- Required. Specifies the resource that is monitored for changes. Don't include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource. '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.subscription' parameters: top: name: $top in: query description: Show only the first n items style: form explode: false schema: minimum: 0 type: integer example: 50 skip: name: $skip in: query description: Skip the first n items style: form explode: false schema: minimum: 0 type: integer search: name: $search in: query description: Search items by search phrases style: form explode: false schema: type: string filter: name: $filter in: query description: Filter items by property values style: form explode: false schema: type: string count: name: $count in: query description: Include count of items style: form explode: false schema: type: boolean examples: {} responses: error: description: error content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError' ODataCountResponse: description: The count of the resource content: text/plain: schema: $ref: '#/components/schemas/ODataCountResponse' tags: - name: directory.companySubscription - name: drives.driveItem - name: Drives.list - name: Groups.site - name: Shares.list - name: Sites.list - name: Subscriptions.subscription - name: subscriptions.subscription.Actions