| Service | Microsoft Docs article | Related commit history on GitHub | Change details |
|---|---|---|---|
| v1.0 | Chatmessage Softdelete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-softdelete.md | + + Title: "chatMessage: softDelete" +description: "Delete a single message or message reply in a channel or a chat." ++ms.localizationpriority: medium +++# chatMessage: softDelete ++Namespace: microsoft.graph +++Delete a single [message](../resources/chatmessage.md) or a [message reply](../resources/chatmessage.md) in a [channel](../resources/channel.md) or a [chat](../resources/chat.md). ++## 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). ++### Permissions for channel ++| Permission type | Permissions (from least to most privileged) | +|:|:--| +|Delegated (work or school account)| ChannelMessage.ReadWrite | +|Delegated (personal Microsoft account)| Not supported. | +|Application| Not supported. | ++### Permissions for chat ++| Permission type | Permissions (from least to most privileged) | +|:|:--| +|Delegated (work or school account)| ChatMessage.ReadWrite | +|Delegated (personal Microsoft account)| Not supported. | +|Application| Not supported. | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{userId}/chats/{chatsId}/messages/{chatMessageId}/softDelete +POST /teams/{teamsId}/channels/{channelId}/messages/{chatMessageId}/softDelete +POST /teams/{teamId}/channels/{channelId}/messages/{messageId}/replies/{replyId}/softDelete +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Example 1: Soft-delete message in a chat ++#### Request +<!-- { + "blockType": "request", + "name": "chatmessagethis-softdelete1" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/8f98f01d-1a73-401a-b9e9-9fd1e6f5e5ar/chats/19:22273db3497f4b32bue61f6e82be21c5@thread.tacv2/messages/1649864053377/softDelete +``` ++#### Response ++<!-- { + "blockType": "response" +} --> ++``` http +HTTP/1.1 204 No Content +``` ++### Example 2: Soft-delete message in a channel ++#### Request ++<!-- { + "blockType": "request", + "name": "chatmessagethis-softdelete2" +} +--> +``` http +POST https://graph.microsoft.com/beta/teams/172b0cce-e65d-44ce-9a49-91d9f2e8593a/channels/19:22273db3497f4b32bue61f6e82be21c5@thread.tacv2/messages/1649864053377/softDelete +``` ++#### Response ++<!-- { + "blockType": "response" +} --> ++``` http +HTTP/1.1 204 No Content +``` ++### Example 3: Soft-delete message of a reply ++#### Request ++<!-- { + "blockType": "request", + "name": "chatmessagethis-softdelete3" +} +--> +``` http +POST https://graph.microsoft.com/beta/teams/172b0cce-e65d-44ce-9a49-91d9f2e8593a/channels/19:22273db3497f4b32bue61f6e82be21c5@thread.tacv2/messages/1649864053377/replies/1649852161658/softDelete +``` ++#### Response ++<!-- { + "blockType": "response" +} --> ++``` http +HTTP/1.1 204 No Content +``` |
| v1.0 | Chatmessage Undosoftdelete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-undosoftdelete.md | + + Title: "chatMessage: undoSoftDelete" +description: "Undelete a single message or a message reply in a channel or a chat." ++ms.localizationpriority: medium +++# chatMessage: undoSoftDelete ++Namespace: microsoft.graph +++Undo soft deletion of a single [message](../resources/chatmessage.md) or a [message reply](../resources/chatmessage.md) in a [channel](../resources/channel.md) or a [chat](../resources/chat.md). ++## 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). ++### Permissions for channel ++| Permission type | Permissions (from least to most privileged) | +|:|:--| +|Delegated (work or school account)| ChannelMessage.ReadWrite | +|Delegated (personal Microsoft account)| Not supported | +|Application| Not supported | ++> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ++### Permissions for chat ++| Permission type | Permissions (from least to most privileged) | +|:|:--| +|Delegated (work or school account)| ChatMessage.ReadWrite | +|Delegated (personal Microsoft account)| Not supported | +|Application| Not supported | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{userId}/chats/{chatsId}/messages/{chatMessageId}/undoSoftDelete +POST /teams/{teamsId}/channels/{channelId}/messages/{chatMessageId}/undoSoftDelete +POST /teams/{teamId}/channels/{channelId}/messages/{messageId}/replies/{replyId}/undoSoftDelete +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Example 1: Undo soft deletion of a message in a chat ++#### Request +<!-- { + "blockType": "request", + "name": "chatmessagethis-undosoftdelete1" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/8f98f01d-1a73-401a-b9e9-9fd1e6f5e5ap/chats/19:22273db3497f4b32bue61f6e82be21c5@thread.tacv2/messages/1649864053377/undoSoftDelete +``` ++#### Response ++<!-- { + "blockType": "response" +} --> ++``` http +HTTP/1.1 204 No Content +``` ++### Example 2: Undo soft deletion of a message in a channel ++#### Request +<!-- { + "blockType": "request", + "name": "chatmessagethis2undosoftdelete2" +} +--> +``` http +POST https://graph.microsoft.com/beta/teams/172b0cce-e65d-44ce-9a49-91d9f2e8593a/channels/19:22273db3497f4b32bue61f6e82be21c5@thread.tacv2/messages/1649864053377/undoSoftDelete +``` ++#### Response ++<!-- { + "blockType": "response" +} --> ++``` http +HTTP/1.1 204 No Content +``` ++### Example 3: Undo soft deletion of a message of a reply in a channel ++#### Request +<!-- { + "blockType": "request", + "name": "chatmessagethis-undosoftdelete3" +} +--> +``` http +POST https://graph.microsoft.com/beta/teams/172b0cce-e65d-44ce-9a49-91d9f2e8593a/channels/19:22273db3497f4b32bue61f6e82be21c5@thread.tacv2/messages/1649864053377/undoSoftDelete +``` ++#### Response ++<!-- { + "blockType": "response" +} --> ++``` http +HTTP/1.1 204 No Content +``` |
| v1.0 | Chatmessage Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-update.md | Title: "Update chatMessage" -description: "Update the policyViolation property of a chatMessage." +description: "Update the properties of a chatMessage object." doc_type: apiPageType ms.localizationpriority: medium ms.prod: "microsoft-teams" [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update a [chatMessage](../resources/chatMessage.md) object. Only the **policyViolation** property of a **chatMessage** can be updated. +Update a [chatMessage](../resources/chatMessage.md) object. +With the exception of the **policyViolation** property, all properties of a **chatMessage** can be updated in delegated permissions scenarios. +Only the **policyViolation** property of a **chatMessage** can be updated in application permissions scenarios. [!INCLUDE [teams-model-A-only-disclaimer](../../includes/teams-model-A-only-disclaimer.md)] One of the following permissions is required to call this API. To learn more, in |Permission type | Permissions (from least to most privileged) | |:--|:|-|Delegated (work or school account) | Not supported. | +|Delegated (work or school account) | Chat.ReadWrite | |Delegated (personal Microsoft account) | Not supported. | |Application | Chat.UpdatePolicyViolation.All for a chat message.</br>ChannelMessage.UpdatePolicyViolation.All for a channel message. | If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-m | Content-Type | application/json. Required. | ## Request body+For applications that use delegated permissions: +In the request body, supply a JSON representation of a [chatMessage](../resources/chatMessage.md) object, +specifying the properties that need to be changed. +For applications that use application permissions: In the request body, supply a JSON representation of a [chatMessage](../resources/chatMessage.md) object, specifying only the **policyViolation** property. -## Response +## Response body +For applications that use delegated permissions: +If successful, this method returns a `204 NoContent` response. +For applications that use application permissions: If successful, this method returns a `200 OK` response. -## Example +## Example for updating policyViolation by using application permissions -### Request +#### Request -The following is an example of the request to update the **policyViolation** property on a Microsoft Teams channel message. +The following is an example of the request to update the **policyViolation** property on a Microsoft Teams channel message by using application permissions. # [HTTP](#tab/http) Content-Type: application/json -### Response +#### Response Here is an example of the response. Here is an example of the response. ```http HTTP/1.1 200 OK ```- <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- { HTTP/1.1 200 OK "section": "documentation", "tocPath": "" }-->+++## Example for updating any property of a message by using delegated permissions ++#### Request ++The following is an example of the request to update the properties on a Microsoft Teams channel message by using delegated permissions. ++<!-- { + "blockType": "request", + "name": "patch_chatMessage_1" +}--> ++```http +PATCH https://graph.microsoft.com/beta/teams/e1234567-e123-4276-55555-6232b0e3a89a/channels/a7654321-e321-0000-0000-123b0e3a00a/messages/19%3Aa21b0b0c05194ebc9e30000000000f61%40thread.skype +Content-Type: application/json ++{ + "messageType": "message", + "subject": null, + "summary": null, + "importance": "normal", + "locale": "en-us", + "from": { + "application": null, + "device": null, + "user": { + "id": "3b102402-813e-4e17-a6b2-f841aef1fdfc", + "displayName": "Sumit Gupta", + "userIdentityType": "aadUser" + }, + "conversation": null + }, + "body": { + "contentType": "text", + "content": "Edit text only" + }, + "attachments": [], + "mentions": [], + "reactions": [] +} +``` ++#### Response ++Here is an example of the response. ++<!-- { + "blockType": "response", +} --> ++```http +HTTP/1.1 204 NoContent +``` ++### Request to update the mentions of a message by using delegated permissions ++The following is an example of the request to update the mentions on a Microsoft Teams channel message by using delegated permissions. ++<!-- { + "blockType": "request", + "name": "patch_chatMessage_2" +}--> ++```http +PATCH https://graph.microsoft.com/beta/teams/e1234567-e123-4276-55555-6232b0e3a89a/channels/a7654321-e321-0000-0000-123b0e3a00a/messages/19%3Aa21b0b0c05194ebc9e30000000000f61%40thread.skype +Content-Type: application/json ++{ + "messageType": "message", + "deletedDateTime": null, + "subject": null, + "summary": null, + "importance": "normal", + "locale": "en-us", + "from": { + "application": null, + "device": null, + "conversation": null, + "user": { + "id": "6b3f3c54-d09c-4fdd-b146-9b514a8a4f40", + "displayName": "Sumit Gupta", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "html", + "content": "<div><div>\n<div>\n<div>\n<div>\n<div><at id=\"0\">Raghav</at><at id=\"1\">TestGlobalBot</at> YEAH" + }, + "attachments": [], + "mentions": [ + { + "id": 0, + "mentionText": "Raghav", + "mentioned": { + "application": null, + "device": null, + "conversation": null, + "user": { + "id": "f1b66449-b46d-49b0-9c3c-53c10234c818e", + "displayName": "Raghav Mankad", + "userIdentityType": "aadUser" + } + } + }, + { + "id": 1, + "mentionText": "TestGlobalBot", + "mentioned": { + "application": { + "id": "03a02232-d8f5-4970-a77e-6e8c76ce7a4e", + "displayName": "TestGlobalBot", + "applicationIdentityType": "bot" + }, + "device": null, + "conversation": null, + "user": null + } + } + ], + "reactions": [] +} +``` ++#### Response ++Here is an example of the response. ++<!-- { + "blockType": "response", +} --> ++```http +HTTP/1.1 204 NoContent +``` ++### Request to update the content with attachments of a message by using delegated permissions ++The following is an example of the request to update the attachments on a Microsoft Teams channel message by using delegated permissions. ++<!-- { + "blockType": "request", + "name": "patch_chatMessage_3" +}--> ++```http +PATCH https://graph.microsoft.com/beta/teams/e1234567-e123-4276-55555-6232b0e3a89a/channels/a7654321-e321-0000-0000-123b0e3a00a/messages/19%3Aa21b0b0c05194ebc9e30000000000f61%40thread.skype +Content-Type: application/json ++{ + "messageType": "message", + "subject": null, + "summary": null, + "importance": "normal", + "locale": "en-us", + "from": { + "application": null, + "device": null, + "user": { + "id": "3b102402-813e-4e17-a6b2-f841aef1fdfc", + "displayName": "Sumit Gupta", + "userIdentityType": "aadUser" + }, + "conversation": null + }, + "body": { + "contentType": "html", + "content": "<p><em>text</em></p><attachment id=\"e8f78756199240b88448ae0fc6db112d\"></attachment><attachment id=\"638464e32834471ea202007da60a5ae6\"></attachment>" + }, + "attachments": [ + { + "id": "e8f78756199240b88448ae0fc6db112d", + "contentType": "application/vnd.microsoft.card.hero", + "contentUrl": null, + "content": "{\r\n \"title\": \"*title*\",\r\n \"subtitle\": \"*subtitle*\",\r\n \"text\": \"Have you found yourself scratching your head trying to figure these questions out? Frustrated trying to access some of the goodies unique to the Microsoft Teams platform? Well, fear not, Bot Builder SDK Extension for Teams in .NET and Node flavors is here! Just head on over to Nuget or NPM to download our tasty helpers, sure to speed up your prep time so you can spend more time maximizing the flavor of the bots you're cooking up.Here’s a small sample of some recipes to whet your appetite.\",\r\n \"images\": [\r\n {\r\n \"url\": \"https://us-api.asm.skype.com/v1/objects/0-eus-d8-ced0c9567ee7b0b233b987bd32f9eacd/views/img_preview\"\r\n }\r\n ],\r\n \"buttons\": [\r\n {\r\n \"type\": \"openUrl\",\r\n \"image\": \"https://urlp.asm.skype.com/v1/url/content?url=https%3a%2f%2fcdn2.iconfinder.com%2fdata%2ficons%2fsocial-icons-33%2f128%2fTrello-128.png\",\r\n \"title\": \"😃😃 click me 😃😃\",\r\n \"value\": \"http://microsoft.com\"\r\n },\r\n {\r\n \"type\": \"imback\",\r\n \"title\": \"&i am back& <>= \\\"\",\r\n \"value\": \"&i am back& <>= \\\"\"\r\n },\r\n {\r\n \"type\": \"openUrl\",\r\n \"title\": \"Open URL\",\r\n \"value\": \"http://google.com\"\r\n }\r\n ]\r\n}", + "name": null, + "thumbnailUrl": null + }, + { + "id": "638464e32834471ea202007da60a5ae6", + "contentType": "application/vnd.microsoft.card.hero", + "contentUrl": null, + "content": "{\r\n \"title\": \"*title*\",\r\n \"subtitle\": \"*subtitle*\",\r\n \"text\": \"Have you found yourself scratching your head trying to figure these questions out? Frustrated trying to access some of the goodies unique to the Microsoft Teams platform? Well, fear not, Bot Builder SDK Extension for Teams in .NET and Node flavors is here! Just head on over to Nuget or NPM to download our tasty helpers, sure to speed up your prep time so you can spend more time maximizing the flavor of the bots you're cooking up.Here’s a small sample of some recipes to whet your appetite.\",\r\n \"images\": [\r\n {\r\n \"url\": \"https://us-api.asm.skype.com/v1/objects/0-eus-d8-ced0c9567ee7b0b233b987bd32f9eacd/views/img_preview\"\r\n }\r\n ],\r\n \"buttons\": [\r\n {\r\n \"type\": \"messageBack\",\r\n \"title\": \"&message back& <>= \\\"\",\r\n \"text\": \"text = &message back& <>= \\\"\",\r\n \"displayText\": \"displayText = &message back& <>= \\\"\",\r\n \"value\": {\r\n \"text\": \"some text 2\"\r\n }\r\n }\r\n ]\r\n}", + "name": null, + "thumbnailUrl": null + } + ], + "mentions": [], + "reactions": [] +} +``` ++#### Response ++Here is an example of the response. ++<!-- { + "blockType": "response", +} --> ++```http +HTTP/1.1 204 NoContent +``` ++### Request to update the reactions in a message by using delegated permissions ++The following is an example of the request to update the reactions property on a Microsoft Teams channel message by using delegated permissions. +++<!-- { + "blockType": "request", + "name": "patch_chatMessage_4" +}--> ++```http +PATCH https://graph.microsoft.com/beta/teams/e1234567-e123-4276-55555-6232b0e3a89a/channels/a7654321-e321-0000-0000-123b0e3a00a/messages/19%3Aa21b0b0c05194ebc9e30000000000f61%40thread.skype +Content-Type: application/json ++{ + "messageType": "message", + "subject": null, + "summary": null, + "importance": "normal", + "locale": "en-us", + "from": { + "application": null, + "device": null, + "user": { + "id": "3b102402-813e-4e17-a6b2-f841aef1fdfc", + "displayName": "Sumit Gupta", + "userIdentityType": "aadUser" + }, + "conversation": null + }, + "body": { + "contentType": "html", + "content": "<p><em>text</em></p><attachment id=\"e8f78756199240b88448ae0fc6db112d\"></attachment><attachment id=\"638464e32834471ea202007da60a5ae6\"></attachment>" + }, + "attachments": [ + { + "id": "e8f78756199240b88448ae0fc6db112d", + "contentType": "application/vnd.microsoft.card.hero", + "contentUrl": null, + "content": "{\r\n \"title\": \"*title*\",\r\n \"subtitle\": \"*subtitle*\",\r\n \"text\": \"Have you found yourself scratching your head trying to figure these questions out? Frustrated trying to access some of the goodies unique to the Microsoft Teams platform? Well, fear not, Bot Builder SDK Extension for Teams in .NET and Node flavors is here! Just head on over to Nuget or NPM to download our tasty helpers, sure to speed up your prep time so you can spend more time maximizing the flavor of the bots you're cooking up.Here’s a small sample of some recipes to whet your appetite.\",\r\n \"images\": [\r\n {\r\n \"url\": \"https://us-api.asm.skype.com/v1/objects/0-eus-d8-ced0c9567ee7b0b233b987bd32f9eacd/views/img_preview\"\r\n }\r\n ],\r\n \"buttons\": [\r\n {\r\n \"type\": \"openUrl\",\r\n \"image\": \"https://urlp.asm.skype.com/v1/url/content?url=https%3a%2f%2fcdn2.iconfinder.com%2fdata%2ficons%2fsocial-icons-33%2f128%2fTrello-128.png\",\r\n \"title\": \"😃😃 click me 😃😃\",\r\n \"value\": \"http://microsoft.com\"\r\n },\r\n {\r\n \"type\": \"imback\",\r\n \"title\": \"&i am back& <>= \\\"\",\r\n \"value\": \"&i am back& <>= \\\"\"\r\n },\r\n {\r\n \"type\": \"openUrl\",\r\n \"title\": \"Open URL\",\r\n \"value\": \"http://google.com\"\r\n }\r\n ]\r\n}", + "name": null, + "thumbnailUrl": null + }, + { + "id": "638464e32834471ea202007da60a5ae6", + "contentType": "application/vnd.microsoft.card.hero", + "contentUrl": null, + "content": "{\r\n \"title\": \"*title*\",\r\n \"subtitle\": \"*subtitle*\",\r\n \"text\": \"Have you found yourself scratching your head trying to figure these questions out? Frustrated trying to access some of the goodies unique to the Microsoft Teams platform? Well, fear not, Bot Builder SDK Extension for Teams in .NET and Node flavors is here! Just head on over to Nuget or NPM to download our tasty helpers, sure to speed up your prep time so you can spend more time maximizing the flavor of the bots you're cooking up.Here’s a small sample of some recipes to whet your appetite.\",\r\n \"images\": [\r\n {\r\n \"url\": \"https://us-api.asm.skype.com/v1/objects/0-eus-d8-ced0c9567ee7b0b233b987bd32f9eacd/views/img_preview\"\r\n }\r\n ],\r\n \"buttons\": [\r\n {\r\n \"type\": \"messageBack\",\r\n \"title\": \"&message back& <>= \\\"\",\r\n \"text\": \"text = &message back& <>= \\\"\",\r\n \"displayText\": \"displayText = &message back& <>= \\\"\",\r\n \"value\": {\r\n \"text\": \"some text 2\"\r\n }\r\n }\r\n ]\r\n}", + "name": null, + "thumbnailUrl": null + } + ], + "mentions": [], + "reactions": [ + { + "reactionType": "angry", + "createdDateTime": "2018-10-21T08:10:30.489Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "f1b66449-b46d-49b0-9c3c-53c10a5c818e", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "laugh", + "createdDateTime": "2018-10-21T08:10:32.489Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "03a02232-d8f5-4970-a77e-6e8c76ce7a4e", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "like", + "createdDateTime": "2018-10-21T02:17:14.67Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "f1b66449-b46d-49b0-9c3c-53c10a5c818e", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "like", + "createdDateTime": "2018-10-21T02:34:40.3Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "4c9041b7-449a-40f7-8855-56da239b9fd1", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "like", + "createdDateTime": "2018-10-21T08:10:25.489Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "03a02232-d8f5-4970-a77e-6e8c76ce7a4e", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "heart", + "createdDateTime": "2018-10-21T08:10:31.489Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "03a02232-d8f5-4970-a77e-6e8c76ce7a4e", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "sad", + "createdDateTime": "2018-10-21T08:10:33.489Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "03a02232-d8f5-4970-a77e-6e8c76ce7a4e", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "surprised", + "createdDateTime": "2018-10-21T08:10:34.489Z", + "user": { + "application": null, + "device": null, + "user": { + "id": "03a02232-d8f5-4970-a77e-6e8c76ce7a4e", + "displayName": null, + "userIdentityType": "aadUser" + } + } + } + ] +} +``` ++#### Response ++Here is an example of the response. ++<!-- { + "blockType": "response", +} --> ++```http +HTTP/1.1 204 NoContent +``` |
| v1.0 | Externalidentitiespolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalidentitiespolicy-get.md | + + Title: "Get externalIdentitiesPolicy" +description: "Read the properties and relationships of the tenant-wide externalIdentitiesPolicy object that controls whether external users can leave an Azure AD tenant via self-service controls." ++ms.localizationpriority: medium +++# Get externalIdentitiesPolicy +Namespace: microsoft.graph +++Read the properties and relationships of the tenant-wide [externalIdentitiesPolicy](../resources/externalidentitiespolicy.md) object that controls whether external users can leave an Azure AD tenant via self-service controls. ++## 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)|Policy.Read.All, Policy.ReadWrite.ExternalIdentities| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.Read.All, Policy.ReadWrite.ExternalIdentities| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /policies/externalIdentitiesPolicy +``` ++## Optional query parameters +This method does not support the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and an [externalIdentitiesPolicy](../resources/externalidentitiespolicy.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "get_externalidentitiespolicy" +} +--> +``` http +GET https://graph.microsoft.com/beta/policies/externalIdentitiesPolicy +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.externalIdentitiesPolicy" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/externalIdentitiesPolicy/$entity", + "id": "externalIdentityPolicy", + "deletedDateTime": null, + "allowExternalIdentitiesToLeave": true, + "allowDeletedIdentitiesDataRemoval": false, + "displayName": "External Identities Policy" + } +} +``` + |
| v1.0 | Externalidentitiespolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalidentitiespolicy-update.md | + + Title: "Update externalIdentitiesPolicy" +description: "Update the settings of the tenant-wide externalIdentitiesPolicy object that controls whether external users can leave an Azure AD tenant via self-service controls." ++ms.localizationpriority: medium +++# Update externalIdentitiesPolicy +Namespace: microsoft.graph +++Update the settings of the tenant-wide [externalIdentitiesPolicy](../resources/externalidentitiespolicy.md) object that controls whether external users can leave an Azure AD tenant via self-service controls. ++## 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)|Policy.ReadWrite.ExternalIdentities| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.ReadWrite.ExternalIdentities| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /policies/externalIdentitiesPolicy +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|allowDeletedIdentitiesDataRemoval|Boolean|Notifies Azure AD whether to clean up the user information about the external identity, from the guest tenant, when the user is deleted in their home tenant. Required.| +|allowExternalIdentitiesToLeave|Boolean|Notifies Azure AD whether to clean up the user information about the external identity, from the guest tenant, when the user is deleted in their home tenant. Required.| ++## Response ++If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "update_externalidentitiespolicy" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/policies/externalIdentitiesPolicy ++{ + "allowExternalIdentitiesToLeave":false +} +``` ++### Response +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
| v1.0 | Todotask Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/todotask-get.md | Content-Type: application/json "dueDateTime": { "dateTime": "2020-08-25T04:00:00.0000000", "timeZone": "UTC"+ }, + "startDateTime": { + "dateTime": "2020-06-23T04:00:00.0000000", + "timeZone": "UTC" } } ``` |
| v1.0 | Todotask Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/todotask-update.md | The following table shows the properties that are required when you create the [ |isReminderOn|Boolean|Set to true if an alert is set to remind the user of the task.| |recurrence|[patternedRecurrence](../resources/patternedrecurrence.md)|The recurrence pattern for the task.| |reminderDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|The date and time for a reminder alert of the task to occur.|+|startDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|The date in the specified time zone at which the task is scheduled to start.| |status|taskStatus|Indicates state or progress of the task. Possible values are: `notStarted`, `inProgress`, `completed`, `waitingOnOthers`, `deferred`.| |title|String|A brief description of the task.| |createdDateTime|DateTimeOffset|The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header.| |
| v1.0 | Todotasklist Delta | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/todotasklist-delta.md | _id_ property is always returned. | Content-Type | string | application/json. Required. | | Prefer | string | odata.maxpagesize={x}. Optional. | +> **Note:** In the request header, the value `odata.maxpagesize` should be greater than or equal to 10 to get the correct `nextLink` value. + ## Response If successful, this method returns a `200 OK` response code and [todoTaskList](../resources/todotasklist.md) collection object in the response body. The main differences between tracking **todoTaskList** and tracking **todoTask** <!-- { "blockType": "ignored" } --> ``` http GET https://graph.microsoft.com/beta/me/todo/lists/delta-Prefer: odata.maxpagesize=2 +Prefer: odata.maxpagesize=12 ``` ### Response getting all the changes for that round. The response below shows a _skipToken_ in an _@odata.nextLink_ response header. -Note: The response object shown here might be shortened for readability. +>**Note:** The response object shown here might be shortened for readability. ```http HTTP/1.1 200 OK |
| v1.0 | Todotasklist Post Tasks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/todotasklist-post-tasks.md | The following table shows the properties that are required when you create the [ |isReminderOn|Boolean|Set to true if an alert is set to remind the user of the task.| |recurrence|[patternedRecurrence](../resources/patternedrecurrence.md)|The recurrence pattern for the task.| |reminderDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|The date and time for a reminder alert of the task to occur.|+|startDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|The date in the specified time zone at which the task is scheduled to start.| |status|taskStatus|Indicates the state or progress of the task. Possible values are: `notStarted`, `inProgress`, `completed`, `waitingOnOthers`, `deferred`.| |title|String|A brief description of the task.| |createdDateTime|DateTimeOffset|The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.| |
| v1.0 | Chatmessage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/chatmessage.md | Represents an individual chat message within a [channel](channel.md) or [chat](c |[Get message in channel](../api/chatmessage-get.md) | [chatMessage](chatmessage.md) | Get a single root message in a channel.| |[Send message in channel](../api/chatmessage-post.md) | [chatMessage](chatmessage.md)| Create a new root message in a channel.| |[Update message in channel](../api/chatmessage-update.md)|[chatMessage](chatmessage.md)| Update the **policyViolation** property of a chat message.|+|[Delete message in channel](../api/chatmessage-softdelete.md)|[chatMessage](chatmessage.md)| Delete the message in a channel.| +|[Undo the deletion of a message in channel](../api/chatmessage-undoSoftdelete.md)|[chatMessage](chatmessage.md)| Undelete the message in a channel.| |**Channel message replies**| | | |[List replies to message](../api/chatmessage-list-replies.md) | [chatMessage](chatmessage.md) collection| List of all replies to a chat message in channel.| |[Get reply message in channel](../api/chatmessage-get.md) | [chatMessage](chatmessage.md) | Get a single reply message in a channel.| |[Reply to a message in channel](../api/chatmessage-post-replies.md) | [chatMessage](chatmessage.md)| Reply to an existing chat message in a channel.| |[Update reply message](../api/chatmessage-update.md)|[chatMessage](chatmessage.md)| Update the **policyViolation** property of a chat message.|+|[Delete reply message in channel](../api/chatmessage-softdelete.md)|[chatMessage](chatmessage.md)| Delete the single reply message in a channel.| +|[Undo deletion of a reply message in channel](../api/chatmessage-undoSoftdelete.md)|[chatMessage](chatmessage.md)| Undelete the single reply message in a channel. |**Chat messages**| | | |[List messages in chat](../api/chat-list-messages.md) | [chatMessage](../resources/chatmessage.md) | List chat messages in a chat. | |[Get message in chat](../api/chatmessage-get.md) | [chatMessage](../resources/chatmessage.md) | Get a single chat message in a chat. | Represents an individual chat message within a [channel](channel.md) or [chat](c |[Create subscription for new chat messages](../api/subscription-post-subscriptions.md) | [subscription](subscription.md) | Listen for new, edited, and deleted chat messages, and reactions to them. | |[Send message in chat](../api/chat-post-messages.md) | [chatMessage](chatmessage.md)| Send a chat message in an existing 1:1 or group chat conversation.| |[Update message in chat](../api/chatmessage-update.md)|[chatMessage](chatmessage.md)| Update the **policyViolation** property of a chat message.|+|[Delete message in chat](../api/chatmessage-softdelete.md)|[chatMessage](chatmessage.md)| Delete the message of a chat.| +|[Undo the deletion of a message in chat](../api/chatmessage-undoSoftdelete.md)|[chatMessage](chatmessage.md)| Undelete the message in a chat.| |**Hosted content**| | | |[List all hosted content](../api/chatmessage-list-hostedcontents.md) | [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) collection| Get all hosted contents associated with a message.| |[Get hosted content](../api/chatmessagehostedcontent-get.md) | [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) | Get hosted content (and its bytes) for a message.| |
| v1.0 | Externalidentitiespolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/externalidentitiespolicy.md | + + Title: "externalIdentitiesPolicy resource type" +description: "Represents the tenant-wide policy that controls whether external users can leave an Azure AD tenant via self-service controls." ++ms.localizationpriority: medium +++# externalIdentitiesPolicy resource type ++Namespace: microsoft.graph +++Represents the tenant-wide policy that controls whether external users can leave the guest Azure AD tenant via self-service controls. When permitted by the administrator, external users can leave the guest Azure AD tenant through the **organizations** menu of the [My Account](https://myaccount.microsoft.com/) portal. ++Inherits from [policyBase](../resources/policybase.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get externalIdentitiesPolicy](../api/externalidentitiespolicy-get.md)|[externalIdentitiesPolicy](../resources/externalidentitiespolicy.md)|Read the properties and relationships of an [externalIdentitiesPolicy](../resources/externalidentitiespolicy.md) object.| +|[Update externalIdentitiesPolicy](../api/externalidentitiespolicy-update.md)|[externalIdentitiesPolicy](../resources/externalidentitiespolicy.md)|Update the properties of an [externalIdentitiesPolicy](../resources/externalidentitiespolicy.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|allowDeletedIdentitiesDataRemoval|Boolean|Notifies Azure AD whether to clean up the user information about the external identity, from the guest tenant, when the user is deleted in their home tenant. | +|allowExternalIdentitiesToLeave|Boolean|Defines whether external users can leave the guest tenant. If set to `false`, self-service controls are not enabled, and the admin of the guest tenant must manually remove the external user from the guest tenant.| +|displayName|String|The policy name. Inherited from [policyBase](../resources/policybase.md).| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.externalIdentitiesPolicy", + "baseType": "microsoft.graph.policyBase", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.externalIdentitiesPolicy", + "id": "String (identifier)", + "deletedDateTime": "String (timestamp)", + "description": "String", + "displayName": "String", + "allowExternalIdentitiesToLeave": "Boolean", + "allowDeletedIdentitiesDataRemoval": "Boolean" +} +``` + |
| v1.0 | Policyroot | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/policyroot.md | None | conditionalAccessPolicies | [conditionalAccessPolicy](conditionalaccesspolicy.md) | The custom rules that define an access scenario. | | crossTenantAccessPolicy | [crossTenantAccessPolicy](crosstenantaccesspolicy.md) | The custom rules that define an access scenario when interacting with external Azure AD tenants. | | defaultAppManagementPolicy | [tenantAppManagementPolicy](tenantappmanagementpolicy.md) | The tenant-wide policy that enforces app management restrictions for all applications and service principals. |+| externalIdentitiesPolicy | [externalIdentitiesPolicy](externalidentitiespolicy.md) | Represents the tenant-wide policy that controls whether external users can leave an Azure AD tenant via self-service controls. | | featureRolloutPolicies | [featureRolloutPolicy](featurerolloutpolicy.md) collection | The feature rollout policy associated with a directory object. | | homeRealmDiscoveryPolicies | [homeRealmDiscoveryPolicy](homerealmdiscoverypolicy.md) collection | The policy to control Azure AD authentication behavior for federated users. | | identitySecurityDefaultsEnforcementPolicy | [identitySecurityDefaultsEnforcementPolicy](identitysecuritydefaultsenforcementpolicy.md) | The policy that represents the security defaults that protect against common attacks. | |
| v1.0 | Todotask | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/todotask.md | This resource supports the following: |lastModifiedDateTime|DateTimeOffset|The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.| |recurrence|[patternedRecurrence](../resources/patternedrecurrence.md)|The recurrence pattern for the task.| |reminderDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|The date and time for a reminder alert of the task to occur.|+|startDateTime|[dateTimeTimeZone](../resources/datetimetimezone.md)|The date in the specified time zone at which the task is scheduled to start.| |status|taskStatus|Indicates the state or progress of the task. Possible values are: `notStarted`, `inProgress`, `completed`, `waitingOnOthers`, `deferred`.| |title|String|A brief description of the task.| The following is a JSON representation of the resource. "reminderDateTime": { "@odata.type": "microsoft.graph.dateTimeTimeZone" },+ "startDateTime": { + "@odata.type": "microsoft.graph.dateTimeTimeZone" + }, "status": "String", "title": "String", "createdDateTime": "String (timestamp)", |
| v1.0 | Tokenissuancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/tokenissuancepolicy.md | The properties form the JSON object that represents a token issuance policy. Thi }--> ``` json "definition": [- "{ \"TokenIssuancePolicy\":{\"TokenResponseSigningPolicy\":\"TokenOnly\",\"SamlTokenVersion\":\"1.1\",\"SigningAlgorithm\":\"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256\",\"Version\":1}}" + "{ \"TokenIssuancePolicy\":{\"TokenResponseSigningPolicy\":\"TokenOnly\",\"SamlTokenVersion\":\"1.1\",\"SigningAlgorithm\":\"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256\",\"Version\":\"1\",\"EmitSAMLNameFormat\": \"true\"}}" ] ``` The properties form the JSON object that represents a token issuance policy. Thi |SamlTokenVersion|String|Version of the SAML token. Supported values are: `1.1`, `2.0`. | |SigningAlgorithm|String|Signing algorithm use by Azure AD to sign the SAML token. Supported values are: `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`, `http://www.w3.org/2000/09/xmldsig#rsa-sha1`.| |Version|Integer|Set value of 1. Required.|-+| EmitSamlNameFormat | Boolean | If selected, Azure Active Directory will add an additional attribute called "NameFormat" that describes the format of the name to restricted, core, and optional claims for this application. [Learn more](/azure/active-directory/develop/reference-claims-mapping-policy-type#claim-sets) | ## Relationships |
| v1.0 | Tokenissuancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/tokenissuancepolicy.md | The properties form the JSON object that represents a token issuance policy. Thi }--> ``` json "definition": [- "{ \"TokenIssuancePolicy\":{\"TokenResponseSigningPolicy\":\"TokenOnly\",\"SamlTokenVersion\":\"1.1\",\"SigningAlgorithm\":\"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256\",\"Version\":1}}" + "{ \"TokenIssuancePolicy\":{\"TokenResponseSigningPolicy\":\"TokenOnly\",\"SamlTokenVersion\":\"1.1\",\"SigningAlgorithm\":\"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256\",\"Version\":\"1\",\"EmitSAMLNameFormat\": \"true\"}}" ] ``` The properties form the JSON object that represents a token issuance policy. Thi |SamlTokenVersion|String|Version of the SAML token. Supported values are: `1.1`, `2.0`. | |SigningAlgorithm|String|Signing algorithm use by Azure AD to sign the SAML token. Supported values are: `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`, `http://www.w3.org/2000/09/xmldsig#rsa-sha1`.| |Version|Integer|Set value of 1. Required.|+| EmitSamlNameFormat | Boolean | If selected, Azure Active Directory will add an additional attribute called "NameFormat" that describes the format of the name to restricted, core, and optional claims for this application. [Learn more](/azure/active-directory/develop/reference-claims-mapping-policy-type#claim-sets) | ## Relationships |