Updates from: 04/05/2024 01:19:50
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Appcatalogs List Teamsapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appcatalogs-list-teamsapps.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog.
-It includes apps from the Microsoft Teams store, and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
+
+This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
> [!NOTE] > In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource.
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "appcatalogs_list_teamsapps" } --> [!INCLUDE [permissions-table](../includes/permissions/appcatalogs-list-teamsapps-permissions.md)]
-> **Note**:
-The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward.
+> [!NOTE]
+> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward.
## HTTP request
Content-Type: application/json
### Example 4: List applications with a given ID, and return the submission review state
-The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the the admin rejected the app.
+The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the admin rejected app.
#### Request
v1.0 Application Post Calls https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-calls.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "application_post_calls" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)]
-> **Notes:**
-> - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table.
-> - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser.
+> [!NOTE]
> - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table.
+
+Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Application Post Onlinemeetings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-onlinemeetings.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "application_post_onlinemeetings" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-onlinemeetings-permissions.md)]
-To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path).
+> [!NOTE]
+> To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path).
## HTTP request
POST /users/{userId}/onlineMeetings
``` > [!NOTE]
->- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
+>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more information, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
## Request headers
v1.0 Attacksimulationroot Delete Trainingcampaigns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-delete-trainingcampaigns.md
+
+ Title: "Delete trainingCampaign"
+description: "Delete a trainingCampaign object."
+
+ms.localizationpriority: medium
++
+# Delete trainingCampaign
+
+Namespace: microsoft.graph
++
+Delete a [trainingCampaign](../resources/trainingcampaign.md) object.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "attacksimulationroot-delete-trainingcampaigns-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/$ref
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_trainingcampaign"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/{trainingCampaignId}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
++++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Attacksimulationroot List Trainingcampaigns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-list-trainingcampaigns.md
+
+ Title: "List trainingCampaign objects"
+description: "Get a list of trainingCampaign objects and their properties."
+
+ms.localizationpriority: medium
++
+# List trainingCampaign objects
+
+Namespace: microsoft.graph
++
+Get a list of [trainingCampaign](../resources/trainingcampaign.md) objects and their properties.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "attacksimulationroot-list-trainingcampaigns-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns
+```
+
+## Optional query parameters
+
+This method supports the `$count`, `$filter`, `$orderby`, `$skipToken`, `$top`, and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. You can use the `$filter` and `$orderby` query parameters on the **campaignSchedule/completionDateTime**, **displayName**, **campaignSchedule/launchDateTime**, and **campaignSchedule/status** properties.
+
+If the result set spans multiple pages, the response body contains an `@odata.nextLink` that you can use to page through the result set.
+
+The following list shows some examples of requests that use the supported OData query parameters:
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns?$count=true
+GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}'
+GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}'&$top=5
+GET /security/attackSimulation/trainingCampaigns?$orderby={property}
+GET /security/attackSimulation/trainingCampaigns?$skipToken={skipToken}
+GET /security/attackSimulation/trainingCampaigns?$top=1
+GET /security/attackSimulation/trainingCampaigns?$select={property}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [trainingCampaign](../resources/trainingcampaign.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "list_trainingcampaign"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
++++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.trainingCampaign)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.etag": "W/\"dub9zfj4Rk68MmY/KYwXKgADRgyGsw==\"",
+ "id": "81c59451-2929-5b39-86f0-5a2b15f1314f",
+ "displayName": "Sample Training Campaign",
+ "description": "Sample Training Campaign Description",
+ "createdDateTime": "2024-02-18T08:36:07.6534871Z",
+ "lastModifiedDateTime": "2024-02-19T08:00:01.9417887Z",
+ "endUserNotificationSetting": null,
+ "includedAccountTarget": null,
+ "excludedAccountTarget": null,
+ "trainingSetting": null,
+ "campaignSchedule": {
+ "launchDateTime": "2024-02-18T08:37:44Z",
+ "completionDateTime": "2024-02-19T07:59:44Z",
+ "status": "completed"
+ },
+ "createdBy": {
+ "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
+ "displayName": "Reed Flores",
+ "email": "reed@contoso.com"
+ },
+ "lastModifiedBy": {
+ "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
+ "displayName": "Reed Flores",
+ "email": "reed@contoso.com"
+ },
+ }
+ ]
+}
+```
+
v1.0 Attacksimulationroot Post Trainingcampaigns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-post-trainingcampaigns.md
+
+ Title: "Create trainingCampaign"
+description: "Create a new trainingCampaign object."
+
+ms.localizationpriority: medium
++
+# Create trainingCampaign
+
+Namespace: microsoft.graph
++
+Create a new [trainingCampaign](../resources/trainingcampaign.md) object.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "attacksimulationroot-post-trainingcampaigns-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/attackSimulation/trainingCampaigns
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [trainingCampaign](../resources/trainingcampaign.md) object.
+
+You can specify the following properties when creating a **trainingCampaign**.
+
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who created the training campaign. Optional.|
+|createdDateTime|DateTimeOffset|The date and time when the training campaign was created. Optional.|
+|description|String|The description of the training campaign. Optional.|
+|displayName|String|The display name of the training campaign. Required.|
+|endUserNotificationSetting|[endUserNotificationSetting](../resources/endusernotificationsetting.md)|Details about the end user notification setting. Required.|
+|excludedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are excluded from the training campaign. Optional.|
+|includedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are targeted in the training campaign. Required.|
+|lastModifiedDateTime|DateTimeOffset|The identity of the user who most recently modified the training campaign. Optional.|
+|trainingSetting|[trainingSetting](../resources/trainingsetting.md)|Details about the training settings for a training campaign. Required.|
+|campaignSchedule|[campaignSchedule](../resources/campaignschedule.md)|Details about the schedule and current status for a training campaign. Required.|
+
+## Response
+
+If successful, this method returns a `202 Accepted` response code and a tracking header named `location` in the response.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_trainingcampaign_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns
+Content-Type: application/json
+
+{
+ "displayName": "Graph Training Campaign",
+ "description": "Graph Training Campaign Description",
+ "createdBy": {
+ "email": "john@contoso.com"
+ },
+ "lastModifiedBy": {
+ "email": "john@contoso.com"
+ },
+ "includedAccountTarget": {
+ "type": "addressBook",
+ "accountTargetEmails": [
+ "john@contoso.com"
+ ]
+ },
+ "endUserNotificationSetting": {
+ "notificationPreference": "microsoft",
+ "settingType": "trainingSelected",
+ "trainingReminder": {
+ "deliveryFrequency": "weekly",
+ "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('fe521249-9901-4584-a987-026a9980c58e')",
+ "defaultLanguage": "en"
+ },
+ "trainingAssignment": {
+ "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('36fb4dc1-7c37-4b96-9096-12e6d6014fae')",
+ "defaultLanguage": "en"
+ }
+ },
+ "trainingSetting": {
+ "settingType": "microsoftCustom",
+ "trainingAssignmentMappings": [
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('40454905-dc26-4f36-b854-3042a5362cb3')"
+ },
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('ea70ae06-3859-4818-be9d-270ee81d80a4')"
+ },
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('d733d88c-1b5a-48e3-a588-9910e41ac21d')"
+ }
+ ]
+ },
+ "campaignSchedule": {
+ "launchDateTime": "2024-02-15T07:59:44Z",
+ "completionDateTime": "2024-02-18T07:59:44Z",
+ "status": "Scheduled"
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+```http
+HTTP/1.1 202 Accepted
+```
v1.0 Channel Archive https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-archive.md
+
+ Title: "channel: archive"
+description: "Archive a channel in a team. "
+
+ms.localizationpriority: medium
+++
+# channel: archive
+
+Namespace: microsoft.graph
++
+Archive a [channel](../resources/channel.md) in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel.
+
+You can delete an archived channel, or add and remove members from it. If you archive a team, its channels are archived for you.
+
+Archiving is asynchronous; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns.
+
+A channel without an owner, or that belongs to a [group](../resources/group.md) that has no owner, can't be archived.
+
+To restore a channel from its archived state, use the [unarchive](channel-unarchive.md) method. A channel canΓÇÖt be archived or unarchived if its team is archived.
+
+## Permissions
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "channel_archive" } -->
+
+> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of.
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+POST /teams/{team-id}/channels/{channel-id}/archive
+POST /groups/{team-id}/team/channels/{channel-id}/archive
+```
+
+## Request headers
+
+| Header | Value |
+|:|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+In the request, you can optionally include the `shouldSetSpoSiteReadOnlyForMembers` parameter in a JSON body, as follows.
+```JSON
+{
+ "shouldSetSpoSiteReadOnlyForMembers": true
+}
+```
+This optional parameter defines whether to set permissions for channel members to read-only on the SharePoint Online site associated with the team. Setting it to false or omitting the body altogether results in this step being skipped.
+
+## Response
+
+If archiving is started successfully, this method returns a `202 Accepted` response code. The response contains a `Location` header, which contains the location of the [teamsAsyncOperation](../resources/teamsasyncoperation.md) that was created to handle archiving of the channel in a team. Check the status of the archiving operation by making a GET request to this location.
+
+## Examples
+
+### Example 1: Archive a channel
+
+The following example shows a request to archive a channel.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "archive_channel"
+}-->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "name": "archive_channel"
+}-->
+```http
+HTTP/1.1 202 Accepted
+Location: /teams/{team-id}/operations/{operation-id}
+Content-Type: text/plain
+Content-Length: 0
+```
+
+### Example 2: Archive a channel when the team is archived
+
+The following example shows a request when the **team is archived**.
+
+#### Request
+
+<!-- { "blockType": "ignored" } -->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive
+```
+
+#### Response
+The following example shows the `400` error response.
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+http/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 193
+
+{
+ "error": {
+ "code": "BadRequest",
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "innerError": {
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "code": "Unknown",
+ "innerError": {},
+ "date": "2023-12-11T04:26:35",
+ "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
+ "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
+ }
+ }
+}
+
+```
+
+<!-- uuid: e848414b-4669-4484-ac36-1504c58a3fb8
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Archive Channel",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": []
+}
+-->
v1.0 Channel Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-get.md
Choose the permission or permissions marked as least privileged for this API. Us
This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. + <!-- { "blockType": "permissions", "name": "channel_get" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-get-permissions.md)]
HTTP/1.1 200 OK
"email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "standard",
+ "isArchived": false,
"moderationSettings": { "userNewMessageRestriction": "everyone", "replyRestriction": "everyone",
Content-type: application/json
"email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "standard",
+ "isArchived": false,
"moderationSettings": { "userNewMessageRestriction": "moderators", "replyRestriction": "everyone",
Content-type: application/json
"email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "private",
+ "isArchived": false,
"moderationSettings": null } ```
v1.0 Channel List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-list.md
Content-type: application/json
"description": "AutoTestTeam_20210311_150740.2550_fim3udfdjen9", "membershipType": "standard", "email": "someperson@microsoft.com",
- "moderationSettings": null
+ "moderationSettings": null,
+ "isArchived": false
} ] }
Content-type: application/json
"createdDateTime": "2020-05-27T19:22:25.692Z", "displayName": "General", "description": "test private team",
- "membershipType": "private"
+ "membershipType": "private",
+ "isArchived": false,
} ] }
Content-length: 262
"webUrl": "https://teams.microsoft.com/l/channel/19%3ALpxShHZZh9utjNcEmUS5aOEP9ASw85OUn05NcWYAhX81%40thread.tacv2/shared%20channel-01?groupId=6a720ba5-7373-463b-bc9f-4cd04b5c6742&tenantId=df81db53-c7e2-418a-8803-0e68d4b88607", "membershipType": "shared", "email": "someperson@microsoft.com",
+ "isArchived": false,
"moderationSettings": null } ]
v1.0 Channel Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-members.md
Include the following properties in the request body.
If successful, this method returns a `201 Created` response code and a [conversationMember](../resources/conversationmember.md) object in the response body.
+> [!NOTE]
+> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user.
+ ## Examples ### Example 1: Add a member to a private channel
v1.0 Channel Post Messages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-messages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "channel_post_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-messages-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is 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.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
-In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> - The Group.ReadWrite.All permission is 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.
+> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
<!-- markdownlint-disable MD024 --> <!-- markdownlint-disable MD001 -->
v1.0 Channel Unarchive https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-unarchive.md
+
+ Title: "channel: unarchive"
+description: "Restore an archived channel in a team. Unarchiving restores the ability for users to send messages and edit the channel."
+ms.localizationpriority: medium
++++
+# channel: unarchive
+
+Namespace: microsoft.graph
++
+Restore an archived [channel](../resources/channel.md). Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the [archive](channel-archive.md) API.
+
+Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchive operation completes successfully, which might occur after this method responds.
+
+> **Note**: An archived channel that belongs to an archived team cannot be unarchived. Unarchive the team before you unarchive the channel; otherwise, an error will occur.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "channel_unarchive" } -->
+
+> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of.
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+POST /teams/{team-id}/channels/{channel-id}/unarchive
+POST /groups/{team-id}/team/channels/{channel-id}/unarchive
+```
+
+## Request headers
+
+| Header | Value |
+|:|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If unarchiving is started successfully, this method returns a `202 Accepted` response code. The response contains a `Location` header, which contains the location of the [teamsAsyncOperation](../resources/teamsasyncoperation.md) that was created to handle unarchiving of the channel of the team. Check the status of the unarchiving operation by making a GET request to this location.
+
+## Example
+
+### Example 1: Unarchive a channel
+The following example shows a request to unarchive a channel.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "unarchive_channel"
+}-->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/unarchive
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "name": "unarchive_channel"
+}-->
+```http
+HTTP/1.1 202 Accepted
+Location: /teams/{team-id}/operations/{operation-id}
+Content-Type: text/plain
+Content-Length: 0
+```
+
+### Example 2: Unarchive a channel when the team is archived
+
+The following example shows a request to unarchive a channel in an archived team.
+
+#### Request
+
+<!-- { "blockType": "ignored" } -->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/unarchive
+```
+
+#### Response
+The following example shows the `400` error response.
+
+<!-- { "blockType": "ignored" } -->
+```http
+http/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 193
+
+{
+ "error": {
+ "code": "BadRequest",
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "innerError": {
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "code": "Unknown",
+ "innerError": {},
+ "date": "2023-12-11T04:26:35",
+ "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
+ "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
+ }
+ }
+}
+
+```
+<!-- uuid: 9a9bb83f-6f35-4426-bb04-73ca43ad6cc8
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Unarchive channel",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": []
+}
+-->
v1.0 Chat Delete Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_delete_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-installedapps-permissions.md)]
-> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Delete Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_delete_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-members-permissions.md)]
-> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Delete Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-tabs.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_delete_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-tabs-permissions.md)]
-> **Note**: The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chat Get Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-installedapps-permissions.md)]
-> **Note**:
-The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
Content-type: application/json
``` ### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat
-The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameterd is required to show the consented permission set.
+The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameter is required to show the consented permission set.
#### Request
v1.0 Chat Get Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-members-permissions.md)]
-> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
GET /users/{user-id | user-principal-name}/chats/{chat-id}/members/{membership-i
## Optional query parameters
-This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers
v1.0 Chat Get Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-tabs.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-tabs-permissions.md)]
-> **Note**: The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-permissions.md)]
-> **Note**: The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat List Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-installedapps-permissions.md)]
-> **Note:**
-The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent):
+> [!NOTE]
+> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent):
> - TeamsAppInstallation.ReadWriteAndConsentSelfForChat > - TeamsAppInstallation.ReadWriteAndConsentForChat > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All
v1.0 Chat List Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-members-permissions.md)]
-> **Note**: The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chat List Messages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-messages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-messages-permissions.md)]
-> **Note:** The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
This method supports the following [OData query parameters](/graph/query-paramet
| [$orderby](/graph/query-parameters#orderby-parameter) | Currently supports the **lastModifiedDateTime** (default) and **createdDateTime** properties in descending order. The ascending order is currently not supported.| | [$filter](/graph/query-parameters#filter-parameter) | Sets the date range filter for the **lastModifiedDateTime** and **createdDateTime** properties. The **lastModifiedDateTime** property supports the `gt` and `lt` operators. The **createdDateTime** property supports the `lt` operator. You can only filter results if the request URL contains the `$orderby` and `$filter` query parameters configured for the same property; otherwise, the `$filter` query option is ignored.|
-The other [OData query parameters](/graph/query-parameters) are not currently supported.
+The other [OData query parameters](/graph/query-parameters) aren't currently supported.
## Request headers
v1.0 Chat List Operations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-operations.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_operations" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-operations-permissions.md)]
-> **Note:** The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- {
v1.0 Chat List Permissiongrants https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-permissiongrants.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_permissiongrants" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-permissiongrants-permissions.md)]
-> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chat Patch Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-patch-tabs.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_patch_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-patch-tabs-permissions.md)]
-> **Note:** The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Patch https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-patch.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_patch" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-patch-permissions.md)]
-> **Note:**S The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Post Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_post_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-installedapps-permissions.md)]
-> **Notes:**
+> [!NOTE]
> - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
v1.0 Chat Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_post_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-members-permissions.md)]
-> **Note:** The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Post Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-tabs.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_post_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-tabs-permissions.md)]
-> **Note:** The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chat Sendactivitynotification https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-sendactivitynotification.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_sendactivitynotification" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-sendactivitynotification-permissions.md)]
->**Note:** The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Teamsappinstallation Upgrade https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-teamsappinstallation-upgrade.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_teamsappinstallation_upgrade" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-teamsappinstallation-upgrade-permissions.md)]
-> **Notes:**
+> [!NOTE]
> - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
v1.0 Chatmessage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All|
-> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
+> [!NOTE]
+> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
## HTTP request
GET /me/chats/{chat-id}/messages/{message-id}
``` ## Optional query parameters
-This method does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This method doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers | Header | Value |
v1.0 Chatmessage List Hostedcontents https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-list-hostedcontents.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md)
+Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md).s
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco
|Delegated (personal Microsoft account)|Not supported.| |Application| ChannelMessage.Read.Group, ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All |
-> **Note**: The Group.Read.All and Group.ReadWrite.All permissions 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.
+> [!NOTE]
+> The Group.Read.All and Group.ReadWrite.All permissions 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 <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->
Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco
|Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All|
-> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
+> [!NOTE]
+> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
## HTTP request
v1.0 Chatmessage List Replies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-list-replies.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_list_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-list-replies-permissions.md)]
-> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chatmessage Post Replies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-post-replies.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_post_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is 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.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
-In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> - The Group.ReadWrite.All permission is 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.
+> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chatmessage Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-post.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_post" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is 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.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> - The Group.ReadWrite.All permission is 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.
+> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
### Permissions for chat <!-- { "blockType": "permissions", "name": "chatmessage_post_2" } -->
v1.0 Chatmessage Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-update.md
You can update all the properties of **chatMessage** in delegated permissions sc
Updating works only for chats where conversation members are Microsoft Teams users. If one of the members is using Skype, the operation fails.
-This method does not support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message.
+This method doesn't support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message.
[!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
| Delegated (personal Microsoft account) | Not supported. | | Application | ChannelMessage.UpdatePolicyViolation.All, Group.ReadWrite.All** |
-> **Note:** The Group.ReadWrite.All permission is 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.
+> [!NOTE]
+> The Group.ReadWrite.All permission is 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 <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->
PATCH /teams/(team-id)/channels/{channel-id}/messages/{message-id}/replies/{repl
PATCH /chats/{chatThread-id}/messages/{message-id}?model=A ```
-If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) will be used.
+If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) is used.
## Request headers
HTTP/1.1 204 NoContent
The following example shows a request to update the attachments on a Microsoft Teams channel message by using delegated permissions. - # [HTTP](#tab/http) <!-- { "blockType": "request",
v1.0 Chatmessagehostedcontent Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessagehostedcontent-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| ChannelMessage.Read.Group, ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All |
-> **Note:**: The Group.Read.All and Group.ReadWrite.All permissionsare 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.
+> [!NOTE]
+> The Group.Read.All and Group.ReadWrite.All permissionsare 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 <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->
GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages/{message-id}
## Optional query parameters
-This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers
v1.0 Cloudpcdeviceimage Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcdeviceimage-delete.md
If successful, this method returns a `204 No Content` response code.
### Request
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_deviceimages_from_virtualendpoint"
If successful, this method returns a `204 No Content` response code.
DELETE https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/435849e6-0263-4621-9f93-8657667af3bb ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response **Note:** The response object shown here might be shortened for readability.
v1.0 Cloudpcdeviceimage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcdeviceimage-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcDevice
### Request
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcdeviceimage"
If successful, this method returns a `200 OK` response code and a [cloudPcDevice
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/eda7ed64-7705-4079-9d08-c2bd883f4fff ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response **Note:** The response object shown here might be shortened for readability.
v1.0 Cloudpcgalleryimage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcgalleryimage-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcGaller
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcgalleryimage",
The following example shows a request.
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/galleryImages/MicrosoftWindowsDesktop_windows-ent-cpc_19h2-ent-cpc-os ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcprovisioningpolicy Apply https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-apply.md
+
+ Title: "cloudPcProvisioningPolicy: apply"
+description: "Apply the current provisioning policy configuration to all Cloud PC devices under a specified policy."
+
+ms.localizationpriority: medium
+++
+# cloudPcProvisioningPolicy: apply
+
+Namespace: microsoft.graph
++
+Apply the current [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration to all Cloud PC devices under a specified policy. Currently, the region is the only policy setting that you can apply.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "cloudpcprovisioningpolicy_apply" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+POST /deviceManagement/virtualEndpoint/provisioningPolicies/{id}/apply
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the parameters.
+
+The following table shows the parameter that you can use with this method.
+
+|Parameter|Type|Description|
+|:|:|:|
+|policySettings|cloudPcPolicySettingType|The target property of this apply action. Possible values are: `region`, `singleSignOn`, `unknownFutureValue`. The default value is `region`. This action applies `region` as a value if this parameter is `null`.|
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "apply_cloudpcprovisioningpolicy"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply
+Content-Type: application/json
+
+{
+ "policySettings": "region"
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+``` http
+HTTP/1.1 204 No Content
+```
v1.0 Cloudpcprovisioningpolicy Applyconfig https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-applyconfig.md
+
+ Title: "cloudPcProvisioningPolicy: applyConfig"
+description: "Update the provisioning policy configuration for a set of Cloud PC devices by their IDs."
+
+ms.localizationpriority: medium
+++
+# cloudPcProvisioningPolicy: applyConfig
+
+Namespace: microsoft.graph
++
+Update the [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration for a set of Cloud PC devices by their IDs. This method supports retry and allows you to apply the configuration to a subset of Cloud PCs initially to test.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "cloudpcprovisioningpolicy_applyconfig" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /deviceManagement/virtualEndpoint/provisioningPolicies/applyConfig
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the parameters.
+
+The following table shows the parameters that you can use with this method.
+
+|Parameter|Type|Description|
+|:|:|:|
+|cloudPcIds|String collection|A collection of Cloud PC IDs.|
+|policySettings|cloudPcPolicySettingType|The target property of this apply action. Possible values are: `region`, `singleSignOn`, `unknownFutureValue`. The default value is `region`. This action applies `region` as a value if this parameter is `null`.|
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "cloudpcprovisioningpolicythis.applyconfig"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/applyConfig
+Content-Type: application/json
+
+{
+ "cloudPcIds": [
+ "52aa2645-36ee-47d2-9eb3-b8fbb17c3fc4",
+ "ff117b6c-e3e6-41be-9cae-eb6743249a30"
+ ],
+ "policySettings": "region"
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
v1.0 Cloudpcprovisioningpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-get.md
Content-Type: application/json
"@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",
- "domainJoinConfiguration": {
- "domainJoinType": "hybridAzureADJoin",
- "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff"
- },
"domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
Content-Type: application/json
"imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType": "custom",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "windowsSettings": {
- "language": "en-US"
- },
"windowsSetting": { "locale": "en-US" },
Content-Type: application/json
"@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",
- "domainJoinConfiguration": {
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "regionName": null,
- "type": "hybridAzureADJoin"
- },
"domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
Content-Type: application/json
"imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType": "custom",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "windowsSettings": {
- "language": "en-US"
- },
"windowsSetting": { "locale": "en-US" },
The following example shows a request.
--> ``` http
-GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfiguration,imageDisplayName,imageId,imageType,onPremisesConnectionId,windowsSetting,managedBy,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl
+GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfigurations,imageDisplayName,imageId,imageType,windowsSetting,managedBy,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl
``` # [C#](#tab/csharp)
Content-Type: application/json
"cloudPcGroupDisplayName": "MyCloudPcGroup", "description": "The ProvisioningPolicy for West US employees.", "displayName": "WestUsPolicy",
- "domainJoinConfiguration": {
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "regionName": null,
- "type": "hybridAzureADJoin"
- },
"domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
Content-Type: application/json
"imageType": "custom", "localAdminEnabled": true, "managedBy": "windows365",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "windowsSettings": {
- "language": "en-US"
- },
"windowsSetting": { "locale": "en-US" },
v1.0 Cloudpcprovisioningpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-update.md
The following table shows the properties that can be updated for the [cloudPcPro
|imageId|String|The ID of the OS image you want to provision on Cloud PCs. The format for a gallery type image is: {publisher_offer_sku}. Supported values for each of the parameters are as follows: <ul><li>publisher: Microsoftwindowsdesktop.</li> <li>offer: windows-ent-cpc.</li> <li>sku: 21h1-ent-cpc-m365, 21h1-ent-cpc-os, 20h2-ent-cpc-m365, 20h2-ent-cpc-os, 20h1-ent-cpc-m365, 20h1-ent-cpc-os, 19h2-ent-cpc-m365 and 19h2-ent-cpc-os.</li></ul>| |imageType|cloudPcProvisioningPolicyImageType|The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: `gallery`, `custom`.| |windowsSetting|[cloudPcWindowsSettings](../resources/cloudpcwindowssetting.md)|Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. |
-|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID.|
-|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.|
+|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID. The **domainJoinConfiguration** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
+|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service. The **onPremisesConnectionId** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
|windowsSettings (deprecated)|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. The **windowsSettings** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **windowsSetting** property.| ## Response
v1.0 Cloudpcreports Getremoteconnectionhistoricalreports https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getremoteconnectionhistoricalreports.md
The following table shows the parameters that can be used with this action.
|Parameter|Type|Description| |:|:|:|
-|filter|String|OData filter syntax. Supported filters include `and`, `or`, `lt`, `le`, `gt`, `ge` and `eq`.|
+|filter|String|OData filter syntax. Supported filters include `and`, `or`, `lt`, `le`, `gt`, `ge` and `eq`. The `CloudPcId` filter is required; for example: `CloudPcId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. If this filter is missing, malformed, or invalid, a query config will be thrown.|
|select|String collection|OData select syntax. The columns to include in the report.| |search|String|The string to search for.| |groupBy|String collection|A list of columns that describe how to group the data in the report.|
Content-length: 199
"UsageInHour", "RoundTripTimeInMsP50", "AvailableBandwidthInMBpsP50",
- "RemoteSignInTimeInSec",
+ "RemoteSignInTimeInSec"
], "top": 25,
- "skip": 0,
+ "skip": 0
} ```
v1.0 Devicemanagement Alertrecord Changealertrecordsportalnotificationassent https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/devicemanagement-alertrecord-changealertrecordsportalnotificationassent.md
+
+ Title: "alertRecord: changeAlertRecordsPortalNotificationAsSent"
+description: "Change the isPortalNotificationSent property to true for a list of alert records for the current user."
+
+ms.localizationpriority: medium
+++
+# alertRecord: changeAlertRecordsPortalNotificationAsSent
+
+Namespace: microsoft.graph.deviceManagement
++
+Set the **isPortalNotificationSent** property of all [portal notification](../resources/devicemanagement-portalnotification.md) resources associated with the specified [alertRecord](../resources/devicemanagement-alertrecord.md) to `true`, marking them as sent. A maximum of 100 [alertRecord](../resources/devicemanagement-alertrecord.md) IDs can be received at one time, and a maximum of 100 **portal notification** resources can be changed in the **isPortalNotificationSent** property status.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "devicemanagement_alertrecord_changealertrecordsportalnotificationassent" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /deviceManagement/monitoring/alertRecords/changeAlertRecordsPortalNotificationAsSent
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+|Property|Type|Description|
+|:|:|:|
+|alertRecordIds| String collection | A list of up to 100 [alertRecord](../resources/devicemanagement-alertrecord.md) IDs.|
+
+## Response
+
+If successful, this action returns a `202 Accepted` response code.
+
+## Example
+
+### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "alertrecordthis.changeAlertRecordsPortalNotificationAsSent"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/deviceManagement/monitoring/alertRecords/changeAlertRecordsPortalNotificationAsSent
+
+{
+ "alertRecordIds": [
+ "1d2b92e3-539a-481f-b38a-c2c050b422ad",
+ "4bf624c4-a801-4631-989c-7f1a3a0d1d83",
+ ]
+
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
++++
+### Response
+
+The following example shows the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 202 ACCEPTED
+```
v1.0 Directory Delete Externaluserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-externaluserprofiles.md
DELETE https://graph.microsoft.com/beta/directory/externalUserProfiles/{id}
[!INCLUDE [sample-code](../includes/snippets/php/delete-externaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory Delete Pendingexternaluserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-pendingexternaluserprofiles.md
DELETE https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles/{i
[!INCLUDE [sample-code](../includes/snippets/php/delete-pendingexternaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory List Externaluserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-externaluserprofiles.md
GET https://graph.microsoft.com/beta/directory/externalUserProfiles
[!INCLUDE [sample-code](../includes/snippets/php/list-externaluserprofiles-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-externaluserprofiles-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory List Pendingexternaluserprofile https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-pendingexternaluserprofile.md
GET https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles
[!INCLUDE [sample-code](../includes/snippets/php/list-pendingexternaluserprofiles-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-pendingexternaluserprofiles-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory Post Pendingexternaluserprofile https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-pendingexternaluserprofile.md
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/create-pendingexternaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/create-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Domain Post Federationconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-post-federationconfiguration.md
Title: "Create internalDomainFederation"
description: "Create a new internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_post_federationconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-post-federationconfiguration-permissions.md)]
+> [!IMPORTANT]
+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios.
+ [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request
You can specify the following properties when creating an **internalDomainFedera
|displayName|String|The display name of the federated identity provider.| |issuerUri|String|Issuer URI of the federation server.| |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications.|
-|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and will update the federation settings for the domain when a new certificate is available.|
+|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and updates the federation settings for the domain when a new certificate is available.|
|passiveSignInUri|String|URI that web-based clients are directed to when signing in to Microsoft Entra services.| |preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`.| |activeSignInUri|String|URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Microsoft Entra ID. Corresponds to the **ActiveLogOnUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.| |isSignedAuthenticationRequestRequired|Boolean|If true, when SAML authentication requests are sent to the federated SAML IDP, Microsoft Entra ID signs those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IDP aren't signed.|
-|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the auto-rollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.|
+|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base 64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the autorollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.|
|signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |federatedIdpMfaBehavior|federatedIdpMfaBehavior|Determines whether Microsoft Entra ID accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: `acceptIfMfaDoneByFederatedIdp`, `enforceMfaByFederatedIdp`, `rejectMfaByFederatedIdp`, `unknownFutureValue`. For more information, see [federatedIdpMfaBehavior values](#federatedidpmfabehavior-values).| + ### federatedIdpMfaBehavior values | Member | Description |
You can specify the following properties when creating an **internalDomainFedera
| rejectMfaByFederatedIdp | Microsoft Entra ID always performs MFA and rejects MFA that's performed by the federated identity provider. | **Note:** **federatedIdpMfaBehavior** is an evolved version of the **SupportsMfa** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).
-+ Switching between **federatedIdpMfaBehavior** and **SupportsMfa** is not supported.
++ Switching between **federatedIdpMfaBehavior** and **SupportsMfa** isn't supported. + Once **federatedIdpMfaBehavior** property is set, Microsoft Entra ID ignores the **SupportsMfa** setting. + If the **federatedIdpMfaBehavior** property is never set, Microsoft Entra ID continues to honor the **SupportsMfa** setting. + If neither **federatedIdpMfaBehavior** nor **SupportsMfa** is set, Microsoft Entra ID defaults to `acceptIfMfaDoneByFederatedIdp` behavior.
v1.0 Driveitem Assignsensitivitylabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-assignsensitivitylabel.md
Namespace: microsoft.graph
Asynchronously assign a sensitivity label to a [driveItem][item-resource].
-This API is part of Microsoft SharePoint and OneDrive APIs that perform advanced premium administrative functions and is considered a protected API. Protected APIs require you to have more validation, beyond permission and consent, before you can use them. Before you call this API, you must [request access](https://aka.ms/PreviewSPOPremiumAPI).
-
-For more information about sensitivity labels from an administrator's perspective, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files?view=o365-worldwide&preserve-view=true).
+This API is part of the Microsoft SharePoint and OneDrive APIs that perform advanced premium administrative functions, and is considered a protected API. Protected APIs require you to have more validation, beyond permission and consent, before you can use them.
> [!NOTE]
-> This is a metered API and some charges for use may apply. For details, see [Overview of metered Microsoft 365 APIs in Microsoft Graph](/graph/metered-api-overview).
+> This is a metered API and some charges for use may apply. For details, see [Overview of metered Microsoft 365 APIs in Microsoft Graph](/graph/metered-api-overview). Before you call this API, you must [Enable metered APIs and services in Microsoft Graph](/graph/metered-api-setup?tabs=azurecloudshell).
+
+This API applies sensitivity labels to files at rest. Office clients don't apply watermarks, headers, or footers to files that contain the label information. For more information about sensitivity labels from an administrator's perspective, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files?view=o365-worldwide&preserve-view=true).
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
v1.0 Driveitem Get Contentstream https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-get-contentstream.md
The following example shows how to download a file.
GET https://graph.microsoft.com/beta/drives/b!fMInbiL5dkK51VbATG0ddrCg6AJpEj9Lm4uGj5HgEi4guyuYp4W5SbH4dPfXTbCF/items/014Y52UITTNSVUQI43PZBJMKLAY6LJBUVE/contentStream ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+ # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/download-item-content-stream-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+ #### Response
GET https://graph.microsoft.com/beta/drives/b!fMInbiL5dkK51VbATG0ddrCg6AJpEj9Lm4
Range: bytes=0-1023 ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+ # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/download-item-partial-stream-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+ #### Response
v1.0 Educationgradingscheme Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-delete.md
DELETE https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-856
[!INCLUDE [sample-code](../includes/snippets/php/delete-educationgradingscheme-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Educationgradingscheme Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-get.md
GET https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f
[!INCLUDE [sample-code](../includes/snippets/php/get-educationgradingscheme-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Educationgradingscheme Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-educationgradingscheme-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-Type: application/json
[!INCLUDE [snippet-not-available](../includes/snippets/snippet-not-available.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [snippet-not-available](../includes/snippets/snippet-not-available.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Externaluserprofile Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-get.md
GET https://graph.microsoft.com/beta/directory/externalUserProfiles/{id}
[!INCLUDE [sample-code](../includes/snippets/php/get-externaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Externaluserprofile Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-externaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Internaldomainfederation Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/internaldomainfederation-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "internaldomainfederation_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-delete-permissions.md)]
+> [!IMPORTANT]
+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios.
+
+<!-- Domain Name Administrator and Hybrid Identity Administrator can't delete federated domains -->
The calling user must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - Security Administrator
v1.0 Internaldomainfederation Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/internaldomainfederation-update.md
Title: "Update internalDomainFederation"
description: "Update the properties of an internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "internaldomainfederation_update" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-update-permissions.md)]
+> [!IMPORTANT]
+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios.
+ [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request
PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId}
|passiveSignInUri|String|URI that web-based clients are directed to when signing into Microsoft Entra services. | |preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`. | |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.|
-|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and will update the federation settings for the domain when a new certificate is available. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).|
+|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and updates the federation settings for the domain when a new certificate is available. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).|
|signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| + ### federatedIdpMfaBehavior values | Member | Description |
v1.0 Itemanalytics Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/itemanalytics-get.md
GET /sites/{site-id}/analytics
GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics ```
+> [!NOTE]
+> The value for `{item-id}` in the `/sites/{site-id}/lists/{list-id}/items/{item-id}` request is the `listItemUniqueId`. To get the `listItemUniqueId` of an item, call the `/sites/{site-id}/lists/{list-id}/items/{item-id}?$select=sharepointIds` endpoint. For details, see [sharePointIds](/graph/api/resources/sharepointids).
+ ## Optional query parameters This method supports the [OData query parameters](/graph/query-parameters) to help customize the response.
v1.0 Listitem Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/listitem-delta.md
description: "Get newly created, updated, or deleted list items without having to perform a full read of the entire items collection." Title: "lisItem: delta"
+ Title: "listItem: delta"
ms.localizationpriority: "medium" doc_type: apiPageType + # listItem: delta Namespace: microsoft.graph
Your app begins by calling `delta` without any parameters.
The service starts enumerating the hierarchy of the list, returning pages of items, and either an **@odata.nextLink** or an **@odata.deltaLink**. Your app should continue calling with the **@odata.nextLink** until you see an **@odata.deltaLink** returned.
-After you have received all the changes, you might apply them to your local state.
+After you received all the changes, you can apply them to your local state.
To check for changes in the future, call `delta` again with the **@odata.deltaLink** from the previous response.
-The delta feed shows the latest state for each item, not each change. If an item were renamed twice, it will only show up once, with its latest name.
+The delta feed shows the latest state for each item, not each change. If an item was renamed twice, it only shows up once, with its latest name.
The same item might appear more than once in a delta feed, for various reasons. You should use the last occurrence you see.
-Deleted items are returned with the [deleted facet](../resources/deleted.md). Deleted indicates that the item is deleted and cannot be restored.
+Deleted items are returned with the [deleted](../resources/deleted.md) facet. `Deleted` indicates that the item is deleted and can't be restored.
Items with this property should be removed from your local state. > **Note:** You should only delete a folder locally if it's empty after syncing all the changes.
In the request URL, you can include the following optional query parameter.
| Parameter | Type | Description | |:-|:-|:-|
-| token | string | Optional. If unspecified, enumerates the current state of the hierarchy. If `latest`, returns an empty response with the latest delta token. If a previous delta token, returns a new state since that token.|
+| token | String | If unspecified, enumerates the current state of the hierarchy. If `latest`, returns an empty response with the latest delta token. If a previous delta token, returns a new state since that token.|
-This method supports the `$select`, `$expand`, and `$top` [OData query parameters](/graph/query-parameters) to customize the response.
+This method also supports the `$select`, `$expand`, and `$top` [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers
Don't supply a request body for this method.
If successful, this method returns a `200 OK` response code and a collection of [listItem](../resources/listitem.md) objects in the response body.
-In addition to a collection of **listItem** objects, the response will also include one of the following properties.
+In addition to a collection of **listItem** objects, the response also includes one of the following properties.
-| Name | Value | Description |
-|:|:-|:-|
-| **@odata.nextLink** | URL | A URL to retrieve the next available page of changes, if there are additional changes in the current set. |
-| **@odata.deltaLink** | URL | A URL returned instead of **@odata.nextLink** after all current changes have been returned. Used to read the next set of changes in the future. |
+| Name | Value | Description |
+|:--|:-|:-|
+| @odata.nextLink | URL | A URL to retrieve the next available page of changes, if there are more changes in the current set. |
+| @odata.deltaLink | URL | A URL returned instead of **@odata.nextLink** after all current changes have been returned. Use this property to read the next set of changes in the future. |
-In some cases, the service will return a `410 Gone` response code with an error response that contains one of the following error codes, and a `Location` header containing a new `nextLink` that starts a fresh delta enumeration. This occurs when the service can't provide a list of changes for a given token (for example, if a client tries to reuse an old token after being disconnected for a long time, or if the server state has changed and a new token is required).
+In some cases, the service returns a `410 Gone` response code with an error response that contains one of the following error codes, and a `Location` header that contains a new `nextLink` that starts a fresh delta enumeration. This occurs when the service can't provide a list of changes for a given token; for example, if a client tries to reuse an old token after being disconnected for a long time, or if the server state has changed and a new token is required.
After the full enumeration is completed, compare the returned items with your local state and follow the instructions based on the error type. | Error type | Instructions | |:|:-|
-| `resyncChangesApplyDifferences` | Replace any local items with the versions from the server (including deletes) if you're sure that the service was up to date with your local changes when you last synchronized. Upload any local changes that the server doesn't know about. |
-| `resyncChangesUploadDifferences` | Upload any local items that the service did not return, and upload any items that differ from the versions from the server (keep both copies if you're not sure which one is more up-to-date). |
+| `resyncChangesApplyDifferences` | Replace any local items with the versions from the server (including deletes) if you're sure that the service was up-to-date with your local changes when you last synchronized. Upload any local changes that the server doesn't know about. |
+| `resyncChangesUploadDifferences` | Upload any local items that the service didn't return and upload any items that differ from the versions from the server. Keep both copies if you're not sure which one is more up-to-date. |
-In addition to the resync errors and for more details about how errors are returned, see [Microsoft Graph error responses and resource types][error-response].
+In addition to the resync errors and for more details about how errors are returned, see [Microsoft Graph error responses and resource types](/graph/errors).
## Examples ### Example 1: Initial request
-The following is an example of the initial request that shows how to call this API to establish your local state.
+The following example shows an initial request and how to call this API to establish your local state.
#### Request
-The following is an example of the initial request.
-
+The following example shows an initial request.
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_listItem_delta_first", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE", "22e03ef3-6ef4-424d-a1d3-92a337807c30"] } -->
GET https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-
#### Response
-The following is an example of the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more items are available in the current set of items. Your app should continue to request the URL value of **@odata.nextLink** until all pages of items have been retrieved.
+The following example shows the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more items are available in the current set of items. Your app should continue to request the URL value of **@odata.nextLink** until all pages of items have been retrieved.
-<!-- { "blockType": "response", "name": "get_listItem_delta_first", "@odata.type": "microsoft.graph.listItem", "isCollection": true, "truncated": true, "scope": "site.read" } -->
+<!-- { "blockType": "response", "name": "get_listItem_delta_first", "@odata.type": "Collection(microsoft.graph.listItem)", "truncated": true, "scope": "site.read" } -->
```http HTTP/1.1 200 OK Content-type: application/json {
- "value": [
- {
- "createdDateTime": "2020-06-02T22:46:58Z",
- "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"",
- "id": "1",
- "lastModifiedDateTime": "2021-10-14T23:27:27Z",
- "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder",
- "createdBy": {
- "user": {
- "displayName": "John doe",
- }
- },
- "parentReference": {
- "id": "1",
- "path": "Shared%20Documents",
- "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
- },
- "contentType": {
- "id": "0x00123456789abc",
- "name": "Folder"
- }
- },
- {
- "createdDateTime": "2020-06-02T22:46:58Z",
- "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC067},756\"",
- "id": "2",
- "lastModifiedDateTime": "2021-10-14T23:27:27Z",
- "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemA.txt",
- "createdBy": {
- "user": {
- "displayName": "John doe",
- }
- },
- "parentReference": {
- "id": "2",
- "path": "Shared%20Documents",
- "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
- },
- "contentType": {
- "id": "0x00123456789abc",
- "name": "Document"
- }
- },
- {
- "createdDateTime": "2020-06-02T22:46:58Z",
- "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC068},756\"",
- "id": "3",
- "lastModifiedDateTime": "2021-10-14T23:27:27Z",
- "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemB.txt",
- "createdBy": {
- "user": {
- "displayName": "John doe",
- }
- },
- "parentReference": {
- "id": "3",
- "path": "Shared%20Documents",
- "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
- },
- "contentType": {
- "id": "0x00123456789abc",
- "name": "Document"
- }
+ "value": [
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"",
+ "id": "1",
+ "lastModifiedDateTime": "2021-10-14T23:27:27Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
+ }
+ },
+ "parentReference": {
+ "id": "1",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Folder"
+ }
+ },
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC067},756\"",
+ "id": "2",
+ "lastModifiedDateTime": "2021-10-14T23:27:27Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemA.txt",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
+ }
+ },
+ "parentReference": {
+ "id": "2",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Document"
+ }
+ },
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC068},756\"",
+ "id": "3",
+ "lastModifiedDateTime": "2021-10-14T23:27:27Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemB.txt",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
}
- ],
- "@odata.nextLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
+ },
+ "parentReference": {
+ "id": "3",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Document"
+ }
+ }
+ ],
+ "@odata.nextLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
} ```
The following example shows a request that gets the last page in a set and how t
The following example shows a request after the initial request. - # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-listItem-delta-last", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] }-->
GET https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-
#### Response
-The following is an example of the response that indicates that the item named `TestItemB.txt` was deleted and the item `TestFolder` was either added or modified between the initial request and this request to update the local state.
-
-The final page of items will include the **@odata.deltaLink** property, which provides the URL that can be used later to retrieve changes since the current set of items.
+The following example shows the response that indicates that the item named `TestItemB.txt` was deleted and the item `TestFolder` was either added or modified between the initial request and this request to update the local state.
+The final page of items includes the **@odata.deltaLink** property that provides the URL that can be used later to retrieve changes since the current set of items.
-<!-- { "blockType": "response", "name": "get-listItem-delta-last", "truncated": true, "@odata.type": "microsoft.graph.listItem", "isCollection": true, "scope": "site.read" } -->
+<!-- { "blockType": "response", "name": "get-listItem-delta-last", "truncated": true, "@odata.type": "Collection(microsoft.graph.listItem)", "scope": "site.read" } -->
```http HTTP/1.1 200 OK Content-type: application/json {
- "value": [
- {
- "createdDateTime": "2020-06-02T22:46:58Z",
- "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"",
- "id": "1",
- "lastModifiedDateTime": "2016-03-21T20:01:37Z",
- "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder",
- "createdBy": {
- "user": {
- "displayName": "John doe",
- }
- },
- "parentReference": {
- "id": "1",
- "path": "Shared%20Documents",
- "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
- },
- "contentType": {
- "id": "0x00123456789abc",
- "name": "Folder"
- }
- },
- {
- "id": "3",
- "parentReference": {
- "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
- },
- "contentType": {
- "id": "0x00123456789abc",
- "name": "Document"
- },
- "deleted": {"state": "deleted"}
+ "value": [
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"",
+ "id": "1",
+ "lastModifiedDateTime": "2016-03-21T20:01:37Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
}
- ],
- "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
+ },
+ "parentReference": {
+ "id": "1",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Folder"
+ }
+ },
+ {
+ "id": "3",
+ "parentReference": {
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Document"
+ },
+ "deleted": {
+ "state": "deleted"
+ },
+ "@removed": {
+ "reason": "deleted"
+ }
+ }
+ ],
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
} ``` ### Example 3: Delta link request
-In some scenarios, it might be useful to request the current `deltaLink` value without first enumerating all of the items in the list already. This can be useful if your app only wants to know about changes and doesn't need to know about existing items.
+In some scenarios, you might want to request the current `deltaLink` value without first enumerating all of the items in the list already. This can be useful if your app only wants to know about changes and doesn't need to know about existing items.
To retrieve the latest `deltaLink`, call `delta` with the query string parameter `?token=latest`. #### Request The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-delta-latest_datalink_tokenislatest", "scope": "sites.read", "target": "action", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] } --> ```msgraph-interactive
-GET /sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest
+GET https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest
``` # [C#](#tab/csharp)
GET /sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-
The following example shows the response.
-<!-- { "blockType": "response", "name": "get-delta-latest_datalink_tokenislatest", "isEmpty": true, "@odata.type": "microsoft.graph.listItem", "isCollection": true } -->
+<!-- { "blockType": "response", "name": "get-delta-latest_datalink_tokenislatest", "isEmpty": true, "@odata.type": "Collection(microsoft.graph.listItem)" } -->
```http HTTP/1.1 200 OK Content-type: application/json {
- "value": [ ],
- "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
+ "value": [ ],
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
} ``` ## Related content
-[Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview)
-[Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance)
-[error-response]: /graph/errors
+- [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview)
+- [Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance)
<!-- { "type": "#page.annotation",
v1.0 Mailfolder Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mailfolder-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
## Request headers
-| Name | Type | Description |
-|:--|:-|:--|
-| Authorization | string | Bearer {token}. Required. |
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
## Request body
v1.0 Outlookcategory Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlookcategory-update.md
Title: "Update Outlook category"
-description: "Update the writable property, **color**, of the specified outlookCategory object. You can't modify the **displayName** property "
+ Title: "Update outlookCategory"
+description: "Update the writable property, **color**, of the specified outlookCategory object."
ms.localizationpriority: medium doc_type: apiPageType
-# Update Outlook category
+# Update outlookCategory
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property
-once you have created the category.
+Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property once you have created the category.
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
maintains their previous values or be recalculated based on changes to other pro
## Response
-If successful, this method returns a `200 OK` response code and updated [outlookCategory](../resources/outlookcategory.md) object in the response body.
+If successful, this method returns a `200 OK` response code and an updated [outlookCategory](../resources/outlookcategory.md) object in the response body.
## Example
-##### Request
+### Request
The following example shows a request. # [HTTP](#tab/http)
Content-type: application/json
-##### Response
-The following example shows the response. Note: The response object shown here might be shortened for readability.
+### Response
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Outlookuser List Mastercategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlookuser-list-mastercategories.md
Title: "List Outlook categories"
-description: "Get all the categories that have been defined for the user."
+ Title: "List masterCategories"
+description: "Get all the categories that have been defined for a user."
ms.localizationpriority: medium doc_type: apiPageType
-# List Outlook categories
+# List masterCategories
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get all the categories that have been defined for the user.
+Get all the categories that have been defined for a user.
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
v1.0 Partners Billing Billedreconciliation Export https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partners-billing-billedreconciliation-export.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/billedreconciliationthisexport-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/billedreconciliationthisexport-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Pendingexternaluserprofile Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pendingexternaluserprofile-get.md
GET https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles/{id}
[!INCLUDE [sample-code](../includes/snippets/php/get-pendingexternaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Pendingexternaluserprofile Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pendingexternaluserprofile-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-pendingexternaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Security Authoritytemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-authoritytemplate-get.md
The following example shows a request.
} --> ``` http
-GET https://graph.microsoft.com/beta/security/labels/authorities/{authorityTemplateId}
+GET https://graph.microsoft.com/beta/security/labels/authorities/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5
``` # [C#](#tab/csharp)
GET https://graph.microsoft.com/beta/security/labels/authorities/{authorityTempl
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "value": { "@odata.type": "#microsoft.graph.security.authorityTemplate",
- "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",
- "displayName": "String",
+ "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5",
+ "displayName": "Business",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)"
- }
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
} ```
v1.0 Security Categorytemplate Delete Subcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-delete-subcategories.md
Choose the permission or permissions marked as least privileged for this API. Us
} --> ``` http
-DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}/$ref
+DELETE /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId}/$ref
``` ## Request headers
The following example shows a request.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}
+DELETE https://graph.microsoft.com/beta/security/labels/categories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5/subCategories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5
``` # [JavaScript](#tab/javascript)
DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retenti
### Response
-The following example shows the response.
+Here's an example of the response.
> <!-- { "blockType": "response",
v1.0 Security Categorytemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-get.md
GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemp
``` ## Optional query parameters
-This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports some of the OData query parameters to help customize the response. For example, to retrieve the **subcategories** property associated with this particular category, you can use the `expand` parameter:`$expand=subcategories`. For general information, see [OData query parameters](/graph/query-parameters).
## Request headers |Name|Description|
The following example shows a request.
} --> ``` http
-GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}
+GET https://graph.microsoft.com/beta/security/labels/categories/e2c79762-34a9-75ba-b6f0-a7c9a57978ef
``` # [C#](#tab/csharp)
GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplat
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"value": { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",
- "displayName": "String",
+ "displayName": "Accounts payable",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)"
- }
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
} ```
v1.0 Security Categorytemplate List Subcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-list-subcategories.md
Choose the permission or permissions marked as least privileged for this API. Us
} --> ``` http
-GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories
+GET /security/labels/categories/{categoryTemplateId}/subCategories
``` ## Optional query parameters
The following example shows a request.
} --> ``` http
-GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories
+GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}/subCategories
``` # [JavaScript](#tab/javascript)
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.subCategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",
- "displayName": "String",
+ "displayName": "Vendor Invoice",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime": "2021-03-24T02:09:08Z"
} ] }
v1.0 Security Categorytemplate Post Subcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-post-subcategories.md
Choose the permission or permissions marked as least privileged for this API. Us
} --> ``` http
-POST /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories
+POST /security/labels/categories/{categoryTemplateId}/subCategories
``` ## Request headers
You can specify the following properties when creating a **subCategoryTemplate**
|Property|Type|Description| |:|:|:|
-|displayName|String| Unique string that defines a sub-category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md). Optional.|
+|displayName|String| Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md). Optional.|
## Response- If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. ## Examples
The following example shows a request.
} --> ``` http
-POST https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories
+POST https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}/subCategories
Content-Type: application/json { "@odata.type": "#microsoft.graph.security.subCategoryTemplate",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- }
+ "displayName": "Vendor Invoice",
} ```
Content-Type: application/json
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.subCategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)"
-}
+ "displayName": "Vendor Invoice",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
```
v1.0 Security Citationtemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-citationtemplate-get.md
The following example shows a request.
} --> ``` http
-GET https://graph.microsoft.com/beta/security/labels/citations/{citationTemplateId}
+GET https://graph.microsoft.com/beta/security/labels/citations/c0475d01-d532-8a53-6e26-14ea58c640bf
``` # [C#](#tab/csharp)
GET https://graph.microsoft.com/beta/security/labels/citations/{citationTemplate
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"value": { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",
- "displayName": "String",
+ "displayName": "Contoso Company Policy",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)",
- "citationUrl": "String",
- "citationJurisdiction": "String"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "Contoso"
} } ```
v1.0 Security Departmenttemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-departmenttemplate-get.md
The following example shows a request.
} --> ``` http
-GET https://graph.microsoft.com/beta/security/labels/departments/{departmentTemplateId}
+GET https://graph.microsoft.com/beta/security/labels/departments/11b44677-9f06-c85a-4a0b-766b66904bf8
``` # [C#](#tab/csharp)
GET https://graph.microsoft.com/beta/security/labels/departments/{departmentTemp
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"value": { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",
- "displayName": "String",
+ "displayName": "Finance",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)"
- }
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
} ```
v1.0 Security Detectionrule Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-detectionrule-delete.md
DELETE https://graph.microsoft.com/beta/security/rules/detectionRules/302
[!INCLUDE [sample-code](../includes/snippets/php/delete-detectionrule-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-detectionrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Security Detectionrule Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-detectionrule-get.md
GET https://graph.microsoft.com/beta/security/rules/detectionRules/7506
[!INCLUDE [sample-code](../includes/snippets/php/get-detectionrule-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-detectionrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Security Detectionrule List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-detectionrule-list.md
GET https://graph.microsoft.com/beta/security/rules/detectionRules?$top=3
[!INCLUDE [sample-code](../includes/snippets/php/list-detectionrule-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-detectionrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Security Fileplanreferencetemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-fileplanreferencetemplate-get.md
The following example shows a request.
} --> ``` http
-GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePlanReferenceTemplateId}
+GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/b1f7b518-a44f-1d4b-c6f1-ab8771d3907c
``` # [C#](#tab/csharp)
GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePla
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"value": { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",
- "displayName": "String",
+ "displayName": "FIN 01-02-001",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)"
- }
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
} ```
v1.0 Security Healthissue Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-healthissue-get.md
+
+ Title: "Get healthIssue"
+description: "Read the properties and relationships of a healthIssue object."
+
+ms.localizationpriority: medium
Last updated : 03/20/2024++
+# Get healthIssue
+
+Namespace: microsoft.graph.security
++
+Read the properties and relationships of a [healthIssue](../resources/security-healthissue.md) object.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "security_healthissue_get" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/identities/healthIssues/{healthIssueId}
+```
++
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.healthIssue](../resources/security-healthissue.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "sampleKeys": ["b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c"],
+ "name": "get_security_healthissue"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/identities/healthIssues/b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c
+```
++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.healthIssue",
+ "name": "get_security_healthissue"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.healthIssue",
+ "ID": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c",
+ "displayName": "Directory Services Object Auditing is not configured as required",
+ "healthIssueType": "Global",
+ "issueTypeId": "1031",
+ "severity": "medium",
+ "status": "open",
+ "createdDateTime": "2022-07-15T12:19:27.7211305Z",
+ "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z",
+ "domainNames": [
+ "domain1.contoso.com",
+ "domain2.contoso.com"
+ ],
+ "sensorDNSNames": [
+ "DC1.domain1.contoso.com",
+ "DC2.domain2.contoso.com"
+ ],
+ "description": "Directory Services Object Auditing is not configured as required on domain1.contoso.com",
+ "recommendations": [
+ "Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"
+ ],
+ "recommendedActionCommands": [
+ "Import-Module DefenderForIdentity",
+ "Set-MDIConfiguration -Configuration DomainObjectAuditing -Mode Domain -Force"
+ ],
+ "additionalInformation": [
+ "Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)",
+ "Descendant Group Objects (Schema-Id-Guid: bf967a9c-0de6-11d0-a285-00aa003049e2)",
+ "Descendant Computer Objects (Schema-Id-Guid: bf967a86-0de6-11d0-a285-00aa003049e2)",
+ "Descendant msDS-GroupManagedServiceAccount Objects (Schema-Id-Guid: 7b8b558a-93a5-4af7-adca-c017e67f1057)",
+ "Descendant msDS-ManagedServiceAccount Objects (Schema-Id-Guid: ce206244-5827-4a86-ba1c-1c0c386c1b64)"
+ ]
+}
+```
+
v1.0 Security Healthissue Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-healthissue-update.md
+
+ Title: "Update healthIssue"
+description: "Update the properties of a healthIssue object."
+
+ms.localizationpriority: medium
Last updated : 03/20/2024++
+# Update healthIssue
+
+Namespace: microsoft.graph.security
++
+Update the properties of a [healthIssue](../resources/security-healthissue.md) object.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "security_healthissue_update" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /security/identities/healthIssues/{healthIssueId}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|status|microsoft.graph.security.healthIssueStatus|The status of the health issue. The possible values are: `open`, `closed`, `suppressed`, `unknownFutureValue`.|
++
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.healthIssue](../resources/security-healthissue.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "sampleKeys": ["b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c"],
+ "name": "update_healthissue"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/security/identities/healthIssues/b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c
+Content-Type: application/json
+
+{
+ "status": "closed"
+}
+```
++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "@odata.type": "microsoft.graph.security.healthIssue",
+ "truncated": true,
+ "name": "update_healthissue"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.healthIssue",
+ "ID": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c",
+ "displayName": "Directory Services Object Auditing is not configured as required",
+ "healthIssueType": "Global",
+ "issueTypeId": "1031",
+ "severity": "medium",
+ "status": "closed",
+ "createdDateTime": "2022-07-15T12:19:27.7211305Z",
+ "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z",
+ "domainNames": [
+ "domain1.contoso.com",
+ "domain2.contoso.com"
+ ],
+ "sensorDNSNames": [
+ "DC1.domain1.contoso.com",
+ "DC2.domain2.contoso.com"
+ ],
+ "description": "Directory Services Object Auditing is not configured as required on domain1.contoso.com",
+ "recommendations": [
+ "Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"
+ ],
+ "recommendedActionCommands": [
+ "Import-Module DefenderForIdentity",
+ "Set-MDIConfiguration -Configuration DomainObjectAuditing -Mode Domain -Force"
+ ],
+ "additionalInformation": [
+ "Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)",
+ "Descendant Group Objects (Schema-Id-Guid: bf967a9c-0de6-11d0-a285-00aa003049e2)",
+ "Descendant Computer Objects (Schema-Id-Guid: bf967a86-0de6-11d0-a285-00aa003049e2)",
+ "Descendant msDS-GroupManagedServiceAccount Objects (Schema-Id-Guid: 7b8b558a-93a5-4af7-adca-c017e67f1057)",
+ "Descendant msDS-ManagedServiceAccount Objects (Schema-Id-Guid: ce206244-5827-4a86-ba1c-1c0c386c1b64)"
+ ]
+}
+```
+
v1.0 Security Identitycontainer List Healthissues https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-identitycontainer-list-healthissues.md
+
+ Title: "List healthIssues"
+description: "Get a list of health issue objects and their properties."
+
+ms.localizationpriority: medium
Last updated : 03/20/2024++
+# List healthIssues
+
+Namespace: microsoft.graph.security
++
+Get a list of [health issue](../resources/security-healthissue.md) objects and their properties.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "security_identitycontainer_list_healthissues" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/identities/healthIssues
+```
+
+## Optional query parameters
+
+This method supports the following OData query parameters to help customize the response: `$count`, `$filter`, `$skip`, `$top`. For general information, see [OData query parameters](/graph/query-parameters).
+
+The following examples show how to use optional query parameters.
+
+### Get all open health alerts
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/identities/healthIssues?$filter=Status eq 'open'
+```
+
+### Get the top five open health alerts
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/identities/healthIssues?$filter=Status eq 'open'&$top=5
+```
+
+### Get open health alerts based on issue type
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/identities/healthIssues?$filter=Status eq 'open' and healthIssueType eq 'global'
+GET /security/identities/healthIssues?$filter=Status eq 'open' and healthIssueType eq 'sensor'
+```
+
+### Get open health alerts based on severity
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq 'medium'
+GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq 'low'
+```
+
+See open global health alerts that domain name \ sensor DNS name ends with spesific value (name=contoso.com)
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/identities/healthissues?$filter=Status eq 'open' and healthIssueType eq 'global' and domainNames/any(s:endswith(s,'contoso.com'))
+GET /security/identities/healthissues?$filter=Status eq 'open' and healthIssueType eq 'global' and sensorDNSNames/any(s:endswith(s,'contoso.com'))
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [healthIssue](../resources/security-healthissue.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "name": "get_healthIssues"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/identities/healthIssues
+```
++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.healthIssue)",
+ "name": "get_healthIssues"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.healthIssue",
+ "ID": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c",
+ "displayName": "Directory Services Object Auditing is not configured as required",
+ "healthIssueType": "Global",
+ "issueTypeId": "1031",
+ "severity": "medium",
+ "status": "open",
+ "createdDateTime": "2022-07-15T12:19:27.7211305Z",
+ "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z",
+ "domainNames": [
+ "domain1.contoso.com",
+ "domain2.contoso.com"
+ ],
+ "sensorDNSNames": [
+ "DC1.domain1.contoso.com",
+ "DC2.domain2.contoso.com"
+ ],
+ "description": "Directory Services Object Auditing is not configured as required on domain1.contoso.com",
+ "recommendations": [
+ "Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"
+ ],
+ "recommendedActionCommands": [
+ "Import-Module DefenderForIdentity",
+ "Set-MDIConfiguration -Configuration DomainObjectAuditing -Mode Domain -Force"
+ ],
+ "additionalInformation": [
+ "Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)",
+ "Descendant Group Objects (Schema-Id-Guid: bf967a9c-0de6-11d0-a285-00aa003049e2)",
+ "Descendant Computer Objects (Schema-Id-Guid: bf967a86-0de6-11d0-a285-00aa003049e2)",
+ "Descendant msDS-GroupManagedServiceAccount Objects (Schema-Id-Guid: 7b8b558a-93a5-4af7-adca-c017e67f1057)",
+ "Descendant msDS-ManagedServiceAccount Objects (Schema-Id-Guid: ce206244-5827-4a86-ba1c-1c0c386c1b64)"
+ ]
+ }
+ ]
+}
+```
+
v1.0 Security Labelsroot Delete Authorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-authorities.md
The following example shows a request.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/security/labels/authorities/{authorityTemplateId}
+DELETE https://graph.microsoft.com/beta/security/labels/authorities/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5
``` # [C#](#tab/csharp)
DELETE https://graph.microsoft.com/beta/security/labels/authorities/{authorityTe
### Response
-The following example shows the response.
+Here's an example of the response.
> <!-- { "blockType": "response",
v1.0 Security Labelsroot Delete Categories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-categories.md
The following example shows a request.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}
+DELETE https://graph.microsoft.com/beta/security/labels/categories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5
``` # [C#](#tab/csharp)
DELETE https://graph.microsoft.com/beta/security/labels/categories/{categoryTemp
### Response
-The following example shows the response.
+Here's an example of the response.
> <!-- { "blockType": "response",
v1.0 Security Labelsroot Delete Citations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-citations.md
The following example shows a request.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/security/labels/citations/{citationTemplateId}
-```
+DELETE https://graph.microsoft.com/beta/security/labels/citations/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5
# [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/delete-citationtemplate-csharp-snippets.md)]
DELETE https://graph.microsoft.com/beta/security/labels/citations/{citationTempl
### Response
-The following example shows the response.
+Here's an example of the response.
> <!-- { "blockType": "response",
v1.0 Security Labelsroot Delete Departments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-departments.md
The following example shows a request.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/security/labels/departments/{departmentTemplateId}
+DELETE https://graph.microsoft.com/beta/security/labels/departments/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5
``` # [C#](#tab/csharp)
DELETE https://graph.microsoft.com/beta/security/labels/departments/{departmentT
### Response
-The following example shows the response.
+Here's an example of the response.
> <!-- { "blockType": "response",
v1.0 Security Labelsroot Delete Fileplanreferences https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-delete-fileplanreferences.md
The following example shows a request.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePlanReferenceTemplateId}
+DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5
``` # [C#](#tab/csharp)
DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/{file
### Response
-The following example shows the response.
+Here's an example of the response.
> <!-- { "blockType": "response",
v1.0 Security Labelsroot List Authorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-authorities.md
GET https://graph.microsoft.com/beta/security/labels/authorities
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",
- "displayName": "String",
+ "displayName": "Business",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ },
+ {
+ "@odata.type": "#microsoft.graph.security.authorityTemplate",
+ "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5",
+ "displayName": "Legal",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
} ] }
v1.0 Security Labelsroot List Categories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-categories.md
GET https://graph.microsoft.com/beta/security/labels/categories
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",
- "displayName": "String",
+ "displayName": "Accounts Payable",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
- }
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ },
+ {
+ "@odata.type": "#microsoft.graph.security.categoryTemplate",
+ "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5",
+ "displayName": "Accounts",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
] } ```
v1.0 Security Labelsroot List Citations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-citations.md
GET https://graph.microsoft.com/beta/security/labels/citations
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",
- "displayName": "String",
+ "displayName": "Contoso Company Policy",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)",
- "citationUrl": "String",
- "citationJurisdiction": "String"
+ "createdDateTime": "2021-03-24T02:09:08Z",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "Contoso"
} ] }
v1.0 Security Labelsroot List Departments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-departments.md
GET https://graph.microsoft.com/beta/security/labels/departments
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",
- "displayName": "String",
+ "displayName": "Finance",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime": "2021-03-24T02:09:08Z"
} ] }
v1.0 Security Labelsroot List Fileplanreferences https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-fileplanreferences.md
GET https://graph.microsoft.com/beta/security/labels/filePlanReferences
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",
- "displayName": "String",
+ "displayName": "FIN 01-02-001",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime": "2021-03-24T02:09:08Z"
} ] }
v1.0 Security Labelsroot List Retentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-list-retentionlabel.md
If successful, this method returns a `200 OK` response code and a collection of
## Examples ### Request-
+Here's an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
GET https://graph.microsoft.com/beta/security/labels/retentionLabels
### Response
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
- "displayName": "String",
- "behaviorDuringRetentionPeriod": "String",
- "actionAfterRetentionPeriod": "String",
- "retentionTrigger": "String",
+ "displayName": "Retention Schedule 10004",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "relabel",
+ "retentionTrigger": "dateCreated",
"retentionDuration": {
- "@odata.type": "microsoft.graph.security.retentionDuration"
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": "730"
},
- "isInUse": "Boolean",
- "descriptionForAdmins": "String",
- "descriptionForUsers": "String",
+ "isInUse": true,
+ "descriptionForAdmins": "creation based retention label for schedule 10004",
+ "descriptionForUsers": "retains for 2 years then relabeled",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)",
+ "createdDateTime": "2017-11-27T02:10:12Z",
"lastModifiedBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "9563a605-e827-4324-a5a9-09efddff1e90",
+ "displayName": "Records Manager"
+ }
},
- "lastModifiedDateTime": "String (timestamp)",
- "labelToBeApplied": "String",
- "defaultRecordBehavior": "String"
+ "lastModifiedDateTime": "2020-08-28T22:13:09Z",
+ "labelToBeApplied": "Retention schedule 10005",
+ "defaultRecordBehavior": "startLocked"
} ] }
v1.0 Security Labelsroot Post Authorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-authorities.md
You can specify the following properties when creating a **authorityTemplate**.
|Property|Type|Description| |:|:|:|
-|displayName|String|Unique string that defines an authortiy name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).|
+|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).|
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.authorityTemplate",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- }
+ "displayName": "Business",
} ```
Content-Type: application/json
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",
- "displayName": "String",
+ "displayName": "Business",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime" : "2021-03-24T02:09:08Z"
} ```
v1.0 Security Labelsroot Post Categories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-categories.md
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.categoryTemplate",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- }
+ "displayName": "Accounts Payable",
} ```
Content-Type: application/json
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",
- "displayName": "String",
+ "displayName": "Accounts Payable",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime" : "2021-03-24T02:09:08Z"
} ```
v1.0 Security Labelsroot Post Citations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-citations.md
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.citationTemplate",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "citationUrl": "String",
- "citationJurisdiction": "String"
+ "displayName": "Contoso Company Policy",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "Contoso"
} ```
Content-Type: application/json
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "displayName": "Contoso Company Policy",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
+ "createdDateTime" : "2021-03-24T02:09:08Z",
"createdDateTime": "String (timestamp)",
- "citationUrl": "String",
+ "citationUrl": "www.citationUrl.com",
"citationJurisdiction": "String" } ```
v1.0 Security Labelsroot Post Departments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-departments.md
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.departmentTemplate",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- }
+ "displayName": "Finance",
} ```
Content-Type: application/json
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",
- "displayName": "String",
+ "displayName": "Finance",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime" : "2021-03-24T02:09:08Z"
} ```
v1.0 Security Labelsroot Post Fileplanreferences https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
- "displayName": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- }
+ "displayName": "FIN 01-02-001",
} ```
Content-Type: application/json
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",
- "displayName": "String",
+ "displayName": "FIN 01-02-001",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
},
- "createdDateTime": "String (timestamp)"
+ "createdDateTime" : "2021-03-24T02:09:08Z"
} ```
v1.0 Security Labelsroot Post Retentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-labelsroot-post-retentionlabel.md
Specify the following properties when you create a **retentionLabel**.
|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained. | |retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content. | |retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`. |
-|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`. |
+|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it's created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`. |
|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. |
If successful, this method returns a `201 Created` response code and a [microsof
## Examples ### Request
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
Content-length: 555
{ "@odata.type": "#microsoft.graph.security.retentionLabel",
- "displayName": "String",
- "behaviorDuringRetentionPeriod": "String",
- "actionAfterRetentionPeriod": "String",
- "retentionTrigger": "String",
+ "displayName": "Retention Schedule 10005",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "startDispositionReview",
+ "retentionTrigger": "dateOfEvent",
+ "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')",
"retentionDuration": {
- "@odata.type": "microsoft.graph.security.retentionDuration"
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 2555
},
- "isInUse": "Boolean",
- "descriptionForAdmins": "String",
- "descriptionForUsers": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "labelToBeApplied": "String",
- "defaultRecordBehavior": "String",
+ "dispositionReviewStages": [
+ {
+ "stageNumber" : 1,
+ "name": "Stage1",
+ "reviewersEmailAddresses ": [
+ "Admin@contoso.onmicrosoft.com"
+ ]
+ }
+ ],
+ "descriptionForAdmins": "retain for 7 years",
+ "descriptionForUsers": "retain for 7 years",
"descriptors": { "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')", "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')",
Content-length: 555
"departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')", "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')" },
+ "defaultRecordBehavior":"startLocked",
} ```
Content-length: 555
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
- "displayName": "String",
- "behaviorDuringRetentionPeriod": "String",
- "actionAfterRetentionPeriod": "String",
- "retentionTrigger": "String",
+ "displayName": "Retention Schedule 10005",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "startDispositionReview",
+ "retentionTrigger": "dateOfEvent",
"retentionDuration": {
- "@odata.type": "microsoft.graph.security.retentionDuration"
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 2555
},
- "isInUse": "Boolean",
- "descriptionForAdmins": "String",
- "descriptionForUsers": "String",
+ "dispositionReviewStages": [
+ {
+ "stageNumber" : 1,
+ "name": "Stage1",
+ "reviewersEmailAddresses ": [
+ "Admin@contoso.onmicrosoft.com"
+ ]
+ }
+ ],
+ "isInUse": true,
+ "descriptionForAdmins": "retain for 7 years",
+ "descriptionForUsers": "retain for 7 years",
+ "defaultRecordBehavior":"startLocked",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)",
- "lastModifiedBy": {
- "@odata.type": "microsoft.graph.identitySet"
+ "user": {
+ "id": "9563a605-e827-4324-a5a9-09efddff1e90",
+ "displayName": "Admin"
+ }
},
- "lastModifiedDateTime": "String (timestamp)",
- "labelToBeApplied": "String",
- "defaultRecordBehavior": "String",
+ "createdDateTime": "2021-08-23T16:43:55Z",
+ "labelToBeApplied": " ",
+ "defaultRecordBehavior": "startLocked",
"descriptors": { "authority": { "displayName": "Business"
v1.0 Security Retentionevent Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionevent-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
## Examples ### Request-
+Here's an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
GET https://graph.microsoft.com/beta/security/triggers/retentionEvents/{retentio
### Response
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"description": "String", "eventQueries": [ {
- "@odata.type": "microsoft.graph.security.eventQueries"
+ "@odata.type": "microsoft.graph.security.eventQuery"
} ], "eventTriggerDateTime": "String (timestamp)",
v1.0 Security Retentionevent List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionevent-list.md
If successful, this method returns a `200 OK` response code and a collection of
## Examples ### Request-
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/security/triggers/retentionEvents
### Response
+Here's an example of a request.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"description": "String", "eventQueries": [ {
- "@odata.type": "microsoft.graph.security.eventQueries"
+ "@odata.type": "microsoft.graph.security.eventQuery"
} ], "eventTriggerDateTime": "String (timestamp)",
v1.0 Security Retentionevent Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionevent-post.md
Title: "Create retentionEvent" description: "Create a new retentionEvent object."-+ ms.localizationpriority: medium doc_type: apiPageType
Specify the following properties when creating a **retentionEvent**.
|:|:|:| |description|String|Optional information about the event.| |displayName|String|Name of the event.|
-|eventQuery|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.|
+|eventQuery|[microsoft.graph.security.eventQuery](../resources/security-eventquery.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.|
|eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |retentionEventType|String|Name of the event type associated with the event.|
If successful, this method returns a `201 Created` response code and a [microsof
## Examples ### Request
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
Content-length: 616
"description": "String", "eventQueries": [ {
- "@odata.type": "microsoft.graph.security.eventQueries"
+ "@odata.type": "microsoft.graph.security.eventQuery"
} ], "eventTriggerDateTime": "String (timestamp)",
Content-length: 616
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"description": "String", "eventQueries": [ {
- "@odata.type": "microsoft.graph.security.eventQueries"
+ "@odata.type": "microsoft.graph.security.eventQuery"
} ], "eventTriggerDateTime": "String (timestamp)",
v1.0 Security Retentionlabel Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionlabel-delete.md
If successful, this method returns a `204 No Content` response code.
## Examples ### Request
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
If successful, this method returns a `204 No Content` response code.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}
+DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50
``` # [C#](#tab/csharp)
DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retenti
### Response
+Here's an example of the response.
+ > <!-- { "blockType": "response",
v1.0 Security Retentionlabel Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionlabel-get.md
GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabel
``` ## Optional query parameters
-This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType`. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType` or `$expand=descriptors`. For general information, see [OData query parameters](/graph/query-parameters).
## Request headers |Name|Description|
If successful, this method returns a `200 OK` response code and a [microsoft.gra
## Examples ### Request
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retention
### Response
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"value": { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
- "displayName": "String",
- "behaviorDuringRetentionPeriod": "String",
- "actionAfterRetentionPeriod": "String",
- "retentionTrigger": "String",
- "retentionDuration": {
- "@odata.type": "microsoft.graph.security.retentionDuration"
- },
- "isInUse": "Boolean",
- "descriptionForAdmins": "String",
- "descriptionForUsers": "String",
- "createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)",
- "lastModifiedBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "lastModifiedDateTime": "String (timestamp)",
- "labelToBeApplied": "String",
- "defaultRecordBehavior": "String"
+ "displayName": "Retention Schedule 10004",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "relabel",
+ "retentionTrigger": "dateCreated",
+ "retentionDuration": {
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 730
+ },
+ "isInUse": true,
+ "descriptionForAdmins": "creation based retention label for schedule 10004",
+ "descriptionForUsers": "retains for 2 years then relabeled",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2017-11-27T02:10:12Z",
+ "lastModifiedBy": {
+ "user": {
+ "id": "9563a605-e827-4324-a5a9-09efddff1e90",
+ "displayName": "Records Manager"
+ }
+ },
+ "lastModifiedDateTime": "2020-08-28T22:13:09Z",
+ "labelToBeApplied": "Retention schedule 10005",
+ "defaultRecordBehavior": "startLocked"
} } ```
v1.0 Security Retentionlabel Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-retentionlabel-update.md
PATCH /security/labels/retentionLabels/{retentionLabelId}
|descriptionForUsers|String|This is an optional property that provides the label information for the user.| |dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained.| |retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.|
-|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.|
+|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.|
|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | ## Response
-If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body.
+If successful, this method returns a `204 No Content` response code.
## Examples ### Request
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
If successful, this method returns a `200 OK` response code and an updated [micr
} --> ``` http
-PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}
+PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50
Content-Type: application/json Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": {
- "@odata.type": "microsoft.graph.security.retentionDuration"
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 2555
},
- "descriptionForAdmins": "String",
- "descriptionForUsers": "String",
- "labelToBeApplied": "String",
- "defaultRecordBehavior": "String"
} ```
Content-length: 555
### Response
->**Note:** The response object shown here might be shortened for readability.
+Here's an example of the response.
+ <!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.security.retentionLabel"
+ "blockType": "response"
} --> ``` http
-HTTP/1.1 200 OK
-Content-Type: application/json
-
-{
- "@odata.type": "#microsoft.graph.security.retentionLabel",
- "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
- "retentionDuration": {
- "@odata.type": "microsoft.graph.security.retentionDuration"
- },
- "descriptionForAdmins": "String",
- "descriptionForUsers": "String",
- "labelToBeApplied": "String",
- "defaultRecordBehavior": "String"
-}
+HTTP/1.1 204 No Content
```
v1.0 Security Subcategorytemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-subcategorytemplate-get.md
Choose the permission or permissions marked as least privileged for this API. Us
} --> ``` http
-GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}
+GET /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId}
``` ## Optional query parameters
The following example shows a request.
} --> ``` http
-GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}
+GET https://graph.microsoft.com/beta/security/labels/categories/82d00422-1f60-46cd-9809-33ca0b4d2286/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0
``` # [JavaScript](#tab/javascript)
GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionL
### Response
-The following example shows the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
"value": { "@odata.type": "#microsoft.graph.security.subCategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",
- "displayName": "String",
+ "displayName": "Vendor Invoice",
"createdBy": {
- "@odata.type": "microsoft.graph.identitySet"
- },
- "createdDateTime": "String (timestamp)"
- }
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+ } ```
v1.0 Site Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-delta.md
description: "Get newly created, updated, or deleted sites without having to perform a full read of the entire sites collection." Title: "site: delta" ms.localizationpriority: "medium"+ doc_type: apiPageType
The following example shows the initial request and how to call this API to esta
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_sites_delta_first", "tags": "service.graph" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/sites/delta ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more sites are available in the current set of sites. Your app should continue to request the URL value of **@odata.nextLink** until all pages of sites are retrieved.
The following example shows a request that accesses the last page in a set and h
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get-sites-delta-last", "tags": "service.graph" }-->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/sites/delta?token=1230919asd190410jlka ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response that indicates that the site named `AllCompany` was deleted between the initial request and this request to update the local state.
To retrieve the latest `deltaLink`, call `delta` with the query string parameter
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get-sites-delta-latest", "scopes": "sites.read", "tags": "service.graph", "target": "action" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/sites/delta?token=latest ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
v1.0 Site Follow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-follow.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/follow-site-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/follow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Site Unfollow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-unfollow.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/unfollow-site-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/unfollow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Team List Allchannels https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-list-allchannels.md
Don't supply a request body for this method.
## Response
-If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
+If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body. The response also includes the **@odata.id** property, which can be used to access the channel and run other operations on the [channel](../resources/channel.md) object.
> [!Note]
-> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more details, see [Known issues with Microsoft Graph](https://developer.microsoft.com/en-us/graph/known-issues/?search=14971).
+> Currently, invoking the URL returned from the **@odata.id** property fails for cross-tenant shared channels. You can solve this issue if you remove the `/tenants/{tenant-id}` part from the URL before you call this API. For more information, see [Known issues with Microsoft Graph](https://developer.microsoft.com/en-us/graph/known-issues/?search=14971).
## Examples
Content-Type: application/json
"displayName": "General", "description": "AutoTestTeam_20210311_150740.2550_fim3udfdjen9", "membershipType": "standard",
+ "isArchived": false,
"tenantId": "b3246f44-b4gb-4627-96c6-25b18fa2c910" }, {
Content-Type: application/json
"createdDateTime": "2020-05-27T19:22:25.692Z", "displayName": "Shared channel from Contoso", "membershipType": "shared",
+ "isArchived": false,
"tenantId": "b3246f44-b4gb-5678-96c6-25b18fa2c910" } ]
Content-Type: application/json
"membershipType": "shared", "tenantId": "b3246f44-b4gb-5678-96c6-25b18fa2c910", "email": "someperson@microsoft.com",
- "moderationSettings": null
+ "moderationSettings": null,
+ "isArchived": false,
+ "tenantId": "b3246f44-b4gb-5678-96c6-25b18fa2c910"
} ] }
v1.0 Team Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-post-members.md
If successful, this method returns a `201 Created` response code and a [conversa
For best results, stagger calls with a 2 second buffer.
+> [!NOTE]
+> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user.
+ ## Examples ### Example 1: Add a member to a team
v1.0 Training Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/training-get.md
GET /security/attackSimulation/trainings/{trainingId}
## Optional query parameters
-This method does not currently support the [OData query parameters](/graph/query-parameters) to customize the response.
+This method doesn't currently support [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers
Content-Type: application/json
"email": "yibsu", "id": null, "displayName": null
- }
+ },
+ "customUrl" : null
} ```
v1.0 Trainingcampaign Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trainingcampaign-get.md
+
+ Title: "Get trainingCampaign"
+description: "Read the properties and relationships of a trainingCampaign object."
+
+ms.localizationpriority: medium
++
+# Get trainingCampaign
+
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [trainingCampaign](../resources/trainingcampaign.md) object.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "trainingcampaign-get-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}
+```
+
+## Optional query parameters
+
+This method supports some of 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. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [trainingCampaign](../resources/trainingcampaign.md) object in the response body.
+
+## Examples
+
+### Example 1: Get a training campaign
+
+The following example shows how to get an attack simulation campaign for a tenant.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name" : "get_trainingcampaign"
+}-->
+
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++++
+#### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.trainingCampaign",
+ "name" : "get_trainingcampaign"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "id": "81c59451-2929-5b39-86f0-5a2b15f1314f",
+ "displayName": "graph toc update 2",
+ "description": "Graph Test",
+ "createdDateTime": "2024-02-18T08:36:07.6534871Z",
+ "lastModifiedDateTime": "2024-02-19T08:00:01.9417887Z",
+ "endUserNotificationSetting": null,
+ "includedAccountTarget": null,
+ "excludedAccountTarget": null,
+ "trainingSetting": null,
+ "report": null,
+ "campaignSchedule": {
+ "launchDateTime": "2024-02-18T08:37:44Z",
+ "completionDateTime": "2024-02-19T07:59:44Z",
+ "status": "completed"
+ },
+ "createdBy": {
+ "email": "attacksim@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com",
+ "id": "478a22cd-aecc-41df-b995-88c8de17aaf5",
+ "displayName": "attacksim"
+ },
+ "lastModifiedBy": {
+ "email": "attacksim@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com",
+ "id": "478a22cd-aecc-41df-b995-88c8de17aaf5",
+ "displayName": "attacksim"
+ }
+}
+```
+
+### Example 2: Get included account targets
+
+The following example shows how to get included account targets (users) for a Training campaign for a tenant.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name" : "get_trainingcampaign_includedtargets"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/includedAccountTarget
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++++
+#### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accountTargetContent",
+ "name" : "get_trainingcampaign_includedtargets"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
+ "type": "addressBook",
+ "accountTargetEmails": [
+ "john@contoso.com"
+ ]
+}
+```
+
+### Example 3: Get excluded account targets
+
+The following example shows how to get the excluded account targets (users) for a Training campaign for a tenant.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name" : "get_trainingcampaign_excludedtargets"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/excludedAccountTarget
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++++
+#### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accountTargetContent",
+ "name" : "get_trainingcampaign_excludedtargets"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
+ "type": "addressBook",
+ "accountTargetEmails": [
+ "alie@contoso.com"
+ ]
+}
+```
+
+### Example 4: Get training setting
+
+The following example shows how to get training setting details for a training campaign.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name" : "get_trainingcampaign_training"
+}
+-->
+
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/trainingSetting
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++++
+#### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.trainingSetting",
+ "name" : "get_trainingcampaign_training"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "trainingCompletionDuration": "0",
+ "completionDateTime": "2024-02-19T07:59:44Z",
+ "settingType": "microsoftManaged"
+}
+```
+
+### Example 5: Get end user notification setting
+
+The following example shows how to get end user notification setting details for a training campaign.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name" : "get_trainingcampaign_eun"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/endUserNotificationSetting
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++++
+#### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.endUserNotificationSetting",
+ "name" : "get_trainingcampaign_eun"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "settingType": "trainingSelected",
+ "positiveReinforcement": null,
+ "notificationPreference": "microsoft",
+ "trainingAssignment" : {
+ "deliveryFrequency": "unknown",
+ "defaultLanguage": "en",
+ "endUserNotification": {
+ "id": "36fb4dc1-7c37-4b96-9096-12e6d6014fae",
+ "displayName": "Microsoft default training only campaign-training assignment notification"
+ }
+ },
+ "trainingReminder" : {
+ "deliveryFrequency": "weekly",
+ "defaultLanguage": "en",
+ "endUserNotification": {
+ "id": "fe521249-9901-4584-a987-026a9980c58e",
+ "displayName": "Microsoft default training only campaign-training reminder notification"
+ }
+ }
+}
+```
v1.0 Trainingcampaign Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trainingcampaign-update.md
+
+ Title: "Update trainingCampaign"
+description: "Update the properties of a trainingCampaign object."
+
+ms.localizationpriority: medium
++
+# Update trainingCampaign
+
+Namespace: microsoft.graph
++
+Update the properties of a [trainingCampaign](../resources/trainingcampaign.md) object.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "trainingcampaign-update-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /security/attackSimulation/trainingCampaigns/{trainingCampaignId}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who created the training campaign. Optional.|
+|createdDateTime|DateTimeOffset|The date and time of creation of the training campaign. Optional.|
+|description|String|The description of the training campaign. Optional.|
+|displayName|String|The display name of the training campaign. Required.|
+|endUserNotificationSetting|[endUserNotificationSetting](../resources/endusernotificationsetting.md)|Details about the end user notification setting. Required.|
+|excludedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are excluded from the training campaign. Optional.|
+|includedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are targeted in the training campaign. Required.|
+|lastModifiedDateTime|DateTimeOffset|The identity of the user who most recently modified the training campaign. Optional.|
+|trainingSetting|[trainingSetting](../resources/trainingsetting.md)|Details about the training settings for a training campaign. Required.|
+|campaignSchedule|[campaignSchedule](../resources/campaignschedule.md)|Details about the schedule and current status for a training campaign. Required.|
+
+## Response
+
+If successful, this method returns a `202 Accepted` response code and a tracking header named `location` in the response.
+
+## Example
+
+The following example shows how to update the status of the training campaign. In this case, a scheduled training campaign is canceled.
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_trainingcampaign"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/{trainingCampaignId}
+Content-Type: application/json
+
+{
+ "displayName": "Graph Training Campaign",
+ "description": "Graph Training Campaign Description",
+ "createdBy": {
+ "email": "john@contoso.com"
+ },
+ "lastModifiedBy": {
+ "email": "john@contoso.com"
+ },
+ "includedAccountTarget": {
+ "type": "addressBook",
+ "accountTargetEmails": [
+ "john@contoso.com"
+ ]
+ },
+ "endUserNotificationSetting": {
+ "notificationPreference": "microsoft",
+ "settingType": "trainingSelected",
+ "trainingReminder": {
+ "deliveryFrequency": "weekly",
+ "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('fe521249-9901-4584-a987-026a9980c58e')",
+ "defaultLanguage": "en"
+ },
+ "trainingAssignment": {
+ "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('36fb4dc1-7c37-4b96-9096-12e6d6014fae')",
+ "defaultLanguage": "en"
+ }
+ },
+ "trainingSetting": {
+ "settingType": "microsoftCustom",
+ "trainingAssignmentMappings": [
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('40454905-dc26-4f36-b854-3042a5362cb3')"
+ },
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('ea70ae06-3859-4818-be9d-270ee81d80a4')"
+ },
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('d733d88c-1b5a-48e3-a588-9910e41ac21d')"
+ }
+ ]
+ },
+ "campaignSchedule": {
+ "launchDateTime": "2024-02-15T07:59:44Z",
+ "completionDateTime": "2024-02-18T07:59:44Z",
+ "status": "Cancelled"
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+```http
+HTTP/1.1 202 Accepted
+```
+
v1.0 Trainingcampaignreportoverview Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trainingcampaignreportoverview-get.md
+
+ Title: "Get trainingCampaignReportOverview"
+description: "Get an overview of a training campaign."
+
+ms.localizationpriority: medium
++
+# Get trainingCampaignReportOverview
+Namespace: microsoft.graph
++
+Get an overview of a training campaign.
+
+## Permissions
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "trainingcampaignreportoverview_get" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/overview
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [trainingCampaignReportOverview](../resources/trainingcampaignreportoverview.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/report/overview
+```
+++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.trainingCampaignReportOverview"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "trainingModuleCompletion": {
+ "trainingsAssignedUserCount": 1,
+ "assignedTrainingsInfos": [
+ {
+ "assignedUserCount": 1,
+ "completedUserCount": 0,
+ "displayName": "Identity Theft"
+ },
+ {
+ "assignedUserCount": 1,
+ "completedUserCount": 0,
+ "displayName": "Introduction to Information Security"
+ },
+ {
+ "assignedUserCount": 1,
+ "completedUserCount": 0,
+ "displayName": "Malware"
+ }
+ ]
+ },
+ "userCompletionStatus": {
+ "notStartedUsersCount": 0,
+ "completedUsersCount": 0,
+ "inProgressUsersCount": 1,
+ "notCompletedUsersCount": 0,
+ "previouslyAssignedUsersCount": 0
+ },
+ "trainingNotificationDeliveryStatus": {
+ "resolvedTargetsCount": 1,
+ "successfulMessageDeliveryCount": 1,
+ "failedMessageDeliveryCount": 0
+ }
+}
+```
+
v1.0 User List Memberof https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-memberof.md
Choose the permission or permissions marked as least privileged for this API. Us
[!INCLUDE [limited-info](../../includes/limited-info.md)]
+> [!TIP]
+> - Calling the `/me/memberOf` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when you use the `/me/memberOf` endpoint.
+> - To list the members of a group with hidden membership, the `Member.Read.Hidden` permission is required.
+ ## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Usersettings List Windows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/usersettings-list-windows.md
GET https://graph.microsoft.com/beta/me/settings/windows
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting1-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/me/settings/windows?$filter=settingType eq
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting2-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting2-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/me/settings/windows?$filter=settingType eq
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting3-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting3-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/me/settings/windows?$filter=windowsDeviceId
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting4-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting4-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Usertrainingcampaigndetails List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/usertrainingcampaigndetails-list.md
+
+ Title: "List campaign users"
+description: "List users of a tenant and their online actions in a training campaign."
+
+ms.localizationpriority: medium
++
+# List trainingCampaignUsers
+Namespace: microsoft.graph
++
+List users of a tenant and their online actions in a training campaign.
+
+## Permissions
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "usersimulationdetails_list" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers
+```
+
+## Optional query parameters
+
+This method supports the `$count`, `$skipToken`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response.
+
+If the result set spans multiple pages, the response body contains an `@odata.nextLink` that you can use to page through the result set.
+
+The following list shows some examples of requests that use the supported OData query parameters:
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers?$count=true
+GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers?$skipToken={skipToken}
+GET /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/report/campaignUsers?$top=1
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [userSimulationDetails](../resources/usersimulationdetails.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "list_campaignusersdetails"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/report/campaignUsers
+```
+
+# [JavaScript](#tab/javascript)
+++++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.userSimulationDetails)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "isCompromised": true,
+ "compromisedDateTime": "2021-01-01T01:02:01.01Z",
+ "simulationEvents": [
+ {
+ "eventName": "SuccessfullyDeliveredEmail",
+ "eventDateTime": "2021-01-01T01:01:01.01Z",
+ "ipAddress": "100.200.100.200",
+ "osPlatformDeviceDetails": "Sample OS",
+ "browser": "Sample Browser"
+ },
+ {
+ "eventName": "EmailLinkClicked",
+ "eventDateTime": "2021-01-01T01:02:01.01Z",
+ "ipAddress": "100.200.100.200",
+ "osPlatformDeviceDetails": "Sample OS",
+ "browser": "Sample Browser"
+ }
+ ],
+ "trainingEvents": [
+ {
+ "displayName": "Sample Training",
+ "latestTrainingStatus": "assigned",
+ "trainingAssignedProperties": {
+ "contentDateTime": "2021-01-01T01:03:01.01Z",
+ "ipAddress": "100.200.100.200",
+ "osPlatformDeviceDetails": "Sample OS",
+ "browser": "Sample Browser",
+ "potentialScoreImpact": 5.0
+ },
+ "trainingUpdatedProperties": {
+ "contentDateTime": "2021-01-01T01:04:01.01Z",
+ "ipAddress": "100.200.100.201",
+ "osPlatformDeviceDetails": "Sample OS-2",
+ "browser": "Sample Browser",
+ "potentialScoreImpact": 5.0
+ },
+ "trainingCompletedProperties": {
+ "contentDateTime": "2021-01-01T01:05:01.01Z",
+ "ipAddress": "100.200.100.202",
+ "osPlatformDeviceDetails": "Sample OS",
+ "browser": "Sample Browser-2",
+ "potentialScoreImpact": 5.0
+ }
+ }
+ ],
+ "assignedTrainingsCount": 1,
+ "completedTrainingsCount": 0,
+ "inProgressTrainingsCount": 0,
+ "reportedPhishDateTime": "2021-01-01T01:01:01.01Z",
+ "simulationUser": {
+ "userId": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
+ "displayName": "Reed Flores",
+ "email": "reed@contoso.com"
+ }
+ }
+ ]
+}
+```
+
v1.0 Virtualendpoint List Provisioningpolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-provisioningpolicies.md
Content-Type: application/json
"@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",
- "domainJoinConfiguration": {
- "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
- "type": "hybridAzureADJoin"
- },
"domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
Content-Type: application/json
], "enableSingleSignOn": true, "id": "1d164206-bf41-4fd2-8424-a3192d39ffff",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
"imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType":"custom",
- "windowsSettings": {
- "language": "en-US"
- },
"windowsSetting": { "locale": "en-US" },
v1.0 Virtualendpoint Post Provisioningpolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-post-provisioningpolicies.md
The following table lists the properties that are required when you create the [
|imageType|cloudPcProvisioningPolicyImageType|The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: `gallery`, `custom`.| |provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs using this policy. By default, the license type is `dedicated` if the **provisioningType** isn't specified when you create the **cloudPcProvisioningPolicy**. You can't change this property after the **cloudPcProvisioningPolicy** was created. Possible values are: `dedicated`, `shared`, `unknownFutureValue`.| |windowsSetting|[cloudPcWindowsSettings](../resources/cloudpcwindowssetting.md)|Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. |
-|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID.|
-|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.|
+|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID. The **domainJoinConfiguration** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
+|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service. The **onPremisesConnectionId** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
|windowsSettings (deprecated)|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. The **windowsSettings** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **windowsSetting** property.| ## Response
v1.0 Windowssetting Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowssetting-get.md
GET https://graph.microsoft.com/beta/me/settings/windows/{windowsSettingId}
[!INCLUDE [sample-code](../includes/snippets/php/get-windowssetting-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-windowssetting-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Windowssetting List Instances https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowssetting-list-instances.md
GET https://graph.microsoft.com/beta/me/settings/windows/{windowsSettingId}/inst
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssettinginstance-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Windowssettinginstance Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowssettinginstance-get.md
GET https://graph.microsoft.com/beta/me/settings/windows/{windowsSettingId}/inst
[!INCLUDE [sample-code](../includes/snippets/php/get-windowssettinginstance-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Windowsupdates Product Findbycatalogid https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-product-findbycatalogid.md
Title: "product: findByCatalogId"
description: "Find the product revisions associated with a catalog ID and the known issues directly or indirectly related to the catalog ID." ms.localizationpriority: medium-+ doc_type: apiPageType
If successful, this method returns a `200 OK` response code and a collection of
### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "windowsupdates.FindByCatalogId"
The following example shows a request.
GET https://graph.microsoft.com/beta/admin/windows/updates/products/FindByCatalogId(catalogID='10cb1ba292c5586e22c9991be3f12fbd39f2ebf231cb5d201c67f42fbaccc567')?expand=revisions($expand=catalogEntry,knowledgeBaseArticle),knownIssues($expand=originatingKnowledgeBaseArticle,resolvingKnowledgeBaseArticle) ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Windowsupdates Product Findbykbnumber https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-product-findbykbnumber.md
Title: "product: findByKbNumber"
description: "Find the product revisions associated with a knowledge base number and the known issues directly or indirectly related to the knowledge base number." ms.localizationpriority: medium-+ doc_type: apiPageType
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "windowsupdates.findByCatalogId"
The following example shows a request.
GET https://graph.microsoft.com/beta/admin/windows/updates/products/FindByKbNumber(kbNumber=5029332)?expand=revisions($expand=catalogEntry,knowledgeBaseArticle),knownIssues ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Windowsupdates Product Getknownissuesbytimerange https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-product-getknownissuesbytimerange.md
Title: "product: getKnownIssuesByTimeRange"
description: "Get known issues related to a particular product based on a specified timeframe in the past." ms.localizationpriority: medium-+ doc_type: apiPageType
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "windowsupdates.GetKnownIssuesByTimeRange",
The following example shows a request.
GET https://graph.microsoft.com/beta/admin/windows/updates/products/1/GetKnownIssuesByTimeRange(daysInPast=70,includeAllActive=false) ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Accesspackageresource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageresource.md
In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md),
|displayName|String|The display name of the resource, such as the application name, group name, or site name.| |id|String| Read-only.| |isPendingOnboarding|Boolean|`True` if the resource is not yet available for assignment. Read-only. |
-|originId|String|The unique identifier of the resource in the origin system. In the case of a Microsoft Entra group, originId is the identifier of the group. |
-|originSystem|String|The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication`, or `AadGroup`.|
+|originId|String|The unique identifier of the resource in the origin system. In the case of a Microsoft Entra group, originId is the identifier of the group. Supports `$filter` (`eq`).|
+|originSystem|String|The type of the resource in the origin system, such as `SharePointOnline`, `AadApplication`, or `AadGroup`. Supports `$filter` (`eq`).|
|resourceType|String|The type of the resource, such as `Application` if it is a Microsoft Entra connected application, or `SharePoint Online Site` for a SharePoint Online site.| |url|String|A unique resource locator for the resource, such as the URL for signing a user into an application.|
v1.0 Application https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/application.md
This resource supports:
| requiredResourceAccess |[requiredResourceAccess](requiredresourceaccess.md) collection| Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. <br/><br/>No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). Not nullable. <br><br>Supports `$filter` (`eq`, `not`, `ge`, `le`).| | samlMetadataUrl | String | The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable. | | serviceManagementReference | String | References application or service contact information from a Service or Asset Management database. Nullable. |
-| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` (default), and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).|
+| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg` (default), `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount`, and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).|
| servicePrincipalLockConfiguration | [servicePrincipalLockConfiguration](servicePrincipalLockConfiguration.md) | Specifies whether sensitive properties of a multitenant application should be locked for editing after the application is provisioned in a tenant. Nullable. `null` by default. | | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | | tags |String collection| Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here also appear in the **tags** property of any associated [service principals](serviceprincipal.md).<br><br>Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`) and `$search`.|
This resource supports:
| Value | Description | |:|:--|
-|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).|
+|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant). This is the default value for the **signInAudience** property.|
|AzureADMultipleOrgs|Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).|
-|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. This is the default value for the **signInAudience** property.|
+|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. |
|PersonalMicrosoftAccount|Users with a personal Microsoft account only.| ### Limits on requested permissions per app
v1.0 Attacksimulationroot https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attacksimulationroot.md
Title: "attackSimulationRoot resource type"
-description: "Represents an abstract type that provides the ability to launch a realistic phishing attack that organizations can learn from."
+description: "Represents an abstract type for launching realistic phishing attacks that organizations can learn from."
ms.localizationpriority: medium
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents an abstract type that provides the ability to launch a realistic phishing attack that organizations can learn from.
+Represents an abstract type for launching realistic phishing attacks that organizations can learn from.
## Methods
Represents an abstract type that provides the ability to launch a realistic phis
| **Training** | | | |[List trainings](../api/attacksimulationroot-list-trainings.md)|[training](../resources/training.md) collection|Get a list of the [training](../resources/training.md) objects and their properties.| |[Get training](../api/training-get.md)|[training](../resources/training.md)|Get an attack simulation [training](../resources/training.md) for a tenant. |-
+|[List trainingCampaigns](../api/attacksimulationroot-list-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md) collection|Get the trainingCampaign resources from the trainingCampaigns navigation property.|
+|[Create trainingCampaign](../api/attacksimulationroot-post-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md)|Create a new trainingCampaign object.|
## Properties None.
None.
|simulationAutomations|[simulationAutomation](../resources/simulationautomation.md) collection|Represents simulation automation created to run on a tenant.| |simulations|[simulation](../resources/simulation.md) collection|Represents an attack simulation training campaign in a tenant.| |trainings|[training](../resources/training.md) collection|Represents details about attack simulation trainings.|
+|trainingCampaigns|[trainingCampaign](../resources/trainingcampaign.md) collection|Represents a training campaign in a tenant.|
## JSON representation
-Here's a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Campaignschedule https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/campaignschedule.md
+
+ Title: "campaignSchedule resource type"
+description: "Represents a schedule for launching a campaign."
+
+ms.localizationpriority: medium
++
+# campaignSchedule resource type
+
+Namespace: microsoft.graph
++
+Represents a schedule for launching a campaign.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|completionDateTime|DateTimeOffset|The date and time at which the campaign completed.|
+|launchDateTime|DateTimeOffset|The date and time at which the campaign was launched.|
+|status|campaignStatus|The current state of the campaign. The possible values are: `unknown`, `draft`, `inProgress`, `scheduled`, `completed`, `failed`, `cancelled`, `excluded`, `deleted`, `unknownFutureValue`.|
+
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.campaignSchedule"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.campaignSchedule",
+ "completionDateTime": "String (timestamp)",
+ "launchDateTime": "String (timestamp)",
+ "status": "String"
+}
+```
+
v1.0 Channel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/channel.md
where files are shared, and where tabs are added.
|[List channel members](../api/channel-list-members.md) | [conversationMember](conversationmember.md) collection | Get the list of members in a channel.| |[Add channel member](../api/channel-post-members.md) | [conversationMember](conversationmember.md) | Add a member to a channel. Only supported for channels with a **membershipType** of `private` or `shared`.| |[Get channel member](../api/channel-get-members.md) | [conversationMember](conversationmember.md) collection | Get a member in a channel.|
+|[Archive channel](../api/channel-archive.md) | None | Archive a channel.|
+|[Unarchive channel](../api/channel-unarchive.md) | None | Unarchive a channel.|
|[Update channel member's role](../api/channel-update-members.md) | [conversationMember](conversationmember.md) | Update the properties of a member of the channel. Only supported for channels with a **membershipType** of `private` or `shared`.| |[Remove channel member](../api/channel-delete-members.md) | None | Delete a member from a channel. Only supported for channels with a **membershipType** of `private` or `shared`.| |[Complete migration](../api/channel-completemigration.md)|[channel](channel.md)| Removes the migration mode from the channel and makes the channel available to users to post and read messages.|
where files are shared, and where tabs are added.
|[Provision channel email address](../api/channel-provisionemail.md) |[provisionChannelEmailResult](../resources/provisionchannelemailresult.md)| Provision an email address for the channel.| |[Remove channel email address](../api/channel-removeemail.md) | None | Remove the email address of the channel.| |[Remove incoming channel](../api/team-delete-incomingchannels.md) | None| Remove an incoming [channel](../resources/channel.md) (a **channel** shared with a **team**) from a [team](../resources/team.md).|
-|[List teams sharing a channel](../api/sharedwithchannelteaminfo-list.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md) collection|Get the list of teams that has been shared the specified channel.|
-|[Get team sharing a channel](../api/sharedwithchannelteaminfo-get.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md)|Get a team that has been shared the specified channel.|
+|[List teams sharing a channel](../api/sharedwithchannelteaminfo-list.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md) collection|Get the list of teams that share the specified channel.|
+|[Get team sharing a channel](../api/sharedwithchannelteaminfo-get.md)|[sharedWithChannelTeamInfo](../resources/sharedwithchannelteaminfo.md)|Get a team that shares the specified channel.|
|[Unshare channel with team](../api/sharedwithchannelteaminfo-delete.md)|None|Unshare a channel with a team.| |[List allowed members](../api/sharedwithchannelteaminfo-list-allowedmembers.md)|[conversationMember](../resources/conversationmember.md) collection|Get the list of team members who have access to the shared channel.| |[Check user access](../api/channel-doesuserhaveaccess.md)|Boolean|Check whether a user has access to a shared channel or not.|
where files are shared, and where tabs are added.
| Property | Type |Description| |:|:--|:-| |description|String|Optional textual description for the channel.|
-|displayName|String|Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.|
+|displayName|String|Channel name as it appears to the user in Microsoft Teams. The maximum length is 50 characters.|
|id|String|The channel's unique identifier. Read-only.| |isFavoriteByDefault|Boolean|Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with [Create team](../api/team-post.md). Default: `false`.| |email|String| The email address for sending messages to the channel. Read-only.|
-|webUrl|String|A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.|
-|membershipType|[channelMembershipType](../resources/channel.md#channelmembershiptype-values)|The type of the channel. Can be set during creation and can't be changed. The possible values are: `standard`, `private`, `unknownFutureValue`, `shared`. The default value is `standard`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `shared`.|
+|webUrl|String|A hyperlink to the channel in Microsoft Teams. This URL is supplied when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.|
+|membershipType|[channelMembershipType](../resources/channel.md#channelmembershiptype-values)|The type of the channel. Can be set during creation and can't be changed. The possible values are: `standard`, `private`, `unknownFutureValue`, `shared`. The default value is `standard`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `shared`.|
|createdDateTime|dateTimeOffset|Read only. Timestamp at which the channel was created.| |moderationSettings|[channelModerationSettings](../resources/channelmoderationsettings.md)|Settings to configure channel moderation to control who can start new posts and reply to posts in that channel.|
-|summary|[channelSummary](../resources/channelsummary.md)|Contains summary information about the channel, including number of guests, members, owners, and an indicator for members from other tenants. The **summary** property will only be returned if it is specified in the `$select` clause of the [Get channel](../api/channel-get.md) method.|
+|summary|[channelSummary](../resources/channelsummary.md)|Contains summary information about the channel, including number of guests, members, owners, and an indicator for members from other tenants. The **summary** property is only returned if it appears in the `$select` clause of the [Get channel](../api/channel-get.md) method.|
|tenantId |string | The ID of the Microsoft Entra tenant. |
+|isArchived| Boolean | Indicates whether the channel is archived. Read-only. |
### channelMembershipType values
where files are shared, and where tabs are added.
### Instance attributes
-Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.
+Instance attributes are properties with special behaviors. These properties are temporary. They either define behavior that the service should perform, or provide short-term property values, such as a download URL for an item that expires.
| Property name| Type | Description |:--|:-|:-|
For a POST request example, see [Request (create channel in migration state)](/m
## JSON representation
-The following is a JSON representation of the resource.
+The following JSON representation shows the resource type
<!-- { "blockType": "resource",
The following is a JSON representation of the resource.
"email": "string", "webUrl": "string", "membershipType": "String",
+ "isArchived": false,
"createdDateTime": "string (timestamp)", "moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" } }
v1.0 Cloudpc https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpc.md
Title: "cloudPC resource type"
-description: "Cloud managed virtual desktops."
+description: "Represents a cloud-managed virtual desktop."
ms.localizationpriority: medium
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|Method|Return type|Description| |:|:|:|
-|[List cloudPCs](../api/virtualendpoint-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List properties and relationships of the [cloudPC](../resources/cloudpc.md) objects.|
-|[Get cloudPC](../api/cloudpc-get.md)|[cloudPC](../resources/cloudpc.md)|Read the properties and relationships of a [cloudPC](../resources/cloudpc.md) object.|
-|[Get provisioned cloudPCs](../api/cloudpc-getprovisionedcloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|Get all provisioned Cloud PCs of a specific service plan for users under a Microsoft Entra user group.|
+|[List cloudPCs](../api/virtualendpoint-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List properties and relationships of the Cloud PC objects.|
+|[Get cloudPC](../api/cloudpc-get.md)|[cloudPC](../resources/cloudpc.md)|Read the properties and relationships of a Cloud PC object.|
+|[Get provisioned Cloud PCs](../api/cloudpc-getprovisionedcloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|Get all provisioned Cloud PCs of a specific service plan for users under a Microsoft Entra user group.|
|[Change user account type](../api/cloudpc-changeuseraccounttype.md)|None|Change the account type of the user on a specific Cloud PC.|
-|[End grace period](../api/cloudpc-endgraceperiod.md)|None|End the grace period for a [cloudPC](../resources/cloudpc.md) object.|
+|[End grace period](../api/cloudpc-endgraceperiod.md)|None|End the grace period for a Cloud PC object.|
|[Get remote action results](../api/manageddevice-getcloudpcremoteactionresults.md)|[cloudPcRemoteActionResult](../resources/cloudpcremoteactionresult.md)|Check the [Cloud PC-specified remote action results](../resources/cloudpcremoteactionresult.md) for a Cloud PC device.|
-|[Power on](../api/cloudpc-poweron.md)|None|Power on a specific Windows Frontline [cloudPC](../resources/cloudpc.md) object. This action supports MEM admin scenarios.|
-|[Power off](../api/cloudpc-poweroff.md)|None|Power off a specific Windows Frontline [cloudPC](../resources/cloudpc.md) object.This action supports MEM admin scenarios.|
-|[Reboot](../api/cloudpc-reboot.md)|None|Reboot a specific [cloudPC](../resources/cloudpc.md) object.|
-|[Rename](../api/cloudpc-rename.md)|None|Rename a specific [cloudPC](../resources/cloudpc.md) object. Use this API to update the **displayName** for the Cloud PC entity.|
-|[Reprovision](../api/cloudpc-reprovision.md)|None|Reprovision a [cloudPC](../resources/cloudpc.md) object.|
+|[Power on](../api/cloudpc-poweron.md)|None|Power on a specific Windows Frontline Cloud PC object. This action supports MEM admin scenarios.|
+|[Power off](../api/cloudpc-poweroff.md)|None|Power off a specific Windows Frontline Cloud PC object. This action supports MEM admin scenarios.|
+|[Reboot](../api/cloudpc-reboot.md)|None|Reboot a specific Cloud PC object.|
+|[Rename](../api/cloudpc-rename.md)|None|Rename a specific Cloud PC object. Use this API to update the **displayName** for the Cloud PC entity.|
+|[Reprovision](../api/cloudpc-reprovision.md)|None|Reprovision a Cloud PC object.|
|[Bulk reprovision remote action](../api/manageddevice-bulkreprovisioncloudpc.md)|None|Bulk reprovision a set of Cloud PC devices with Intune managed device IDs.| |[Resize remote action](../api/manageddevice-resizecloudpc.md)|None|Upgrade or downgrade an existing Cloud PC to another configuration with new vCPU and storage size through Intune managed device ID.|
-|[Start](../api/cloudpc-start.md)|None|Start a specific [cloudPC](../resources/cloudpc.md) for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. |
-|[Stop](../api/cloudpc-stop.md)|None|Stop a specific [cloudPC](../resources/cloudpc.md) for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. |
-|[Troubleshoot](../api/cloudpc-troubleshoot.md)|None|Troubleshoot a specific [cloudPC](../resources/cloudpc.md) object. Use this API to check the health status of the Cloud PC and the session host.|
-|[Restore](../api/cloudpc-restore.md)|None|Restore a [cloudPC](../resources/cloudpc.md) object to a previous state from a snapshot.|
+|[Start](../api/cloudpc-start.md)|None|Start a specific Cloud PC for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. |
+|[Stop](../api/cloudpc-stop.md)|None|Stop a specific Cloud PC for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. |
+|[Troubleshoot](../api/cloudpc-troubleshoot.md)|None|Troubleshoot a specific Cloud PC object. Use this API to check the health status of the Cloud PC and the session host.|
+|[Restore](../api/cloudpc-restore.md)|None|Restore a Cloud PC object to a previous state from a snapshot.|
|[Bulk restore remote action](../api/manageddevice-bulkrestorecloudpc.md)|[cloudPcBulkRemoteActionResult](../resources/cloudpcbulkremoteactionresult.md)|Restore multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices and a restore point date and time.| |[Set review status](../api/manageddevice-setcloudpcreviewstatus.md)|None|Set the review status of a specific Cloud PC device.| |[Get review status](../api/manageddevice-getcloudpcreviewstatus.md)|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|Get the review status of a specific Cloud PC device.| |[Bulk set review status](../api/manageddevice-bulksetcloudpcreviewstatus.md)|[cloudPcBulkRemoteActionResult](../resources/cloudpcbulkremoteactionresult.md)|Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices.|
-|[List for user](../api/user-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List the [cloudPC](../resources/cloudpc.md) devices that are attributed to the signed-in user.|
-|[Get launch info for user](../api/cloudpc-getcloudpclaunchinfo.md)|[cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md)|Get the [cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md) for the signed-in user.|
+|[List for user](../api/user-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List the Cloud PC devices that are attributed to the signed-in user.|
+|[Get launch info for user](../api/cloudpc-getcloudpclaunchinfo.md)|[cloudPcLaunchInfo](../resources/cloudpclaunchinfo.md)|Get the [cloudPcLaunchInfo](../resources/cloudpclaunchinfo.md) for the signed-in user.|
|[Get connectivity history](../api/cloudpc-getcloudpcconnectivityhistory.md)|[cloudPcConnectivityEvent](../resources/cloudpcconnectivityevent.md) collection|Get the Cloud PC connectivity history.| |[Get supported remote actions](../api/cloudpc-getsupportedcloudpcremoteactions.md)|[cloudPcRemoteActionCapability](../resources/cloudpcremoteactioncapability.md) collection|Get a list of supported Cloud PC remote actions for a specific Cloud PC device, including the action names and capabilities.|
-|[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents that failed to install on the [cloudPC](../resources/cloudpc.md).|
-|[Bulk resize](../api/cloudpc-retrypartneragentinstallation.md)|[cloudPcRemoteActionResult](../resources//cloudpcremoteactionresult.md) collection|Perform a bulk resize action to resize a group of [cloudPCs](../resources/cloudpc.md) that have successfully passed validation (cloudPC: validateBulkResize). If any devices can't be resized, they're labeled as "resize failed", while the remaining devices are `provisioned` for the resize process.|
-|[Validate bulk resize](../api/cloudpc-validatebulkresize.md)|[cloudPcResizeValidateResult](../resources/cloudPcResizeValidationResult.md) collection|Validate that a set of [cloudPC](../resources/cloudpc.md) devices meet the requirements to be bulk resized.|
+|[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents that failed to install on the Cloud PC.|
+|[Bulk resize](../api/cloudpc-retrypartneragentinstallation.md)|[cloudPcRemoteActionResult](../resources//cloudpcremoteactionresult.md) collection|Perform a bulk resize action to resize a group of Cloud PCs that have successfully passed validation (cloudPC: validateBulkResize). If any devices can't be resized, they're labeled as "resize failed", while the remaining devices are `provisioned` for the resize process.|
+|[Validate bulk resize](../api/cloudpc-validatebulkresize.md)|[cloudPcResizeValidateResult](../resources/cloudPcResizeValidationResult.md) collection|Validate that a set of Cloud PC devices meet the requirements to be bulk resized.|
|[Get frontline access state](../api/cloudpc-getfrontlinecloudpcaccessstate.md)|[frontlineCloudPcAccessState](#frontlinecloudpcaccessstate-values)|Get the access state of the frontline Cloud PC. The possible values are: `unassigned`, `noLicensesAvailable`, `activationFailed`, `active`, `activating`, `standbyMode`, `unknownFutureValue`.| |[Get shift work access state](../api/cloudpc-getshiftworkcloudpcaccessstate.md) (deprecated)|[shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values-deprecated)|Get the access state of the shift work Cloud PC. The possible values are: `unassigned`, `noLicensesAvailable`, `activationFailed`, `active`, `activating`, `waitlisted`, `unknownFutureValue`, `standbyMode`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `standbyMode`. This API is deprecated and will stop returning data on December 31, 2023. Going forward, use the [getFrontlineCloudPcAccessState](../api/cloudpc-getfrontlinecloudpcaccessstate.md) API.| |[Reprovision remote action](../api/manageddevice-reprovisioncloudpc.md) (deprecated)|None|Reprovision a Cloud PC with an Intune [managed device](../resources/cloudpc.md) ID. This API is deprecated and will stop returning data on September 30, 2023. Going forward, use the [reprovision](../api/cloudpc-reprovision.md) API.|
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|imageDisplayName|String|Name of the OS image that's on the Cloud PC.| |lastLoginResult|[cloudPcLoginResult](../resources/cloudpcloginresult.md)|The last login result of the Cloud PC. For example, `{ "time": "2014-01-01T00:00:00Z"}`.| |lastModifiedDateTime|DateTimeOffset|The last modified date and time of the Cloud PC. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
-|lastRemoteActionResult|[cloudPcRemoteActionResult](../resources/cloudpcremoteactionresult.md)|The last remote action result of the enterprise Cloud PCs. The supported remote actions are: `Reboot`, `Rename`, `Reprovision`, `Restore`, and `Troubleshoot`.|
+|lastRemoteActionResult|[cloudPcRemoteActionResult](../resources/cloudpcremoteactionresult.md)|The last remote action result of the enterprise Cloud PCs. The supported remote actions are: `Reboot`, `Rename`, `Reprovision`, `Restore`, `Troubleshoot`.|
|managedDeviceId|String|The Intune device ID of the Cloud PC.| |managedDeviceName|String|The Intune device name of the Cloud PC.| |onPremisesConnectionName|String|The Azure network connection that is applied during the provisioning of Cloud PCs.|
-|osVersion|[cloudPcOperatingSystem](../resources/cloudpcorganizationsettings.md#cloudpcoperatingsystem-values)|The version of the operating system (OS) to provision on Cloud PCs. Possible values are: `windows10`, `windows11`, and `unknownFutureValue`.|
+|osVersion|[cloudPcOperatingSystem](../resources/cloudpcorganizationsettings.md#cloudpcoperatingsystem-values)|The version of the operating system (OS) to provision on Cloud PCs. Possible values are: `windows10`, `windows11`, `unknownFutureValue`.|
|partnerAgentInstallResults|[cloudPcPartnerAgentInstallResult](../resources/cloudpcpartneragentinstallresult.md) collection|The results of every partner agent's installation status on Cloud PC.|
-|powerState|[cloudPcPowerState](#cloudpcpowerstate-values)|The power state of a Cloud PC. The possible values are: `running`, `poweredOff` and `unknown`. This property only supports shift work Cloud PCs.|
+|powerState|[cloudPcPowerState](#cloudpcpowerstate-values)|The power state of a Cloud PC. The possible values are: `running`, `poweredOff`, `unknown`. This property only supports shift work Cloud PCs.|
|provisioningPolicyId|String|The provisioning policy ID of the Cloud PC.| |provisioningPolicyName|String|The provisioning policy that is applied during the provisioning of Cloud PCs.| |provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|The type of licenses to be used when provisioning Cloud PCs using this policy. Possible values are: `dedicated`, `shared`, `unknownFutureValue`. Default value is `dedicated`. | |servicePlanId|String|The service plan ID of the Cloud PC.| |servicePlanName|String|The service plan name of the Cloud PC.| |servicePlanType|[cloudPcServicePlanType](../resources/cloudpcserviceplan.md#cloudpcserviceplantype-values)|The service plan type of the Cloud PC.|
-|status|[microsoft.graph.cloudPcStatus](#cloudpcstatus-values)|The status of the Cloud PC. Possible values are: `notProvisioned`, `provisioning`, `provisioned`, `upgrading`, `inGracePeriod`, `deprovisioning`, `failed`, `restoring`.|
+|status|[microsoft.graph.cloudPcStatus](#cloudpcstatus-values)|The status of the Cloud PC. Possible values are: `notProvisioned`, `provisioning`, `provisioned`, `inGracePeriod`, `deprovisioning`, `failed`, `provisionedWithWarnings`, `resizing`, `restoring`, `pendingProvision`, `unknownFutureValue`, `movingRegion`, `resizePendingLicense`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `movingRegion`, `resizePendingLicense`.|
|statusDetails|[cloudPcStatusDetails](../resources/cloudpcstatusdetails.md)|The details of the Cloud PC status.|
-|userAccountType|[cloudPcUserAccountType](../resources/cloudpcorganizationsettings.md#cloudpcuseraccounttype-values)|The account type of the user on provisioned Cloud PCs. Possible values are: `standardUser`, `administrator`, and `unknownFutureValue`.|
+|userAccountType|[cloudPcUserAccountType](../resources/cloudpcorganizationsettings.md#cloudpcuseraccounttype-values)|The account type of the user on provisioned Cloud PCs. Possible values are: `standardUser`, `administrator`, `unknownFutureValue`.|
|userPrincipalName|String|The user principal name (UPN) of the user assigned to the Cloud PC.| ### cloudPcDiskEncryptionState values
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|:|:| |notAvailable|The Cloud PC isn't provisioned, or is in a state where encryption isn't available.| |notEncrypted|The Cloud PC should be encrypted, but the encryption isn't done so yet (reserved, shouldn't happen).|
-|encryptedUsingPlatformManagedKey|The Cloud PC is encrypted using a platform managed key. This is the default value if the customer-managed key isn't enabled.|
+|encryptedUsingPlatformManagedKey|The Cloud PC is encrypted using a platform managed key. This member is the default value if the customer-managed key isn't enabled.|
|encryptedUsingCustomerManagedKey|The Cloud PC is encrypted using the customer-managed key.| |unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|unknown|The Cloud PC status is unknown.| ### cloudPcStatus values
-The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `movingRegion`, `resizePendingLicense`.
+The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `movingRegion`, `resizePendingLicense`.
|Member|Description| |:|:|
-|notProvisioned|The Cloud PC hasn't been provisioned.|
+|notProvisioned|The Cloud PC hasn't been provisioned yet.|
|provisioning|Cloud PC provisioning is in progress.|
-|provisioned|The Cloud PC is provisioned and can be accessed by end users.|
-|inGracePeriod|The Cloud PC is in the one week grace period before itΓÇÖs deprovisioned.|
+|provisioned|The Cloud PC is provisioned and users can access it.|
+|inGracePeriod|The Cloud PC is in the one week grace period before deprovision.|
|deprovisioning|The Cloud PC is deprovisioning.|
-|failed|The operation on Cloud PC has failed.|
-|provisionedWithWarnings|The Cloud PC is provisioned and can be accessed by end users but with some warnings. The user can continue to use this Cloud PC.|
+|failed|The operation on Cloud PC failed.|
+|provisionedWithWarnings|The Cloud PC is provisioned and end users can access it with some warnings. The user can continue to use this Cloud PC.|
|resizing|The Cloud PC is resizing.| |pendingProvision|The provisioning is pending on the Cloud PC. In this case, the number of Cloud PCs in grace period is more than the number of total available licenses. | |restoring|The Cloud PC is restoring.| |unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| |movingRegion|Indicates that the Cloud PC is being moved from one region to another.|
-|resizePendingLicense|Indicates that the Cloud PC resize process has been initiated but can't be completed because the target license hasn't been identified. It's currently awaiting customer action to resolve the licensing issue.|
+|resizePendingLicense|Indicates that the Cloud PC resize process was initiated but can't be completed because the target license hasn't been identified. It's currently awaiting customer action to resolve the licensing issue.|
### frontlineCloudPcAccessState values
v1.0 Cloudpcprovisioningpolicy https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcprovisioningpolicy.md
Represents a Cloud PC provisioning policy.
|[Update cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-update.md)|[cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md)|Update the properties of a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) object.| |[Delete cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-delete.md)|None|Delete a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) object.| |[Assign cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-assign.md)|None |Assign a [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md) to user groups.|
+|[Apply cloudPcProvisioningPolicy](../api/cloudpcprovisioningpolicy-apply.md)|None|Apply the current [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration to all Cloud PC devices under a specified policy. Currently, you can only change the region.|
+|[applyConfig](../api/cloudpcprovisioningpolicy-applyconfig.md)|None|Update the [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration for a set of Cloud PC devices by their IDs.|
## Properties
Represents a Cloud PC provisioning policy.
|microsoftManagedDesktop|[microsoftManagedDesktop](../resources/microsoftmanageddesktop.md)|The specific settings to **microsoftManagedDesktop** that enables Microsoft Managed Desktop customers to get device managed experience for Cloud PC. To enable **microsoftManagedDesktop** to provide more value, an admin needs to specify certain settings in it. Supports `$filter`, `$select`, and `$orderBy`.| |provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs using this policy. By default, the license type is `dedicated` if the **provisioningType** isn't specified when you create the **cloudPcProvisioningPolicy**. You can't change this property after the **cloudPcProvisioningPolicy** was created. Possible values are: `dedicated`, `shared`, `unknownFutureValue`.| |windowsSetting|[cloudPcWindowsSettings](../resources/cloudpcwindowssetting.md)|Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. |
-|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID.|
-|onPremisesConnectionId (deprecated)|String|The ID of the [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md). To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.|
+|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID. The **domainJoinConfiguration** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
+|onPremisesConnectionId (deprecated)|String|The ID of the [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md). To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service. The **onPremisesConnectionId** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
|windowsSettings (deprecated)|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. The **windowsSettings** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **windowsSetting** property.| ### cloudPcProvisioningType values
v1.0 Connector https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/connector.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Connectors are lightweight agents that sit on-premises and facilitate the outbound connection to the [Microsoft Entra application proxy](/azure/active-directory/app-proxy/what-is-application-proxy) service. Each connector is part of a [connectorGroup](connectorgroup.md).
+Represents an Application Proxy connector. Connectors are lightweight agents that sit on-premises and facilitate the outbound connection to the [Microsoft Entra application proxy](/azure/active-directory/app-proxy/what-is-application-proxy) service. Each connector is part of a [connectorGroup](connectorgroup.md).
## Methods | Method | Return Type | Description | |:-|:|:| | [List connectors](../api/connector-list.md) | [connector](connector.md) collection | Retrieve a list of connector objects. |
-| [Get connector](../api/connector-get.md) | [connector](connector.md) | Read properties and relationships of connector object. |
-| [List memberOf](../api/connector-list-memberof.md) | [connectorGroup](connectorgroup.md) collection | List the connectorGroup object collection the connector is a member of. |
-| [Add connector to connectorGroup](../api/connector-post-memberof.md)| [connectorGroup](connectorgroup.md) | Add a connector to a connectorGroup. |
+| [Get connector](../api/connector-get.md) | [connector](connector.md) | Read the properties and relationships of a connector object. |
+| [List memberOf](../api/connector-list-memberof.md) | [connectorGroup](connectorgroup.md) collection | List the **connectorGroup** object collection the connector is a member of. |
+| [Add connector to connectorGroup](../api/connector-post-memberof.md)| [connectorGroup](connectorgroup.md) | Add a connector to a **connectorGroup**. |
## Properties | Property | Type | Description | |:-|:|:|
-|externalIp|String| The external IP address as detected by the the connector server. Read-only. |
-|id|String| Unique identifier of the connector. Read-only. |
-|machineName|String| The machine name the connector is installed and running on. |
-|status|connectorStatus| Indicates the status of the connector. Possible values are: `active`, `inactive`. Read-only. |
+|externalIp|String| The external IP address as detected by the connector server. Read-only. |
+|id|String| The unique identifier of the connector. Read-only. |
+|machineName|String| The name of the computer on which the connector is installed and runs on. |
+|status|connectorStatus| Indicates the status of the connector. The possible values are: `active`, `inactive`. Read-only. |
+|version|String|The version of the connector.|
## Relationships | Relationship | Type |Description| |:|:--|:-|
-|memberOf|[connectorGroup](connectorgroup.md) collection| The connectorGroup that the connector is a member of. Read-only. |
+|memberOf|[connectorGroup](connectorgroup.md) collection| The **connectorGroup** that the connector is a member of. Read-only. |
## JSON representation
-The following is a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!-- { "blockType": "resource",
The following is a JSON representation of the resource.
"externalIp": "String", "id": "String (identifier)", "machineName": "String",
- "status": "string"
+ "status": "String",
+ "version": "String"
}- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Connectors Api Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/connectors-api-overview.md
The following are current known limitations:
- An application is limited to 25 concurrent operations on a connection. - Connections have a capacity limit of 5,000,000 items or ~350 GB of data. - Maximum size of an **externalItem** entity is 4 MB.-- Sorting results is not supported. ## Next steps
v1.0 Enums https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums.md
Possible values for user account types (group membership), per Windows definitio
| gallery | | unknownFutureValue |
+### cloudPcPolicySettingType values
+
+|Member|
+|:|
+|region|
+|singleSignOn|
+|unknownFutureValue|
+ ### chatType values | Member | Value | Description |
v1.0 Filterdatetime https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filterdatetime.md
Title: "FilterDatetime resource type"
+ Title: "filterDatetime resource type"
description: "Represents how to filter a date when filtering on values." ms.localizationpriority: medium doc_type: resourcePageType
-# FilterDatetime resource type
+# filterDatetime resource type
Namespace: microsoft.graph
Represents how to filter a date when filtering on values.
## Properties | Property | Type |Description| |:|:--|:-|
-|date|string|The date in ISO8601 format used to filter data.|
-|specificity|string|How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is set to "month," the filter operation will keep all rows with a date in the month of April 2009. Possible values are: `Year`, `Monday`, `Day`, `Hour`, `Minute`, `Second`.|
+|date|String|The date in ISO 8601 format used to filter data.|
+|specificity|String|Defines how specific you should use the **date** to keep data. For example, if the date is `2005-04-02` and the **specificity** property is set to `month`, the filter operation keeps all rows with a date in the month of April 2009. The possible values are: `Year`, `Month`, `Day`, `Hour`, `Minute`, `Second`.|
## Relationships
-None
+None.
## JSON representation
-Here's a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!-- { "blockType": "resource",
Here's a JSON representation of the resource.
```json {
- "date": "string",
- "specificity": "string"
+ "date": "String",
+ "specificity": "String"
}- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
Here's a JSON representation of the resource.
"suppressions": [] } -->--
v1.0 Internaldomainfederation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/internaldomainfederation.md
Title: "internalDomainFederation resource type"
description: "Represents configurations of the domains in a tenant that are federated with Azure AD." ms.localizationpriority: medium-+ doc_type: resourcePageType
Inherits from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).
|signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| + ### federatedIdpMfaBehavior values | Member | Description |
v1.0 Messagerule https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/messagerule.md
Title: "messageRule resource type"
-description: "A rule that applies to messages in the Inbox of a user."
+description: "Represents a rule that applies to messages in the Inbox of a user."
ms.localizationpriority: medium
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A rule that applies to messages in the Inbox of a user.
+Represents a rule that applies to messages in the Inbox of a user.
In Outlook, you can set up rules for incoming messages in the Inbox to carry out specific actions upon certain conditions.
and available rule conditions and exceptions are represented by the [messageRule
| Property | Type |Description| |:|:--|:-| | actions | [messageRuleActions](messageruleactions.md) | Actions to be taken on a message when the corresponding conditions are fulfilled. |
-| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled, will trigger the corresponding actions for that rule. |
+| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled trigger the corresponding actions for that rule. |
| displayName | String | The display name of the rule. | | exceptions | [messageRulePredicates](messagerulepredicates.md) | Exception conditions for the rule. | | hasError | Boolean | Indicates whether the rule is in an error condition. Read-only. |
and available rule conditions and exceptions are represented by the [messageRule
## JSON representation
-Here is a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!-- { "blockType": "resource",
v1.0 Onpremisespublishingprofile https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisespublishingprofile.md
Various Azure services (for example, Microsoft Entra Connect [Passthrough Authen
|:-|:|:| |hybridAgentUpdaterConfiguration|[hybridAgentUpdaterConfiguration](hybridagentupdaterconfiguration.md)| Represents a **hybridAgentUpdaterConfiguration** object.| |id|String| Represents a publishing type. Possible values are: `applicationProxy`, `exchangeOnline`, `authentication`, `provisioning`, `adAdministration`. Read-only.|
-|isEnabled|Boolean| Represents if [Microsoft Entra application proxy](/azure/active-directory/app-proxy/what-is-application-proxy) is enabled for the tenant. |
+|isEnabled|Boolean| Represents if [Microsoft Entra application proxy](/entra/identity/app-proxy/) is enabled for the tenant. |
## Relationships
v1.0 Plannertask https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertask.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a Planner task in Microsoft 365. A Planner task is contained in a [plan](plannerplan.md) and can be assigned to a [bucket](plannerbucket.md) in a plan. Each task object has a [details](plannertaskdetails.md) object that can contain more information about the task. For more information about relationships between group, plan, and task, see [Use the Planner REST API](planner-overview.md)
+Represents a Planner task in Microsoft 365. A Planner task is contained in a [plan](plannerplan.md) and can be assigned to a [bucket](plannerbucket.md) in a plan. Each task object has a [details](plannertaskdetails.md) object that can contain more information about the task. For more information about relationships between group, plan, and task, see [Use the Planner REST API](planner-overview.md).
## Methods
Represents a Planner task in Microsoft 365. A Planner task is contained in a [pl
| Property | Type |Description| |:|:--|:-| |activeChecklistItemCount|Int32|Number of checklist items with value set to `false`, representing incomplete items.|
-|appliedCategories|[plannerAppliedCategories](plannerappliedcategories.md)|The categories to which the task has been applied. See [applied Categories](plannerappliedcategories.md) for possible values.|
+|appliedCategories|[plannerAppliedCategories](plannerappliedcategories.md)|The categories to which the task applies. See [applied Categories](plannerappliedcategories.md) for possible values.|
|assigneePriority|String|Hint used to order items of this type in a list view. The format is defined as outlined [here](planner-order-hint-format.md).| |assignments|[plannerAssignments](plannerassignments.md)|The set of assignees the task is assigned to.|
-|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service. |
+|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service. |
|checklistItemCount|Int32|Number of checklist items that are present on the task.| |completedBy|[identitySet](identityset.md)|Identity of the user that completed the task.| |completedDateTime|DateTimeOffset|Read-only. Date and time at which the `'percentComplete'` of the task is set to `'100'`. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`|
Represents a Planner task in Microsoft 365. A Planner task is contained in a [pl
|creationSource|[plannerTaskCreation](../resources/plannertaskcreation.md)|Contains information about the origin of the task.| |dueDateTime|DateTimeOffset|Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |hasDescription|Boolean|Read-only. Value is `true` if the details object of the task has a nonempty description and `false` otherwise.|
-|id|String|Read-only. ID of the task. It is 28 characters long and case-sensitive. [Format validation](tasks-identifiers-disclaimer.md) is done on the service.|
+|id|String|Read-only. A unique 28-character case-sensitive ID for the task. [Format validation](tasks-identifiers-disclaimer.md) is done on the service.|
+|isOnMyDay|Boolean|A Boolean value that indicates whether to show this task in the MyDay view. `true` to show the task. Otherwise, `false`.|
+|isOnMyDayLastModifiedDate|Date|Read-only. The date on which task is added to or removed from MyDay.|
|orderHint|String|Hint used to order items of this type in a list view. The format is defined as outlined [here](planner-order-hint-format.md).| |percentComplete|Int32|Percentage of task completion. When set to `100`, the task is considered completed. |
-|priority|Int32|Priority of the task. Valid range of values is between `0` and `10` (inclusive), with increasing value being lower priority (`0` has the highest priority and `10` has the lowest priority). Currently, Planner interprets values `0` and `1` as "urgent", `2` and `3` and `4` as "important", `5`, `6`, and `7` as "medium", and `8`, `9`, and `10` as "low". Currently, Planner sets the value `1` for "urgent", `3` for "important", `5` for "medium", and `9` for "low".|
+|priority|Int32|The priority of the task. Valid values are between `0` and `10`, inclusive. Larger values indicate lower priority. For example, `0` has the highest priority and `10` has the lowest priority. Currently, Planner interprets values `0` and `1` as "urgent", `2` and `3` and `4` as "important", `5`, `6`, and `7` as "medium", and `8`, `9`, and `10` as "low". Currently, Planner sets the value `1` for "urgent", `3` for "important", `5` for "medium", and `9` for "low".|
|planId|String|Plan ID to which the task belongs.| |previewType|String|This sets the type of preview that shows up on the task. Possible values are: `automatic`, `noPreview`, `checklist`, `description`, `reference`.| |recurrence|[plannerTaskRecurrence](../resources/plannertaskrecurrence.md)|Defines active or inactive recurrence for the task. `null` when the recurrence has never been defined for the task.|
Represents a Planner task in Microsoft 365. A Planner task is contained in a [pl
|:|:--|:-| |assignedToTaskBoardFormat|[plannerAssignedToTaskBoardTaskFormat](plannerassignedtotaskboardtaskformat.md)| Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.| |bucketTaskBoardFormat|[plannerBucketTaskBoardTaskFormat](plannerbuckettaskboardtaskformat.md)| Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.|
-|details|[plannerTaskDetails](plannertaskdetails.md)| Read-only. Nullable. Additional details about the task.|
+|details|[plannerTaskDetails](plannertaskdetails.md)| Read-only. Nullable. More details about the task.|
|progressTaskBoardFormat|[plannerProgressTaskBoardTaskFormat](plannerprogresstaskboardtaskformat.md)| Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.| ## JSON representation
Here's a JSON representation of the resource.
"dueDateTime": "String (timestamp)", "hasDescription": "Boolean", "id": "String (identifier)",
+ "isOnMyDay": "Boolean",
+ "isOnMyDayLastModifiedDate": "Date",
"orderHint": "String", "percentComplete": "Int32", "planId": "String",
v1.0 Security Api Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-api-overview.md
TheΓÇ» [incident](security-incident.md) resource and its APIs allow you to sort
> **Note:** We recommend that you use the [threat submission](https://github.com/microsoftgraph/microsoft-graph-docs/pull/16242/files#threat-submission) API instead. +
+## Records management
+
+Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels.
+ ## Secure Score [Microsoft Secure Score](https://techcommunity.microsoft.com/t5/Security-Privacy-and-Compliance/Office-365-Secure-Score-is-now-Microsoft-Secure-Score/ba-p/182358) is a security analytics solution that gives you visibility into your security portfolio and how to improve it. With a single score, you can better understand what you have done to reduce your risk in Microsoft solutions. You can also compare your score with other organizations and see how your score has been trending over time. The [secureScore](securescores.md) and [secureScoreControlProfile](securescorecontrolprofiles.md) entities help you balance your organization's security and productivity needs while enabling the appropriate mix of security features. You can also project what your score will be after you adopt security features.
The Microsoft Graph threat submission API helps organizations to submit a threat
> **Note:** These APIs are only availbe for Defender for Office 365 Plan 2 or Microsoft 365 A5/E5/F5/G5 Security service plans. For the most up-to-date list of service plans, see [Microsoft Defender for Office 365 service description](/office365/servicedescriptions/office-365-advanced-threat-protection-service-description).
+## Identities
+
+### Health Issues
+The Defender for Identity health issues API allows you to monitor the health status of your sensors and agents across your hybrid identity infrastructure. You can use this API to retrieve information about the current health issues of your sensors, such as the issue type, status, configuration, and severity. You can also use this API to identify and resolve any issues that may affect the functionality or security of your sensors and agents.
+ ## Common use cases The following are some of the most popular requests for working with the Microsoft Graph security API.
The following are some of the most popular requests for working with the Microso
|Query email metadata|[LIST analyzedemails](../api/security-collaborationroot-list-analyzedemails.md)|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails?startTime={startTime}&endTime={endTime}](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails?startTime={startTime}&endTime={endTime}&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |Get details of a single message instance|[GET analyzedemails/Id](../api/security-analyzedemail-get.md)|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails/{Id}](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails/Id&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |Remediate analyzed email|[analyzedEmai: remediate](../api/security-analyzedemail-remediate.md )|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails/remediate](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails/remediate&method=POST&version=beta&GraphUrl=https://graph.microsoft.com)|
+| **Identities**|||
+| List health issues | [List health issues](../api/security-identityContainer-list-healthIssues.md) | [https://graph.microsoft.com/beta/security/identities/healthIssues](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/healthIssues&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) |
+ You can use Microsoft Graph [webhooks](/graph/webhooks) to subscribe to and receive notifications about updates to Microsoft Graph security API entities.
v1.0 Security Appliedcategory https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-appliedcategory.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the file plan descriptor of type category applied to a particular retention label.
+Represents a file plan descriptor that specifies a group of similar types of content in a department. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+To create, get, or delete an **appliedCategory** descriptor, use the [categoryTemplate](security-categorytemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
v1.0 Security Authority https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-authority.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the file plan descriptor of type authority applied to a particular retention label.
+Represents a file plan descriptor that specifies the type of the underlying authority which determines the content to be retained and its retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+To create, get, or delete an **authority** descriptor, use the [authorityTemplate](security-authoritytemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
v1.0 Security Authoritytemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-authoritytemplate.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Specifies the underlying authority that describes the type of content to be retained and its retention schedule.
+Supports CRUD operations to apply and manage the [authority](security-authority.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **authority** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources
## Properties |Property|Type|Description| |:|:|:|
-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the authority. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|createdDateTime|DateTimeOffset|Represents the date and time in which the authority is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|id|String|Unique ID of the authority. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the authority descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only. |
+|createdDateTime|DateTimeOffset|Represents the date and time in which the authority descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the authority. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
## Relationships None.
v1.0 Security Categorytemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-categorytemplate.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Specifies a group of similar types of content in a particular department.
-
+Supports CRUD operations to apply and manage the [appliedCategory](security-appliedcategory.md) descriptor, and any [subCategory](security-subcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). These file plan descriptors supplement a retention label to improve the manageability and organization of Microsoft 365 content.
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources
## Properties |Property|Type|Description| |:|:|:|
-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the category. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|createdDateTime|DateTimeOffset|Represents the date and time in which the category is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|id|String|Unique ID of the category. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the category descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the category descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the category. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
## Relationships |Relationship|Type|Description|
v1.0 Security Citation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-citation.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the file plan descriptor of type citation applied to a particular retention label.
+Represents a file plan descriptor that specifies a rule or regulation created by a jurisdiction to determine whether certain content should be retained or deleted. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+To create, get, or delete a **citation** descriptor, use the [citationTemplate](security-citationtemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
v1.0 Security Citationtemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-citationtemplate.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted.
-
+Supports CRUD operations to apply and manage the [citation](security-citation.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **citation** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources
|:|:|:| |citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.| |citationUrl|String|Represents the URL to the published citation.|
-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the citation. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|createdDateTime|DateTimeOffset|Represents the date and time in which the citation is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|id|String|Unique ID of the citation. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the citation descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the citation descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the citation. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
## Relationships None.
v1.0 Security Department https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-department.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the file plan descriptor of type department applied to a particular retention label.
+Represents a file plan descriptor that specifies the department or business unit of an organization to which a [retention label](security-retentionlabel.md) applies. Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md).
+To create, get, or delete a **department** descriptor, use the [departmentTemplate](security-departmenttemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
v1.0 Security Departmenttemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-departmenttemplate.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Specifies the department or business unit of an organization to which a label belongs.
-
+Supports CRUD operations to apply and manage the [department](security-department.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **department** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources
## Properties |Property|Type|Description| |:|:|:|
-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the department. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|createdDateTime|DateTimeOffset|Represents the date and time in which the department is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|id|String|Unique ID of the department. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the department descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the department descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the department. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
## Relationships None.
v1.0 Security Eventquery https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-eventquery.md
+
+ Title: "eventQuery resource type"
+description: "Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event."
+
+ms.localizationpriority: medium
++
+# eventQuery resource type
+
+Namespace: microsoft.graph.security
++
+Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|queryType|microsoft.graph.security.queryType|Represents the type of query associated with an event. 'files' for SPO and ODB and 'messages' for EXO.The possible values are: `files`, `messages`, `unknownFutureValue`.|
+|query|String|Represents unique identification for the query. 'Asset ID' for SharePoint Online and OneDrive for Business, 'keywords' for Exchange Online.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.eventQuery"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.eventQuery",
+ "queryType": "String",
+ "query": "String"
+}
+```
++
v1.0 Security Fileplandescriptor https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplandescriptor.md
Title: "filePlanDescriptor resource type"
-description: "Represents a group of columns associated with a particular retention label, to improve the manageability and organization of the content you need to label."
+description: "Represents a set of optional descriptors to supplement a retention label and improve the manageability and organization of content in Microsoft 365 for an organization."
ms.localizationpriority: medium
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a group of columns to improve the manageability and organization of the content you need to label.
+Represents a _set_ of optional file plan descriptors to supplement a [retention label](security-retentionlabel.md) and improve the manageability and organization of Microsoft 365 content.
+You can add a descriptor by using the POST operation of the corresponding file plan descriptor _template_, and specifying data for the descriptor. For example, to include a [citation](security-citation.md) descriptor, use the [create citationTemplate](../api/security-labelsroot-post-citations.md) operation. Similarly, you can use the GET or DELETE operations on the template resource for the descriptor.
+
+To list the descriptors that supplement a retention label, use the [GET](../api/security-retentionlabel-get.md) operation on that [retentionLabel](security-retentionlabel.md) resource and apply `$expand` on the **descriptors** relationship.
+
+For information on how retention labels and file plan descriptors work in the [Microsoft Purview compliance portal](https://compliance.microsoft.com/), see [Use file plan to create and manage retention labels](/purview/file-plan-manager).
Inherits from [microsoft.graph.entity](../resources/entity.md).
None.
|filePlanReferenceTemplate|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Security Fileplandescriptorbase https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplandescriptorbase.md
Title: "filePlanDescriptorBase resource type"
-description: "Represents the name for each file plan descriptor column associated with a particular label."
+description: "Specifies properties common to file plan descriptor resources."
ms.localizationpriority: medium
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the name for each [file plan descriptor](../resources/security-fileplandescriptor.md) column associated with a particular label.
+Specifies properties common to file plan descriptor resources. Base type for each of the descriptors: [appliedCategory](security-appliedcategory.md), [authority](security-authority.md), [citation](security-citation.md), [department](security-department.md), [filePlanReference](security-fileplanreference.md), and [subCategory](security-subcategory.md).
## Properties |Property|Type|Description| |:|:|:|
-|displayName|String|Unique string that defines the name for each [file plan descriptor](../resources/security-fileplandescriptor.md) associated with a particular retention label.|
+|displayName|String|Unique string that defines the name for the file plan descriptor associated with a particular retention label.|
## Relationships None.
v1.0 Security Fileplandescriptortemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplandescriptortemplate.md
Title: "filePlanDescriptorTemplate resource type"
-description: "Represents a group of columns to improve the manageability and organization of the content you need to label."
+description: "Specifies the properties common to the template resources for file plan descriptors."
ms.localizationpriority: medium
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a group of columns to improve the manageability and organization of the content you need to label.
+Specifies the properties common to the template resources for file plan descriptors. Base type for each of the template resources: [authorityTemplate](security-authoritytemplate.md), [categoryTemplate](security-categorytemplate.md), [citationTemplate](security-citationtemplate.md), [departmentTemplate](security-departmenttemplate.md), [filePlanReferenceTemplate](security-fileplanreferencetemplate.md), and [subCategoryTemplate](security-subcategorytemplate.md).
Inherits from [microsoft.graph.entity](../resources/entity.md). ## Methods
-|Method|Return type|Description|
-|:|:|:|
-|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get the authorityTemplate resources from the authorityTemplate navigation property.|
-|[Add authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Add authorityTemplate by posting to the authorityTemplate collection.|
-|[Remove authorities](../api/security-labelsroot-delete-authorities.md)|None|Remove a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.|
-|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get the categoryTemplate resources from the categoryTemplate navigation property.|
-|[Add categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Add categoryTemplate by posting to the categoryTemplate collection.|
-|[Remove categories](../api/security-labelsroot-delete-categories.md)|None|Remove a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.|
-|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get the citationTemplate resources from the citationTemplate navigation property.|
-|[Add citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Add citationTemplate by posting to the citationTemplate collection.|
-|[Remove citations](../api/security-labelsroot-delete-citations.md)|None|Remove a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.|
-|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get the departmentTemplate resources from the departmentTemplate navigation property.|
-|[Add departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Add departmentTemplate by posting to the departmentTemplate collection.|
-|[Remove departments](../api/security-labelsroot-delete-departments.md)|None|Remove a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.|
-|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get the filePlanReferenceTemplate resources from the filePlanReferenceTemplate navigation property.|
-|[Add filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Add filePlanReferenceTemplate by posting to the filePlanReferenceTemplate collection.|
-|[Remove filePlanReferences](../api/security-labelsroot-delete-fileplanreferences.md)|None|Remove a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.|
+None.
## Properties |Property|Type|Description| |:|:|:|
-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the filePlanDescriptorTemplate column.|
-|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanDescriptorTemplate is created.|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the filePlanDescriptorTemplate column. Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanDescriptorTemplate is created. Read-only.|
|displayName|String|Unique string that defines a filePlanDescriptorTemplate name.|
-|id|String|Unique ID of the filePlanDecriptorTemplate column. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+|id|String|Unique ID of the filePlanDecriptorTemplate column. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
## Relationships None.
v1.0 Security Fileplanreference https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplanreference.md
Title: "filePlanReference resource type"
-description: "Represents the file plan descriptor of type filePlanReference applied to a particular retention label."
+description: "Represents the file plan descriptor of a reference ID, supplementing a specified retention label."
ms.localizationpriority: medium
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the file plan descriptor of type filePlanReference applied to a particular retention label.
+Represents a file plan descriptor that specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+To create, get, or delete a **filePlanReference** descriptor, use the [filePlanReferenceTemplate](security-fileplanreferencetemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). ## Properties |Property|Type|Description| |:|:|:|
-|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+|displayName|String|Unique string that defines a reference ID. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
## Relationships None.
v1.0 Security Fileplanreferencetemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-fileplanreferencetemplate.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule.
-
+Supports CRUD operations to apply and manage the [filePlanReference](security-fileplanreference.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **filePlanReference** descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources
## Properties |Property|Type|Description| |:|:|:|
-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the file plan reference. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanReference is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the file plan reference descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanReference descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
|id|String|Unique ID of the filePlanReference. Inherited from [microsoft.graph.entity](../resources/entity.md).| ## Relationships
v1.0 Security Healthissue https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-healthissue.md
+
+ Title: "healthIssue resource type"
+description: "Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified."
+
+ms.localizationpriority: medium
Last updated : 03/20/2024++
+# healthIssue resource type
+
+Namespace: microsoft.graph.security
++
+Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified.
+
+Inherits from [microsoft.graph.entity](../resources/entity.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List](../api/security-identityContainer-list-healthissues.md)|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md) collection|Get a list of [healthIssue](../resources/security-healthissue.md) objects and their properties.|
+|[Get](../api/security-healthissue-get.md)|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md)|Read the properties and relationships of a [healthIssue](../resources/security-healthissue.md) object.|
+|[Update](../api/security-healthissue-update.md)|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md)|Update the properties of a [healthIssue](../resources/security-healthissue.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|additionalInformation|String collection|Contains additional information about the issue, such as a list of items to fix.|
+|createdDateTime|DateTimeOffset|The date and time of when the health issue was generated.|
+|description|String|Contains more detailed information about the health issue.|
+|displayName|String|The display name of the health issue.|
+|domainNames|String collection|A list of the fully qualified domain names of the domains or the sensors the health issue is related to.|
+|healthIssueType|[microsoft.graph.security.healthIssueType](#healthissuetype-values)|The type of the health issue. The possible values are: `sensor`, `global`, `unknownFutureValue`. For a list of all health issues and their identifiers, see [Microsoft Defender for Identity health issues](/defender-for-identity/health-alerts). |
+|ID|String|A unique identifier that represents the health issue.|
+|issueTypeId|String|The type identifier of the health issue. For a list of all health issues and their identifiers, see [Microsoft Defender for Identity health issues](/defender-for-identity/health-alerts).|
+|lastModifiedDateTime|DateTimeOffset|The date and time of when the health issue was last updated.|
+|recommendations|String collection|This field contains a list of recommended actions that can be taken to resolve the issue effectively and efficiently. These actions might include how to investigate the issue further. Not limited to prewritten responses.|
+|recommendedActionCommands|String collection|Contains a list of commands from the product's PowerShell module that can be used to resolve the issue, if available. If there aren't any commands that can be used to solve the issue, this field is empty. The commands, if present, provide a quick and efficient way to address the issue. The commands run in order for the single recommended fix.|
+|sensorDNSNames|String collection|A list of the dns names of the sensors the health issue is related to.|
+|severity|[microsoft.graph.security.healthIssueSeverity](#healthissueseverity-values)|The severity of the health issue. The possible values are: `low`, `medium`, `high`, `unknownFutureValue`.|
+|status|[microsoft.graph.security.healthIssueStatus](#healthissuestatus-values)|The status of the health issue. The possible values are: `open`, `closed`, `suppressed`, `unknownFutureValue`.|
+
+#### healthIssueSeverity values
+
+| Member | Description |
+| :--| : |
+| low | Low severity health issues usually indicate minor issues that don't have a significant impact on your environment. These issues require further investigation, but they usually don't require immediate action. |
+| medium | Medium severity health issues indicate more significant issues that could potentially impact your environment. These issues may require further investigation and action to prevent any potential problems. |
+| high | High severity health issues indicate critical issues that could have a severe impact on your environment. These issues require immediate attention and action. |
+| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.|
+
+#### healthIssueStatus values
+
+| Member | Description |
+| :--| : |
+| open | The issue is open and should be addressed. |
+| closed | The issue was addressed. Either someone manually closed the issue or took an action on the affected item, or it was closed automatically by the system. |
+| suppressed | The operator suppressed the issue manually. |
+| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.|
+
+#### healthIssueType values
+
+| Member | Description |
+| :--| : |
+| Sensor | The issue is on specific sensor. |
+| Global | The issue is in the Defender for identity system configuration. |
+| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.|
+
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "ID",
+ "@odata.type": "microsoft.graph.security.healthIssue",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.healthIssue",
+ "ID": "String (identifier)",
+ "displayName": "String",
+ "healthIssueType": "String",
+ "issueTypeId": "String",
+ "severity": "String",
+ "status": "String",
+ "createdDateTime": "String (timestamp)",
+ "lastModifiedDateTime": "String (timestamp)",
+ "domainNames": [
+ "String"
+ ],
+ "sensorDNSNames": [
+ "String"
+ ],
+ "description": "String",
+ "recommendations": [
+ "String"
+ ],
+ "recommendedActionCommands": [
+ "String"
+ ],
+ "additionalInformation": [
+ "String"
+ ]
+}
+```
+
v1.0 Security Identitycontainer https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-identitycontainer.md
+
+ Title: "identityContainer resource type"
+description: "A container for security identities APIs."
+
+ms.localizationpriority: medium
Last updated : 03/27/2024++
+# identityContainer resource type
+
+Namespace: microsoft.graph.security
++
+A container for security identities APIs. Currently exposes the [healthIssues](security-healthissue.md) relationship.
+
+## Methods
+
+None.
+
+## Properties
+
+None.
+
+## Relationships
+
+|Relationship|Type|Description|
+|:|:|:|
+|healthIssues|[microsoft.graph.security.healthIssue](security-healthissue.md) collection| Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified.|
+
+## JSON representation
+
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.identityContainer",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.identityContainer"
+}
+```
v1.0 Security Labelsroot https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-labelsroot.md
Title: "labelsRoot resource type"
-description: "Represents the entry point for the retentionLabels resource type."
+description: "A root resource for capabilities that support records management for Microsoft 365 data in an organization."
ms.localizationpriority: medium
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the entry point for the [retentionLabel](security-retentionlabel.md) resource type.
+A root resource for capabilities that support records management for Microsoft 365 data in an organization.
+Those capabilities include using a [retention label](security-retentionlabel.md) to configure retention and deletion settings for a type of content in the Microsoft 365 data, and using one or more [file plan descriptors](security-fileplandescriptor.md) to supplement the retention label and provide additional options to better manage and organize the content.
Inherits from [microsoft.graph.entity](../resources/entity.md).
v1.0 Security Recordsmanagement Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-recordsmanagement-overview.md
The Microsoft Purview records management APIs help organizations manage retentio
The records management solution is a part of the Microsoft Purview compliance center. ## Manage retention labels
-Records management admins and developers need to maintain records management systems with labels that are created, updated, and deleted periodically.
+Many organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content.
-Developers and compliance admins can use the records management APIs to perform operations on records management labels in order to maintain their systems.
+You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period.
+
+In addition, you can use [file plan descriptors](security-fileplandescriptor.md) to supplement a retention label and improve the manageability and organization of Microsoft 365 content. Examples of file plan descriptors include [authority](security-authority.md), [citation](security-citation.md), and [department](security-department.md).
## Trigger events for an existing label
-When an employee leaves a company, information is updated in the HR management system. From the leave date, confidential documents need to be retained for a period for 7 years. These documents have the label `Employee_departure` applied.
+Some scenarios require starting a retention period for certain documents upon a specific event, such as an employee leaving an organization, a contract expiring, or the fiscal year ending.
+
+You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period.
-Developers and compliance administrators can use records management APIs to read the label `Employee_departure` and look up the associated event type `Event-employee_departure`.
+As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. Use the **retentionLabel** and **retentionEvent** APIs to do the following for each employee record when the employee starts:
+1. Apply a **retentionLabel** configured as follows:
+ - A display name of "Personnel information"
+ - A **retentionDuration** of 1827 days (5 years)
+ - Listening to the **retentionEventType** named "Employee departure"
+2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventquery.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event.
-Compliance admins can use records management APIs to create an event for the associated event type. The retention period for the confidential documents starts after the creation of this event.
+When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventquery.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event.
## Entities The records management API includes the following key entities.
The records management API includes the following key entities.
| Name | Type | Use case | |:-|:-|:-| | Label | [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) | Contains retention settings and actions that can be applied to an item at the end of a period. |
+| File plan descriptors |[microsoft.graph.securty.fileplandescriptor](../resources/security-fileplandescriptor.md) | Represents a set of optional descriptors to supplement a retention label and improve their manageability for an organization. |
| Retention event | [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) | Represents a trigger for event-based retention, where a retention period starts after the event occurs. | | Retention event type | [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) | Represents a single group for the same type of retention events. |
v1.0 Security Retentionevent https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-retentionevent.md
To learn more about it, see [Start retention when an event occurs](/microsoft-36
|description|String|Optional information about the event.| |displayName|String|Name of the event.| |eventPropagationResult|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md)|Represents the success status of a created event and additional information.|
-|eventQueries|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.|
+|eventQuery|[microsoft.graph.security.eventQuery](../resources/security-eventquery.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.|
|retentionEventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md) collection|Status of event propogation to the scoped locations after the event has been created.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |id|String|Represents the unique ID of the user who created the retentionEvent. [entity](/graph/api/resources/entity).|
The following is a JSON representation of the resource.
"description": "String", "eventQueries": [ {
- "@odata.type": "microsoft.graph.security.eventQueries"
+ "@odata.type": "microsoft.graph.security.eventQuery"
} ], "eventTriggerDateTime": "String (timestamp)",
The following is a JSON representation of the resource.
}, "lastStatusUpdateDateTime": "String (timestamp)" }
-```
+```
v1.0 Security Retentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-retentionlabel.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents how customers can manage their data, including whether and for how long to retain or delete it.
+Represents how organizations, for compliance and governance purposes, can manage their data at an item level (email or document), including whether and for how long to retain or delete the item.
+
+Organizations can use retention labels for different types of content that require different retention settings. For example, they can apply a retention label to tax forms and supporting documents to retain them for the period required by law.
+
+Organizations can configure retention labels with the retention periods and actions based on factors such as the date last modified or created. They can also start different retention periods by specifying an [event that can trigger retention](security-retentionevent.md) when the event occurs.
+
+For more information on how retention labels work, when to use them, and how Microsoft Purview supports retention labels to let you configure retention and deletion settings, see [Learn about retention policies and retention labels](/purview/retention).
## Methods |Method|Return type|Description|
Represents how customers can manage their data, including whether and for how lo
## Properties |Property|Type|Description| |:|:|:|
-|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on a document with this label applied during the retention period. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.|
+|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on the labeled document after the period specified by the retentionDuration property expires. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.|
|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`.| |createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the retentionLabel.| |createdDateTime|DateTimeOffset|Represents the date and time in which the retentionLabel is created.|
v1.0 Security Subcategory https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-subcategory.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a unique subcategory applied to a retention label.
+Represents a unique subcategory applied to a [retention label](security-retentionlabel.md). Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md).
+To create, get, or delete a **subCategory** descriptor, use the [subCategoryTemplate](security-subcategorytemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
v1.0 Security Subcategorytemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-subcategorytemplate.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the file plan descriptor of type subcategory for retention labels.
-
+Supports CRUD operations to apply and manage the [subCategory](security-subcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **subCategory** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources
## Properties |Property|Type|Description| |:|:|:|
-|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the subcategory. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|createdDateTime|DateTimeOffset|Represents the date and time in which the subcategory is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
-|ID|String|Unique ID of the subcategory. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the subcategory descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the subcategory descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the subcategory. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
## Relationships None.
v1.0 Security https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security.md
None.
|alerts_v2 | [microsoft.graph.security.alert](security-alert.md) collection | A collection of alerts in Microsoft 365 Defender.| |attackSimulation|[attackSimulationRoot](../resources/attacksimulationroot.md)|Provides tenants capability to launch a simulated and realistic phishing attack and learn from it.| |collaboration|[microsoft.graph.security.collaborationRoot](../resources/security-collaborationroot.md)|Enables read and other actions on collaborative entities in Microsoft Defender.|
+|identities|[microsoft.graph.security.identityContainer](../resources/security-identityContainer.md)|A container for security identities APIs.|
|incidents | [microsoft.graph.security.incident](security-incident.md) collection | A collection of incidents in Microsoft 365 Defender, each of which is a set of correlated alerts and associated metadata that reflects the story of an attack.| |secureScores | [secureScore](securescores.md) collection | Measurements of tenantsΓÇÖ security posture to help protect them from threats. | |securityactions|[securityAction](../resources/securityaction.md) collection|Actions that respond to alerts to block malicious activities.|
v1.0 Simulation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/simulation.md
Inherits from [entity](../resources/entity.md).
|Member|Description | |:|:|
-|unknown| The simulation status is not defined. |
+|unknown| The simulation status isn't defined. |
|draft| The simulation is in draft mode. | |running| The simulation is running. | |scheduled| The simulation is scheduled. |
-|succeeded| The simulation has succeeded. |
-|failed| The simulation has failed. |
+|succeeded| The simulation is complete with success status. |
+|failed| The simulation is complete with fail status. |
|cancelled| The simulation is cancelled. | |excluded| The simulation is excluded. |
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
### simulationAttackTechnique values
Inherits from [entity](../resources/entity.md).
|driveByUrl| Attack technique that involves an end user clicking a URL link in the phishing payload. | |linkInAttachment| Attack technique that involves an end user clicking a URL link in an attachment. | |linkToMalwareFile| Attack technique that involves an end user clicking a URL link to a malware file. |
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
|oAuthConsentGrant| Attack technique that involves an end user who gives access consent to an app.|
+|phishTraining| Attack technique that involves training end users on actions to be performed on a phish mail.|
### simulationAttackType values
Inherits from [entity](../resources/entity.md).
|social| Attack that uses social skills to manipulate victims psychologically, creating a false sense of curiosity, urgency, or fear. | |cloud| Attack on a host or user in a cloud environment, for example, denial of service attacks.| |endpoint| Attack on endpoints of a corporate network, such as desktops, laptops, mobile phones, and Internet of Things (IoT) devices. |
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
### simulationContentStatus values |Member|Description | |:|:|
-|unknown| The simulation content status is not defined. |
+|unknown| The simulation content status isn't defined. |
|draft| The simulation content status is in draft state. | |ready| The simulation content status is in ready state. | |archive| The simulation content status is archive state. | |delete| The simulation content status is in delete state. |
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
### simulationContentSource values |Member|Description | |:|:|
-|unknown| The simulation content source is not defined. |
+|unknown| The simulation content source isn't defined. |
|global| The simulation content source is global. | |tenant| The simulation content source is tenant. |
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
## Relationships
v1.0 Teamsasyncoperationtype https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsasyncoperationtype.md
Title: "teamsAsyncOperationType enum type"
-description: "Types of teamsAsyncOperation. Members will be added here as more async operations are supported."
+description: "Types of teamsAsyncOperation. Members are added here as more async operations are supported."
ms.localizationpriority: medium
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Types of [teamsAsyncOperation](teamsasyncoperation.md). Members will be added here as more async operations are supported.
+Types of [teamsAsyncOperation](teamsasyncoperation.md). Members are added here as more async operations are supported.
## Members
-The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `teamifyGroup`, `createChannel`, `createChat`.
+The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `teamifyGroup`, `createChannel`, `createChat`, `archiveChannel`, `unarchiveChannel`.
| Member | Description | |:|:-|
The following table lists the members of an [evolvable enumeration](/graph/best-
|archiveTeam|Operation to archive a team.| |unarchiveTeam|Operation to restore an archived team.| |createTeam|Operation to create a team from scratch.|
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
|teamifyGroup |Operation to create a team from a group. | |createChannel |Operation to create a channel in a team. | |createChat|Operation to create a chat from scratch.|
+|archiveChannel |Operation to archive a channel.|
+|unarchiveChannel |Operation to unarchive a channel.|
v1.0 Training https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/training.md
Inherits from [entity](../resources/entity.md).
|Property|Type|Description| |:|:|:|
-|availabilityStatus|trainingAvailabilityStatus|Training availability status. Possible values are: `unknown`, `notAvailable`, `available`, `archive`, `delete`, `unknownFutureValue`.|
-|createdBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who created the training.|
-|createdDateTime|DateTimeOffset|Date and time when the training was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
+|availabilityStatus|trainingAvailabilityStatus|The training availability status. Possible values are: `unknown`, `notAvailable`, `available`, `archive`, `delete`, `unknownFutureValue`.|
+|createdBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who created the training.|
+|createdDateTime|DateTimeOffset|The date and time when the training was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
+|customUrl|String|The training URL|
|description|String|The description for the training.| |displayName|String|The display name for the training.|
-|durationInMinutes|Int32|Training duration.|
-|hasEvaluation|Boolean|Indicates whether the training has any evaluation.|
-|id|String|Unique identifier for the **training** object. Inherited from [entity](../resources/entity.md).|
-|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who last modified the training.|
-|lastModifiedDateTime|DateTimeOffset|Date and time when the training was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
-|source|[simulationContentSource](../resources/simulation.md#simulationcontentsource-values)|Training content source. Possible values are: `unknown`, `global`, `tenant`, `unknownFutureValue`.|
-|supportedLocales|String collection|Supported locales for content for the associated training.|
+|durationInMinutes|Int32|The duration of the training in minutes.|
+|hasEvaluation|Boolean|Whether the training has any evaluation.|
+|id|String|The unique identifier for the **training** object. Inherited from [entity](../resources/entity.md).|
+|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who last modified the training.|
+|lastModifiedDateTime|DateTimeOffset|The date and time when the training was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
+|source|[simulationContentSource](../resources/simulation.md#simulationcontentsource-values)|The source of the training content. Possible values are: `unknown`, `global`, `tenant`, `unknownFutureValue`.|
+|supportedLocales|String collection|The supported locales for content for the associated training.|
|tags|String collection|Training tags.| |type|trainingType|The type of training. Possible values are: `unknown`, `phishing`, `unknownFutureValue`.|
Inherits from [entity](../resources/entity.md).
|Relationship|Type|Description| |:|:|:|
-|languageDetails|[trainingLanguageDetail](../resources/traininglanguagedetail.md) collection|Language specific details on a training.|
+|languageDetails|[trainingLanguageDetail](../resources/traininglanguagedetail.md) collection|Details about the language used in the training.|
## JSON representation
The following JSON representation shows the resource type.
"id": "String (identifier)", "lastModifiedBy": {"@odata.type": "microsoft.graph.emailIdentity"}, "lastModifiedDateTime": "String (timestamp)",
+ "customUrl": "String",
"source": "String", "supportedLocales": ["String"], "tags": ["String"],
v1.0 Trainingcampaign https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingcampaign.md
+
+ Title: "trainingCampaign resource type"
+description: "Represents a training campaign."
+
+ms.localizationpriority: medium
++
+# trainingCampaign resource type
+
+Namespace: microsoft.graph
++
+Represents a training campaign. In Attack simulation training in Microsoft 365 E5 or Microsoft Defender for Office 365 Plan 2, training campaigns are a fast, direct way to provide security training to users. Instead of creating and launching simulated phishing attacks that eventually lead to training, you can create and assign training campaigns directly to users.
+
+A training campaign contains one or more built-in training modules that you select. Currently, there are over 70 training modules to select from. For more information about training modules, see training modules for Training campaigns in Attack simulation training.
++
+Inherits from [entity](../resources/entity.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List trainingCampaigns](../api/attacksimulationroot-list-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md) collection|Get a list of the [trainingCampaign](../resources/trainingcampaign.md) objects and their properties.|
+|[Create trainingCampaign](../api/attacksimulationroot-post-trainingcampaigns.md)|[trainingCampaign](../resources/trainingcampaign.md)|Create a new [trainingCampaign](../resources/trainingcampaign.md) object.|
+|[Get trainingCampaign](../api/trainingcampaign-get.md)|[trainingCampaign](../resources/trainingcampaign.md)|Read the properties and relationships of a [trainingCampaign](../resources/trainingcampaign.md) object.|
+|[Update trainingCampaign](../api/trainingcampaign-update.md)|[trainingCampaign](../resources/trainingcampaign.md)|Update the properties of a [trainingCampaign](../resources/trainingcampaign.md) object.|
+|[Delete trainingCampaign](../api/attacksimulationroot-delete-trainingcampaigns.md)|None|Delete a [trainingCampaign](../resources/trainingcampaign.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|campaignSchedule|[campaignSchedule](../resources/campaignschedule.md)|Details about the schedule and current status for a training campaign|
+|createdBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who created the training campaign|
+|createdDateTime|DateTimeOffset|Date and time of creation of the training campaign.|
+|description|String|Description of the training campaign.|
+|displayName|String|Display name of the training campaign. Supports `$filter` and `$orderby`.|
+|endUserNotificationSetting|[endUserNotificationSetting](../resources/endusernotificationsetting.md)|Details about the end user notification setting.|
+|excludedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|Users excluded from the training campaign.|
+|id|String|Unique identifier for the training campaign. Inherited from [entity](../resources/entity.md).|
+|includedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|Users targeted in the training campaign.|
+|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who most recently modified the training campaign.|
+|lastModifiedDateTime|DateTimeOffset|Date and time of the most recent modification of the training campaign.|
+|report|[trainingCampaignReport](../resources/trainingcampaignreport.md)|Report of the training campaign.|
+|trainingSetting|[trainingSetting](../resources/trainingsetting.md)|Details about the training settings for a training campaign.|
+
+### campaignStatus values
+
+|Member|Description |
+|:|:|
+|unknown| The campaign status isn't defined. |
+|draft| The campaign is in draft mode. |
+|inProgress| The campaign is in progress. |
+|scheduled| The campaign is scheduled. |
+|completed| The campaign is complete. |
+|failed| The campaign failed. |
+|cancelled| The campaign is cancelled. |
+|excluded| The campaign is excluded. |
+|deleted| The campaign is in draft mode. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
+
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.trainingCampaign",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.trainingCampaign",
+ "id": "String (identifier)",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.emailIdentity"
+ },
+ "createdDateTime": "String (timestamp)",
+ "description": "String",
+ "displayName": "String",
+ "endUserNotificationSetting": {
+ "@odata.type": "microsoft.graph.endUserNotificationSetting"
+ },
+ "excludedAccountTarget": {
+ "@odata.type": "microsoft.graph.accountTargetContent"
+ },
+ "includedAccountTarget": {
+ "@odata.type": "microsoft.graph.accountTargetContent"
+ },
+ "lastModifiedBy": {
+ "@odata.type": "microsoft.graph.emailIdentity"
+ },
+ "lastModifiedDateTime": "String (timestamp)",
+ "report": {
+ "@odata.type": "microsoft.graph.trainingCampaignReport"
+ },
+ "trainingSetting": {
+ "@odata.type": "microsoft.graph.trainingSetting"
+ },
+ "campaignSchedule": {
+ "@odata.type": "microsoft.graph.campaignSchedule"
+ }
+}
+```
+
+## Related content
+- [Training campaigns in Attack simulation training](/microsoft-365/security/office-365-security/attack-simulation-training-training-campaigns?view=o365-worldwide&preserve-view=true)
+
v1.0 Trainingcampaignreport https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingcampaignreport.md
+
+ Title: "trainingCampaignReport resource type"
+description: "Represents a report of a training campaign, including an overview and a list of the users who participated in the campaign."
+
+ms.localizationpriority: medium
++
+# trainingCampaignReport resource type
+
+Namespace: microsoft.graph
++
+Represents a report of a training campaign, including an overview and a list of the users who participated in the campaign.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|campaignUsers|[userSimulationDetails](../resources/usersimulationdetails.md) collection|The overview of the attack simulation and training campaign.|
+|overview|[trainingCampaignReportOverview](../resources/trainingcampaignreportoverview.md)|The tenant users and their online actions in a training campaign.|
+
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.trainingCampaignReport"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.trainingCampaignReport",
+ "overview": {
+ "@odata.type": "microsoft.graph.trainingCampaignReportOverview"
+ },
+ "campaignUsers": [
+ {
+ "@odata.type": "microsoft.graph.userSimulationDetails"
+ }
+ ]
+}
+```
+
v1.0 Trainingcampaignreportoverview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingcampaignreportoverview.md
+
+ Title: "trainingCampaignReportOverview resource type"
+description: "Represents an overview report of a training campaign."
+
+ms.localizationpriority: medium
++
+# trainingCampaignReportOverview resource type
+
+Namespace: microsoft.graph
++
+Represents an overview report of a training campaign.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|trainingModuleCompletion|[trainingEventsContent](../resources/trainingeventscontent.md)|Aggregate data of training completion.|
+|trainingNotificationDeliveryStatus|[trainingNotificationDelivery](../resources/trainingnotificationdelivery.md)|Aggregate data of training mail delivery over the course of the training campaign.|
+|userCompletionStatus|[userTrainingCompletionSummary](../resources/usertrainingcompletionsummary.md)|Aggregate data of users training progress.|
+
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.trainingCampaignReportOverview"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.trainingCampaignReportOverview",
+ "trainingModuleCompletion": {
+ "@odata.type": "microsoft.graph.trainingEventsContent"
+ },
+ "userCompletionStatus": {
+ "@odata.type": "microsoft.graph.userTrainingCompletionSummary"
+ },
+ "trainingNotificationDeliveryStatus": {
+ "@odata.type": "microsoft.graph.trainingNotificationDelivery"
+ }
+}
+```
+
v1.0 Trainingnotificationdelivery https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trainingnotificationdelivery.md
+
+ Title: "trainingNotificationDelivery resource type"
+description: "Contains aggregate data about training mail delivery over the course of the training campaign."
+
+ms.localizationpriority: medium
++
+# trainingNotificationDelivery resource type
+
+Namespace: microsoft.graph
++
+Contains aggregate data about training mail delivery over the course of the training campaign.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|failedMessageDeliveryCount|Int32|The number of users to whom mails couldn't be delivered.|
+|resolvedTargetsCount|Int32|The number of users whose email address was successfully resolved from target users.|
+|successfulMessageDeliveryCount|Int32|The number of users who received a mail while the training campaign was in the "in progress" state.|
+
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.trainingNotificationDelivery"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.trainingNotificationDelivery",
+ "resolvedTargetsCount": "Integer",
+ "successfulMessageDeliveryCount": "Integer",
+ "failedMessageDeliveryCount": "Integer"
+}
+```
+
v1.0 User https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/user.md
This resource supports:
| surname | String | The user's surname (family name or last name). Maximum length is 64 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | | usageLocation | String | A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: `US`, `JP`, and `GB`. Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| | userPrincipalName | String | The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's verified domain collection. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md).<br>NOTE: This property can't contain accent characters. Only the following characters are allowed `A - Z`, `a - z`, `0 - 9`, `' . - _ ! # ^ ~`. For the complete list of allowed characters, see [username policies](/azure/active-directory/authentication/concept-sspr-policy#userprincipalname-policies-that-apply-to-all-user-accounts). <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`) and `$orderby`.
-| userType | String | A String value that can be used to classify user types in your directory, such as `Member` and `Guest`. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) |
+| userType | String | A String value that can be used to classify user types in your directory. The possible values are `Member` and `Guest`. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) |
> [!TIP] > Directory extensions and associated data are returned by default; schema extensions and associated data are returned only on `$select`; and open extensions and associated data are returned only on `$expand`.
v1.0 Usertrainingcompletionsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/usertrainingcompletionsummary.md
+
+ Title: "userTrainingCompletionSummary resource type"
+description: "Contains aggregate data about userss training progress."
+
+ms.localizationpriority: medium
++
+# userTrainingCompletionSummary resource type
+
+Namespace: microsoft.graph
++
+Contains aggregate data about userss training progress.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|completedUsersCount|Int32|The number of users who completed all the trainings before the due date.|
+|inProgressUsersCount|Int32|The number of users who started at least one training.|
+|notCompletedUsersCount|Int32|The number of users who didn't complete all the trainings before the due date.|
+|notStartedUsersCount|Int32|The number of users who didn't start any training.|
+|previouslyAssignedUsersCount|Int32|The number of users who are already assigned the same training.|
+
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.userTrainingCompletionSummary"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.userTrainingCompletionSummary",
+ "notStartedUsersCount": "Integer",
+ "completedUsersCount": "Integer",
+ "inProgressUsersCount": "Integer",
+ "notCompletedUsersCount": "Integer",
+ "previouslyAssignedUsersCount": "Integer"
+}
+```
+
v1.0 Appcatalogs List Teamsapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/appcatalogs-list-teamsapps.md
doc_type: apiPageType
Namespace: microsoft.graph List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog.
-This includes apps from the Microsoft Teams store, as well as apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
+This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
> [!NOTE] > In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource.
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "appcatalogs_list_teamsapps" } --> [!INCLUDE [permissions-table](../includes/permissions/appcatalogs-list-teamsapps-permissions.md)]
-> **Note**:
-The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward.
+> [!NOTE]
+> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward.
## HTTP request
GET /appCatalogs/teamsApps
This method supports the `$filter`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response.
-Using `$expand=AppDefinitions` will return more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app has been approved, rejected, or remains under review.
+Using `$expand=AppDefinitions` returns more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app is approved, rejected, or remains under review.
> **Note:** You can filter on any of the fields of the [teamsApp](../resources/teamsapp.md) object to shorten the list of results. You can use any of the following filter operations: Equal, not-equal, and, or, and not.
Content-Type: application/json
### Example 4: List applications with a given ID, and return the submission review state
-The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the app's submission review state. `Submitted` means the review is pending, `published` means the app was approved by the admin, and `rejected` means the app was rejected by the admin.
+The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the app's submission review state. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the admin rejected the app.
#### Request
v1.0 Application Post Calls https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-post-calls.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "application_post_calls" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)]
-> **Notes:**
+> [!NOTE]
> - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table.
-> - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser.
> - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser.
+ ## HTTP request <!-- { "blockType": "ignored" } --> ```http
v1.0 Channel Get Filesfolder https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-get-filesfolder.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "channel_get_filesfolder" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-get-filesfolder-permissions.md)]
-> **Note**: The Group.Read.All and Group.ReadWrite.All permissions 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.
+> [!NOTE]
+> The Group.Read.All and Group.ReadWrite.All permissions 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.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Channel List Messages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-list-messages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "channel_list_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-list-messages-permissions.md)]
-> **Note**: The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Channel Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post-members.md
Include the following properties in the request body.
If successful, this method returns a `201 Created` response code and a [conversationMember](../resources/conversationmember.md) object in the response body.
+> [!NOTE]
+> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user.
+ ## Examples ### Example 1: Add a member to a private channel
v1.0 Channel Post Messages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post-messages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "channel_post_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-messages-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is 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.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
-In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> The Group.ReadWrite.All permission is 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.
+> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
<!-- markdownlint-disable MD024 --> <!-- markdownlint-disable MD001 -->
POST /teams/{team-id}/channels/{channel-id}/messages
## Request body
-In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. )ther properties are optional.
+In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. All other properties are optional.
## Response
v1.0 Channel Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post.md
doc_type: apiPageType
Namespace: microsoft.graph
-Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams.
+Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams.
If you're creating a private channel, you can add a maximum of 200 members.
If you're creating a private channel, you can add a maximum of 200 members.
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of.
+ |Permission type | Permissions (from least to most privileged) | |:--|:| |Delegated (work or school account) | Channel.Create, Group.ReadWrite.All, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |
-|Application | Channel.Create.Group*, Channel.Create, Teamwork.Migrate.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+|Application | Channel.Create.Group, Channel.Create, Teamwork.Migrate.All, Group.ReadWrite.All, Directory.ReadWrite.All |
-> **Notes**:
-> The Group.ReadWrite.All and Directory.ReadWrite.All permissions 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 marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
->
-> This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of.
->
-> In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported
-using Teamwork.Migrate.All and/or [migration APIs](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
+> [!NOTE]
+> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions 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.
+> - The Channel.Create.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported using Teamwork.Migrate.All and/or [migration APIs](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
## HTTP request <!-- { "blockType": "ignored" } -->
Location: /teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels('19:4b6bed8d24
#### Request
-The following example shows a request to create a private channel and add a user as an team owner.
+The following example shows a request to create a private channel and add a user as a team owner.
# [HTTP](#tab/http)
v1.0 Chat Get Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-get-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-installedapps-permissions.md)]
-> **Note:**
-The TeamsAppInstallation.ReadWriteAndConsentSelfForChat and TeamsAppInstallation.ReadWriteAndConsentForChat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsAppInstallation.ReadWriteAndConsentSelfForChat and TeamsAppInstallation.ReadWriteAndConsentForChat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
Content-type: application/json
### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat
-The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameterd is required to show the consented permission set.
+The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameter is required to show the consented permission set.
#### Request
v1.0 Chat List Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-list-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-installedapps-permissions.md)]
-> **Note:**
-The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent):
+> [!NOTE]
+> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent):
> - TeamsAppInstallation.ReadWriteAndConsentSelfForChat > - TeamsAppInstallation.ReadWriteAndConsentForChat > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All
v1.0 Chat Post Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-post-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_post_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-installedapps-permissions.md)]
-> **Note:** These TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions.
+> [!NOTE]
+> These TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions.
## HTTP request
POST /chats/{chat-id}/installedApps
## Request body The request body should include the generated app ID of the catalog app. For more information, see [teamsApp properties](../resources/teamsapp.md#properties).
-The following table lists additional parameters that can be used with the request body.
+The following table lists other parameters that can be used with the request body.
|Parameter|Type|Description| |:|:|:|
The following example shows the response.
HTTP/1.1 201 Created ```
-### Example 2: Install app in a chat and and consent to the resource-specific permissions required by the app
+### Example 2: Install app in a chat and consent to the resource-specific permissions required by the app
To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app).
v1.0 Chat Teamsappinstallation Upgrade https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-teamsappinstallation-upgrade.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_teamsappinstallation_upgrade" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-teamsappinstallation-upgrade-permissions.md)]
-> **Note:** The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions.
+> [!NOTE]
+> The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions.
## HTTP request <!-- { "blockType": "ignored" } -->
POST /chats/{chat-id}/installedApps/{app-installation-id}/upgrade
In the request body, supply a JSON representation of the parameters.
-The following table lists additional parameters that can be used with the upgrade action.
+The following table lists other parameters that can be used with the upgrade action.
|Parameter|Type|Description| |:|:|:|
v1.0 Chatmessage Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-delta.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_delta" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-delta-permissions.md)]
-> **Note**: The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chatmessage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All|
-> **Note:** The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
+> [!NOTE]
+> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
## HTTP request
GET /me/chats/{chat-id}/messages/{message-id}
``` ## Optional query parameters
-This method does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This method doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers | Header | Value |
v1.0 Chatmessage List Hostedcontents https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-list-hostedcontents.md
doc_type: "apiPageType"
Namespace: microsoft.graph
-Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md)
+Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md).
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco
|Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All|
-> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chatmessage List Replies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-list-replies.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_list_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-list-replies-permissions.md)]
-> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chatmessage Post Replies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-post-replies.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_post_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is 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.
+> [!NOTE]
+> The Group.ReadWrite.All permission is 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.
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
-In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chatmessage Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-post.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_post" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)]
-> **Note**: The Group.ReadWrite.All permissino is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table.
+> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported.
### Permissions for chat <!-- { "blockType": "permissions", "name": "chatmessage_post_2" } -->
v1.0 Chatmessage Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessage-update.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | ChannelMessage.UpdatePolicyViolation.All, Group.ReadWrite.All** |
-> **Note:** The Group.ReadWrite.All permission is 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.
+> [!NOTE]
+> The Group.ReadWrite.All permission is 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 <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->
v1.0 Chatmessagehostedcontent Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chatmessagehostedcontent-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All|
-> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages/{message-id}
## Optional query parameters
-This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers
v1.0 Cloudpc Endgraceperiod https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-endgraceperiod.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "endgraceperiod_cloudpc"
The following example shows a request.
POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/4b18de4b-ab05-4059-8c61-0323a7df4ced/endGracePeriod ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpc Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-get.md
If successful, this method returns a `200 OK` response code and a [cloudPC](../r
The following example shows a request to get the default properties of a Cloud PC.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpc_default_properties"
The following example shows a request to get the default properties of a Cloud P
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc43ec9 ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpc Reboot https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-reboot.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request to reboot a Cloud PC for the administrator.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "reboot_cloudpc"
The following example shows a request to reboot a Cloud PC for the administrator
POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/831dd62e-cfa1-4d49-a3b4-58d4e9920f8e/reboot ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpc Rename https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-rename.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request to rename a Cloud PC for the administrator.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "rename_cloudpc"
Content-Type: application/json
} ```
+# [CLI](#tab/cli)
+
+# [JavaScript](#tab/javascript)
+++ ### Response The following example shows the response. <!-- {
v1.0 Cloudpc Restore https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-restore.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "cloudpc_restore",
Content-length: 37
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpc Troubleshoot https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpc-troubleshoot.md
If successful, this method returns a `204 No Content` response code.
### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "troubleshoot_cloudpc"
The following example shows a request.
POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/ff4eb6ab-d56a-4edf-90c1-baaec8dd6032/troubleshoot ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response. <!-- {
v1.0 Cloudpcauditevent Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcauditevent-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcAuditE
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcauditevent"
The following example shows a request.
``` http GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/auditEvents/{id} ```+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Cloudpcauditevent Getauditactivitytypes https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcauditevent-getauditactivitytypes.md
Get audit activity types by tenant ID.
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-<!-- { "blockType": "permissions", "name": "cloudpcauditevent_getAuditActivityTypes" } -->
+<!-- { "blockType": "permissions", "name": "cloudpcauditevent_getauditactivitytypes" } -->
[!INCLUDE [permissions-table](../includes/permissions/cloudpcauditevent-getauditactivitytypes-permissions.md)] ## HTTP request
If successful, this method returns a `200 OK` response code and a String collect
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "cloudpcauditevent_getauditactivitytypes"
The following example shows a request.
``` http GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/auditEvents/getAuditActivityTypes ```+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Cloudpcdeviceimage Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcdeviceimage-delete.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_deviceimages_from_virtualendpoint"
The following example shows a request.
DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages/435849e6-0263-4621-9f93-8657667af3bb ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcdeviceimage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcdeviceimage-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcDevice
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcdeviceimage"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages/eda7ed64-7705-4079-9d08-c2bd883f4fff ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcdeviceimage Getsourceimages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcdeviceimage-getsourceimages.md
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "cloudpcdeviceimage_getsourceimages"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages/getSourceImages ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcgalleryimage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcgalleryimage-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcGaller
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcgalleryimage",
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/galleryImages/MicrosoftWindowsDesktop_windows-ent-cpc_19h2-ent-cpc-os ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpconpremisesconnection Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-delete.md
You cannot delete an Azure network connection when it's in use, as indicated by
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-<!-- { "blockType": "permissions", "name": "cloudPcOnPremisesConnection_delete" } -->
+<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_delete" } -->
[!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-delete-permissions.md)] ## HTTP request
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_onpremisesconnections_from_virtualendpoint"
The following example shows a request.
DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Cloudpconpremisesconnection Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-get.md
Read the properties and relationships of the [cloudPcOnPremisesConnection](../re
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-<!-- { "blockType": "permissions", "name": "cloudPcOnPremisesConnection_get" } -->
+<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_get" } -->
[!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-get-permissions.md)] ## HTTP request
If successful, this method returns a `200 OK` response code and a [cloudPcOnPrem
#### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpconpremisesconnection"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ #### Response
Content-Type: application/json
#### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpconpremisesconnection_withDetails"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id}?$select=id,displayName,healthCheckStatus,healthCheckStatusDetail,inUse ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ #### Response
v1.0 Cloudpconpremisesconnection Runhealthcheck https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-runhealthcheck.md
It triggers a new health check for the [cloudPcOnPremisesConnection (../resource
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-<!-- { "blockType": "permissions", "name": "cloudPcOnPremisesConnection_runhealthcheck" } -->
+<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_runhealthcheck" } -->
[!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-runhealthcheck-permissions.md)] ## HTTP request
If successful, this method returns a `204 No Content` response code.
### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "cloudpconpremisesconnection_runhealthcheck_2"
The following example shows a request.
``` http POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections/{id}/runHealthChecks ```+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Cloudpconpremisesconnection Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpconpremisesconnection-update.md
Update the properties of a [cloudPcOnPremisesConnection](../resources/cloudpconp
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-<!-- { "blockType": "permissions", "name": "cloudPcOnPremisesConnection_update" } -->
+<!-- { "blockType": "permissions", "name": "cloudpconpremisesconnection_update" } -->
[!INCLUDE [permissions-table](../includes/permissions/cloudpconpremisesconnection-update-permissions.md)] ## HTTP request
If successful, this method returns a `200 OK` response code and an updated [clou
### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_onpremisesconnections"
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Cloudpcprovisioningpolicy Assign https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-assign.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "assign_cloudpcprovisioningpolicy",
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcprovisioningpolicy Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-delete.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_provisioningpolicies_from_virtualendpoint"
The following example shows a request.
DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcprovisioningpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-get.md
The following example shows how to get the properties of the specified provision
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcprovisioningpolicy_1"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
The following example shows how to get the properties of the specified provision
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcprovisioningpolicy_2"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff?$expand=assignments ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
The following example shows a request that retrieves the selected properties of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcprovisioningpolicy_3"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfigurations,imageDisplayName,imageId,imageType,windowsSetting,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
v1.0 Cloudpcprovisioningpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcprovisioningpolicy-update.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_provisioningpolicy"
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcusersetting Assign https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-assign.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "cloudpcusersetting_assign",
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcusersetting Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-delete.md
If successful, this method returns a `204 No Content` response code.
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_cloudpcusersetting"
The following example shows a request.
DELETE https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings/b0c2d35f-3385-46c8-a6f5-6c3dfad7ffff ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcusersetting Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-get.md
The following example shows how to get the properties of the specified user sett
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcusersetting"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings/556092f8-92f8-5560-f892-6055f8926055 ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
The following example shows how to get the properties of the specified user sett
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcusersetting_2"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings/b0c2d35f-3385-46c8-a6f5-6c3dfad7ffff?$expand=assignments ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
v1.0 Cloudpcusersetting Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/cloudpcusersetting-update.md
If successful, this method returns a `200 OK` response code and an updated [clou
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_cloudpcusersetting"
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Conversationmember Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/conversationmember-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| For **user** or **chat** resource: Not supported.<br/><br/>For **channel** resource: TeamMember.Read.Group, ChannelMember.Read.All, ChannelMember.ReadWrite.All |
-> **Note:** The TeamMember.Read.Group permmission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamMember.Read.Group permmission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Crosstenantaccesspolicyconfigurationdefault Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-get.md
Content-Type: application/json
} ] }
+ },
+ "invitationRedemptionIdentityProviderConfiguration":
+ {
+ "primaryIdentityProviderPrecedenceOrder": [
+ "externalFederation",
+ "azureActiveDirectory",
+ "socialIdentityProviders"
+ ],
+ "fallbackIdentityProvider": "defaultConfiguredIdp"
} } ```
v1.0 Crosstenantaccesspolicyconfigurationdefault Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md
If successful, this method returns a `204 No Content` response code.
## Examples
-### Request
+### Example 1: Block outbound B2B collaboration for a group of users
+#### Request
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_crosstenantaccesspolicyconfigurationdefault" } -->- ``` http PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default Content-Type: application/json
Content-Type: application/json
} ```
-# [C#](#tab/csharp)
+#### Response
-# [CLI](#tab/cli)
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
-# [Go](#tab/go)
+``` http
+HTTP/1.1 204 No Content
+```
-# [Java](#tab/java)
+### Example 2: Update default invitation redemption configuration
-# [JavaScript](#tab/javascript)
+#### Request
-# [PHP](#tab/php)
+<!-- {
+ "blockType": "request",
+ "name": "update_crosstenantaccesspolicyconfigurationdefault_idpconfiguration"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default
+Content-Type: application/json
-# [PowerShell](#tab/powershell)
+{
+ "invitationRedemptionIdentityProviderConfiguration": {
+ "primaryIdentityProviderPrecedenceOrder": [
+ "externalFederation",
+ "azureActiveDirectory",
+ "socialIdentityProviders"
+ ],
+ "fallbackIdentityProvider": "defaultConfiguredIdp"
+ }
+}
+```
-# [Python](#tab/python)
+#### Response
-
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+``` http
+HTTP/1.1 204 No Content
+```
+
+### Example 3: Disallow Microsoft accounts as an option for redeeming B2B invitations
+
+#### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "update_crosstenantaccesspolicyconfigurationdefault_idpconfiguration_noMsa"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default
+Content-Type: application/json
+
+{
+ "invitationRedemptionIdentityProviderConfiguration": {
+ "primaryIdentityProviderPrecedenceOrder": [
+ "externalFederation",
+ "azureActiveDirectory",
+ "socialIdentityProviders"
+ ],
+ "fallbackIdentityProvider": "emailOneTimePasscode"
+ }
+}
+```
-### Response
+#### Response
<!-- { "blockType": "response",
v1.0 Deletedchat Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/deletedchat-get.md
GET https://graph.microsoft.com/v1.0/teamwork/deletedChats/19:64dedcac16b74a209b
[!INCLUDE [sample-code](../includes/snippets/php/get-deletedchat-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-deletedchat-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Deletedchat Undodelete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/deletedchat-undodelete.md
POST https://graph.microsoft.com/v1.0/teamwork/deletedChats/19:64dedcac16b74a209
[!INCLUDE [sample-code](../includes/snippets/php/deletedchatundodelete-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/deletedchatundodelete-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Domain Post Federationconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-post-federationconfiguration.md
Title: "Create internalDomainFederation"
description: "Create a new internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_post_federationconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-post-federationconfiguration-permissions.md)]
+> [!IMPORTANT]
+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios.
+ [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request
You can specify the following properties when creating an **internalDomainFedera
|displayName|String|The display name of the federated identity provider.| |issuerUri|String|Issuer URI of the federation server.| |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications.|
-|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and will update the federation settings for the domain when a new certificate is available.|
+|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and updates the federation settings for the domain when a new certificate is available.|
|passiveSignInUri|String|URI that web-based clients are directed to when signing in to Microsoft Entra services.| |preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`.| |activeSignInUri|String|URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Microsoft Entra ID. Corresponds to the **ActiveLogOnUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.|
-|isSignedAuthenticationRequestRequired|Boolean|If true, when SAML authentication requests are sent to the federated SAML IDP, Microsoft Entra ID will sign those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IDP are not signed.|
-|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the auto-rollover update, a new federation service is being set up, or if the new token signing certificate is not present in the federation properties after the federation service certificate has been updated.|
+|isSignedAuthenticationRequestRequired|Boolean|If true, when SAML authentication requests are sent to the federated SAML IDP, Microsoft Entra ID signs those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IDP aren't signed.|
+|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base 64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the autorollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.|
|signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |federatedIdpMfaBehavior|federatedIdpMfaBehavior|Determines whether Microsoft Entra ID accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: `acceptIfMfaDoneByFederatedIdp`, `enforceMfaByFederatedIdp`, `rejectMfaByFederatedIdp`, `unknownFutureValue`. For more information, see [federatedIdpMfaBehavior values](#federatedidpmfabehavior-values).| + ### federatedIdpMfaBehavior values | Member | Description |
v1.0 Internaldomainfederation Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/internaldomainfederation-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "internaldomainfederation_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-delete-permissions.md)]
+> [!IMPORTANT]
+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios.
+
+<!-- Domain Name Administrator and Hybrid Identity Administrator can't delete federated domains -->
The calling user must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): - Security Administrator
v1.0 Internaldomainfederation Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/internaldomainfederation-update.md
Title: "Update internalDomainFederation"
description: "Update the properties of an internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "internaldomainfederation_update" } --> [!INCLUDE [permissions-table](../includes/permissions/internaldomainfederation-update-permissions.md)]
+> [!IMPORTANT]
+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios.
+ [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request
PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId}
|activeSignInUri|String|URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Microsoft Entra ID. Corresponds to the **ActiveLogOnUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |displayName|String|The display name of the federated identity Provider (IdP). | |federatedIdpMfaBehavior|federatedIdpMfaBehavior|Determines whether Microsoft Entra ID accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: `acceptIfMfaDoneByFederatedIdp`, `enforceMfaByFederatedIdp`, `rejectMfaByFederatedIdp`, `unknownFutureValue`. For more information, see [federatedIdpMfaBehavior values](#federatedidpmfabehavior-values).|
-|isSignedAuthenticationRequestRequired|Boolean|If `true`, when SAML authentication requests are sent to the federated SAML IdP, Microsoft Entra ID will sign those requests using the OrgID signing key. If `false` (default), the SAML authentication requests sent to the federated IdP are not signed.|
+|isSignedAuthenticationRequestRequired|Boolean|If `true`, when SAML authentication requests are sent to the federated SAML IdP, Microsoft Entra ID signs those requests using the OrgID signing key. If `false` (default), the SAML authentication requests sent to the federated IdP aren't signed.|
|issuerUri|String|Issuer URI of the federation server.| |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications.|
-|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the auto-rollover update, a new federation service is being set up, or if the new token signing certificate is not present in the federation properties after the federation service certificate has been updated.|
+|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base 64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the autorollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.|
|passiveSignInUri|String|URI that web-based clients are directed to when signing into Microsoft Entra services. | |preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`. | |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.|
-|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and will update the federation settings for the domain when a new certificate is available. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).|
+|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and updates the federation settings for the domain when a new certificate is available. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).|
|signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| + ### federatedIdpMfaBehavior values | Member | Description |
v1.0 Itemanalytics Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/itemanalytics-get.md
GET /drives/{drive-id}/items/{item-id}/analytics/lastSevenDays
GET /sites/{site-id}/analytics/lastSevenDays GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics/lastSevenDays ```+
+> [!NOTE]
+> The value for `{item-id}` in the `/sites/{site-id}/lists/{list-id}/items/{item-id}` request is the `listItemUniqueId`. To get the `listItemUniqueId` of an item, call the `/sites/{site-id}/lists/{list-id}/items/{item-id}?$select=sharepointIds` endpoint. For details, see [sharePointIds](/graph/api/resources/sharepointids).
+ ## Optional query parameters This method supports the [OData query parameters](/graph/query-parameters) to help customize the response.
v1.0 Listitem Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/listitem-delta.md
++
+description: "Get newly created, updated, or deleted list items without having to perform a full read of the entire items collection."
+ Title: "listItem: delta"
+ms.localizationpriority: "medium"
++
+# listItem: delta
+
+Namespace: microsoft.graph
+
+Get newly created, updated, or deleted [list items](../resources/listitem.md) without having to perform a full read of the entire items collection.
+
+Your app begins by calling `delta` without any parameters.
+The service starts enumerating the hierarchy of the list, returning pages of items, and either an **@odata.nextLink** or an **@odata.deltaLink**.
+Your app should continue calling with the **@odata.nextLink** until you see an **@odata.deltaLink** returned.
+
+After you received all the changes, you can apply them to your local state.
+To check for changes in the future, call `delta` again with the **@odata.deltaLink** from the previous response.
+
+The delta feed shows the latest state for each item, not each change. If an item was renamed twice, it only shows up once, with its latest name.
+The same item might appear more than once in a delta feed, for various reasons. You should use the last occurrence you see.
+
+Deleted items are returned with the [deleted](../resources/deleted.md) facet and **@removed** annotation with the reason of removal. `Deleted` indicates that the item is deleted and can't be restored.
+Items with this property should be removed from your local state.
+
+> **Note:** You should only delete a folder locally if it's empty after syncing all the changes.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "listitem_delta" } -->
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /sites/{siteId}/lists/{listId}/items/delta
+```
+
+## Query parameters
+
+In the request URL, you can include the following optional query parameter.
+
+| Parameter | Type | Description |
+|:-|:-|:-|
+| token | String | If unspecified, enumerates the current state of the hierarchy. If `latest`, returns an empty response with the latest delta token. If a previous delta token, returns a new state since that token.|
+
+This method also supports the `$select`, `$expand`, and `$top` [OData query parameters](/graph/query-parameters) to customize the response.
+
+## Request headers
+
+|Header |Value |
+|-|-|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [listItem](../resources/listitem.md) objects in the response body.
+
+In addition to a collection of **listItem** objects, the response also includes one of the following properties.
+
+| Name | Value | Description |
+|:--|:-|:|
+| @odata.nextLink | URL | A URL to retrieve the next available page of changes if there are more changes in the current set. |
+| @odata.deltaLink | URL | A URL returned instead of **@odata.nextLink** after all current changes have been returned. Use this property to read the next set of changes in the future. |
+
+In some cases, the service returns a `410 Gone` response code with an error response that contains one of the following error codes, and a `Location` header that contains a new `nextLink` that starts a fresh delta enumeration. This occurs when the service can't provide a list of changes for a given token; for example, if a client tries to reuse an old token after being disconnected for a long time, or if the server state has changed and a new token is required.
+
+After the full enumeration is completed, compare the returned items with your local state and follow the instructions based on the error type.
+
+| Error type | Instructions |
+|:-|:-|
+| resyncChangesApplyDifferences | Replace any local items with the versions from the server (including deletes) if you're sure that the service was up-to-date with your local changes when you last synchronized. Upload any local changes that the server doesn't know about. |
+| resyncChangesUploadDifferences | Upload any local items that the service didn't return and upload any items that differ from the versions from the server. Keep both copies if you're not sure which one is more up-to-date. |
+
+In addition to the resync errors and for more details about how errors are returned, see [Microsoft Graph error responses and resource types](/graph/errors).
+
+## Examples
+
+### Example 1: Initial request
+
+The following example shows an initial request and how to call this API to establish your local state.
+
+#### Request
+
+The following example shows an initial request.
+
+# [HTTP](#tab/http)
+<!-- { "blockType": "request", "name": "get_listItem_delta_first", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE", "22e03ef3-6ef4-424d-a1d3-92a337807c30"] } -->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more items are available in the current set of items. Your app should continue to request the URL value of **@odata.nextLink** until all pages of items have been retrieved.
+
+<!-- { "blockType": "response", "name": "get_listItem_delta_first", "@odata.type": "Collection(microsoft.graph.listItem)", "truncated": true, "scope": "site.read" } -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "value": [
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"",
+ "id": "1",
+ "lastModifiedDateTime": "2021-10-14T23:27:27Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
+ }
+ },
+ "parentReference": {
+ "id": "1",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Folder"
+ }
+ },
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC067},756\"",
+ "id": "2",
+ "lastModifiedDateTime": "2021-10-14T23:27:27Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemA.txt",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
+ }
+ },
+ "parentReference": {
+ "id": "2",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Document"
+ }
+ },
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC068},756\"",
+ "id": "3",
+ "lastModifiedDateTime": "2021-10-14T23:27:27Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestItemB.txt",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
+ }
+ },
+ "parentReference": {
+ "id": "3",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Document"
+ }
+ }
+ ],
+ "@odata.nextLink": "https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
+}
+```
+
+### Example 2: Last page request
+
+The following example shows a request that gets the last page in a set and how to call this API to update your local state.
+
+#### Request
+
+The following example shows a request after the initial request.
+
+# [HTTP](#tab/http)
+<!-- { "blockType": "request", "name": "get-listItem-delta-last", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] }-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response that indicates that the item named `TestItemB.txt` was deleted and the item `TestFolder` was either added or modified between the initial request and this request to update the local state.
+
+The final page of items includes the **@odata.deltaLink** property that provides the URL that can be used later to retrieve changes since the current set of items.
+
+<!-- { "blockType": "response", "name": "get-listItem-delta-last", "truncated": true, "@odata.type": "Collection(microsoft.graph.listItem)", "scope": "site.read" } -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "value": [
+ {
+ "createdDateTime": "2020-06-02T22:46:58Z",
+ "eTag": "\"{12AD05BB-59B8-43AA-9456-77C44E9BC066},756\"",
+ "id": "1",
+ "lastModifiedDateTime": "2016-03-21T20:01:37Z",
+ "webUrl": "http://contoso.sharepoint.com/Shared%20Documents/TestFolder",
+ "createdBy": {
+ "user": {
+ "displayName": "John doe"
+ }
+ },
+ "parentReference": {
+ "id": "1",
+ "path": "Shared%20Documents",
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Folder"
+ }
+ },
+ {
+ "id": "3",
+ "parentReference": {
+ "siteId": "12AD05BB-59B8-43AA-9456-77C44E9BC066"
+ },
+ "contentType": {
+ "id": "0x00123456789abc",
+ "name": "Document"
+ },
+ "deleted": {
+ "state": "deleted"
+ },
+ "@removed": {
+ "reason": "deleted"
+ }
+ }
+ ],
+ "@odata.deltaLink": "https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
+}
+```
+
+### Example 3: Delta link request
+
+In some scenarios, you might want to request the current `deltaLink` value without first enumerating all of the items in the list already. This can be useful if your app only wants to know about changes and doesn't need to know about existing items.
+To retrieve the latest `deltaLink`, call `delta` with the query string parameter `?token=latest`.
+
+#### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- { "blockType": "request", "name": "get-delta-latest_datalink_tokenislatest", "scope": "sites.read", "target": "action", "sampleKeys": ["contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","22e03ef3-6ef4-424d-a1d3-92a337807c30"] } -->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+
+<!-- { "blockType": "response", "name": "get-delta-latest_datalink_tokenislatest", "isEmpty": true, "@odata.type": "Collection(microsoft.graph.listItem)" } -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "value": [ ],
+ "@odata.deltaLink": "https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka"
+}
+```
+
+## Related content
+- [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview)
+- [Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance)
+
+<!-- {
+ "type": "#page.annotation",
+ "description": "Sync changes from the service to your client state.",
+ "keywords": "sync,delta,changes,$delta",
+ "section": "documentation",
+ "tocPath": "ListItem/Get delta"
+} -->
v1.0 M365appsinstallationoptions Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/m365appsinstallationoptions-get.md
GET https://graph.microsoft.com/v1.0/admin/microsoft365Apps/installationOptions
- ### Response The following example shows a response. >**Note:** The response object shown here might be shortened for readability.
v1.0 Mailfolder Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/mailfolder-get.md
GET /users/{id | userPrincipalName}/mailFolders/{id}
``` ## Optional query parameters This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.+ ## Request headers
-| Name | Type | Description|
-|:--|:|:-|
-| Authorization | string | Bearer {token}. Required. |
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
## Request body Don't supply a request body for this method.
v1.0 Outlookcategory Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/outlookcategory-update.md
Title: "Update Outlook category"
-description: "Update the writable property, **color**, of the specified outlookCategory object. You can't modify the **displayName** property "
+ Title: "Update outlookCategory"
+description: "Update the writable property, **color**, of the specified outlookCategory object."
ms.localizationpriority: medium doc_type: apiPageType
-# Update Outlook category
+# Update outlookCategory
Namespace: microsoft.graph
-Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property
-once you have created the category.
+Update the writable property, **color**, of the specified [outlookCategory](../resources/outlookcategory.md) object. You can't modify the **displayName** property once you have created the category.
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
maintains their previous values or are recalculated based on changes to other pr
## Response
-If successful, this method returns a `200 OK` response code and updated [outlookCategory](../resources/outlookcategory.md) object in the response body.
+If successful, this method returns a `200 OK` response code and an updated [outlookCategory](../resources/outlookcategory.md) object in the response body.
## Example
-##### Request
+### Request
The following example shows a request. # [HTTP](#tab/http)
Content-type: application/json
-##### Response
-The following example shows the response. Note: The response object shown here might be shortened for readability.
+### Response
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Outlookuser List Mastercategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/outlookuser-list-mastercategories.md
Title: "List Outlook categories"
-description: "Get all the categories that have been defined for the user."
+ Title: "List masterCategories"
+description: "Get all the categories that have been defined for a user."
ms.localizationpriority: medium doc_type: apiPageType
-# List Outlook categories
+# List masterCategories
Namespace: microsoft.graph
-Get all the categories that have been defined for the user.
+Get all the categories that have been defined for a user.
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
v1.0 Reportroot Getrelyingpartydetailedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/reportroot-getrelyingpartydetailedsummary.md
+
+ Title: "reportRoot: getRelyingPartyDetailedSummary"
+description: "Get a summary of AD FS relying parties information."
+
+ms.localizationpriority: medium
++
+# reportRoot: getRelyingPartyDetailedSummary
+
+Namespace: microsoft.graph
++
+Get a summary of AD FS relying parties information.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "reportroot-getrelyingpartydetailedsummary-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /reports/getRelyingPartyDetailedSummary(period='parameterValue')
+```
+
+## Function parameters
+In the request URL, provide the following query parameters with values.
+The following table lists the parameters that are required when you call this function.
+
+## Optional query parameters
+
+This method supports the `$filter` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+|Parameter|Type|Description|
+|:|:|:|
+|period|String|Specifies the length of time over which the report is aggregated. The supported values are: D1, D7, D30. These values follow the format `Dn` where n represents the number of days over which the report is aggregated.|
++
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [relyingPartyDetailedSummary](../resources/relyingpartydetailedsummary.md) collection in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "reportrootthis.getrelyingpartydetailedsummary"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/reports/getRelyingPartyDetailedSummary(period='D7')
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
++++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.relyingPartyDetailedSummary)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.relyingPartyDetailedSummary",
+ "id": "31b45f83-0f5c-40be-80af-02e918f3b55b",
+ "relyingPartyId": "https://customer.contoso.com/mgmt",
+ "serviceId": "4cce6fff-4ccc-41fe-8521-bce16ea521e9",
+ "relyingPartyName": "Contoso",
+ "successfulSignInCount": 0,
+ "failedSignInCount": 225,
+ "totalSignInCount": 225,
+ "signInSuccessRate": 0,
+ "uniqueUserCount": 1,
+ "migrationStatus": "ready",
+ "replyUrls": [
+ "https://adfshelp.microsoft.com/Contoso/tokenresponse"
+ ],
+ "migrationValidationDetails": [
+ {
+ "name": "AdditionalWSFedEndpointCheckResult",
+ "value": "{\"result\": 0, \"message\": \"No additional WS-Federation endpoints were found.\"}"
+ },
+ {
+ "name": "AllowedAuthenticationClassReferencesCheckResult",
+ "value": "{\"result\": 0, \"message\": \"AllowedAuthenticationClassReferences is not set up.\"}"
+ }
+ ]
+ }
+ ]
+}
+```
+
+<!-- {
+ "type": "#page.annotation",
+ "description": "reportRoot: getRelyingPartyDetailedSummary",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ "Error: reportrootthis.getrelyingpartydetailedsummary/container/signInSuccessRate:
+ Expected type Double but actual was Int64. Property: signInSuccessRate, actual value: '0'"
+ ]
+}-->
+
v1.0 Search Acronym Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-acronym-delete.md
DELETE https://graph.microsoft.com/v1.0/search/acronyms/733b26d5-af76-4eea-ac69-
[!INCLUDE [sample-code](../includes/snippets/php/delete-acronym-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Acronym Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-acronym-get.md
GET https://graph.microsoft.com/v1.0/search/acronyms/733b26d5-af76-4eea-ac69-1a0
[!INCLUDE [sample-code](../includes/snippets/php/get-acronym-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Acronym Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-acronym-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-acronym-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Bookmark Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-bookmark-delete.md
DELETE https://graph.microsoft.com/v1.0/search/bookmarks/733b26d5-af76-4eea-ac69
[!INCLUDE [sample-code](../includes/snippets/php/delete-bookmark-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Bookmark Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-bookmark-get.md
GET https://graph.microsoft.com/v1.0/search/bookmarks/733b26d5-af76-4eea-ac69-1a
[!INCLUDE [sample-code](../includes/snippets/php/get-bookmark-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Bookmark Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-bookmark-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-bookmark-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Qna Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-qna-delete.md
DELETE https://graph.microsoft.com/v1.0/search/qnas/733b26d5-af76-4eea-ac69-1a0c
[!INCLUDE [sample-code](../includes/snippets/php/delete-qna-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Qna Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-qna-get.md
GET https://graph.microsoft.com/v1.0/search/qnas/733b26d5-af76-4eea-ac69-1a0ce87
[!INCLUDE [sample-code](../includes/snippets/php/get-qna-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Qna Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-qna-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-qna-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Searchentity List Acronyms https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-list-acronyms.md
GET https://graph.microsoft.com/v1.0/search/acronyms
[!INCLUDE [sample-code](../includes/snippets/php/list-acronym-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-acronym-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Searchentity List Bookmarks https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-list-bookmarks.md
GET https://graph.microsoft.com/v1.0/search/bookmarks
[!INCLUDE [sample-code](../includes/snippets/php/list-bookmark-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-bookmark-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Searchentity List Qnas https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-list-qnas.md
GET https://graph.microsoft.com/v1.0/search/qnas
[!INCLUDE [sample-code](../includes/snippets/php/list-qna-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-qna-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Searchentity Post Acronyms https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-post-acronyms.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/create-acronym-from-acronyms-e1-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/create-acronym-from-acronyms-e1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Searchentity Post Bookmarks https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-post-bookmarks.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/create-bookmark-from-bookmarks-e1-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/create-bookmark-from-bookmarks-e1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Searchentity Post Qnas https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/search-searchentity-post-qnas.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/create-qna-from-qnas-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/create-qna-from-qnas-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Security Authoritytemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-authoritytemplate-get.md
+
+ Title: "Get authorityTemplate"
+description: "Read the properties and relationships of an authorityTemplate."
+
+ms.localizationpriority: medium
++
+# Get authorityTemplate
+Namespace: microsoft.graph.security
+
+Read the properties and relationships of a [authorityTemplate](../resources/security-authoritytemplate.md) object.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/authorities/{authorityTemplateId}
+GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/authorityTemplate
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_authoritytemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/authorities/a94af2e3-853b-6fcc-c898-d61d3a6d9efc
+```
+++
+### Response
+Here's an example of the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.authorityTemplate"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.security.authorityTemplate",
+ "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",
+ "displayName": "String",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+}
+```
+
v1.0 Security Categorytemplate Delete Subcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md
+
+ Title: "Delete subCategoryTemplate"
+description: "Delete a subCategoryTemplate object."
+
+ms.localizationpriority: medium
++
+# Delete subCategoryTemplate
+Namespace: microsoft.graph.security
+
+Delete a [subCategoryTemplate](../resources/security-subcategorytemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId}/$ref
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_subcategorytemplate"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/security/labels/categories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5/subCategories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5
+```
+
+### Response
+Here's an example of the response.
+>
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Categorytemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-get.md
+
+ Title: "Get categoryTemplate"
+description: "Read the properties and relationships of a categoryTemplate object."
+
+ms.localizationpriority: medium
++
+# Get categoryTemplate
+Namespace: microsoft.graph.security
+
+Read the properties and relationships of a [categoryTemplate](../resources/security-categorytemplate.md) object.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/categories/{categoryTemplateId}
+GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate
+```
+
+## Optional query parameters
+This method supports some of the OData query parameters to help customize the response. For example, to retrieve the **subategories** property associated with this particular category, you can use the `expand` parameter:`$expand=subcategories`. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_categorytemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/categories/e2c79762-34a9-75ba-b6f0-a7c9a57978ef
+```
+
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.categoryTemplate"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.security.categoryTemplate",
+ "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",
+ "displayName": "Accounts payable",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+}
+```
+
v1.0 Security Categorytemplate List Subcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md
+
+ Title: "List subCategories"
+description: "Get the subCategoryTemplate resources from the subCategories navigation property."
+
+ms.localizationpriority: medium
++
+# List subCategories
+Namespace: microsoft.graph.security
+
+Get a list of subcategories [subCategoryTemplate](../resources/security-subcategorytemplate.md) associated with a category template.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/categories/{categoryTemplateId}/subCategories
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) objects in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_subcategorytemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId}/subCategories
+```
++
+### Response
+Here's an example of the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.subCategoryTemplate)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.subCategoryTemplate",
+ "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",
+ "displayName": "Vendor Invoice",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
+ ]
+}
+```
+
v1.0 Security Categorytemplate Post Subcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md
+
+ Title: "Create subCategoryTemplate"
+description: "Create a new subCategoryTemplate object."
+
+ms.localizationpriority: medium
++
+# Create subCategoryTemplate
+Namespace: microsoft.graph.security
+
+Create a new [subCategoryTemplate](../resources/security-subcategorytemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/labels/categories/{categoryTemplateId}/subCategories
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.
+
+You can specify the following properties when creating a **subCategoryTemplate**.
+
+|Property|Type|Description|
+|:|:|:|
+|displayName|String| Unique string that defines a sub-category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md). Optional.|
++++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_subcategorytemplate_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId}/subCategories
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.subCategoryTemplate",
+ "displayName": "Vendor Invoice",
+}
+```
+++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.subCategoryTemplate"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.subCategoryTemplate",
+ "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",
+ "displayName": "Vendor Invoice",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
+```
+
v1.0 Security Citationtemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-citationtemplate-get.md
+
+ Title: "Get citationTemplate"
+description: "Read the properties and relationships of a citationTemplate object."
+
+ms.localizationpriority: medium
++
+# Get citationTemplate
+Namespace: microsoft.graph.security
+
+Read the properties and relationships of a [citationTemplate](../resources/security-citationtemplate.md) object.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/citations/{citationTemplateId}
+GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/citationTemplate
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_citationtemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/citations/c0475d01-d532-8a53-6e26-14ea58c640bf
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.citationTemplate"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.security.citationTemplate",
+ "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",
+ "displayName": "Contoso Company Policy",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "Contoso"
+ }
+}
+```
+
v1.0 Security Departmenttemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-departmenttemplate-get.md
+
+ Title: "Get departmentTemplate"
+description: "Read the properties and relationships of a departmentTemplate object."
+
+ms.localizationpriority: medium
++
+# Get departmentTemplate
+Namespace: microsoft.graph.security
+
+Read the properties and relationships of a [departmentTemplate](../resources/security-departmenttemplate.md) object.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/departments/{departmentTemplateId}
+GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/departmentTemplate
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_departmenttemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/departments/11b44677-9f06-c85a-4a0b-766b66904bf8
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.departmentTemplate"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.security.departmentTemplate",
+ "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",
+ "displayName": "Finance",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+}
+```
+
v1.0 Security Fileplanreferencetemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md
+
+ Title: "Get filePlanReferenceTemplate"
+description: "Read the properties and relationships of a filePlanReferenceTemplate object."
+
+ms.localizationpriority: medium
++
+# Get filePlanReferenceTemplate
+Namespace: microsoft.graph.security
+
+Read the properties and relationships of a [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/filePlanReferences/{filePlanReferenceTemplateId}
+GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/filePlanReferenceTemplate
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_fileplanreferencetemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/b1f7b518-a44f-1d4b-c6f1-ab8771d3907c
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.filePlanReferenceTemplate"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
+ "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",
+ "displayName": "String",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+}
+```
+
v1.0 Security Labelsroot Delete Authorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-authorities.md
+
+ Title: "Delete authorityTemplate"
+description: "Delete an authorityTemplate object."
+
+ms.localizationpriority: medium
++
+# Delete authorityTemplate
+Namespace: microsoft.graph.security
+
+Delete a [authorityTemplate](../resources/security-authoritytemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application| RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/labels/authorities/{authorityTemplateId}/$ref
+DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/authorityTemplate/$ref
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_authoritytemplate"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/security/labels/authorities/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5
+```
++
+### Response
+Here's an example of the response.
+>
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Labelsroot Delete Categories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-categories.md
+
+ Title: "Delete categoryTemplate"
+description: "Delete a categoryTemplate object."
+
+ms.localizationpriority: medium
++
+# Delete categoryTemplate
+Namespace: microsoft.graph.security
+
+Delete a [categoryTemplate](../resources/security-categorytemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/labels/categories/{categoryTemplateId}/$ref
+DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/$ref
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_categorytemplate"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/security/labels/categories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5
+```
++
+### Response
+Here's an example of the response.
+>
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Labelsroot Delete Citations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-citations.md
+
+ Title: "Delete citationTemplate"
+description: "Delete a citationTemplate object."
+
+ms.localizationpriority: medium
++
+# Delete citationTemplate
+Namespace: microsoft.graph.security
+
+Delete a [citationTemplate](../resources/security-citationtemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/labels/citations/{citationTemplateId}/$ref
+DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/citationTemplate/$ref
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_citationtemplate"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/security/labels/citations/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5
+```
+
+### Response
+Here's an example of the response.
+>
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Labelsroot Delete Departments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-departments.md
+
+ Title: "Delete departmentTemplate"
+description: "Delete a departmentTemplate object."
+
+ms.localizationpriority: medium
++
+# Delete departmentTemplate
+Namespace: microsoft.graph.security
+
+Delete a [departmentTemplate](../resources/security-departmenttemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/labels/departments/{departmentTemplateId}/$ref
+DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/departmentTemplate/$ref
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_departmenttemplate"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/security/labels/departments/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5
+```
++
+### Response
+Here's an example of the response.
+>
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Labelsroot Delete Fileplanreferences https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md
+
+ Title: "Delete filePlanReferenceTemplate"
+description: "Delete a filePlanReferenceTemplate object."
+
+ms.localizationpriority: medium
++
+# Delete filePlanReferenceTemplate
+Namespace: microsoft.graph.security
+
+Delete a [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/labels/filePlanReferences/{filePlanReferenceTemplateId}/$ref
+DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/filePlanReferenceTemplate/$ref
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_fileplanreferencetemplate"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5
+```
++
+### Response
+Here's an example of the response.
+>
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Labelsroot List Authorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-authorities.md
+
+ Title: "List authorityTemplates"
+description: "Get a list of the authorityTemplate objects and their properties."
+
+ms.localizationpriority: medium
++
+# List authorityTemplates
+Namespace: microsoft.graph.security
++
+Get a list of the [authorityTemplate](../resources/security-authoritytemplate.md) objects and their properties.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/authorities
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) objects in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_authoritytemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/authorities
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.authorityTemplate)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.authorityTemplate",
+ "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",
+ "displayName": "Business",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ },
+ {
+ "@odata.type": "#microsoft.graph.security.authorityTemplate",
+ "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5",
+ "displayName": "Legal",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
+ ]
+}
+```
v1.0 Security Labelsroot List Categories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-categories.md
+
+ Title: "List categoryTemplates"
+description: "Get a list of the categoryTemplate objects and their properties."
+
+ms.localizationpriority: medium
++
+# List categoryTemplates
+Namespace: microsoft.graph.security
+
+Get a list of the [categoryTemplate](../resources/security-categorytemplate.md) objects and their properties.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/categories
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) objects in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_categorytemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/categories
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.categoryTemplate)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.categoryTemplate",
+ "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",
+ "displayName": "Accounts Payable",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ },
+ {
+ "@odata.type": "#microsoft.graph.security.categoryTemplate",
+ "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5",
+ "displayName": "Accounts",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
+ ]
+}
+```
v1.0 Security Labelsroot List Citations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-citations.md
+
+ Title: "List citationTemplates"
+description: "Get a list of the citationTemplate objects and their properties."
+
+ms.localizationpriority: medium
++
+# List citationTemplates
+Namespace: microsoft.graph.security
+
+Get a list of the [citationTemplate](../resources/security-citationtemplate.md) objects and their properties.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/citations
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) objects in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_citationtemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/citations
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.citationTemplate)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.citationTemplate",
+ "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",
+ "displayName": "Contoso Company Policy",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "Contoso"
+ }
+ ]
+}
+```
+
v1.0 Security Labelsroot List Departments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-departments.md
+
+ Title: "List departmentTemplates"
+description: "Get a list of the departmentTemplate objects and their properties."
+
+ms.localizationpriority: medium
++
+# List departmentTemplates
+Namespace: microsoft.graph.security
+
+Get a list of the [departmentTemplate](../resources/security-departmenttemplate.md) objects and their properties.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/departments
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) objects in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_departmenttemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/departments
+```
+
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.departmentTemplate)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.departmentTemplate",
+ "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",
+ "displayName": "Finance",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
+ ]
+}
+```
+
v1.0 Security Labelsroot List Fileplanreferences https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md
+
+ Title: "List filePlanReferenceTemplates"
+description: "Get a list of the filePlanReferenceTemplate objects and their properties."
+
+ms.localizationpriority: medium
++
+# List filePlanReferenceTemplates
+Namespace: microsoft.graph.security
+
+Get a list of the [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects and their properties.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/filePlanReferences
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_fileplanreferencetemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.filePlanReferenceTemplate)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
+ "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",
+ "displayName": "FIN 01-02-001",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-03-24T02:09:08Z"
+ }
+ ]
+}
+```
+
v1.0 Security Labelsroot List Retentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md
+
+ Title: "List retentionLabels"
+description: "Get a list of the retentionLabel objects and their properties."
+
+ms.localizationpriority: medium
++
+# List retentionLabels
+Namespace: microsoft.graph.security
+
+Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not Supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/retentionLabels
+```
+
+## Optional query parameters
+This method supports the `expand` OData query parameter to help customize the response.
+
+For example:
+- To retrieve the **retentionEventType** property, use `$expand=retentionEventType`.
+- To retrieve the **descriptors** property, use `$expand=descriptors`.
+
+For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) objects in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+<!-- {
+ "blockType": "request",
+ "name": "list_retentionlabel"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.security.retentionLabel)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.security.retentionLabel",
+ "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
+ "displayName": "Retention Schedule 10004",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "relabel",
+ "retentionTrigger": "dateCreated",
+ "retentionDuration": {
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": "730"
+ },
+ "isInUse": true,
+ "descriptionForAdmins": "creation based retention label for schedule 10004",
+ "descriptionForUsers": "retains for 2 years then relabeled",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2017-11-27T02:10:12Z",
+ "lastModifiedBy": {
+ "user": {
+ "id": "9563a605-e827-4324-a5a9-09efddff1e90",
+ "displayName": "Records Manager"
+ }
+ },
+ "lastModifiedDateTime": "2020-08-28T22:13:09Z",
+ "labelToBeApplied": "Retention schedule 10005",
+ "defaultRecordBehavior": "startLocked"
+ }
+ ]
+}
+```
++
v1.0 Security Labelsroot Post Authorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-authorities.md
+
+ Title: "Create authorityTemplate"
+description: "Create a new authorityTemplate object."
+
+ms.localizationpriority: medium
++
+# Create authorityTemplate
+Namespace: microsoft.graph.security
+
+Create a new [authorityTemplate](../resources/security-authoritytemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/labels/authorities
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.
+
+You can specify the following properties when creating a **authorityTemplate**.
+
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).|
++++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_authoritytemplate_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/security/labels/authorities
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.authorityTemplate",
+ "displayName": "Business",
+}
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.authorityTemplate"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.authorityTemplate",
+ "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc",
+ "displayName": "Business",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+```
+
v1.0 Security Labelsroot Post Categories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-categories.md
+
+ Title: "Create categoryTemplate"
+description: "Create a new categoryTemplate object."
+
+ms.localizationpriority: medium
++
+# Create categoryTemplate
+Namespace: microsoft.graph.security
+
+Create a new [categoryTemplate](../resources/security-categorytemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/labels/categories
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.
+
+You can specify the following properties when creating a **categoryTemplate**.
+
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).|
++++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_categorytemplate_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/security/labels/categories
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.categoryTemplate",
+ "displayName": "Accounts Payable",
+}
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.categoryTemplate"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.categoryTemplate",
+ "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef",
+ "displayName": "Accounts Payable",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+```
v1.0 Security Labelsroot Post Citations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-citations.md
+
+ Title: "Create citationTemplate"
+description: "Create a new citationTemplate object."
+
+ms.localizationpriority: medium
++
+# Create citationTemplate
+Namespace: microsoft.graph.security
+
+Create a new [citationTemplate](../resources/security-citationtemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/labels/citations
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.
+
+You can specify the following properties when creating a **citationTemplate**.
+
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).|
+|citationUrl|String|Represents the URL to the published citation. Optional.|
+|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation. Optional.|
++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_citationtemplate_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/security/labels/citations
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.citationTemplate",
+ "displayName": "Contoso Company Policy",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "Contoso"
+}
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.citationTemplate"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.citationTemplate",
+ "id": "c0475d01-d532-8a53-6e26-14ea58c640bf",
+ "displayName": "Contoso Company Policy",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z",
+ "createdDateTime": "String (timestamp)",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "String"
+}
+```
+
v1.0 Security Labelsroot Post Departments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-departments.md
+
+ Title: "Create departmentTemplate"
+description: "Create a new departmentTemplate object."
+
+ms.localizationpriority: medium
++
+# Create departmentTemplate
+Namespace: microsoft.graph.security
+
+Create a new [departmentTemplate](../resources/security-departmenttemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/labels/departments
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.
+
+You can specify the following properties when creating a **departmentTemplate**.
+
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).|
++++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_departmenttemplate_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/security/labels/departments
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.departmentTemplate",
+ "displayName": "Finance",
+}
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.departmentTemplate"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.departmentTemplate",
+ "id": "11b44677-9f06-c85a-4a0b-766b66904bf8",
+ "displayName": "Finance",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+```
+
v1.0 Security Labelsroot Post Fileplanreferences https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md
+
+ Title: "Create filePlanReferenceTemplate"
+description: "Create a new filePlanReferenceTemplate object."
+
+ms.localizationpriority: medium
++
+# Create filePlanReferenceTemplate
+Namespace: microsoft.graph.security
+
+Create a new [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/labels/filePlanReferences
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.
+
+You can specify the following properties when creating a **filePlanReferenceTemplate**.
+
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a file plan reference name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).|
++++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_fileplanreferencetemplate_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/security/labels/filePlanReferences
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
+ "displayName": "FIN 01-02-001",
+}
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.filePlanReferenceTemplate"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
+ "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",
+ "displayName": "FIN 01-02-001",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+```
+
v1.0 Security Labelsroot Post Retentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md
+
+ Title: "Create retentionLabel"
+description: "Create a new retentionLabel object."
+
+ms.localizationpriority: medium
++
+# Create retentionLabel
+Namespace: microsoft.graph.security
+
+Create a new [retentionLabel](../resources/security-retentionlabel.md) object.
+
+To create a [disposition review stage](../resources/security-dispositionreviewstage.md), include the **actionAfterRetentionPeriod** property in the request body with one of the possible values specified.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/labels/retentionLabels
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+In the request body, supply a JSON representation of the [retentionLabel](../resources/security-retentionlabel.md) object.
+
+Specify the following properties when you create a **retentionLabel**.
+
+|Property|Type|Description|
+|:|:|:|
+|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on a document with this label applied during the retention period. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`. |
+|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`. |
+|descriptionForAdmins|String|Provides label information for the admin. Optional. |
+|descriptionForUsers|String|Provides the label information for the user. Optional. |
+|displayName|String|Unique string that defines a label name. |
+|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained. |
+|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content. |
+|retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`. |
+|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it's created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`. |
+|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. |
+++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_retentionlabel_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/v1.0/security/labels/retentionLabels
+Content-Type: application/json
+Content-length: 555
+
+{
+ "@odata.type": "#microsoft.graph.security.retentionLabel",
+ "displayName": "Retention Schedule 10005",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "startDispositionReview",
+ "retentionTrigger": "dateOfEvent",
+ "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')",
+ "retentionDuration": {
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 2555
+ },
+ "dispositionReviewStages": [
+ {
+ "stageNumber" : 1,
+ "name": "Stage1",
+ "reviewersEmailAddresses ": [
+ "Admin@contoso.onmicrosoft.com"
+ ]
+ }
+ ],
+ "descriptionForAdmins": "retain for 7 years",
+ "descriptionForUsers": "retain for 7 years",
+ "descriptors": {
+ "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')",
+ "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')",
+ "citationTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/citations('0e23f4fc-b966-4c40-94de-fb8a383658e4')",
+ "departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')",
+ "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')"
+ },
+ "defaultRecordBehavior":"startLocked",
+}
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.retentionLabel"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.security.retentionLabel",
+ "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
+ "displayName": "Retention Schedule 10005",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "startDispositionReview",
+ "retentionTrigger": "dateOfEvent",
+ "retentionDuration": {
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 2555
+ },
+ "dispositionReviewStages": [
+ {
+ "stageNumber" : 1,
+ "name": "Stage1",
+ "reviewersEmailAddresses ": [
+ "Admin@contoso.onmicrosoft.com"
+ ]
+ }
+ ],
+ "isInUse": true,
+ "descriptionForAdmins": "retain for 7 years",
+ "descriptionForUsers": "retain for 7 years",
+ "defaultRecordBehavior":"startLocked",
+ "createdBy": {
+ "user": {
+ "id": "9563a605-e827-4324-a5a9-09efddff1e90",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2021-08-23T16:43:55Z",
+ "labelToBeApplied": " ",
+ "defaultRecordBehavior": "startLocked",
+ "descriptors": {
+ "authority": {
+ "displayName": "Business"
+ },
+ "category": {
+ "displayName": "Accounts Payable",
+ },
+ "citation": {
+ "displayName" : "Contoso Company Policy",
+ "citationUrl": "www.citationUrl.com",
+ "citationJurisdiction": "Contoso"
+ },
+ "department": {
+ "displayName" : "Finance"
+ },
+ "filePlanReference": {
+ "displayName" : "FIN 01-02-001"
+ }
+ }
+}
+```
+
v1.0 Security Retentionlabel Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-retentionlabel-delete.md
+
+ Title: "Delete retentionLabel"
+description: "Deletes a retentionLabel object."
+
+ms.localizationpriority: medium
++
+# Delete retentionLabel
+Namespace: microsoft.graph.security
+
+Delete a [retentionLabel](../resources/security-retentionlabel.md) object.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/labels/retentionLabels/{retentionLabelId}
+
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_retentionlabel"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50
+```
++
+### Response
+Here's an example of the response.
+>
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Retentionlabel Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-retentionlabel-get.md
+
+ Title: "Get retentionLabel"
+description: "Read the properties and relationships of a retentionLabel object."
+
+ms.localizationpriority: medium
++
+# Get retentionLabel
+Namespace: microsoft.graph.security
+
+Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.md) object.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not Supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/retentionLabels/{retentionLabelId}
+GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId}
+```
+
+## Optional query parameters
+This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType` or `$expand=descriptors`. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_retentionlabel"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}
+```
+
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.retentionLabel"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.security.retentionLabel",
+ "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
+ "displayName": "Retention Schedule 10004",
+ "behaviorDuringRetentionPeriod": "retain",
+ "actionAfterRetentionPeriod": "relabel",
+ "retentionTrigger": "dateCreated",
+ "retentionDuration": {
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 730
+ },
+ "isInUse": true,
+ "descriptionForAdmins": "creation based retention label for schedule 10004",
+ "descriptionForUsers": "retains for 2 years then relabeled",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime": "2017-11-27T02:10:12Z",
+ "lastModifiedBy": {
+ "user": {
+ "id": "9563a605-e827-4324-a5a9-09efddff1e90",
+ "displayName": "Records Manager"
+ }
+ },
+ "lastModifiedDateTime": "2020-08-28T22:13:09Z",
+ "labelToBeApplied": "Retention schedule 10005",
+ "defaultRecordBehavior": "startLocked"
+ }
+}
+```
+
v1.0 Security Retentionlabel Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-retentionlabel-update.md
+
+ Title: "Update retentionLabel"
+description: "Update the properties of a retentionLabel object."
+
+ms.localizationpriority: medium
++
+# Update retentionLabel
+Namespace: microsoft.graph.security
+
+Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object.
+
+To update a [disposition review stage](../resources/security-dispositionreviewstage.md), include the **actionAfterRetentionPeriod** property in the request body with one of the possible values specified.
+
+## 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)|RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /security/labels/retentionLabels/{retentionLabelId}
+
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|descriptionForAdmins|String|This is an optional property that provides the label information for the admin.|
+|descriptionForUsers|String|This is an optional property that provides the label information for the user.|
+|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained.|
+|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.|
+|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created. The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.|
+|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. |
+++
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "update_retentionlabel"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50
+Content-Type: application/json
+Content-length: 555
+
+{
+ "@odata.type": "#microsoft.graph.security.retentionLabel",
+ "retentionDuration": {
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays",
+ "days": 2555
+ },
+}
+```
+
+### Response
+Here's an example of the response.
+
+<!-- {
+ "blockType": "response"
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Security Subcategorytemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-subcategorytemplate-get.md
+
+ Title: "Get subCategoryTemplate"
+description: "Read the properties and relationships of a subCategoryTemplate object."
+
+ms.localizationpriority: medium
++
+# Get subCategoryTemplate
+Namespace: microsoft.graph.security
+
+Read the properties and relationships of a [subCategoryTemplate](../resources/security-subcategorytemplate.md) object.
+
+## 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)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId}
+```
+
+## Optional query parameters
+This method supports some of 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
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body.
+
+## Examples
+
+### Request
+Here's an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_subcategorytemplate"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/security/labels/categories/82d00422-1f60-46cd-9809-33ca0b4d2286/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0
+```
++
+### Response
+Here's an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.security.subCategoryTemplate"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.security.subCategoryTemplate",
+ "id": "2ac39915-dbeb-e933-82e2-92b981835fa0",
+ "displayName": "Vendor Invoice",
+ "createdBy": {
+ "user": {
+ "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
+ "displayName": "Admin"
+ }
+ },
+ "createdDateTime" : "2021-03-24T02:09:08Z"
+}
+}
+```
+
v1.0 Site Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/site-delta.md
The following example shows the initial request and how to call this API to esta
The following example shows the initial request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_sites_delta_first", "tags": "service.graph" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/v1.0/sites/delta ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more sites are available in the current set of sites. Your app should continue to request the URL value of **@odata.nextLink** until all pages of sites are retrieved.
The following example shows a request that accesses the last page in a set and h
The following example shows a request after the initial request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get-sites-delta-last", "tags": "service.graph" }-->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/v1.0/sites/delta?token=1230919asd190410jlka ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response that indicates that the site named `All Company` was deleted between the initial request and this request to update the local state.
To retrieve the latest `deltaLink`, call `delta` with the query string parameter
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get-sites-delta-latest", "scopes": "sites.read", "tags": "service.graph", "target": "action" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/v1.0/sites/delta?token=latest ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
v1.0 Site Follow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/site-follow.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/follow-site-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/follow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Site Unfollow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/site-unfollow.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/unfollow-site-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/unfollow-site-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Team Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-post-members.md
If successful, this method returns a `201 Created` response code and a [conversa
For best results, stagger calls with a 2 second buffer.
+> [!NOTE]
+> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user.
+ ## Examples ### Example 1: Add a member to a team
v1.0 User List Memberof https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-memberof.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "user_list_memberof" } --> [!INCLUDE [permissions-table](../includes/permissions/user-list-memberof-permissions.md)]
-> **Note:** To list the members of a group with hidden membership, the Member.Read.Hidden permission is required.
+> [!TIP]
+> - Calling the `/me/memberOf` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when you use the `/me/memberOf` endpoint.
+> - To list the members of a group with hidden membership, the `Member.Read.Hidden` permission is required.
[!INCLUDE [limited-info](../../includes/limited-info.md)]
v1.0 Usersettings List Windows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/usersettings-list-windows.md
GET https://graph.microsoft.com/v1.0/me/settings/windows
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting1-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=settingType eq
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting2-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting2-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=settingType eq
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting3-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting3-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/v1.0/me/settings/windows?$filter=windowsDeviceId
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssetting4-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssetting4-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Virtualendpoint List Auditevents https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-auditevents.md
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpcauditevent"
The following example shows a request.
``` http GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/auditEvents ```+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Virtualendpoint List Cloudpcs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-cloudpcs.md
The following example shows how to get a list of all [cloudPC](../resources/clou
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpcs"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
The following example shows how to use the `$top` query parameter to get the top
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpcs_with_top_query"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs?$top=2 ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ #### Response The following example shows the response.
v1.0 Virtualendpoint List Deviceimages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-deviceimages.md
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpcdeviceimages"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/deviceImages ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Virtualendpoint List Galleryimages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-galleryimages.md
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpcgalleryimage"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/galleryImages ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Virtualendpoint List Onpremisesconnections https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-onpremisesconnections.md
List properties and relationships of the [cloudPcOnPremisesConnection](../resour
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-<!-- { "blockType": "permissions", "name": "virtualendpoint-list-onpremisesconnections" } -->
+<!-- { "blockType": "permissions", "name": "virtualendpoint_list_onpremisesconnections" } -->
[!INCLUDE [permissions-table](../includes/permissions/virtualendpoint-list-onpremisesconnections-permissions.md)] ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpconpremisesconnections"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/onPremisesConnections ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Virtualendpoint List Provisioningpolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-provisioningpolicies.md
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpcprovisioningpolicies"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/provisioningPolicies ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Virtualendpoint List Usersettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-list-usersettings.md
If successful, this method returns a `200 OK` response code and a collection of
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_cloudpcusersetting"
The following example shows a request.
GET https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/userSettings ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Virtualendpoint Post Deviceimages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-deviceimages.md
If successful, this method returns a `201 Created` response code and a [cloudPcD
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_cloudpcdeviceimage_from_cloudpcdeviceimage"
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Virtualendpoint Post Onpremisesconnections https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-onpremisesconnections.md
Create a new [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnect
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-<!-- { "blockType": "permissions", "name": "virtualendpoint-post-onpremisesconnections" } -->
+<!-- { "blockType": "permissions", "name": "virtualendpoint_post_onpremisesconnections" } -->
[!INCLUDE [permissions-table](../includes/permissions/virtualendpoint-post-onpremisesconnections-permissions.md)] ## HTTP request
If successful, this method returns a `201 Created` response code and a [cloudPcO
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_cloudpconpremisesconnection_from_cloudpconpremisesconnection"
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++ ### Response
v1.0 Virtualendpoint Post Provisioningpolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-provisioningpolicies.md
If successful, this method returns a `201 Created` response code and a [cloudPcP
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_cloudpcprovisioningpolicy_from_cloudpcprovisioningpolicy"
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Virtualendpoint Post Usersettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualendpoint-post-usersettings.md
If successful, this method returns a `201 Created` response code and a [cloudPcU
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_cloudpcusersetting_from_"
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Windowssetting Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/windowssetting-get.md
GET https://graph.microsoft.com/v1.0/me/settings/windows/{windowsSettingId}
[!INCLUDE [sample-code](../includes/snippets/php/get-windowssetting-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-windowssetting-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Windowssetting List Instances https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/windowssetting-list-instances.md
GET https://graph.microsoft.com/v1.0/me/settings/windows/{windowsSettingId}/inst
[!INCLUDE [sample-code](../includes/snippets/php/list-windowssettinginstance-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Windowssettinginstance Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/windowssettinginstance-get.md
GET https://graph.microsoft.com/v1.0/me/settings/windows/{windowsSettingId}/inst
[!INCLUDE [sample-code](../includes/snippets/php/get-windowssettinginstance-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-windowssettinginstance-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Link Validation Config.Json https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/config/link-validation-config.json a/api-reference/v1.0/config/link-validation-config.json
"/partner-center", "/powershell", "/previous-versions",
- "/purview",
+ "/purview",
"/rest", "/security", "/skypeforbusiness",
v1.0 Application https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/application.md
This resource supports:
| samlMetadataUrl | String | The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable. | | serviceManagementReference | String | References application or service contact information from a Service or Asset Management database. Nullable. | | servicePrincipalLockConfiguration | [servicePrincipalLockConfiguration](servicePrincipalLockConfiguration.md) | Specifies whether sensitive properties of a multitenant application should be locked for editing after the application is provisioned in a tenant. Nullable. `null` by default. |
-| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg`, `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount` (default), and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you might need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).|
+| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: `AzureADMyOrg` (default), `AzureADMultipleOrgs`, `AzureADandPersonalMicrosoftAccount`, and `PersonalMicrosoftAccount`. See more in the [table](#signinaudience-values). <br/><br/>The value of this object also limits the number of permissions an app can request. For more information, see [Limits on requested permissions per app](#limits-on-requested-permissions-per-app). <br><br>The value for this property has implications on other app object properties. As a result, if you change this property, you might need to change other properties first. For more information, see [Validation differences for signInAudience](/azure/active-directory/develop/supported-accounts-validation?context=graph/context).<br><br>Supports `$filter` (`eq`, `ne`, `not`).|
| spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | | tags |String collection| Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here will also appear in the **tags** property of any associated [service principals](serviceprincipal.md).<br><br>Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`) and `$search`.| | tokenEncryptionKeyId |String|Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.|
This resource supports:
| Value | Description | |:|:--|
-|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single tenant).|
+|AzureADMyOrg|Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single tenant). This is the default value for the **signInAudience** property. |
|AzureADMultipleOrgs|Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).|
-|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. This is the default value for the **signInAudience** property. |
+|AzureADandPersonalMicrosoftAccount|Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant. For authenticating users with Azure AD B2C user flows, use `AzureADandPersonalMicrosoftAccount`. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider. |
|PersonalMicrosoftAccount|Users with a personal Microsoft account only.|
v1.0 Connectors Api Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/connectors-api-overview.md
The following are current known limitations:
- An application is limited to 25 concurrent operations on a connection. - Connections have a capacity limit of 5,000,000 items or ~350 GB of data. - Maximum size of an `externalItem` entity is 4 MB.-- Sorting results is not supported. ## Next steps
v1.0 Crosstenantaccesspolicy Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/crosstenantaccesspolicy-overview.md
The cross-tenant access settings API can be used to set up multiple configuratio
</td> <td> Users in group 'g1' are blocked from accessing application 'a1' only. All users, including users in group 'g1' are able to access any other application. </td> </tr>
+<tr>
+<td>
+ Prioritize using an external federation over Entra ID during guest user invitation redemption
+</td>
+<td>
+
+``` json
+"invitationRedemptionIdentityProviderConfiguration": {
+ "primaryIdentityProviderPrecedenceOrder": [
+ "externalFederation",
+ "azureActiveDirectory",
+ "socialIdentityProviders"
+ ],
+ "fallbackIdentityProvider": "defaultConfiguredIdp"
+}
+```
+</td>
+<td>
+Check if the guest user is from an externally federated partner before trying Entra ID for authentication.
+</td>
+</tr>
</table> ## Cross-tenant access settings vs tenant restrictions
v1.0 Crosstenantaccesspolicyconfigurationdefault https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md
The default configuration defined for inbound and outbound settings of Microsoft
|Property|Type|Description| |:|:|:|
-| automaticUserConsentSettings | [inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md) | Determines the default configuration for automatic user consent settings. The **inboundAllowed** and **outboundAllowed** properties are always `false` and cannot be updated in the default configuration. Read-only. |
+| automaticUserConsentSettings | [inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md) | Determines the default configuration for automatic user consent settings. The **inboundAllowed** and **outboundAllowed** properties are always `false` and can't be updated in the default configuration. Read-only. |
| b2bCollaborationInbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B collaboration. | | b2bCollaborationOutbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B collaboration. | | b2bDirectConnectInbound |[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) | Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B direct connect. | | b2bDirectConnectOutbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B direct connect. | | inboundTrust | [crossTenantAccessPolicyInboundTrust](../resources/crosstenantaccesspolicyinboundtrust.md) | Determines the default configuration for trusting other Conditional Access claims from external Microsoft Entra organizations. |
-| isServiceDefault | Boolean | If `true`, the default configuration is set to the system default configuration. If `false`, the default settings have been customized. |
+| invitationRedemptionIdentityProviderConfiguration | [defaultInvitationRedemptionIdentityProviderConfiguration](../resources/defaultInvitationRedemptionIdentityProviderConfiguration.md) | Defines the priority order based on which an identity provider is selected during invitation redemption for a guest user. |
+| isServiceDefault | Boolean | If `true`, the default configuration is set to the system default configuration. If `false`, the default settings are customized. |
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!-- { "blockType": "resource", "keyProperty": "id",
The following is a JSON representation of the resource.
"b2bDirectConnectInbound": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting"}, "b2bDirectConnectOutbound": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyB2BSetting"}, "inboundTrust": {"@odata.type": "microsoft.graph.crossTenantAccessPolicyInboundTrust"},
+ "invitationRedemptionIdentityProviderConfiguration": {
+ "@odata.type": "microsoft.graph.defaultInvitationRedemptionIdentityProviderConfiguration"
+ },
"isServiceDefault": "Boolean" } ```
v1.0 Defaultinvitationredemptionidentityproviderconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/defaultinvitationredemptionidentityproviderconfiguration.md
+
+ Title: "defaultInvitationRedemptionIdentityProviderConfiguration resource type"
+description: "Defines the invitation redemption provider configuration to set redemption flow settings for Microsoft Entra ID B2B collaboration."
+
+ms.localizationpriority: medium
+++
+# defaultInvitationRedemptionIdentityProviderConfiguration resource type
+
+Namespace: microsoft.graph
+
+Defines the invitation redemption provider configuration to set redemption flow settings for Microsoft Entra ID B2B collaboration.
+
+Inherits from [invitationRedemptionIdentityProviderConfiguration](../resources/invitationRedemptionIdentityProviderConfiguration.md)
+
+## Properties
+
+|Property|Type|Description|
+|:|:|:|
+| primaryIdentityProviderPrecedenceOrder | b2bIdentityProvidersType collection | Collection of identity providers in priority order of preference to be used for guest invitation redemption. Possible values are: `azureActiveDirectory`, `externalFederation`, or `socialIdentityProviders`. |
+| fallbackIdentityProvider | b2bIdentityProvidersType | The fallback identity provider to be used in case no primary identity provider can be used for guest invitation redemption. Possible values are: `defaultConfiguredIdp`, `emailOneTimePasscode`, or `microsoftAccount`. |
+
+## Relationships
+
+None.
+
+## JSON representation
+
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.defaultInvitationRedemptionIdentityProviderConfiguration"
+}
+-->
+
+``` json
+{
+ "primaryIdentityProviderPrecedenceOrder": ["String"],
+ "fallbackIdentityProvider": "String"
+}
+```
v1.0 Device https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/device.md
This resource is an open type that allows other properties to be passed in. You
|mdmAppId|String|Application identifier used to register device into MDM. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`).| |model|String| Model of the device. Read-only. | |onPremisesLastSyncDateTime|DateTimeOffset|The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z` Read-only. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`).|
+|onPremisesSecurityIdentifier|String|The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on `$select`. Supports `$filter` (`eq`).|
|onPremisesSyncEnabled|Boolean|`true` if this object is synced from an on-premises directory; `false` if this object was originally synced from an on-premises directory but is no longer synced; `null` if this object has never been synced from an on-premises directory (default). Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). | |operatingSystem|String| The type of operating system on the device. Required. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`, and `eq` on `null` values). | |operatingSystemVersion|String|The version of the operating system on the device. Required. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`, and `eq` on `null` values). |
The following is a JSON representation of the resource.
"mdmAppId": "String", "model": "String", "onPremisesLastSyncDateTime": "String (timestamp)",
+ "onPremisesSecurityIdentifier": "Boolean",
"onPremisesSyncEnabled": "Boolean", "operatingSystem": "String", "operatingSystemVersion": "String",
v1.0 Enums Security https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/enums-security.md
Namespace: microsoft.graph.security
+### actionAfterRetentionPeriod values
+
+| Member |
+| : |
+| none |
+| delete |
+| startDispositionReview |
+| unknownFutureValue |
+ ### behaviorDuringRetentionPeriod values | Member |
Namespace: microsoft.graph.security
| markdown | | unknownFutureValue |
+### defaultRecordBehavior values
+
+| Member |
+| :-- |
+| startLocked |
+| startUnlocked |
+| unknownFutureValue |
+ ### detectionStatus values | Member
Namespace: microsoft.graph.security
| messages | | unknownFutureValue |
+### retentionTrigger values
+
+| Member |
+| :-- |
+| dateLabeled |
+| dateCreated |
+| dateModified |
+| dateOfEvent |
+| unknownFutureValue |
+ ### vulnerabilitySeverity values | Member |
v1.0 Enums https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/enums.md
Namespace: microsoft.graph
| serviceProvider | | unknownFutureValue |
+### migrationStatus values
+
+|Member|
+|:|
+|ready|
+|needsReview|
+|additionalStepsRequired|
+|unknownFutureValue|
+ ### appCredentialRestrictionType values | Member |
Possible values for user account types (group membership), per Windows definitio
| assigned | | unknownFutureValue | | inactive |+
+### b2bIdentityProvidersType values
+
+|Member|
+|:--|
+|azureActiveDirectory|
+|externalFederation|
+|socialIdentityProviders|
+|emailOneTimePasscode|
+|microsoftAccount|
+|defaultConfiguredIdp|
+|unknownFutureValue|
v1.0 Filterdatetime https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/filterdatetime.md
Title: "FilterDatetime resource type"
+ Title: "filterDatetime resource type"
description: "Represents how to filter a date when filtering on values." ms.localizationpriority: medium
doc_type: resourcePageType
-# FilterDatetime resource type
+# filterDatetime resource type
Namespace: microsoft.graph
Represents how to filter a date when filtering on values.
## Properties | Property | Type |Description| |:|:--|:-|
-|date|string|The date in ISO8601 format used to filter data.|
-|specificity|string|How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is set to "month", the filter operation will keep all rows with a date in the month of April 2009. The possible values are: `Year`, `Monday`, `Day`, `Hour`, `Minute`, `Second`.|
+|date|String|The date in ISO 8601 format used to filter data.|
+|specificity|String|Defines how specific you should use the **date** to keep data. For example, if the date is `2005-04-02` and the **specificity** property is set to `month`, the filter operation keeps all rows with a date in the month of April 2009. The possible values are: `Year`, `Month`, `Day`, `Hour`, `Minute`, `Second`.|
## Relationships
-None
+None.
## JSON representation
-Here's a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!-- { "blockType": "resource",
Here's a JSON representation of the resource.
```json {
- "date": "string",
- "specificity": "string"
+ "date": "String",
+ "specificity": "String"
}- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Internaldomainfederation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/internaldomainfederation.md
Title: "internalDomainFederation resource type"
description: "Represents configurations of the domains in a tenant that are federated with Azure AD." ms.localizationpriority: medium-+ doc_type: resourcePageType
Inherits from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).
|signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| + ### federatedIdpMfaBehavior values | Member | Description |
v1.0 Invitationredemptionidentityproviderconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/invitationredemptionidentityproviderconfiguration.md
+
+ Title: "invitationRedemptionIdentityProviderConfiguration resource type"
+description: "Defines the invitation redemption provider configuration base type to set redemption flow settings for Microsoft Entra ID B2B collaboration."
+
+ms.localizationpriority: medium
+++
+# invitationRedemptionIdentityProviderConfiguration resource type
+
+Namespace: microsoft.graph
+
+Defines the invitation redemption provider configuration base type to set redemption flow settings for Microsoft Entra ID B2B collaboration.
+
+Two types of identity providers are in the precedence order: primary identity providers and fallback identity providers. Fallback identity providers are used when no primary identity provider is available and must always be specified.
+
+The primary identity providers are:
+
+- azureActiveDirectory: Any user located in another Microsoft Entra ID tenant.
+- externalFederation: Any user located in an identity provider associated with a SAML or WS-Federation relationship.
+- socialIdentityProviders: Any user using a gmail.com account when Google Federation is configured.
+
+The fallback identity providers are:
+
+- defaultConfiguredIdp: Check for an existing Microsoft account, then use a one-time email passcode (if enabled), and finally, create a new Microsoft account if no primary identity providers are available for the user.
+- emailOneTimePasscode: Always use one-time email passcode if no primary identity providers are available for the user.
+- microsoftAccount: Always use an existing Microsoft account or create a new Microsoft account if no primary identity providers are available for the user.
+
+## Properties
+
+|Property|Type|Description|
+|:|:|:|
+| primaryIdentityProviderPrecedenceOrder | b2bIdentityProvidersType collection | Collection of identity providers in priority order of preference to be used for guest invitation redemption. Possible values are: `azureActiveDirectory`, `externalFederation`, or `socialIdentityProviders`. |
+| fallbackIdentityProvider | b2bIdentityProvidersType | The fallback identity provider to be used in case no primary identity provider can be used for guest invitation redemption. Possible values are: `defaultConfiguredIdp`, `emailOneTimePasscode`, or `microsoftAccount`. |
+
+## Relationships
+
+None.
+
+## JSON representation
+
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.invitationRedemptionIdentityProviderConfiguration"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.invitationRedemptionIdentityProviderConfiguration",
+ "primaryIdentityProviderPrecedenceOrder": [
+ "String"
+ ],
+ "fallbackIdentityProvider": "String"
+}
+```
v1.0 Listitem https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/listitem.md
- Title: listItem resource
-description: Represents an item in a sharepoint list.
+
+ Title: "listItem resource"
+description: "Represents an item in a SharePoint list."
ms.localizationpriority: high doc_type: resourcePageType
All examples are relative to a **[list][]**: `https://graph.microsoft.com/v1.0/s
| [List documentSetVersions](../api/listitem-list-documentsetversions.md) | [documentSetVersion][] collection | Get a list of the versions of a document set item in a list. | | [Create documentSetVersion](../api/listitem-post-documentsetversions.md) | [documentSetVersion][] | Create a new version of a document set item in a list. | | [Restore documentSetVersion](../api/documentsetversion-restore.md) | No Content | Restore the document set item to a specific version. |
+| [Get delta](../api/listitem-delta.md) | [listItem](../resources/listitem.md) collection | Get newly created, updated, or deleted [list items](../resources/listitem.md) without having to perform a full read of the entire items collection. |
[Get]: ../api/listitem-get.md [Get analytics]: ../api/itemanalytics-get.md
The following properties are inherited from **[baseItem][]**.
## JSON representation
-The following is a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!--{ "blockType": "resource",
v1.0 Messagerule https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/messagerule.md
Title: "messageRule resource type"
-description: "A rule that applies to messages in the Inbox of a user."
+description: "Represents a rule that applies to messages in the Inbox of a user."
ms.localizationpriority: medium
doc_type: resourcePageType
Namespace: microsoft.graph
-A rule that applies to messages in the Inbox of a user.
+Represents a rule that applies to messages in the Inbox of a user.
In Outlook, you can set up rules for incoming messages in the Inbox to carry out specific actions upon certain conditions.
and available rule conditions and exceptions are represented by the [messageRule
| Property | Type |Description| |:|:--|:-| | actions | [messageRuleActions](messageruleactions.md) | Actions to be taken on a message when the corresponding conditions are fulfilled. |
-| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled, will trigger the corresponding actions for that rule. |
+| conditions | [messageRulePredicates](messagerulepredicates.md) | Conditions that when fulfilled trigger the corresponding actions for that rule. |
| displayName | String | The display name of the rule. | | exceptions | [messageRulePredicates](messagerulepredicates.md) | Exception conditions for the rule. | | hasError | Boolean | Indicates whether the rule is in an error condition. Read-only. |
and available rule conditions and exceptions are represented by the [messageRule
## JSON representation
-Here is a JSON representation of the resource.
+The following JSON representation shows the resource type.
<!-- { "blockType": "resource",
v1.0 Relyingpartydetailedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/relyingpartydetailedsummary.md
+
+ Title: "relyingPartyDetailedSummary resource type"
+description: "Represents the summary of AD FS relying parties' information on daily, weekly, or monthly frequency."
+
+ms.localizationpriority: medium
++
+# relyingPartyDetailedSummary resource type
+
+Namespace: microsoft.graph
+
+Represents the summary of AD FS relying parties' information on daily, weekly, or monthly frequency.
++
+Inherits from [entity](../resources/entity.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List relyingPartyDetailedSummary](../api/reportroot-getrelyingpartydetailedsummary.md)| [relyingPartyDetailedSummary](../resources/relyingpartydetailedsummary.md) collection|Get a summary of AD FS relying parties information.|
+
+## Properties
+
+|Property|Type|Description|
+|:|:|:|
+|failedSignInCount|Int64|Number of failed sign ins on AD FS in the period specified.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|id|String|Unique identifier for the report. Inherited from [entity](../resources/entity.md).|
+|migrationStatus|migrationStatus|Indicates whether the app can be easily moved to Entra ID. The possible values are: `ready`, `needsReview`, `additionalStepsRequired`, `unknownFutureValue`.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|migrationValidationDetails|[keyValuePair](../resources/keyvaluepair.md) collection|Specifies all the validations checks done on applications config details.|
+|relyingPartyId|String|Identifies the relying party to this federation service. It's used when issuing claims to the relying party.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|relyingPartyName|String|Name of the relying party's website or other entity on the Internet that uses an identity provider to authenticate a user who wants to log in.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|replyUrls|String collection|Specifies where the relying party expects to receive the token.|
+|serviceId|String|Uniquely identifies the Active Directory forest.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|signInSuccessRate|Double|Calculated as `Number of successful / (Number of successful + Number of failed sign ins)` or `successfulSignInCount / totalSignInCount` on AD FS in the period specified.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|successfulSignInCount|Int64|Number of successful sign ins on AD FS.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|totalSignInCount|Int64|Number of successful + failed sign ins on AD FS in the period specified.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
+|uniqueUserCount|Int64|Number of unique users that signed into the application.<br/><br/> Supports `$orderby`, `$filter` (`eq`).|
++
+## Relationships
+None.
+
+## JSON representation
+The following JSON representation shows the resource type.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.relyingPartyDetailedSummary",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.relyingPartyDetailedSummary",
+ "id": "String (identifier)",
+ "relyingPartyId": "String",
+ "serviceId": "String",
+ "relyingPartyName": "String",
+ "successfulSignInCount": "Integer",
+ "failedSignInCount": "Integer",
+ "totalSignInCount": "Integer",
+ "signInSuccessRate": "Double",
+ "uniqueUserCount": "Integer",
+ "migrationStatus": "String",
+ "migrationValidationDetails": [
+ {
+ "@odata.type": "microsoft.graph.keyValuePair"
+ }
+ ],
+ "replyUrls": [
+ "String"
+ ]
+}
+```
+
v1.0 Reportroot https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/reportroot.md
Represents a container for Microsoft Entra reporting resources.
## Methods
-| Method | Return type | Description |
-| :- | : | : |
-| [List userRegistrationDetails](../api/authenticationmethodsroot-list-userregistrationdetails.md) | [userRegistrationDetails](../resources/userregistrationdetails.md) collection | Get the state of authentication methods of all users in the tenant. |
-| [Get userRegistrationDetails](../api/userregistrationdetails-get.md) | [userRegistrationDetails](../resources/userregistrationdetails.md) collection | Get the state of authentication methods of a user in the tenant. |
+None.
## Properties
v1.0 Security Api Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-api-overview.md
TheΓÇ» [incident](security-incident.md) resource and its APIs allow you to sort
The Microsoft Graph threat assessment API helps organizations to assess the threat received by any user in a tenant. This empowers customers to report spam emails, phishing URLs or malware attachments they receive to Microsoft. The policy check result and rescan result can help tenant administrators understand the threat scanning verdict and adjust their organizational policy. +
+## Records management
+
+Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let people effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels.
++ ## Secure Score [Microsoft Secure Score](https://techcommunity.microsoft.com/t5/Security-Privacy-and-Compliance/A-new-home-and-an-all-new-look-for-Microsoft-Secure-Score/ba-p/529641) is a security analytics solution that gives you visibility into your security portfolio and how to improve it. With a single score, you can better understand what you did to reduce your risk in Microsoft solutions. You can also compare your score with other organizations and see how your score has been trending over time. The Microsoft Graph security [secureScore](securescore.md) and [secureScoreControlProfile](securescorecontrolprofile.md) entities help you balance your organization's security and productivity needs while enabling the appropriate mix of security features. You can also project what your score would be after you adopt security features.
v1.0 Security Appliedcategory https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-appliedcategory.md
+
+ Title: "appliedCategory resource type"
+description: "Represents the file plan descriptor of type category applied to a particular retention label."
+
+ms.localizationpriority: medium
++
+# appliedCategory resource type
+
+Namespace: microsoft.graph.security
+
+Represents a file plan descriptor that specifies a group of similar types of content in a department. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+
+To create, get, or delete an **appliedCategory** descriptor, use the [categoryTemplate](security-categorytemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
+
+Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a category name applied to the label. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+|subCategory|[microsoft.graph.security.subCategory](../resources/security-subcategory.md)|Represents the file plan descriptor for a subcategory under a specific category, which has been assigned to a particular retention label.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.appliedCategory"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.appliedCategory",
+ "displayName": "String",
+ "subCategory": {
+ "@odata.type": "microsoft.graph.security.subCategory"
+ }
+}
+```
+
v1.0 Security Authority https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-authority.md
+
+ Title: "authority resource type"
+description: "Represents the file plan descriptor of type authority applied to a particular retention label."
+
+ms.localizationpriority: medium
++
+# authority resource type
+
+Namespace: microsoft.graph.security
+
+Represents a file plan descriptor that specifies the type of the underlying authority which determines the content to be retained and its retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+
+To create, get, or delete an **authority** descriptor, use the [authorityTemplate](security-authoritytemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
+
+Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.authority"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.authority",
+ "displayName": "String"
+}
+```
+
v1.0 Security Authoritytemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-authoritytemplate.md
+
+ Title: "authorityTemplate resource type"
+description: "Specifies the underlying authority that describes the type of content to be retained and its retention schedule."
+
+ms.localizationpriority: medium
++
+# authorityTemplate resource type
+
+Namespace: microsoft.graph.security
+
+Supports CRUD operations to apply and manage the [authority](security-authority.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **authority** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
+
+Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get a list of the [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) objects and their properties.|
+|[Create authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Create a new [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.|
+|[Get authorities](../api/security-authoritytemplate-get.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.|
+|[Delete authorities](../api/security-labelsroot-delete-authorities.md)|None|Delete a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the authority descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the authority descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the authority. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.authorityTemplate",
+ "baseType": "microsoft.graph.security.filePlanDescriptor",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.authorityTemplate",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)"
+}
+```
+
v1.0 Security Categorytemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-categorytemplate.md
+
+ Title: "categoryTemplate resource type"
+description: "Specifies a group of similar types of content in a particular department."
+
+ms.localizationpriority: medium
++
+# categoryTemplate resource type
+
+Namespace: microsoft.graph.security
+
+Supports CRUD operations to apply and manage the [appliedCategory](security-appliedcategory.md) descriptor, and any [subCategory](security-subcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). These file plan descriptors supplement a retention label to improve the manageability and organization of Microsoft 365 content.
+
+Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get a list of the [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) objects and their properties.|
+|[Create categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Create a new [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.|
+|[Get categories](../api/security-categorytemplate-get.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.|
+|[Delete categories](../api/security-labelsroot-delete-categories.md)|None|Delete a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.|
+|[List subCategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get the subCategoryTemplate resources from the subCategories navigation property.|
+|[Create subCategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new subCategoryTemplate object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the category descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the category descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the category. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
+
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|subCategories|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Represents all subcategories under a particular category.|
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.categoryTemplate",
+ "baseType": "microsoft.graph.security.filePlanDescriptor",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.categoryTemplate",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)"
+}
+```
+
v1.0 Security Citation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-citation.md
+
+ Title: "citation resource type"
+description: "Represents the file plan descriptor of type citation applied to a particular retention label."
+
+ms.localizationpriority: medium
++
+# citation resource type
+
+Namespace: microsoft.graph.security
+
+Represents a file plan descriptor that specifies a rule or regulation created by a jurisdiction to determine whether certain content should be retained or deleted. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+
+To create, get, or delete a **citation** descriptor, use the [citationTemplate](security-citationtemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
+
+Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.|
+|citationUrl|String|Represents the URL to the published citation.|
+|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.citation"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.citation",
+ "displayName": "String",
+ "citationUrl": "String",
+ "citationJurisdiction": "String"
+}
+```
+
v1.0 Security Citationtemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-citationtemplate.md
+
+ Title: "citationTemplate resource type"
+description: "The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted."
+
+ms.localizationpriority: medium
++
+# citationTemplate resource type
+
+Namespace: microsoft.graph.security
+
+Supports CRUD operations to apply and manage the [citation](security-citation.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **citation** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
+
+Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get a list of the [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) objects and their properties.|
+|[Create citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Create a new [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.|
+|[Get citations](../api/security-citationtemplate-get.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Read the properties and relationships of a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.|
+|[Delete citations](../api/security-labelsroot-delete-citations.md)|None|Delete a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.|
+|citationUrl|String|Represents the URL to the published citation.|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the citation descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the citation descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the citation. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.citationTemplate",
+ "baseType": "microsoft.graph.security.filePlanDescriptor",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.citationTemplate",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)",
+ "citationUrl": "String",
+ "citationJurisdiction": "String"
+}
+```
+
v1.0 Security Department https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-department.md
+
+ Title: "department resource type"
+description: "Represents the file plan descriptor of type department applied to a particular retention label."
+
+ms.localizationpriority: medium
++
+# department resource type
+
+Namespace: microsoft.graph.security
+
+Represents a file plan descriptor that specifies the department or business unit of an organization to which a [retention label](security-retentionlabel.md) applies. Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md).
+
+To create, get, or delete a **department** descriptor, use the [departmentTemplate](security-departmenttemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
+
+Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.department"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.department",
+ "displayName": "String"
+}
+```
+
v1.0 Security Departmenttemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-departmenttemplate.md
+
+ Title: "departmentTemplate resource type"
+description: "Specifies the department or business unit of an organization to which a label belongs."
+
+ms.localizationpriority: medium
++
+# departmentTemplate resource type
+
+Namespace: microsoft.graph.security
+
+Supports CRUD operations to apply and manage the [department](security-department.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **department** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
+
+Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get a list of the [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) objects and their properties.|
+|[Create departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Create a new [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.|
+|[Get departments](../api/security-departmenttemplate-get.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Read the properties and relationships of a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.|
+|[Delete departments](../api/security-labelsroot-delete-departments.md)|None|Delete a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the department descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the department descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the department. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.departmentTemplate",
+ "baseType": "microsoft.graph.security.filePlanDescriptor",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.departmentTemplate",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)"
+}
+```
+
v1.0 Security Dispositionreviewstage https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-dispositionreviewstage.md
+
+ Title: "dispositionReviewStage resource type"
+description: "Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item.."
+
+ms.localizationpriority: medium
++
+# dispositionReviewStage resource type
+
+Namespace: microsoft.graph.security
+
+Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item.
+For details, see [Disposition of content](/microsoft-365/compliance/disposition).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object. |
+|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the [retentionLabel](../resources/security-retentionlabel.md) object. |
++
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|id|String|Unique ID for each stage. |
+|name|String|Name representing each stage within a collection. |
+|reviewersEmailAddresses|String collection|A collection of reviewers at each stage. |
+|stageNumber|Int32|The sequence number for each stage of the disposition review. |
++
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.dispositionReviewStage",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.dispositionReviewStage",
+ "id": "String (identifier)",
+ "stageNumber": "Integer",
+ "name": "String",
+ "reviewersEmailAddresses": [
+ "String"
+ ]
+}
+```
v1.0 Security Fileplandescriptor https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplandescriptor.md
+
+ Title: "filePlanDescriptor resource type"
+description: "Represents a set of optional descriptors to supplement a retention label and improve the manageability and organization of content in Microsoft 365 for an organization."
+
+ms.localizationpriority: medium
++
+# filePlanDescriptor resource type
+
+Namespace: microsoft.graph.security
+
+Represents a _set_ of optional descriptors to supplement a [retention label](security-retentionlabel.md) and improve the manageability and organization of Microsoft 365 content.
+
+You can add a descriptor by using the POST operation of the corresponding file plan descriptor _template_, and specifying data for the descriptor. For example, to include a [citation](security-citation.md) descriptor, use the [create citationTemplate](../api/security-labelsroot-post-citations.md) operation. Similarly, you can use the GET or DELETE operations on the template resource for the descriptor.
+
+To list the descriptors that supplement a retention label, use the [GET](../api/security-retentionlabel-get.md) operation on that [retentionLabel](security-retentionlabel.md) resource and apply `$expand` on the **descriptors** relationship.
+
+For information on how retention labels and file plan descriptors work in the [Microsoft Purview compliance portal](https://compliance.microsoft.com/), see [Use file plan to create and manage retention labels](/purview/file-plan-manager).
+
+Inherits from [microsoft.graph.entity](../resources/entity.md).
+
+## Methods
+None.
++
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|authority|[microsoft.graph.security.authority](../resources/security-authority.md)|Represents the file plan descriptor of type authority applied to a particular retention label.|
+|appliedcategory|[microsoft.graph.security.appliedCategory](../resources/security-appliedcategory.md)|Represents the file plan descriptor of type category applied to a particular retention label.|
+|citation|[microsoft.graph.security.citation](../resources/security-citation.md)|Represents the file plan descriptor of type citation applied to a particular retention label.|
+|department|[microsoft.graph.security.department](../resources/security-department.md)|Represents the file plan descriptor of type department applied to a particular retention label.|
+|filePlanReference|[microsoft.graph.security.filePlanReference](../resources/security-fileplanreference.md)|Represents the file plan descriptor of type filePlanReference applied to a particular retention label. ΓÇ»|
++
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|authorityTemplate|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)| Specifies the underlying authority that describes the type of content to be retained and its retention schedule.|
+|categoryTemplate|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Specifies a group of similar types of content in a particular department.|
+|citationTemplate|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. |
+|departmentTemplate|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Specifies the department or business unit of an organization to which a label belongs.|
+|filePlanReferenceTemplate|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule.|
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.filePlanDescriptor",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.filePlanDescriptor",
+ "id": "String (identifier)",
+ "authority": {
+ "@odata.type": "microsoft.graph.security.authority"
+ },
+ "category": {
+ "@odata.type": "microsoft.graph.security.appliedCategory"
+ },
+ "citation": {
+ "@odata.type": "microsoft.graph.security.citation"
+ },
+ "department": {
+ "@odata.type": "microsoft.graph.security.department"
+ },
+ "filePlanReference": {
+ "@odata.type": "microsoft.graph.security.filePlanReference"
+ }
+}
+```
+
v1.0 Security Fileplandescriptorbase https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplandescriptorbase.md
+
+ Title: "filePlanDescriptorBase resource type"
+description: "Specifies properties common to file plan descriptor resources."
+
+ms.localizationpriority: medium
++
+# filePlanDescriptorBase resource type
+
+Namespace: microsoft.graph.security
+
+Specifies properties common to file plan descriptor resources. Base type for each of the descriptors: [appliedCategory](security-appliedcategory.md), [authority](security-authority.md), [citation](security-citation.md), [department](security-department.md), [filePlanReference](security-fileplanreference.md), and [subCategory](security-subcategory.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines the name for the file plan descriptor associated with a particular retention label.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.filePlanDescriptorBase"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.filePlanDescriptorBase",
+ "displayName": "String"
+}
+```
+
v1.0 Security Fileplandescriptortemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplandescriptortemplate.md
+
+ Title: "filePlanDescriptorTemplate resource type"
+description: "Specifies the properties common to the template resources for file plan descriptors."
+
+ms.localizationpriority: medium
++
+# filePlanDescriptorTemplate resource type
+
+Namespace: microsoft.graph.security
+
+Specifies the properties common to the template resources for file plan descriptors. Base type for each of the template resources: [authorityTemplate](security-authoritytemplate.md), [categoryTemplate](security-categorytemplate.md), [citationTemplate](security-citationtemplate.md), [departmentTemplate](security-departmenttemplate.md), [filePlanReferenceTemplate](security-fileplanreferencetemplate.md), and [subCategoryTemplate](security-subcategorytemplate.md).
+
+Inherits from [microsoft.graph.entity](../resources/entity.md).
+
+## Methods
+None.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the filePlanDescriptorTemplate column.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanDescriptorTemplate is created.|
+|displayName|String|Unique string that defines a filePlanDescriptorTemplate name.|
+|id|String|Unique ID of the filePlanDecriptorTemplate column. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.filePlanDescriptorTemplate",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.filePlanDescriptorTemplate",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)"
+}
+```
+
v1.0 Security Fileplanreference https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplanreference.md
+
+ Title: "filePlanReference resource type"
+description: "Represents the file plan descriptor of a reference ID, supplementing a specified retention label."
+
+ms.localizationpriority: medium
++
+# filePlanReference resource type
+
+Namespace: microsoft.graph.security
+
+Represents a file plan descriptor that specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule. Used to supplement a [retention label](security-retentionlabel.md) for [record management purposes](security-recordsmanagement-overview.md).
+
+To create, get, or delete a **filePlanReference** descriptor, use the [filePlanReferenceTemplate](security-fileplanreferencetemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
+
+Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a reference ID. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.filePlanReference"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.filePlanReference",
+ "displayName": "String"
+}
+```
+
v1.0 Security Fileplanreferencetemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-fileplanreferencetemplate.md
+
+ Title: "filePlanReferenceTemplate resource type"
+description: "Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule."
+
+ms.localizationpriority: medium
++
+# filePlanReferenceTemplate resource type
+
+Namespace: microsoft.graph.security
+
+Supports CRUD operations to apply and manage the [filePlanReference](security-fileplanreference.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **filePlanReference** descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
+
+Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get a list of the [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects and their properties.|
+|[Create filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Create a new [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.|
+|[Get filePlanReferences](../api/security-fileplanreferencetemplate-get.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Read the properties and relationships of a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.|
+|[Delete filePlanReferences](../api/security-labelsroot-delete-fileplanreferences.md)|None|Delete a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the file plan reference descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanReference descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the filePlanReference. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.filePlanReferenceTemplate",
+ "baseType": "microsoft.graph.security.filePlanDescriptor",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)"
+}
+```
+
v1.0 Security Labelsroot https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-labelsroot.md
+
+ Title: "labelsRoot resource type"
+description: "A root resource for capabilities that support records management for Microsoft 365 data in an organization."
+
+ms.localizationpriority: medium
++
+# labelsRoot resource type
+
+Namespace: microsoft.graph.security
+
+A root resource for capabilities that support records management for Microsoft 365 data in an organization.
+
+Those capabilities include using a [retention label](security-retentionlabel.md) to configure retention and deletion settings for a type of content in the Microsoft 365 data, and using one or more [file plan descriptors](security-fileplandescriptor.md) to supplement the retention label and provide additional options to better manage and organize the content.
+
+Inherits from [microsoft.graph.entity](../resources/entity.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List retentionLabels](../api/security-labelsroot-list-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection |Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.|
+|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object.|
+|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get the authorityTemplate resources from the authorities navigation property.|
+|[Create authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Create a new authorityTemplate object.|
+|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get the categoryTemplate resources from the categories navigation property.|
+|[Create categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Create a new categoryTemplate object.|
+|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get the citationTemplate resources from the citations navigation property.|
+|[Create citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Create a new citationTemplate object.|
+|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get the departmentTemplate resources from the departments navigation property.|
+|[Create departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Create a new departmentTemplate object.|
+|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get the filePlanReferenceTemplate resources from the filePlanReferences navigation property.|
+|[Create filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Create a new filePlanReferenceTemplate object.|
+
+## Properties
+None.
+++
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|authorities|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Specifies the underlying authority that describes the type of content to be retained and its retention schedule.|
+|categories|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Specifies a group of similar types of content in a particular department.|
+|citations|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted.|
+|departments|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Specifies the department or business unit of an organization to which a label belongs.|
+|filePlanReferences|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Specifies a unique alpha-numeric identifier for an organizationΓÇÖs retention schedule.|
+|retentionLabels|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection|Represents how customers can manage their data, whether and for how long to retain or delete it.|
++
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.labelsRoot",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.labelsRoot",
+ "id": "String (identifier)"
+}
+```
+
v1.0 Security Recordsmanagement Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-recordsmanagement-overview.md
doc_type: conceptualPageType
# Use the Microsoft Graph records management APIs
+The Microsoft Purview records management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations, and increases efficiency by enabling the regular disposition of items that no longer have to be retained.
-The Microsoft Purview Records Management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations. The APIs increase efficiency by enabling the regular disposition of items that no longer have to be retained.
+## Manage retention labels
+Many organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content.
-The records management solution is a part of the Microsoft Purview compliance portal.
+You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period.
+
+In addition, you can use [file plan descriptors](security-fileplandescriptor.md) to supplement a retention label and improve the manageability and organization of Microsoft 365 content. Examples of file plan descriptors include [authority](security-authority.md), [citation](security-citation.md), and [department](security-department.md).
## Trigger events for an existing label
-When an employee leaves a company, information is updated in the HR management system. From the leave date, confidential documents need to be retained for a period for seven years. These documents have the label `Employee_departure` applied.
+Some scenarios require starting a retention period for certain documents upon a specific event, such as an employee leaving an organization, a contract expiring, or the fiscal year ending.
+
+You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period.
-Developers and compliance administrators can use records management APIs to read the label `Employee_departure` and look up the associated event type `Event-employee_departure`.
+As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. Use the **retentionLabel** and **retentionEvent** APIs to do the following for each employee record when the employee starts:
+1. Apply a **retentionLabel** configured as follows:
+ - A display name of "Personnel information"
+ - A **retentionDuration** of 1827 days (5 years)
+ - Listening to the **retentionEventType** named "Employee departure"
+2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventquery.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event.
-Compliance admins can use records management APIs to create an event for the associated event type. The retention period for the confidential documents starts after the creation of this event.
+When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventquery.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event.
## Entities The records management API includes the following key entities. | Name | Type | Use case | |:-|:-|:-|
+| Label | [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) | Contains retention settings and actions that can be applied to an item at the end of a period. |
+| File plan descriptors |[microsoft.graph.securty.fileplandescriptor](../resources/security-fileplandescriptor.md) | Represents a set of optional descriptors to supplement a retention label and improve their manageability for an organization. |
| Retention event | [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) | Represents a trigger for event-based retention, where a retention period starts after the event occurs. | | Retention event type | [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) | Represents a single group for the same type of retention events. |
v1.0 Security Retentionduration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentionduration.md
+
+ Title: "retentionDuration resource type"
+description: "An abstract type that represents how long an item will be retained before it can be deleted."
+
+ms.localizationpriority: medium
++
+# retentionDuration resource type
+
+Namespace: microsoft.graph.security
+
+An abstract type that represents how long an item will be retained before it can be deleted.
+
+Base type of
+[retentionDurationForever](../resources/security-retentiondurationforever.md) and [retentionDurationInDays](../resources/security-retentiondurationindays.md).
+
+## Properties
+None.
+
+## Relationships
+None.
+
+## JSON representation for retentionDuration
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.retentionDuration"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.retentionDuration"
+}
+```
++
v1.0 Security Retentiondurationforever https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentiondurationforever.md
+
+ Title: "retentionDurationForever resource type"
+description: "Represents that content will be retained permanently and will not be deleted."
+
+ms.localizationpriority: medium
++
+# retentionDurationForever resource type
+
+Namespace: microsoft.graph.security
+
+Indicates that content will be retained permanently and will not be deleted.
++
+Inherits from [retentionDuration](../resources/security-retentionduration.md).
+
+## Properties
+None.
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.retentionDurationForever"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.retentionDurationForever"
+}
+```
v1.0 Security Retentiondurationindays https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentiondurationindays.md
+
+ Title: "retentionDurationInDays resource type"
+description: "Represents the number of days an item will be retained before it can be deleted"
+
+ms.localizationpriority: medium
++
+# retentionDurationInDays resource type
+
+Namespace: microsoft.graph.security
+
+Represents the number of days an item will be retained before it can be deleted.
++
+Inherits from [retentionDuration](../resources/security-retentionduration.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|days|Int32|Specifies the time period in days for which an item with the applied retention label will be retained for.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.retentionDurationInDays"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.retentionDurationInDays",
+ "days": "Integer"
+}
+```
v1.0 Security Retentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-retentionlabel.md
+
+ Title: "retentionLabel resource type"
+description: "Represents how customers can manage their data at an item level (email or document), including whether and for how long to retain or delete the item."
+
+ms.localizationpriority: medium
++
+# retentionLabel resource type
+
+Namespace: microsoft.graph.security
+
+Represents how organizations, for compliance and governance purposes, can manage their data at an item level (email or document), including whether and for how long to retain or delete the item.
+
+Organizations can use retention labels for different types of content that require different retention settings. For example, they can apply a retention label to tax forms and supporting documents to retain them for the period required by law.
+
+Organizations can configure retention labels with the retention periods and actions based on factors such as the date last modified or created. They can also start different retention periods by specifying an [event that can trigger retention](security-retentionevent.md) when the event occurs.
+
+For more information on how retention labels work, when to use them, and how Microsoft Purview supports retention labels to let you configure retention and deletion settings, see [Learn about retention policies and retention labels](/purview/retention).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List retentionLabels](../api/security-labelsroot-list-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection|Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.|
+|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object.|
+|[Get retentionLabel](../api/security-retentionlabel-get.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.md) object.|
+|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object.|
+|[Delete retentionLabel](../api/security-retentionlabel-delete.md)|None|Delete a [retentionLabel](../resources/security-retentionlabel.md) object.|
+|[List retentionEventType](../api/security-retentioneventtype-list.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) collection|Get the retentionEventType resources from the exapnd eventType navigation property.|
+|[Add retentionEventType](../api/security-retentioneventtype-post.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Add eventType by adding the relevant odata property when creating a label.|
++
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on the labeled document after the period specified by the retentionDuration property expires. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.|
+|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`.|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the retentionLabel.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the retentionLabel is created.|
+|descriptionForAdmins|String|Provides label information for the admin. Optional.|
+|descriptionForUsers|String|Provides the label information for the user. Optional.|
+|displayName|String|Unique string that defines a label name.|
+|id|String|Unique ID of the retentionLabel. [entity](/graph/api/resources/entity).|
+|isInUse|Boolean|Specifies whether the label is currently being used.|
+|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionLabel.|
+|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionLabel was modified.|
+|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.|
+|retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`.|
+|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.|
+|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. |
++
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.|
+|retentionEventType|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Represents the type associated with a retention event.|
+|descriptors|[microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md)|Represents out-of-the-box values that provide more options to improve the manageability and organization of the content you need to label.|
+++
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.retentionLabel",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.retentionLabel",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "behaviorDuringRetentionPeriod": "String",
+ "actionAfterRetentionPeriod": "String",
+ "retentionTrigger": "String",
+ "retentionDuration": {
+ "@odata.type": "microsoft.graph.security.retentionDuration"
+ },
+ "isInUse": "Boolean",
+ "descriptionForAdmins": "String",
+ "descriptionForUsers": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)",
+ "lastModifiedBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "lastModifiedDateTime": "String (timestamp)",
+ "labelToBeApplied": "String",
+ "defaultRecordBehavior": "String"
+}
+```
v1.0 Security Subcategory https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-subcategory.md
+
+ Title: "subCategory resource type"
+description: "Represents a unique subcategory applied to a retention label."
+
+ms.localizationpriority: medium
++
+# subCategory resource type
+
+Namespace: microsoft.graph.security
+
+Represents a unique subcategory applied to a [retention label](security-retentionlabel.md). Used to supplement a retention label for [record management purposes](security-recordsmanagement-overview.md).
+
+To create, get, or delete a **subCategory** descriptor, use the [subCategoryTemplate](security-subcategorytemplate.md) resource.
+
+This resource is one of a set of file plan descriptors that an administrator can choose to supplement a retention label. To find out more about these optional descriptors, and how to get the descriptors that have been chosen for a retention label, see [file plan descriptor](security-fileplandescriptor.md).
+
+Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).|
+
+## Relationships
+None.
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.subCategory"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.subCategory",
+ "displayName": "String"
+}
+```
+
v1.0 Security Subcategorytemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-subcategorytemplate.md
+
+ Title: "subCategoryTemplate resource type"
+description: "Represents the file plan descriptor of type subcategory for retention labels."
+
+ms.localizationpriority: medium
++
+# subCategoryTemplate resource type
+
+Namespace: microsoft.graph.security
+
+Supports CRUD operations to apply and manage the [subCategory](security-subcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **subCategory** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
+
+Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List subCategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get a list of the [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) objects and their properties.|
+|[Create subCategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.|
+|[Get subCategories](../api/security-subcategorytemplate-get.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.|
+|[Delete subCategories](../api/security-categorytemplate-delete-subcategories.md)|None|Delete a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the subcategory descriptor. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|createdDateTime|DateTimeOffset|Represents the date and time in which the subcategory descriptor is created. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). Read-only.|
+|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md).|
+|id|String|Unique ID of the subcategory. Inherited from [microsoft.graph.entity](../resources/entity.md). Read-only.|
+
+## Relationships
+None.
+
+## JSON representation
+Here's JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.security.subCategoryTemplate",
+ "baseType": "microsoft.graph.security.filePlanDescriptor",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.subCategoryTemplate",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "createdDateTime": "String (timestamp)"
+}
+```
+
v1.0 User https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/user.md
This resource supports:
|surname|String|The user's surname (family name or last name). Maximum length is 64 characters. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |usageLocation|String|A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: `US`, `JP`, and `GB`. Not nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |userPrincipalName|String|The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md).<br>NOTE: This property can't contain accent characters. Only the following characters are allowed `A - Z`, `a - z`, `0 - 9`, ` ' . - _ ! # ^ ~`. For the complete list of allowed characters, see [username policies](/azure/active-directory/authentication/concept-sspr-policy#userprincipalname-policies-that-apply-to-all-user-accounts). <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`) and `$orderby`.
-|userType|String|A string value that can be used to classify user types in your directory, such as `Member` and `Guest`. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) |
+|userType|String|A string value that can be used to classify user types in your directory. The possible values are `Member` and `Guest`. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **NOTE:** For more information about the permissions for member and guest users, see [What are the default user permissions in Microsoft Entra ID?](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#member-and-guest-users) |
> [!TIP] > Directory and schema extensions and their associated data are returned only on `$select`; Open extensions and their associated data are returned only on `$expand`.
v1.0 Toc.Yml https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc.yml a/api-reference/v1.0/toc.yml
items:
items: - name: Microsoft Entra activity reports items:
+ - name: AD FS application activity
+ items:
+ - name: Relying party detailed summary
+ href: resources/relyingpartydetailedsummary.md
+ items:
+ - name: Get relying party detailed summary
+ href: api/reportroot-getrelyingpartydetailedsummary.md
- name: Registration and usage items: - name: Overview
items:
href: api/alert-update.md - name: Records management items:
- - name: Overview
- href: resources/security-recordsManagement-overview.md
- - name: Retention event
- href: resources/security-retentionevent.md
- items:
+ - name: Overview
+ href: resources/security-recordsmanagement-overview.md
+ - name: Retention label
+ href: resources/security-retentionlabel.md
+ items:
+ - name: List
+ href: api/security-labelsroot-list-retentionlabel.md
+ - name: Create
+ href: api/security-labelsroot-post-retentionlabel.md
+ - name: Get
+ href: api/security-retentionlabel-get.md
+ - name: Update
+ href: api/security-retentionlabel-update.md
+ - name: Delete
+ href: api/security-retentionlabel-delete.md
+ - name: File plan descriptors
+ items:
+ - name: File plan descriptors
+ items:
+ - name: File plan descriptor set
+ href: resources/security-fileplandescriptor.md
+ - name: Applied category
+ href: resources/security-appliedcategory.md
+ - name: Authority
+ href: resources/security-authority.md
+ - name: Citation
+ href: resources/security-citation.md
+ - name: Department
+ href: resources/security-department.md
+ - name: File plan reference
+ href: resources/security-fileplanreference.md
+ - name: Subcategory
+ href: resources/security-subcategory.md
+ - name: File plan descriptor templates
+ items:
+ - name: Applied category template
+ items:
+ - name: Category template
+ href: resources/security-categorytemplate.md
- name: List
- href: api/security-retentionevent-list.md
+ href: api/security-labelsroot-list-categories.md
- name: Create
- href: api/security-retentionevent-post.md
+ href: api/security-labelsroot-post-categories.md
- name: Get
- href: api/security-retentionevent-get.md
+ href: api/security-categorytemplate-get.md
- name: Delete
- href: api/security-retentionevent-delete.md
- - name: Retention event type
- href: resources/security-retentioneventtype.md
- items:
+ href: api/security-labelsroot-delete-categories.md
+ - name: Authority template
+ items:
+ - name: Authority template
+ href: resources/security-authoritytemplate.md
- name: List
- href: api/security-retentioneventtype-list.md
+ href: api/security-labelsroot-list-authorities.md
- name: Create
- href: api/security-retentioneventtype-post.md
+ href: api/security-labelsroot-post-authorities.md
- name: Get
- href: api/security-retentioneventtype-get.md
- - name: Update
- href: api/security-retentioneventtype-update.md
+ href: api/security-authoritytemplate-get.md
+ - name: Delete
+ href: api/security-labelsroot-delete-authorities.md
+ - name: Citation template
+ items:
+ - name: Citation template
+ href: resources/security-citationtemplate.md
+ - name: List
+ href: api/security-labelsroot-list-citations.md
+ - name: Create
+ href: api/security-labelsroot-post-citations.md
+ - name: Get
+ href: api/security-citationtemplate-get.md
+ - name: Delete
+ href: api/security-labelsroot-delete-citations.md
+ - name: Department template
+ items:
+ - name: Department template
+ href: resources/security-departmenttemplate.md
+ - name: List
+ href: api/security-labelsroot-list-departments.md
+ - name: Create
+ href: api/security-labelsroot-post-departments.md
+ - name: Get
+ href: api/security-departmenttemplate-get.md
+ - name: Delete
+ href: api/security-labelsroot-delete-departments.md
+ - name: File plan reference template
+ items:
+ - name: File plan reference template
+ href: resources/security-fileplanreferencetemplate.md
+ - name: List
+ href: api/security-labelsroot-list-fileplanreferences.md
+ - name: Create
+ href: api/security-labelsroot-post-fileplanreferences.md
+ - name: Get
+ href: api/security-fileplanreferencetemplate-get.md
- name: Delete
- href: api/security-retentioneventtype-delete.md
+ href: api/security-labelsroot-delete-fileplanreferences.md
+ - name: Subcategory template
+ items:
+ - name: Subcategory template
+ href: resources/security-subcategorytemplate.md
+ - name: List
+ href: api/security-categorytemplate-list-subcategories.md
+ - name: Create
+ href: api/security-categorytemplate-post-subcategories.md
+ - name: Get
+ href: api/security-subcategorytemplate-get.md
+ - name: Delete
+ href: api/security-categorytemplate-delete-subcategories.md
+ - name: Retention event
+ href: resources/security-retentionevent.md
+ items:
+ - name: List
+ href: api/security-retentionevent-list.md
+ - name: Create
+ href: api/security-retentionevent-post.md
+ - name: Get
+ href: api/security-retentionevent-get.md
+ - name: Delete
+ href: api/security-retentionevent-delete.md
+ - name: Retention event type
+ href: resources/security-retentioneventtype.md
+ items:
+ - name: List
+ href: api/security-retentioneventtype-list.md
+ - name: Create
+ href: api/security-retentioneventtype-post.md
+ - name: Get
+ href: api/security-retentioneventtype-get.md
+ - name: Update
+ href: api/security-retentioneventtype-update.md
+ - name: Delete
+ href: api/security-retentioneventtype-delete.md
- name: Secure score href: resources/securescore.md items:
items:
- name: List item href: resources/listitem.md items:
- - name: Get item
- href: api/listitem-get.md
- name: Create item href: api/listitem-create.md
- - name: Update item
+ - name: Get
+ href: api/listitem-get.md
+ - name: Update
href: api/listitem-update.md
- - name: Delete item
+ - name: Delete
href: api/listitem-delete.md
- - name: List versions
- href: api/listitem-list-versions.md
+ - name: Get delta
+ href: api/listitem-delta.md
- name: Get item analytics href: api/itemanalytics-get.md
+ - name: List versions
+ href: api/listitem-list-versions.md
- name: Document set version items: - name: Document set version