| Service | Microsoft Docs article | Related commit history on GitHub | Change details |
|---|---|---|---|
| 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. +<!-- { + "blockType": "request", + "name": "delete_trainingcampaign" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/{trainingCampaignId} +``` +++### 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. +<!-- { + "blockType": "request", + "name": "list_trainingcampaign" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns +``` +++### 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. +<!-- { + "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" + } +} +``` ++### 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 +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) | ChannelSettings.ReadWrite.All | +|Delegated (personal Microsoft account) | Not supported. | +|Application | ChannelSettings.ReadWrite.All | ++> **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 ++<!-- { + "blockType": "request", + "name": "archive_channel" +}--> +```http +POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive +``` ++#### 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 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 ++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) | ChannelSettings.ReadWrite.All | +|Delegated (personal Microsoft account) | Not supported. | +|Application | ChannelSettings.ReadWrite.All | ++> **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 ++<!-- { + "blockType": "request", + "name": "unarchive_channel" +}--> +```http +POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/unarchive +``` ++#### 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 | 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. ++<!-- { + "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" +} +``` ++### 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. ++<!-- { + "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" +} +``` ++### Response ++The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
| 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. ++<!-- { + "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", + ] ++} +``` +++### 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 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 | 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 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 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 OData query parameters to help customize the response, for example: `$count`, `$filter`, `$skip`, `$top`. ++The following are examples of their use: ++See all open health alerts. +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open' +``` ++See top five open health alerts. +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open'&$top=5 +``` ++See open health alerts based on issue type. +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=healthIssueType eq 'global' +GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=healthIssueType eq 'sensor' +``` ++See open health alerts based on severity. +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=severity eq 'medium' +GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=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'&$filter=healthIssueType eq 'global'&$filter=domainNames/any(s:endswith(s,'contoso.com')) +GET /security/identities/healthissues?$filter=Status eq 'open'&$filter=healthIssueType eq 'global'&$filter=sensorDNSNames/any(s:endswith(s,'contoso.com')) +``` ++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 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 | Site Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-delta.md | 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 ++<!-- { + "blockType": "request", + "name" : "get_trainingcampaign" +}--> ++``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a +``` ++++#### 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 ++<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_includedtargets" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/includedAccountTarget +``` ++++#### 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 ++<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_excludedtargets" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/excludedAccountTarget +``` ++++#### 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 ++<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_training" +} +--> ++``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/trainingSetting +``` ++++#### 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 ++<!-- { + "blockType": "request", + "name" : "get_trainingcampaign_eun" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/endUserNotificationSetting +``` ++++#### 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 ++<!-- { + "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" + } +} +``` ++### 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 | 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. +<!-- { + "blockType": "request", + "name": "list_campaignusersdetails" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/f1b13829-3829-f1b1-2938-b1f12938b1a/report/campaignUsers +``` ++++### 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 | 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 |
| 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 | 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 | Security Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-api-overview.md | 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 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | Authenticationmethods Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationmethods-overview.md | Title: "Microsoft Entra authentication methods API overview" description: "Authentication methods are how users authenticate in Azure AD." ms.localizationpriority: medium-+ |
| 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 | 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 -# 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 | 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 | 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`. |