Updates from: 06/15/2021 03:10:50
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Driveitem Createlink https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/driveitem-createlink.md
description: "You can use createLink action to share a DriveItem via a sharing link." Previously updated : 09/10/2017 Title: Share a file with a link
+ Title: "driveItem: createLink"
localization_priority: Normal ms.prod: "sharepoint" doc_type: apiPageType
-# Create a sharing link for a DriveItem
+# driveItem: createLink
Namespace: microsoft.graph
POST /me/drive/items/{itemId}/createLink
POST /sites/{siteId}/drive/items/{itemId}/createLink POST /users/{userId}/drive/items/{itemId}/createLink ```
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
-### Request body
+## Request body
The body of the request defines properties of the sharing link your application is requesting. The request should be a JSON object with the following properties. | Property | Type | Description | | :-| :-- | :|
-|type | string | The type of sharing link to create. Either view, edit, or embed. |
-|password | string | The password of the sharing link that is set by the creator. Optional and OneDrive Personal only. |
-|expirationDateTime | string | A String with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission. |
-|scope | string | Optional. The scope of link to create. Either anonymous or organization. |
-
+|type|String|Optional.The type of sharing link to create. |
+|scope|String|Optional. The scope of link to create. Either anonymous, organization or users.|
+|expirationDateTime|DateTimeOffset|Optional. A String with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission.|
+|password|String|Optional.The password of the sharing link that is set by the creator.|
+|recipients|[driveRecipient](../resources/driverecipient.md) collection|Optional. A collection of recipients who will receive access to the sharing link.|
### Link types
The following values are allowed for the **type** parameter.
| Type value | Description | |:--|:|
-| view | Creates a read-only link to the DriveItem. |
-| edit | Creates a read-write link to the DriveItem. |
-| embed | Creates an embeddable link to the DriveItem. This option is only available for files in OneDrive personal. |
+| view | Creates a read-only link to the Item. |
+| review | Creates a review link to the Item. This option is only available for files in OneDrive for Business and SharePoint. |
+| edit | Creates an read-write link to the Item. |
+| embed | Creates an embeddable link to the Item. |
+| blocksDownload | Creates a read-only link that blocks download to the Item. This option is only available for files in OneDrive for Business and SharePoint. |
+| createOnly | Creates an upload-only link to the Item. This option is only available for folders in OneDrive for Business and SharePoint. |
+| addressBar | Creates the default link that is shown in the browser address bars for newly created files. Only available in OneDrive for Business and SharePoint. The organization admin configures whether this link type is supported, and what features are supported by this link type. |
+| adminDefault | Creates the default link to the DriveItem as determined by the administrator of the organization. Only available in OneDrive for Business and SharePoint. The policy is enforced for the organization by the admin |
### Scope types The following values are allowed for the **scope** parameter.
-If the **scope** parameter is not specified, the default link type for the organization is created.
| Value | Description |:|: | anonymous | Anyone with the link has access, without needing to sign in. This may include people outside of your organization. Anonymous link support may be disabled by an administrator. | organization | Anyone signed into your organization (tenant) can use the link to get access. Only available in OneDrive for Business and SharePoint.-
+| users | Specific people in the recipients collection can use the link to get access. Only available in OneDrive for Business and SharePoint.
## Response
If successful, this method returns a single [Permission](../resources/permission
The response will be `201 Created` if a new sharing link is created for the item or `200 OK` if an existing link is returned.
-## Example
+## Examples
+### Example 1: Create an anonymous sharing link
The following example requests a sharing link to be created for the DriveItem specified by {itemId} in the user's OneDrive. The sharing link is configured to be read-only and usable by anyone with the link.
-### Request
--
-# [HTTP](#tab/http)
+#### Request
<!-- { "blockType": "request",
- "name": "item_createlink"
+ "name": "driveItem_createlink",
+ "sampleKeys": ["01G7ZEPNWQ6DTNTJHHJFBYZD47OAVFOO46"]
}--> ```http POST /me/drive/items/{itemId}/createLink
-Content-type: application/json
+Content-Type: application/json
+Content-length: 212
{ "type": "view",
- "password": "ThisIsMyPrivatePassword",
- "scope": "anonymous"
+ "scope": "anonymous",
+ "password": "String",
+ "recipients": [
+ {
+ "@odata.type": "microsoft.graph.driveRecipient"
+ }
+ ]
} ```+ # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/item-createlink-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
-### Response
-
-<!-- { "blockType": "response", "@odata.type": "microsoft.graph.permission" } -->
+#### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.permission"
+}
+-->
```http HTTP/1.1 201 Created
Content-Type: application/json
} ```
-## Creating company sharable links
+### Example 2: Creating company sharable links
OneDrive for Business and SharePoint support company sharable links. These are similar to anonymous links, except they only work for members of the owning organization. To create a company sharable link, use the **scope** parameter with a value of `organization`.
-### Request
-
+#### Request
-# [HTTP](#tab/http)
-<!-- { "blockType": "request", "name": "create-link-scoped", "scopes": "files.readwrite service.sharepoint" } -->
+<!-- {
+ "blockType": "request",
+ "name": "create-link-scoped",
+ "scopes": "files.readwrite service.sharepoint",
+ "sampleKeys": ["01G7ZEPNWQ6DTNTJHHJFBYZD47OAVFOO46"]
+ } -->
```http POST /me/drive/items/{item-id}/createLink
Content-Type: application/json
-### Response
+#### Response
<!-- { "blockType": "response", "@odata.type": "microsoft.graph.permission" } -->
Content-Type: application/json
} ```
-## Creating embeddable links
+### Example 3: Creating embeddable links
When using the `embed` link type, the webUrl returned can be embedded in an `<iframe>` HTML element. When an embed link is created the `webHtml` property contains the HTML code for an `<iframe>` to host the content.
-**Note:** Embed links are only supported for OneDrive personal.
-
-### Request
+>**Note:** Embed links are only supported for OneDrive personal.
+#### Request
-# [HTTP](#tab/http)
-<!-- { "blockType": "request", "name": "create-embedded-link", "scopes": "files.readwrite service.onedrive" } -->
+<!-- {
+ "blockType": "request",
+ "name": "create-embedded-link",
+ "scopes": "files.readwrite service.onedrive",
+ "sampleKeys": ["01G7ZEPNWQ6DTNTJHHJFBYZD47OAVFOO46"]
+} -->
```http POST /me/drive/items/{item-id}/createLink
Content-Type: application/json
-### Response
+#### Response
<!-- { "blockType": "response", "@odata.type": "microsoft.graph.permission" } -->
Content-Type: application/json
## Remarks
+* To create a link based on the organization's default policy and the caller's permissions on the listItem, omit the scope and type parameters
* Links created using this action do not expire unless a default expiration policy is enforced for the organization. * Links are visible in the sharing permissions for the item and can be removed by an owner of the item. * Links always point to the current version of a item unless the item is checked out (SharePoint only).
Content-Type: application/json
"suppressions": [ ] }>--
+-->
v1.0 Group Post Groups https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/group-post-groups.md
Content-length: 244
The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability. All the default properties are returned from an actual call.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
Content-Type: application/json
The following is an example of a successful response. It includes only default properties. You can subsequently get the **owners** or **members** navigation properties of the group to verify the owner or members.
->**Note:** The response object shown here might be shortened for readability. All the default properties are returned from an actual call.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
v1.0 Listitem Createlink https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/listitem-createlink.md
+
+ Title: "listItem: createLink"
+description: "Create a link to share a listItem"
+
+localization_priority: Normal
++
+# listItem: createLink
+
+Namespace: microsoft.graph
++
+Create a sharing link for a [listItem](../resources/listitem.md).
+
+The **createLink** action creates a new sharing link if the specified link type doesn't already exist for the calling application.
+If a sharing link of the specified type already exists for the app, this action will return the existing sharing link.
+
+**listItem** resources inherit sharing permissions from the [list](../resources/list.md) the item resides in.
+
+## Permissions
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account) | Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All |
+|Delegated (personal Microsoft account) | Files.ReadWrite, Files.ReadWrite.All |
+|Application | Files.ReadWrite.All, Sites.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored",
+ "sampleKeys": ["contoso.sharepoint.com,2288913C-B09C-46C4-BD1D-AEBB3A6E08EB,133A857A-DC2E-4A41-BCF7-D2B9BBC016AF", "A90E03FB-8446-4E0F-82E7-810FA7595A66", "3"]
+}
+-->
+``` http
+POST /sites/{siteId}/lists/{listId}/items/{itemId}/createLink
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, provide a JSON representation of the parameters.
+
+The following table shows the parameters that can be used with this action.
+
+| Property | Type | Description |
+| :-| :-- | :--|
+|type|String|The type of sharing link to create. Optional. |
+|scope|String|The scope of link to create. Either `anonymous`, `organization` or `users`. Optional. |
+|expirationDateTime|DateTimeOffset|A string with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission. Optional. |
+|password|String|The password of the sharing link that is set by the creator. Optional. |
+|recipients|[driveRecipient](../resources/driverecipient.md) collection|A collection of recipients who will receive access to the sharing link. Optional. |
+
+### Link types
+
+The following values are allowed for the **type** parameter.
+
+| Type value | Description |
+|:--|:|
+| view | Creates a read-only link to the item. |
+| review | Creates a review link to the item. This option is only available for files in OneDrive for Business and SharePoint. |
+| edit | Creates an read-write link to the item. |
+| embed | Creates an embeddable link to the item. |
+| blocksDownload | Creates a read-only link that blocks download to the item. This option is only available for files in OneDrive for Business and SharePoint. |
+| createOnly | Creates an upload-only link to the item. This option is only available for folders in OneDrive for Business and SharePoint. |
+| addressBar | Creates the default link that is shown in the browser address bars for newly created files. Only available in OneDrive for Business and SharePoint. The organization admin configures whether this link type is supported, and what features are supported by this link type. |
+| adminDefault | Creates the default link to the item as determined by the administrator of the organization. Only available in OneDrive for Business and SharePoint. The policy is enforced for the organization by the admin |
+
+### Scope types
+
+The following values are allowed for the **scope** parameter.
+
+| Value | Description
+|:|:
+| anonymous | Anyone with the link has access, without needing to sign in. This may include people outside of your organization. Anonymous link support may be disabled by an administrator.
+| organization | Anyone signed into your organization (tenant) can use the link to get access. Only available in OneDrive for Business and SharePoint.
+| users | Specific people in the recipients collection can use the link to get access. Only available in OneDrive for Business and SharePoint.
+
+## Response
+
+If successful, this method returns a single [permission](../resources/permission.md) resource in the response body that represents the requested sharing permissions.
+
+The response will be `201 Created` if a new sharing link is created for the listItem or `200 OK` if an existing link is returned.
+
+## Examples
+
+### Example 1: Create an anonymous sharing link
+The following example requests a sharing link to be created for the listItem specified by {itemId} in the list specified {listId}.
+The sharing link is configured to be read-only and usable by anyone with the link.
+
+#### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "listItem_createlink",
+ "sampleKeys": ["contoso.sharepoint.com,2288913C-B09C-46C4-BD1D-AEBB3A6E08EB,133A857A-DC2E-4A41-BCF7-D2B9BBC016AF", "A90E03FB-8446-4E0F-82E7-810FA7595A66", "3"]
+}-->
+
+```http
+POST sites/{siteId}/lists/{listId}/items/{itemId}/createLink
+Content-Type: application/json
+Content-length: 212
+
+{
+ "type": "view",
+ "scope": "anonymous",
+ "password": "String",
+ "recipients": [
+ {
+ "@odata.type": "microsoft.graph.driveRecipient"
+ }
+ ]
+}
+```
+
+#### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.permission"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "123ABC",
+ "roles": ["write"],
+ "link": {
+ "type": "view",
+ "scope": "anonymous",
+ "webUrl": "https://1drv.ms/A6913278E564460AA616C71B28AD6EB6",
+ "application": {
+ "id": "1234",
+ "displayName": "Sample Application"
+ },
+ },
+ "hasPassword": true
+}
+```
+
+### Example 2: Creating company sharable links
+
+OneDrive for Business and SharePoint support company sharable links.
+These are similar to anonymous links, except they only work for members of the owning organization.
+To create a company sharable link, use the **scope** parameter with a value of `organization`.
+
+#### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "listItem_createlink",
+ "sampleKeys": ["contoso.sharepoint.com,2288913C-B09C-46C4-BD1D-AEBB3A6E08EB,133A857A-DC2E-4A41-BCF7-D2B9BBC016AF", "A90E03FB-8446-4E0F-82E7-810FA7595A66", "3"]
+}-->
+
+```http
+POST /sites/{siteId}/lists/{listId}/items/{itemId}/createLink
+Content-Type: application/json
+
+{
+ "type": "edit",
+ "scope": "organization"
+}
+```
+
+#### Response
+
+<!-- { "blockType": "response", "@odata.type": "microsoft.graph.permission" } -->
+
+```http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "123ABC",
+ "roles": ["write"],
+ "link": {
+ "type": "edit",
+ "scope": "organization",
+ "webUrl": "https://contoso-my.sharepoint.com/personal/ellen_contoso_com/...",
+ "application": {
+ "id": "1234",
+ "displayName": "Sample Application"
+ },
+ }
+}
+```
+
+### Example 3: Creating embeddable links
+
+When using the `embed` link type, the webUrl returned can be embedded in an `<iframe>` HTML element.
+When an embed link is created the `webHtml` property contains the HTML code for an `<iframe>` to host the content.
+
+>**Note:** Embed links are only supported for OneDrive personal.
+
+#### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "listItem_createlink",
+ "sampleKeys": ["contoso.sharepoint.com,2288913C-B09C-46C4-BD1D-AEBB3A6E08EB,133A857A-DC2E-4A41-BCF7-D2B9BBC016AF", "A90E03FB-8446-4E0F-82E7-810FA7595A66", "3"]
+}-->
+
+```http
+POST /sites/{siteId}/lists/{listId}/items/{itemId}/createLink
+Content-Type: application/json
+
+{
+ "type": "embed"
+}
+```
+
+#### Response
+
+<!-- { "blockType": "response", "@odata.type": "microsoft.graph.permission" } -->
+
+```http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "123ABC",
+ "roles": ["read"],
+ "link": {
+ "type": "embed",
+ "webHtml": "<IFRAME src=\"https://onedrive.live.com/...\"></IFRAME>",
+ "webUrl": "https://onedive.live.com/...",
+ "application": {
+ "id": "1234",
+ "displayName": "Sample Application"
+ },
+ }
+}
+```
+
+## Remarks
+
+* To create a link based on the organization's default policy and the caller's permissions on the listItem, omit the scope and type parameters
+* Links created using this action do not expire unless a default expiration policy is enforced for the organization.
+* Links are visible in the sharing permissions for the listItem and can be removed by an owner of the listItem.
+* Links always point to the current version of a listItem unless the listItem is checked out (SharePoint only).
+
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Create a new sharing link for an listItem.",
+ "keywords": "create,sharing,sharing link",
+ "section": "documentation",
+ "tocPath": "Sharing/Create link",
+ "suppressions": [
+ ]
+}
+-->
v1.0 Subscription Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/subscription-delete.md
Depending on the resource and the permission type (delegated or application) req
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| |[callRecord](../resources/callrecords-callrecord.md) | Not supported | Not supported | CallRecords.Read.All |
+|[channels](../resources/channel.md) (/teams/getAllChannels ΓÇô all channels in an organization) | Not supported | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
+|[channels](../resources/channel.md) (/teams/{id}/channels) | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
|[chatMessage](../resources/chatmessage.md) (/teams/{id}/channels/{id}/messages) | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported | ChannelMessage.Read.Group*, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/teams/getAllMessages -- all channel messages in organization) | Not supported | Not supported | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/{id}/messages) | Chat.Read, Chat.ReadWrite | Not supported | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/getAllMessages -- all chat messages in organization) | Not supported | Not supported | Chat.Read.All | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read |
+|[conversationMember](../resources/conversationmember.md) (/teams/{id}/members) | TeamMember.Read.All | Not supported | TeamMember.Read.All |
|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported | Files.ReadWrite | Not supported | |[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.ReadWrite.All | Not supported | Files.ReadWrite.All | |[event](../resources/event.md) | Calendars.Read | Calendars.Read | Calendars.Read |
Depending on the resource and the permission type (delegated or application) req
|[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | |[security alert](../resources/alert.md) | SecurityEvents.ReadWrite.All | Not supported | SecurityEvents.ReadWrite.All |
+|[teams](../resources/team.md) (/teams ΓÇô all teams in an organization) | Not supported | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
+|[teams](../resources/team.md) (/teams/{id}) | Team.ReadBasic.All, TeamSettings.Read.All | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
|[todoTask](../resources/todotask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported | |[user](../resources/user.md) | User.Read.All | User.Read.All | User.Read.All |
v1.0 Subscription Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/subscription-get.md
Depending on the resource and the permission type (delegated or application) req
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| |[callRecord](../resources/callrecords-callrecord.md) | Not supported | Not supported | CallRecords.Read.All |
+|[channels](../resources/channel.md) (/teams/getAllChannels ΓÇô all channels in an organization) | Not supported | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
+|[channels](../resources/channel.md) (/teams/{id}/channels) | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
|[chatMessage](../resources/chatmessage.md) (/teams/{id}/channels/{id}/messages) | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported | ChannelMessage.Read.Group*, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/teams/getAllMessages -- all channel messages in organization) | Not supported | Not supported | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/{id}/messages) | Chat.Read, Chat.ReadWrite | Not supported | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/getAllMessages -- all chat messages in organization) | Not supported | Not supported | Chat.Read.All | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read |
+|[conversationMember](../resources/conversationmember.md) (/teams/{id}/members) | TeamMember.Read.All | Not supported | TeamMember.Read.All |
|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported | Files.ReadWrite | Not supported | |[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.ReadWrite.All | Not supported | Files.ReadWrite.All | |[event](../resources/event.md) | Calendars.Read | Calendars.Read | Calendars.Read |
Depending on the resource and the permission type (delegated or application) req
|[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | |[security alert](../resources/alert.md) | SecurityEvents.ReadWrite.All | Not supported | SecurityEvents.ReadWrite.All |
+|[teams](../resources/team.md) (/teams ΓÇô all teams in an organization) | Not supported | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
+|[teams](../resources/team.md) (/teams/{id}) | Team.ReadBasic.All, TeamSettings.Read.All | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
|[todoTask](../resources/todotask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported | |[user](../resources/user.md) | User.Read.All | User.Read.All | User.Read.All |
v1.0 Subscription Post Subscriptions https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/subscription-post-subscriptions.md
Depending on the resource and the permission type (delegated or application) req
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| |[callRecord](../resources/callrecords-callrecord.md) (/communications/callRecords) | Not supported | Not supported | CallRecords.Read.All |
+|[channels](../resources/channel.md) (/teams/getAllChannels ΓÇô all channels in an organization) | Not supported | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
+|[channels](../resources/channel.md) (/teams/{id}/channels) | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
|[chatMessage](../resources/chatmessage.md) (/teams/{id}/channels/{id}/messages) | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported | ChannelMessage.Read.Group*, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/teams/getAllMessages -- all channel messages in organization) | Not supported | Not supported | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/{id}/messages) | Chat.Read, Chat.ReadWrite | Not supported | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/getAllMessages -- all chat messages in organization) | Not supported | Not supported | Chat.Read.All | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read |
+|[conversationMember](../resources/conversationmember.md) (/teams/{id}/members) | TeamMember.Read.All | Not supported | TeamMember.Read.All |
|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported | Files.ReadWrite | Not supported | |[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.ReadWrite.All | Not supported | Files.ReadWrite.All | |[event](../resources/event.md) | Calendars.Read | Calendars.Read | Calendars.Read |
Depending on the resource and the permission type (delegated or application) req
|[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | |[security alert](../resources/alert.md) | SecurityEvents.ReadWrite.All | Not supported | SecurityEvents.ReadWrite.All |
+|[teams](../resources/team.md) (/teams ΓÇô all teams in an organization) | Not supported | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
+|[teams](../resources/team.md) (/teams/{id}) | Team.ReadBasic.All, TeamSettings.Read.All | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
|[todoTask](../resources/todotask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported | |[user](../resources/user.md) | User.Read.All | User.Read.All | User.Read.All |
The following are valid values for the resource property.
| Resource type | Examples | |: |:-- | |[Call records](../resources/callrecords-callrecord.md)|`communications/callRecords`|
+|[Channels](../resources/channel.md)|`/teams/getAllChannels`, `/teams/{id}/channels`|
|[Chat message](../resources/chatmessage.md) | `chats/{id}/messages`, `chats/getAllMessages`, `teams/{id}/channels/{id}/messages`, `teams/getAllMessages` | |[Contacts](../resources/contact.md)|`me/contacts`|
+|[ConversationMember](../resources/conversationmember.md)|`/teams/{id}/members`|
|[Conversations](../resources/conversation.md)|`groups('{id}')/conversations`| |[Drives](../resources/driveitem.md)|`me/drive/root`| |[Events](../resources/event.md)|`me/events`|
The following are valid values for the resource property.
|[Presence](../resources/presence.md)| `/communications/presences/{id}` (single user), `/communications/presences?$filter=id in ({id},{id}…)` (multiple users)| |[printer](../resources/printer.md) |`print/printers/{id}/jobs`| |[PrintTaskDefinition](../resources/printtaskdefinition.md)|`print/taskDefinitions/{id}/tasks`|
+|[Teams](../resources/team.md)|`/teams`, `/teams/{id}`|
|[Users](../resources/user.md)|`users`| |[todoTask](../resources/todotask.md) | `/me/todo/lists/{todoTaskListId}/tasks` |[Security alert](../resources/alert.md)|`security/alerts?$filter=status eq 'NewAlert'`|
v1.0 Subscription Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/subscription-update.md
Depending on the resource and the permission type (delegated or application) req
| Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--| |[callRecord](../resources/callrecords-callrecord.md) | Not supported | Not supported | CallRecords.Read.All |
+|[channels](../resources/channel.md) (/teams/getAllChannels ΓÇô all channels in an organization) | Not supported | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
+|[channels](../resources/channel.md) (/teams/{id}/channels) | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All |
|[chatMessage](../resources/chatmessage.md) (/teams/{id}/channels/{id}/messages) | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported | ChannelMessage.Read.Group*, ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/teams/getAllMessages -- all channel messages in organization) | Not supported | Not supported | ChannelMessage.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/{id}/messages) | Chat.Read, Chat.ReadWrite | Not supported | Chat.Read.All | |[chatMessage](../resources/chatmessage.md) (/chats/getAllMessages -- all chat messages in organization) | Not supported | Not supported | Chat.Read.All | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read |
+|[conversationMember](../resources/conversationmember.md) (/teams/{id}/members) | TeamMember.Read.All | Not supported | TeamMember.Read.All |
|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported | Files.ReadWrite | Not supported | |[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.ReadWrite.All | Not supported | Files.ReadWrite.All | |[event](../resources/event.md) | Calendars.Read | Calendars.Read | Calendars.Read |
Depending on the resource and the permission type (delegated or application) req
|[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | |[security alert](../resources/alert.md) | SecurityEvents.ReadWrite.All | Not supported | SecurityEvents.ReadWrite.All |
+|[teams](../resources/team.md) (/teams ΓÇô all teams in an organization) | Not supported | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
+|[teams](../resources/team.md) (/teams/{id}) | Team.ReadBasic.All, TeamSettings.Read.All | Not supported | Team.ReadBasic.All, TeamSettings.Read.All |
|[todoTask](../resources/todotask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported | |[user](../resources/user.md) | User.Read.All | User.Read.All | User.Read.All |
v1.0 Group https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/group.md
This resource supports:
|hideFromAddressLists |Boolean |`true` if the group is not displayed in certain parts of the Outlook user interface: in the **Address Book**, in address lists for selecting message recipients, and in the **Browse Groups** dialog for searching groups; false otherwise. Default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`).| |hideFromOutlookClients |Boolean |`true` if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. Default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`).| |id|String|The unique identifier for the group. <br><br>Returned by default. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only.|
-|isAssignableToRole|Boolean|Indicates whether this group can be assigned to an Azure Active Directory role or not.<br><br>This property can only be set while creating the group and is immutable. Only Global Administrator and Privileged Role Administrator roles can set this property. For more information, see [Using a group to manage Azure AD role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Returned by default.|
+|isAssignableToRole|Boolean|Indicates whether this group can be assigned to an Azure Active Directory role.<br><br>This property can only be set while creating the group and is immutable. If set to `true`, the **securityEnabled** property must also be set to `true` and the group cannot be a dynamic group (that is, **groupTypes** cannot contain `DynamicMembership`).Only callers in Global Administrator and Privileged Role Administrator roles can set this property. For more, see [Using a group to manage Azure AD role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Returned by default.|
|infoCatalogs|String collection|Identifies the info segments assigned to the group. Returned by default.| |isSubscribedByMail|Boolean|Indicates whether the signed-in user is subscribed to receive email conversations. Default value is `true`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | |licenseProcessingState|String|Indicates status of the group license assignment to all members of the group. Possible values: `QueuedForProcessing`, `ProcessingInProgress`, and `ProcessingComplete`. <br><br>Returned only on `$select`. Read-only. |
v1.0 Listitem https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/listitem.md
All examples below are relative to a **[list][]**, eg: `https://graph.microsoft.
| [Delete][] | DELETE /items/{item-id} | [Update][] | PATCH /items/{item-id} | [Update column values][Update] | PATCH /items/{item-id}/fields
+| [createLink][CreateLink] | POST /items/{itemId}/createLink
[Get]: ../api/listitem-get.md [Get analytics]: ../api/itemanalytics-get.md
All examples below are relative to a **[list][]**, eg: `https://graph.microsoft.
[Create]: ../api/listitem-create.md [Delete]: ../api/listitem-delete.md [Update]: ../api/listitem-update.md
+[CreateLink]: ../api/listitem-createlink.md
## JSON representation
v1.0 Subscription https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/subscription.md
A subscription allows a client app to receive change notifications about changes
- An [alert][] from the Microsoft Graph Security API. - A [callRecord][] produced after a call or meeting in Microsoft Teams.
+- A [channel](./channel.md) in Microsoft Teams.
- A [chatMessage][] sent via teams or channels in Microsoft Teams. - A [conversation][] in a Microsoft 365 group.
+- A [conversationMember](./conversationmember.md) in a Microsoft 365 group.
- Content in the hierarchy of a root folder [driveItem][] in OneDrive for Business, or of a root folder or subfolder [driveItem][] in a user's personal OneDrive. - A [list][] under a SharePoint [site][]. - A [message][], [event][], or [contact][] in Outlook. - The [presence][] of a user in Microsoft Teams.
+- A [team](./team.md) in Microsoft Teams.
- A [user][] or [group][] in Azure Active Directory. - A [printer][] (when a print job for the printer gets to JobFetchable state - ready to be fetched for printing) and a [printTaskDefinition][] in Universal Print. For more information, see [Subscribe to change notifications from cloud printing APIs](/graph/universal-print-webhook-notifications). - A [todoTask][] of a user in Microsoft To Do.
See [Use the Microsoft Graph API to get change notifications](webhooks.md) for t
|:--|:-| | Security **alert** | 43200 minutes (under 30 days) | | Teams **callRecord** | 4230 minutes (under 3 days) |
+| Teams **channel** | 60 minutes (1 hour) |
| Teams **chatMessage** | 60 minutes (1 hour) |
+| Teams **conversationMember** | 60 minutes (1 hour) |
+| Teams **team** | 60 minutes (1 hour) |
| Group **conversation** | 4230 minutes (under 3 days) | | OneDrive **driveItem** | 42300 minutes (under 30 days) | | SharePoint **list** | 42300 minutes (under 30 days) | | Outlook **message**, **event**, **contact** | 4230 minutes (under 3 days) |
-| **user**, **group**, other directory resources | 4230 minutes (under 3 days) |
+| **user**, **group**, other directory resources | 41760 minutes (under 29 days) |
| **presence** | 60 minutes (1 hour) | | Print **printer** | 4230 minutes (under 3 days) | | Print **printTaskDefinition** | 4230 minutes (under 3 days) |
v1.0 Webhooks https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/webhooks.md
Using the Microsoft Graph API, an app can subscribe to changes on the following
| Outlook personal [contact][] | Changes to all personal contacts in a user's mailbox:<br>`/users/{id}/contacts` | No | | Security [alert][] | Changes to a specific alert:<br>`/security/alerts/{id}` <br>Changes to filtered alerts:<br> `/security/alerts/?$filter`| No | | Teams [callRecord][] | Changes to _all_ call records: `/communications/callRecords` | No |
+| Teams [channel][] | Changes to channels in all teams:<br>`/teams/getAllChannels` <br>Changes to channel in a specific team:<br>`/teams/{id}/channels` | Yes |
| Teams [chatmessage][] | Changes to chat messages in all channels in all teams:<br>`/teams/getAllMessages` <br>Changes to chat messages in a specific channel:<br>`/teams/{id}/channels/{id}/messages`<br>Changes to chat messages in all chats:<br>`/chats/getAllMessages` <br>Changes to chat messages in a specific chat:<br>`/chats/{id}/messages` | Yes |
+| Teams [conversationMember][] | Changes to membership in a specific team:<br>`/teams/{id}/members` | Yes |
| Teams [presence][] | Changes to a single user's presence: `/communications/presences/{id}` <br> Changes to multiple user presences:<br> `/communications/presences?$filter=id in ({id},{id}...)` | Yes |
+| Teams [team][] | Changes to any team in the tenant:<br>`/teams` <br>Changes to specific team:<br>`/teams/{id}` | Yes |
| [todoTask][] | Changes to all task in a specific task list:<br>`/me/todo/lists/{todoTaskListId}/tasks` | No | | [user][] | Changes to all users:<br>`/users` <br>Changes to a specific user:<br>`/users/{id}`| No |
In general, subscription operations require read permission to the resource. For
| Permission type | Supported resource types | | :- | : |
-| Delegated - work or school account | [alert][], [contact][], [conversation][], [driveItem][], [list][], [event][], [group][], [message][], [user][], [presence][], [chatMessage][] (preview), [todoTask][] |
+| Delegated - work or school account | [alert][], [channel][], [contact][], [conversation][], [conversationMember][], [driveItem][], [list][], [event][], [group][], [message][], [user][], [presence][], [chatMessage][] (preview), [team][], [todoTask][] |
| Delegated - personal Microsoft account | [contact][], [driveItem][], [list][], [event][], [message][],[todoTask][] |
-| Application | [alert][], [contact][], [driveItem][], [list][], [event][], [group][], [message][], [user][], [callRecord][], [chatMessage][], [printer][], [printTaskDefinition][]|
+| Application | [alert][], [channel][], [contact][], [driveItem][], [list][], [event][], [group][], [message][], [user][], [callRecord][], [chatMessage][], [conversationMember][], [printer][], [printTaskDefinition][], [team][] |
## See also
In general, subscription operations require read permission to the resource. For
[chatMessage]: ./chatmessage.md [contact]: ./contact.md [conversation]: ./conversation.md
+[conversationMember]: ./conversationmember.md
+[channel]: ./channel.md
[driveItem]: ./driveitem.md [list]: ./list.md [site]: ./site.md
In general, subscription operations require read permission to the resource. For
[presence]: ./presence.md [printer]: ./printer.md [printTaskDefinition]: ./printtaskdefinition.md
+[team]: ./team.md
[todoTask]: ./todoTask.md
v1.0 Conversationmember Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/conversationmember-get.md
One of the following permissions is required to call this API. To learn more, in
> **Note**: Permissions marked with * use [resource-specific consent](https://aka.ms/teams-rsc).
-> [!NOTE]
-> Before calling this API with application permissions, you must request access. For details, see [Protected APIs in Microsoft Teams](/graph/teams-protected-apis).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Conversationmember List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/conversationmember-list.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| Not supported. |
-> [!NOTE]
-> Before calling this API with application permissions, you must request access. For details, see [Protected APIs in Microsoft Teams](/graph/teams-protected-apis).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Group Post Groups https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/group-post-groups.md
Content-length: 244
The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability. All the default properties are returned from an actual call.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-Type: application/json
The following is an example of a successful response. It includes only default properties. You can subsequently get the **owners** or **members** navigation properties of the group to verify the owner or members.
->**Note:** The response object shown here might be shortened for readability. All the default properties are returned from an actual call.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
v1.0 Subscription https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/subscription.md
See [Use the Microsoft Graph API to get change notifications](webhooks.md) for t
| OneDrive **driveItem** | 42300 minutes (under 30 days) | | SharePoint **list** | 42300 minutes (under 30 days) | | Outlook **message**, **event**, **contact** | 4230 minutes (under 3 days) |
-| **user**, **group**, other directory resources | 4230 minutes (under 3 days) |
+| **user**, **group**, other directory resources | 41760 minutes (under 29 days) |
| Print **printer** | 4230 minutes (under 3 days) | | Print **printTaskDefinition** | 4230 minutes (under 3 days) |
v1.0 Toc.Yml https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/toc.yml a/api-reference/v1.0/toc.yml
items:
- name: Delete a history item href: api/projectrome-delete-historyitem.md - name: Devices and apps
- expanded: true
+ expanded: false
items: - name: Cloud printing items: