Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
v1.0 | Accessreviewset Post Definitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewset-post-definitions.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-inactiveguests-m365-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-allusers-m365-aadrole-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-group-multistage-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-insights-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - |
v1.0 | Accessreviewset Post Historydefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewset-post-historydefinitions.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewhistorydefinition-from--powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - ### Response |
v1.0 | Appmanagementpolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appManagementPolicy-delete.md | DELETE https://graph.microsoft.com/beta/policies/appManagementPolicies/{id} [!INCLUDE [sample-code](../includes/snippets/go/delete-appmanagementpolicy-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PowerShell](#tab/powershell) - # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/delete-appmanagementpolicy-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Application List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-list.md | ConsistencyLevel: eventual ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Application Post Applications | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-applications.md | Create a new [application](../resources/application.md) object. > [!IMPORTANT] > Adding [**passwordCredential**](../resources/passwordcredential.md) when creating applications is not supported. Use the [addPassword](application-addpassword.md) method to add passwords or secrets for an application.+> +> Do not share application client IDs (**appId**) in API documentation or code samples. ## 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). |
v1.0 | Application Post Onlinemeetings | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-onlinemeetings.md | Content-Type: application/json } ``` --### Example 2: Create an online meeting in a Microsoft Teams channel with a user token --#### Request --The following is an example of a request. -->**Note:** The Object ID of the user token passed should be a member of the channel represented by **threadId** in the payload. --```http -POST https://graph.microsoft.com/beta/me/onlineMeetings -Content-Type: application/json --{ - "startDateTime":"2019-07-12T14:30:34.2444915-07:00", - "endDateTime":"2019-07-12T15:00:34.2464912-07:00", - "subject":"User meeting in Microsoft Teams channel.", - "chatInfo": { - "threadId":"19%3A3b5239894b776357c1dd79%40thread.skype" - } -} -``` -#### Response --The following is an example of the response. -->**Note:** The response object shown here might be shortened for readability. --<!-- { - "blockType": "example", - "truncated": true, - "@odata.type": "microsoft.graph.onlineMeeting" -} --> --```http -HTTP/1.1 201 Created -Content-Type: application/json --{ - "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('f40f86-17cc-42e7-85f4-f03880d6')/onlineMeetings/$entity", - "audioConferencing": { - "tollNumber": "+12534478", - "tollFreeNumber": "+18660588", - "ConferenceId": "24229", - "dialinUrl": "https://dialin.teams.microsoft.com/22f12fa0-49f-45b-bc69-b8a330?id=24229" - }, - "chatInfo": { - "threadId": "19%3A3b52398f3c5244b776357c1dd79%40thread.skype", - "messageId": "1563302249053", - "replyChainMessageId": null - }, - "creationDateTime": "2019-07-11T02:17:17.6491364Z", - "startDateTime": "2019-07-11T02:17:17.6491364Z", - "endDateTime": "2019-07-11T02:47:17.651138Z", - "id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItHRTNaR1F6WGhyZWFkLnYy", - "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2IzYzczNNlOTY4MGEz%40thread.skype/0?context=%7b%22Tid%22%3a%2288bf-86f1-41af-91ab-2011db47%22%2c%22Oid%22%3a%22fae72-d51-43ec-68c-3704f%22%7d", - "participants": { - "organizer": { - "identity": { - "user": { - "id": "55ae72-d251-43ec-868c-373704f", - "tenantId": "72f98f-86f1-41af-91ab-2d7db47", - "displayName": "Mario Rogers" - } - }, - "role": "presenter", - "upn": "upn-value" - } - }, - "subject": "User meeting in Microsoft Teams channel.", - "joinMeetingIdSettings": { - "isPasscodeRequired": false, - "joinMeetingId": "1234567890", - "passcode": null - } -} -``` --### Example 3: Create a Microsoft Teams live event with a user token +### Example 2: Create a Microsoft Teams live event with a user token #### Request The following is an example of the response. } --> -### Example 4: Create an online meeting that requires a passcode +### Example 3: Create an online meeting that requires a passcode The following example shows how to add a passcode to a meeting. The passcode is used when you join a meeting with a **joinMeetingId**. For more details, see [joinMeetingIdSettings](../resources/joinmeetingidsettings.md). #### Request Content-Type: application/json ``` -### Example 5: Create an online meeting that does not require a passcode +### Example 4: Create an online meeting that does not require a passcode When **isPasscodeRequired** is set to `false` or when **joinMeetingIdSettings** is not specified in the request, the generated online meeting will not have a passcode. #### Request |
v1.0 | Application Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-update.md | In the request body, supply the values for relevant fields that should be update | Property | Type | Description | |:|:-|:--| | api | [apiApplication](../resources/apiapplication.md) | Specifies settings for an application that implements a web API. |-| appRoles | [appRole](../resources/approle.md) collection | The collection of application roles that an application may declare. These roles can be assigned to users, groups, or service principals. Not nullable. | +| appRoles | [appRole](../resources/approle.md) collection | The collection of roles defined for the application. These roles can be assigned to users, groups, or service principals. Not nullable. | | displayName | String | The display name for the application. | | groupMembershipClaims | String | Configures the **groups** claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values:<ul><li>`None`</li><li>`SecurityGroup`: For security groups and Azure Active Directory (Azure AD) roles</li><li>`All`: This will get all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of</li></ul> | | identifierUris | String collection | The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see [Application Objects and Service Principal Objects](/azure/active-directory/develop/app-objects-and-service-principals). The *any* operator is required for filter expressions on multi-valued properties. Not nullable. | |
v1.0 | Attachment Createuploadsession | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attachment-createuploadsession.md | For an inline attachment, set _isInline_ property to `true` and use the _content }--> ```http-POST https://graph.microsoft.com/v1.0/me/messages/AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMA=/attachments/createUploadSession +POST https://graph.microsoft.com/beta/me/messages/AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMA=/attachments/createUploadSession Content-type: application/json { |
v1.0 | Attacksimulationroot Get Simulationautomations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attacksimulationroot-get-simulationautomations.md | + + Title: "Get simulationAutomation" +description: "Get an attack simulation automation for a tenant." ++ms.localizationpriority: medium +++# Get simulationAutomation +Namespace: microsoft.graph +++Get an attack simulation automation for a tenant. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId} +``` ++## Optional query parameters +This method supports the `$count`, `$filter`, `$orderby`, `$skip`, `$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 **displayName** and **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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$count=true +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$filter={property} eq '{property-value}' +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$filter={property} eq '{property-value}'&$top=5 +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$orderby={property} +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$skip={skipCount} +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$top=1 +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$select={property} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [simulationAutomation](../resources/simulationautomation.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "get_simulationautomation" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/simulationAutomations/fbad62b0-b32d-b6ac-9f48-d84bbea08f96 +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.simulationAutomation" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.simulationAutomation", + "id": "fbad62b0-b32d-b6ac-9f48-d84bbea08f96", + "displayName": "Reed Flores", + "description": "Sample Simulation Automation Description", + "status": "running", + "createdDateTime": "2022-01-01T01:01:01.01Z", + "createdBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastModifiedDateTime": "2022-01-01T01:01:01.01Z", + "lastModifiedBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastRunDateTime": "2022-01-01T01:01:01.01Z", + "nextRunDateTime": "2022-01-01T01:01:01.01Z" +} +``` + |
v1.0 | Attacksimulationroot Get Simulations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attacksimulationroot-get-simulations.md | + + Title: "Get simulation" +description: "Get an attack simulation campaign for a tenant." ++ms.localizationpriority: medium +++# Get simulation +Namespace: microsoft.graph +++Get an attack simulation campaign for a tenant. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations/{simulationId} +``` ++## 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 **attackTechnique**, **attackType**, **completionDateTime**, **displayName**, **isAutomated**, **launchDateTime**, and **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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations/{simulationId}?$count=true +GET /security/attackSimulation/simulations/{simulationId}?$filter={property} eq '{property-value}' +GET /security/attackSimulation/simulations/{simulationId}?$filter={property} eq '{property-value}'&$top=5 +GET /security/attackSimulation/simulations/{simulationId}?$orderby={property} +GET /security/attackSimulation/simulations/{simulationId}?$skipToken={skipToken} +GET /security/attackSimulation/simulations/{simulationId}?$top=1 +GET /security/attackSimulation/simulations/{simulationId}?$select={property} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [simulation](../resources/simulation.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "get_simulation" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/attackSimulation/simulations/f1b13829-3829-f1b1-2938-b1f12938b1a +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.simulation" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "f1b13829-3829-f1b1-2938-b1f12938b1f1", + "displayName": "Sample Simulation", + "description": "Sample Simulation Description", + "attackType": "social", + "attackTechnique": "credentialHarvesting", + "status": "scheduled", + "createdDateTime": "2021-01-01T01:01:01.01Z", + "createdBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastModifiedDateTime": "2021-01-01T01:01:01.01Z", + "lastModifiedBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "launchDateTime": "2021-01-01T02:01:01.01Z", + "completionDateTime": "2021-01-07T01:01:01.01Z", + "isAutomated": false, + "automationId": "f1b13829-3829-f1b1-2938-b1f12938b1ab", + "payloadDeliveryPlatform": "email" +} +``` |
v1.0 | Attacksimulationroot List Simulationautomations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attacksimulationroot-list-simulationautomations.md | Title: "List simulationAutomations" description: "Get a list of attack simulation automations for a tenant."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: apiPageType If successful, this method returns a `200 OK` response code and a collection of ## Examples -The following is an example of a request. - ### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", |
v1.0 | Attacksimulationroot List Simulations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attacksimulationroot-list-simulations.md | Title: "List simulations" description: "Get a list of attack simulation campaigns for a tenant."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: apiPageType GET /security/attackSimulation/simulations ``` ## Optional query parameters-This method supports the following OData query parameters to help customize the response: `$count`, `$filter`, `$orderby`, `$skiptoken`, `$top`, `$select`. -The following properties support `$filter` and `$orderby`: **attackTechnique**, **attackType**, **completionDateTime**, **displayName**, **isAutomated**, **launchDateTime**, **status**. +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 **attackTechnique**, **attackType**, **completionDateTime**, **displayName**, **isAutomated**, **launchDateTime**, and **status** properties. -Use `@odata.nextLink` for pagination. +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 are examples of their use: GET /security/attackSimulation/simulations?$count=true GET /security/attackSimulation/simulations?$filter={property} eq '{property-value}' GET /security/attackSimulation/simulations?$filter={property} eq '{property-value}'&$top=5 GET /security/attackSimulation/simulations?$orderby={property}+GET /security/attackSimulation/simulations?$skipToken={skipToken} GET /security/attackSimulation/simulations?$top=1 GET /security/attackSimulation/simulations?$select={property} ``` -For general information, see [OData query parameters](/graph/query-parameters). - ## Request headers |Name|Description| |:|:| Content-Type: application/json "createdDateTime": "2021-01-01T01:01:01.01Z", "createdBy": { "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",- "displayName": "Sample User", - "email": "sampleuser@contoso.com" + "displayName": "Reed Flores", + "email": "reed@contoso.com" }, "lastModifiedDateTime": "2021-01-01T01:01:01.01Z", "lastModifiedBy": { "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",- "displayName": "Sample User", - "email": "sampleuser@contoso.com" + "displayName": "Reed Flores", + "email": "reed@contoso.com" }, "launchDateTime": "2021-01-01T02:01:01.01Z", "completionDateTime": "2021-01-07T01:01:01.01Z", |
v1.0 | Bookingbusiness Post Appointments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bookingbusiness-post-appointments.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - ### Response |
v1.0 | Bookingbusiness Post Services | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bookingbusiness-post-services.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - ### Response |
v1.0 | Bookingbusiness Post Staffmembers | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bookingbusiness-post-staffmembers.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-bookingstaffmember-from-bookingbusiness-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - ### Response |
v1.0 | Bookingstaffmember Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bookingstaffmember-update.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/update-bookingstaffmember-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - ### Response |
v1.0 | Call Logteleconferencedevicequality | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-logteleconferencedevicequality.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) - |
v1.0 | Channel Post Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/channel-post-messages.md | One of the following permissions is required to call this API. To learn more, in | Permission type | Permissions (from least to most privileged) | |:|:--|-| Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All | +| Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All | +| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | ++> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. > **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. |
v1.0 | Chat Delete Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-delete-pinnedmessages.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http-DELETE /chats/{chat-id}/pinnedMessages/{pinnedChatMessageInfoId} +DELETE /chats/{chat-id}/pinnedMessages/{pinnedChatMessageId} ``` ## Request headers |
v1.0 | Chat List Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-list-pinnedmessages.md | Title: "List pinned messages in a chat" + Title: "List pinnedChatMessages in a chat" description: "Get a list of pinned messages in a chat." ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType -# List pinned messages in a chat +# List pinnedChatMessages in a chat Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] If successful, this method returns a `200 OK` response code and a collection of ### Example 1: List all the pinned messages in a chat The following example shows a request that lists all the pinned messages in a chat. -### Request +#### Request The following is an example of a request. # [HTTP](#tab/http) GET https://graph.microsoft.com/beta/chats/19:d65713bc498c4a428c71ef9353e6ce20@t -### Response +#### Response The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { Content-Type: application/json ### Example 2: List all the pinned messages in a chat along with the associated chat message The following example shows a request that lists all the pinned messages in a chat along with the associated chat message. -### Request +#### Request The following is an example of a request. # [HTTP](#tab/http) GET https://graph.microsoft.com/beta/chats/19:d65713bc498c4a428c71ef9353e6ce20@t -### Response +#### Response The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { |
v1.0 | Chat Post Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-post-pinnedmessages.md | POST /chats/{chat-Id}/pinnedMessages |Content-Type|application/json. Required.| ## Request body-The request body should contain the chat message ID. +In the request body, supply the ID of a chat message to pin. ## Response |
v1.0 | Chatmessage Post Replies | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-post-replies.md | One of the following permissions is required to call this API. To learn more, in |:|:--| | Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All | +| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. |
v1.0 | Chatmessage Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-post.md | One of the following permissions is required to call this API. To learn more, in |:|:--| | Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All | +| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. |
v1.0 | Chatmessage Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-update.md | The update only works for chats where members are Microsoft Teams users. If one 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) | Chat.ReadWrite | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Chat.UpdatePolicyViolation.All for a chat message.</br>ChannelMessage.UpdatePolicyViolation.All for a channel message. | +### Permissions for channel +| Permission type | Permissions (from least to most privileged) | +|:|:--| +| Delegated (work or school account) | ChannelMessage.ReadWrite, Group.ReadWrite.All** | +| Delegated (personal Microsoft account) | Not supported. | +| Application | ChannelMessage.UpdatePolicyViolation.All, ChannelMessage.ReadWrite.All, Group.ReadWrite.All** | ++> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ++### Permissions for chat +| Permission type | Permissions (from least to most privileged) | +|:|:--| +| Delegated (work or school account) | Chat.ReadWrite | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Chat.UpdatePolicyViolation.All, Chat.ReadWrite.All | ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Cloudpc Restore | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpc-restore.md | Content-length: 37 [!INCLUDE [sample-code](../includes/snippets/go/cloudpc-restore-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/cloudpc-restore-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Cloudpcusersetting Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcusersetting-update.md | The following table shows the properties that are required when you update the [ |Property|Type|Description| |:|:|:| |displayName|String|The setting name displayed in the user interface.|-|localAdminEnabled|Boolean|To turn on the local admin option, change this setting to `True`.ΓÇ» | -|selfServiceEnabled|Boolean|To turn on the self-service option, change this setting to `True`.ΓÇ»| +|localAdminEnabled|Boolean|To turn on the local admin option, change this setting to `true`.ΓÇ» | +|selfServiceEnabled|Boolean|To turn on the self-service option, change this setting to `true`.ΓÇ»| |restorePointSetting|[cloudPcRestorePointSetting](../resources/cloudpcrestorepointsetting.md)|Defines how frequently a restore point is created (that is, a snapshot is taken) for users' provisioned Cloud PCs (default is 12 hours), and whether the user is allowed to restore their own Cloud PCs to a backup made at a specific point in time.|-|lastModifiedDateTime|DateTimeOffset|The last date and time the setting was modified. The Timestamp type represents the date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like this:ΓÇ»'2014-01-01T00:00:00Z'.ΓÇ»| +|lastModifiedDateTime|DateTimeOffset|The last date and time the setting was modified. The Timestamp type represents the 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`.ΓÇ»| If successful, this method returns a `200 OK` response code and an updated [clou ### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json ### Response->**Note:** The response object shown here might be shortened for readability. ++The following is an example of the response. + <!-- { "blockType": "response", "truncated": true |
v1.0 | Device List Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-list-registeredowners.md | GET /devices/{id}/registeredOwners > Note: The "id" in the request is the "id" property of the device, not the "deviceId" property. ## Optional query parameters+ This method supports the `$search`, `$count`, and `$filter` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the directoryRoles the device is a member of. You can use `$search` on the **displayName** property. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).++When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. + ## Request headers | Name | Description| |:--|:| |
v1.0 | Domain Promote | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/domain-promote.md | POST https://graph.microsoft.com/beta/domains/contoso.com/promote [!INCLUDE [sample-code](../includes/snippets/go/domain-promote-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PowerShell](#tab/powershell) - # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/domain-promote-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Driveitem Delta | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/driveitem-delta.md | When the `Prefer: hierarchicalsharing` header is provided, sharing information w In many scanning scenarios, you might be interested specifically in changes to permissions. To make it clear in the delta query response which changes are the result of permissions being changed, you can provide the `Prefer: deltashowsharingchanges` header. When this header is provided, all items that appear in the delta query response due to permission changes will have the `@microsoft.graph.sharedChanged":"True"` OData annotation. This feature is applicable to SharePoint and OneDrive for Business but not consumer OneDrive accounts. -> **Note:** The use of `Prefer: deltashowsharingchanges` header requires you to use `Prefer: deltashowremovedasdeleted` and `Prefer: deltatraversepermissiongaps`. These header values can be joined together in a single header: `Prefer: deltashowremovedasdeleted, deltatraversepermissiongaps, deltashowsharingchanges`. +> [!NOTE] +> * The use of `Prefer: deltashowsharingchanges` header requires you to use `Prefer: deltashowremovedasdeleted` and `Prefer: deltatraversepermissiongaps`. These header values can be joined together in a single header: `Prefer: deltashowremovedasdeleted, deltatraversepermissiongaps, deltashowsharingchanges`. +> +> * In order to process permissions correctly your application will need to request **Sites.FullControl.All** permissions. ++For additional guidance about scanning scenarios see [Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance). ## Error responses In addition to the resync errors detailed above, see [Error Responses][error-response] for details about how errors are returned. +## See also +[Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) +[Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance) + [error-response]: /graph/errors [item-resource]: ../resources/driveitem.md |
v1.0 | Educationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationcategory-delete.md | One of the following permissions is required to call this API. To learn more, in | Permission type | Permissions (from least to most privileged) | | :- | : | | Delegated (work or school account) | EduAssignments.ReadWriteBasic, EduAssignments.ReadWrite |-| Delegated (personal Microsoft account) | Not Supported. | -| Application | Not Supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Not supported. | ## HTTP request |
v1.0 | Educationclass Post Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationclass-post-assignments.md | POST https://graph.microsoft.com/beta/education/classes/72a7baec-c3e9-4213-a850- Content-type: application/json {- "dueDateTime": "2021-09-07T00:00:00Z", - "displayName": "Reading test 09.03 #4", + "dueDateTime": "2022-09-16T00:00:00Z", + "displayName": "Reading test 09.14 Beta", "instructions": { "contentType": "text", "content": "Read chapter 4" }, "grading": {- "@odata.type": "#microsoft.graph.educationAssignmentGradeType", + "@odata.type": "#microsoft.graph.educationAssignmentPointsGradeType", "maxPoints": 50 }, "assignTo": {- "@odata.type": "#microsoft.graph.educationAssignmentGradeType" + "@odata.type": "#microsoft.graph.educationAssignmentClassRecipient" }, "status": "draft", "allowStudentsToAddResourcesToSubmission": true HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/classes('72a7baec-c3e9-4213-a850-f62de0adad5f')/assignments/$entity", - "classId": "72a7baec-c3e9-4213-a850-f62de0adad5f", - "displayName": "Reading test 09.03 #4", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/classes('f4a941ff-9da6-4707-ba5b-0eae93cad0b4')/assignments/$entity", + "classId": "f4a941ff-9da6-4707-ba5b-0eae93cad0b4", + "displayName": "Reading test 09.14 Beta", "closeDateTime": null,- "dueDateTime": "2021-09-07T00:00:00Z", + "dueDateTime": "2022-09-16T00:00:00Z", "assignDateTime": null, "assignedDateTime": null, "allowLateSubmissions": true, "resourcesFolderUrl": null,- "createdDateTime": "2021-09-03T23:55:51.373004Z", - "lastModifiedDateTime": "2021-09-03T23:55:51.4119944Z", + "feedbackResourcesFolderUrl": null, + "createdDateTime": "2022-09-14T21:24:11.8578804Z", + "lastModifiedDateTime": "2022-09-14T21:24:11.8578831Z", "allowStudentsToAddResourcesToSubmission": true, "status": "draft", "notificationChannelUrl": null,- "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%2272a7baec-c3e9-4213-a850-f62de0adad5f%5C%22,%5C%22displayName%5C%22%3Anull,%5C%22assignmentIds%5C%22%3A%5B%5C%221618dfb0-3ff2-4edf-8d5c-b8f81df00e80%5C%22%5D%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22assignment-viewer%5C%22%7D%22,%22channelId%22%3Anull%7D", + "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%22f4a941ff-9da6-4707-ba5b-0eae93cad0b4%5C%22,%5C%22displayName%5C%22%3Anull,%5C%22assignmentIds%5C%22%3A%5B%5C%22b58c972d-585a-4ed8-8e0e-9c66e5506d26%5C%22%5D,%5C%22submissionId%5C%22%3Anull%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22assignment-viewer%5C%22%7D%22,%22channelId%22%3Anull%7D", "addToCalendarAction": "none", "addedStudentAction": "none",- "id": "1618dfb0-3ff2-4edf-8d5c-b8f81df00e80", + "id": "b58c972d-585a-4ed8-8e0e-9c66e5506d26", "instructions": { "content": "Read chapter 4", "contentType": "text" |
v1.0 | Educationuser Post Rubrics | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationuser-post-rubrics.md | Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Group Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | Group.ReadWrite.All | +The following conditions apply for apps to delete role-assignable groups: ++ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or a global administrator or a privileged role administrator.++ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned the Global Administrator or Privileged Role Administrator Azure AD role.+ ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-members.md | GET /groups/{id}/members ## Optional query parameters -This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`. OData cast is also enabled, for example, you can cast to get just the users that are a member of the group. You can use `$search` on the **displayName** property. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group members that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Group List Owners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-owners.md | Title: "List owners" + Title: "List group owners" description: "Retrieve a list of the group's owners." ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType -# List owners +# List group owners Namespace: microsoft.graph GET /groups/{id}/owners ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group owners that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Group Post Groups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-groups.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | Group.Create, Group.ReadWrite.All, Directory.ReadWrite.All | +For an app create a group with owners or members while it has the *Group.Create* permission, the app must have the privileges to read the object type that it wants to assign as the group owner or member. Therefore: ++ The app can assign itself as the group's owner or member.++ To create the group with users as owners or members, the app must have at least the *User.Read.All* permission.++ To create the group with other service principals as owners or members, the app must have at least the *Application.Read.All* permission.++ To create the group with either users or service principals as owners or members, the app must have at least the *Directory.Read.All* permission.+ ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Identitycontainer Post B2cuserflows | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitycontainer-post-b2cuserflows.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - #### Response Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Identitycontainer Post B2xuserflows | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitycontainer-post-b2xuserflows.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Identitygovernance Customtaskextension Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-customtaskextension-delete.md | DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/cu [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-delete-customtaskextension-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-delete-customtaskextension-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Customtaskextension Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-customtaskextension-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [customTaskExtension](../resources/identitygovernance-customtaskextension.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.customTaskExtension](../resources/identitygovernance-customtaskextension.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/custo [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-customtaskextension-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-customtaskextension-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Customtaskextension Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-customtaskextension-update.md | Content-length: 588 [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-update-customtaskextension-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-update-customtaskextension-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Deleteditemcontainer Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-deletedItemcontainer-delete.md | DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/de [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-delete-deleteditems-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-delete-deleteditems-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Deleteditemcontainer Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-deleteditemcontainer-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [workflow](../resources/identitygovernance-workflow.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/delet [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-deleteditemcontainer-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-deleteditemcontainer-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Lifecyclemanagementsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecyclemanagementsettings-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [lifecycleManagementSettings](../resources/identitygovernance-lifecyclemanagementsettings.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.lifecycleManagementSettings](../resources/identitygovernance-lifecyclemanagementsettings.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/setti [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-lifecyclemanagementsettings-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-lifecyclemanagementsettings-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Lifecyclemanagementsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecyclemanagementsettings-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-update-lifecyclemanagementsettings-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-update-lifecyclemanagementsettings-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Lifecycleworkflowscontainer List Customtaskextensions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-customtaskextensions.md | GET /identityGovernance/lifecycleWorkflows/customTaskExtensions ## Optional query parameters -This method supports the `$select` `$search`, `$orderby`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select` `$search`, `$orderBy`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [customTaskExtension](../resources/identitygovernance-customtaskextension.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.customTaskExtension](../resources/identitygovernance-customtaskextension.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/custo [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-customtaskextension-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-customtaskextension-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Lifecycleworkflowscontainer List Deleteditems | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-deleteditems.md | GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/delet ## Optional query parameters -This method supports the `$select`, `$search`, `$orderby`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$search`, `$orderBy`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [workflow](../resources/identitygovernance-workflow.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/delet [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-deleteditemcontainer-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-deleteditemcontainer-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Lifecycleworkflowscontainer List Taskdefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [taskDefinition](../resources/identitygovernance-taskdefinition.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.taskDefinition](../resources/identitygovernance-taskdefinition.md) objects in the response body. ## Examples -### Request +### Example 1: Retrieve all built-in task definitions ++#### Request The following is an example of a request. GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskD [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-taskdefinition-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-taskdefinition-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskD -### Response +#### Response The following is an example of the response Content-Type: application/json ] } ```++### Example 2: Retrieve all built-in tasks supported for "joiner" workflows ++#### Request ++The following is an example of a request. Because the **category** can be one of `joiner`, `joiner,leaver`, or `leaver`, the request must match categories that are `joiner` or `joiner,leaver` to retrieve all tasks supported for "joiner" workflows. ++<!-- { + "blockType": "request", + "name": "lifecycleworkflows_list_taskdefinition_filter_category" +} +--> +``` http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions?$filter=category eq 'joiner,leaver' OR category eq 'joiner' +``` ++#### Response ++The following is an example of the response ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.identityGovernance.taskDefinition)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions", + "value": [ + { + "category": "joiner,leaver", + "description": "Add user to selected groups", + "displayName": "Add User To Groups", + "id": "22085229-5809-45e8-97fd-270d28d66910", + "version": 1, + "parameters": [ + { + "name": "groupID", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "joiner,leaver", + "description": "Disable user account in the directory", + "displayName": "Disable User Account", + "id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950", + "version": 1, + "parameters": [] + }, + { + "category": "joiner,leaver", + "description": "Enable user account in the directory", + "displayName": "Enable User Account", + "id": "6fc52c9d-398b-4305-9763-15f42c1676fc", + "version": 1, + "parameters": [] + }, + { + "category": "joiner,leaver", + "description": "Remove user from membership of selected Azure AD groups", + "displayName": "Remove user from selected groups", + "id": "1953a66c-751c-45e5-8bfe-01462c70da3c", + "version": 1, + "parameters": [ + { + "name": "groupID", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "joiner", + "description": "Generate Temporary Access Pass and send via email to user's manager", + "displayName": "Generate TAP And Send Email", + "id": "1b555e50-7f65-41d5-b514-5894a026d10d", + "version": 1, + "parameters": [ + { + "name": "tapLifetimeMinutes", + "values": [], + "valueType": "string" + }, + { + "name": "tapIsUsableOnce", + "values": [ + "true", + "false" + ], + "valueType": "enum" + } + ] + }, + { + "category": "joiner", + "description": "Send welcome email to new hire", + "displayName": "Send Welcome Email", + "id": "70b29d51-b59a-4773-9280-8841dfd3f2ea", + "version": 1, + "parameters": [] + }, + { + "category": "joiner,leaver", + "description": "Add user to selected teams", + "displayName": "Add User To Teams", + "id": "e440ed8d-25a1-4618-84ce-091ed5be5594", + "version": 1, + "parameters": [ + { + "name": "teamID", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "joiner,leaver", + "description": "Remove user from membership of selected Teams", + "displayName": "Remove user from selected Teams", + "id": "06aa7acb-01af-4824-8899-b14e5ed788d6", + "version": 1, + "parameters": [ + { + "name": "teamID", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "joiner,leaver", + "description": "Run a Custom Task Extension to callout to an external system.", + "displayName": "Run a Custom Task Extension", + "id": "4262b724-8dba-4fad-afc3-43fcbb497a0e", + "version": 1, + "parameters": [ + { + "name": "customTaskExtensionID", + "values": [], + "valueType": "string" + } + ] + } + ] +} +``` |
v1.0 | Identitygovernance Lifecycleworkflowscontainer List Workflows | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-workflows.md | Title: "List workflows (lifecycle workflows)" + Title: "List workflows (in Lifecycle Workflows)" description: "Get a list of the workflow objects and their properties." ms.localizationpriority: medium ms.prod: "governance" doc_type: apiPageType -# List workflows (lifecycle workflows) +# List workflows (in Lifecycle Workflows) Namespace: microsoft.graph.identityGovernance GET /identityGovernance/lifecycleWorkflows/workflows ## Optional query parameters -This method supports the `$search`, `$select`, `$orderBy`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$search`, `$orderBy`, and `$filter` OData query parameters to help customize the response. `$expand` is supported by the **createdBy** and **lastModifiedBy** relationships only. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [workflow](../resources/identitygovernance-workflow.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) objects in the response body. ## Examples -### Request +### Example 1: Retrieve all workflows created in the tenant ++#### Request The following is an example of a request. GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-workflow-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-workflow-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf -### Response +#### Response The following is an example of the response Content-Type: application/json ] } ```++### Example 2: Retrieve only specific properties of "leaver" workflows ++#### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "lifecycleworkflows_list_workflow_select" +} +--> +``` http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows?$filter=category eq 'leaver'&$select=id,category,displayName,isEnabled,isSchedulingEnabled +``` ++#### Response +The following is an example of the response +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.identityGovernance.workflowTemplate)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows(category,displayName,isEnabled,isSchedulingEnabled)", + "value": [ + { + "category": "leaver", + "displayName": "Pre-Offboarding employees in the R&D department", + "id": "c0548e6c-8849-46e8-be14-8b6d2b04957e", + "isEnabled": true, + "isSchedulingEnabled": true + } + ] +} +``` |
v1.0 | Identitygovernance Lifecycleworkflowscontainer List Workflowtemplates | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-workflowtemplates.md | GET /identityGovernance/lifecycleWorkflows/workflowTemplates ## Optional query parameters -This method supports the `$select`, `$orderby`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$orderBy`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.workflowTemplate](../resources/identitygovernance-workflowtemplate.md) objects in the response body. ## Examples -### Request +### Example 1: Retrieve all Lifecycle Workflows workflow templates ++#### Request The following is an example of a request. GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-workflowtemplate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-workflowtemplate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf -### Response +#### Response The following is an example of the response <!-- { Content-Type: application/json ] } ```++### Example 2: Retrieve workflow templates supported for "leaver" workflows ++#### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "lifecycleworkflows_list_workflowtemplate_filter_category" +} +--> +``` http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflowTemplates?$filter=category eq 'leaver' +``` ++#### Response ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.identityGovernance.workflowTemplate)" +} +--> +```json +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates", + "value": [ + { + "category": "leaver", + "description": "Execute real-time termination tasks for employees on their last day of work", + "displayName": "Real-time employee termination", + "id": "145735f1-57cc-48c2-81ec-727f07a10096", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.onDemandExecutionOnly" + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('145735f1-57cc-48c2-81ec-727f07a10096')/tasks", + "tasks": [ + { + "category": "leaver", + "continueOnError": false, + "description": "Remove user from all Azure AD groups memberships", + "displayName": "Remove user from all groups", + "executionSequence": 1, + "id": "1b89bb69-a8cf-416b-a69e-4f6d8108834c", + "isEnabled": true, + "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc", + "arguments": [] + }, + { + "category": "leaver", + "continueOnError": false, + "description": "Remove user from all Teams memberships", + "displayName": "Remove user from all Teams", + "executionSequence": 2, + "id": "d3cea676-ccce-4426-825c-63c63e9a64c7", + "isEnabled": true, + "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024", + "arguments": [] + }, + { + "category": "leaver", + "continueOnError": false, + "description": "Delete user account in Azure AD", + "displayName": "Delete User Account", + "executionSequence": 3, + "id": "adbd4f05-99f0-4260-a155-7657623ca071", + "isEnabled": true, + "taskDefinitionId": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff", + "arguments": [] + } + ] + }, + { + "category": "leaver", + "description": "Configure pre-offboarding tasks for employees before their last day of work", + "displayName": "Pre-Offboarding of an employee", + "id": "25abd83d-3b5d-4d6f-bb9a-4ed366fd96b1", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "rule": "department eq 'Marketing'" + }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger", + "timeBasedAttribute": "employeeLeaveDateTime", + "offsetInDays": -7 + } + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('25abd83d-3b5d-4d6f-bb9a-4ed366fd96b1')/tasks", + "tasks": [ + { + "category": "joiner,leaver", + "continueOnError": false, + "description": "Remove user from membership of selected Azure AD groups", + "displayName": "Remove user from selected groups", + "executionSequence": 1, + "id": "7e9aac8a-d239-4867-be60-b3c999c50ee7", + "isEnabled": true, + "taskDefinitionId": "1953a66c-751c-45e5-8bfe-01462c70da3c", + "arguments": [ + { + "name": "groupID", + "value": "" + } + ] + }, + { + "category": "joiner,leaver", + "continueOnError": false, + "description": "Remove user from membership of selected Teams", + "displayName": "Remove user from selected Teams", + "executionSequence": 2, + "id": "40eab675-1aaf-432d-b17e-053d93b0fe2e", + "isEnabled": true, + "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6", + "arguments": [ + { + "name": "teamID", + "value": "" + } + ] + } + ] + }, + { + "category": "leaver", + "description": "Configure offboarding tasks for employees on their last day of work", + "displayName": "Offboard an employee", + "id": "e821c59e-d28c-44d7-902f-5fed05e926f1", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "rule": "department eq 'Marketing'" + }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger", + "timeBasedAttribute": "employeeLeaveDateTime", + "offsetInDays": 0 + } + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('e821c59e-d28c-44d7-902f-5fed05e926f1')/tasks", + "tasks": [ + { + "category": "joiner,leaver", + "continueOnError": false, + "description": "Disable user account in the directory", + "displayName": "Disable User Account", + "executionSequence": 1, + "id": "8d9eab35-6c32-4b76-acbd-6a22cb07aa6a", + "isEnabled": true, + "taskDefinitionId": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950", + "arguments": [] + }, + { + "category": "leaver", + "continueOnError": false, + "description": "Remove user from all Azure AD groups memberships", + "displayName": "Remove user from all groups", + "executionSequence": 2, + "id": "4f5d8835-5d38-4106-ac7e-ebc407749bd2", + "isEnabled": true, + "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc", + "arguments": [] + }, + { + "category": "leaver", + "continueOnError": false, + "description": "Remove user from all Teams memberships", + "displayName": "Remove user from all Teams", + "executionSequence": 3, + "id": "8087b303-e7d5-492d-ab75-31d4aa34bd73", + "isEnabled": true, + "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024", + "arguments": [] + } + ] + }, + { + "category": "leaver", + "description": "Configure offboarding tasks for employees after their last day of work", + "displayName": "Post-Offboarding of an employee", + "id": "50149a4a-7c2d-4fd8-8018-761f4eb915cb", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "rule": "department eq 'Marketing'" + }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger", + "timeBasedAttribute": "employeeLeaveDateTime", + "offsetInDays": 7 + } + }, + "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('50149a4a-7c2d-4fd8-8018-761f4eb915cb')/tasks", + "tasks": [ + { + "category": "leaver", + "continueOnError": false, + "description": "Remove all licenses assigned to the user", + "displayName": "Remove all licenses for user", + "executionSequence": 1, + "id": "760ab754-8249-4bce-9315-1ad06488e434", + "isEnabled": true, + "taskDefinitionId": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e", + "arguments": [] + }, + { + "category": "leaver", + "continueOnError": false, + "description": "Remove user from all Teams memberships", + "displayName": "Remove user from all Teams", + "executionSequence": 2, + "id": "17b4e37b-c50b-4e04-a11c-93479f487d1d", + "isEnabled": true, + "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024", + "arguments": [] + }, + { + "category": "leaver", + "continueOnError": false, + "description": "Delete user account in Azure AD", + "displayName": "Delete User Account", + "executionSequence": 3, + "id": "46849618-30e7-4b67-abf0-f8c7f0d54b95", + "isEnabled": true, + "taskDefinitionId": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff", + "arguments": [] + } + ] + } + ] +} +``` |
v1.0 | Identitygovernance Lifecycleworkflowscontainer Post Customtaskextensions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-post-customtaskextensions.md | You can specify the following properties when creating a **customTaskExtension** ## Response -If successful, this method returns a `201 Created` response code and a [customTaskExtension](../resources/identitygovernance-customtaskextension.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [microsoft.graph.identityGovernance.customTaskExtension](../resources/identitygovernance-customtaskextension.md) object in the response body. ## Examples Content-length: 588 [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-create-customtaskextension-from--go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-create-customtaskextension-from--php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Lifecycleworkflowscontainer Post Workflows | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-post-workflows.md | Title: "Create workflow (lifecycle workflow)" -description: "Create a new workflow object." +description: "Create a new workflow object. You can create up to 50 workflows in a tenant." ms.localizationpriority: medium ms.prod: "governance" Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new [workflow](../resources/identitygovernance-workflow.md) object. +Create a new [workflow](../resources/identitygovernance-workflow.md) object. You can create up to 50 workflows in a tenant. ## Permissions You can specify the following properties when creating a **workflow**. |Property|Type|Description| |:|:|:|-|category|[microsoft.graph.identityGovernance.lifecycleWorkflowCategory](../resources/identitygovernance-workflow.md)|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. Can be only one value.| +|category|[microsoft.graph.identityGovernance.lifecycleWorkflowCategory](../resources/identitygovernance-workflow.md)|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. Can be only one value. Required.| |description|String|A string that describes the purpose of the workflow for administrative use.|-|displayName|String|A unique string that identifies the workflow. | -|executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines for who and when a workflow will run. | +|displayName|String|A unique string that identifies the workflow. Required.| +|executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines for who and when a workflow will run. Required. | |id|String|Identifier used for individually addressing a specific workflow.| |isEnabled|Boolean|A Boolean value that denotes whether the workflow is set to run or not.| |isSchedulingEnabled|Boolean|A Boolean value that denotes whether scheduling is enabled or not. | You can specify the following properties when creating a **workflow**. ## Response -If successful, this method returns a `201 Created` response code and a [workflow](../resources/identitygovernance-workflow.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) object in the response body. ## Examples ### Request -The following is an example of a request. +The following is an example of a request that creates a workflow with the following configuration: ++ It's a "leaver" workflow that's enabled and schedule to run.++ It runs for new users that are based in Australia, on their employeeHireDate.++ Two tasks are carried out when the workflow runs: the user's account is enabled and a "Welcome" email is sent to the user. # [HTTP](#tab/http) <!-- { The following is an example of a request. ``` http POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows Content-Type: application/json-Content-length: 454 { "category": "joiner", Content-length: 454 [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-create-workflow-from--go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-create-workflow-from--php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Run Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [run](../resources/identitygovernance-run.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-workflow-run-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-workflow-run-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Run List Taskprocessingresults | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-list-taskprocessingresults.md | GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/{runId}/u ## Optional query parameters -This method supports the `$select`, `$orderby`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$orderBy`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-run-taskprocessingresult-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-run-taskprocessingresult-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Run List Userprocessingresults | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-list-userprocessingresults.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [userProcessingResults](../resources/identitygovernance-userprocessingresult.md) object in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.userProcessingResults](../resources/identitygovernance-userprocessingresult.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-run-taskprocessingresult-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-run-taskprocessingresult-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Run Summary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-summary.md | Do not supply a request body for this method. ## Response -If successful, this function returns a `200 OK` response code and a [runSummary](../resources/identitygovernance-runsummary.md) in the response body. +If successful, this function returns a `200 OK` response code and a [microsoft.graph.identityGovernance.runSummary](../resources/identitygovernance-runsummary.md) in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-runthissummary-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-runthissummary-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Task Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-task-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [task](../resources/identitygovernance-task.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.task](../resources/identitygovernance-task.md) object in the response body. ## Examples |
v1.0 | Identitygovernance Taskdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-taskdefinition-get.md | Title: "Get taskDefinition" -description: "Read the properties and relationships of a taskDefinition object." +description: "Read the details of a built-in workflow task." ms.localizationpriority: medium ms.prod: "governance" Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the properties and relationships of a [taskDefinition](../resources/identitygovernance-taskdefinition.md) object. +Read the details of a built-in workflow [task](../resources/identitygovernance-taskdefinition.md). ## Permissions Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [taskDefinition](../resources/identitygovernance-taskdefinition.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.taskDefinition](../resources/identitygovernance-taskdefinition.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskD [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-taskdefinition-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-taskdefinition-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Taskreport List Taskprocessingresults | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-taskreport-list-taskprocessingresults.md | GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/{t ## Optional query parameters -This method supports the `$select`, `$orderby`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$orderBy`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-taskreport-taskprocessingresult-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-taskreport-taskprocessingresult-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Taskreport Summary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-taskreport-summary.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [taskReportSummary](../resources/identitygovernance-taskreportsummary.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.taskReportSummary](../resources/identitygovernance-taskreportsummary.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-taskreportsummary-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-taskreportsummary-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Userprocessingresult Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-userprocessingresult-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [userProcessingResult](../resources/identitygovernance-userprocessingresult.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-run-userprocessingresult-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-run-userprocessingresult-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Userprocessingresult List Taskprocessingresults | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-userprocessingresult-list-taskprocessingresults.md | GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/userProcessing ## Optional query parameters -This method supports the `$select`, `$orderby`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$orderBy`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-workflow-userprocessingresult-taskprocessingresult-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-workflow-userprocessingresult-taskprocessingresult-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Userprocessingresult Summary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-userprocessingresult-summary.md | In the request URL, provide the following query parameters with values. |startDateTime|DateTimeOffset|The start date and time of the user processing result summary.| |endDateTime|DateTimeOffset|The end date and time of the user processing result summary| +## Optional query parameters ++This method supports the `$count`, `$orderBy`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++ ## Request headers |Name|Description| Do not supply a request body for this method. ## Response -If successful, this function returns a `200 OK` response code and a [userSummary](../resources/identitygovernance-usersummary.md) in the response body. +If successful, this function returns a `200 OK` response code and a [microsoft.graph.identityGovernance.userSummary](../resources/identitygovernance-usersummary.md) in the response body. ## Examples GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-userprocessingresultthissummary-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-userprocessingresultthissummary-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow Activate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-activate.md | Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Activate (run on-demand) a [workflow](../resources/identitygovernance-workflow.md) object. +Run a [workflow](../resources/identitygovernance-workflow.md) object on-demand. You can run any workflow on-demand, including scheduled workflows. Workflows created from the "Real-time employee termination" template are run on-demand only. When you run a workflow on demand, the tasks are executed regardless of whether the user state matches the scope and trigger execution conditions. ## Permissions Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-workflowthisactivate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-workflowthisactivate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow Createnewversion | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-createnewversion.md | The following table shows the parameters that can be used with this action. ## Response -If successful, this action returns a `200 OK` response code and a [workflow](../resources/identitygovernance-workflow.md) in the response body. +If successful, this action returns a `200 OK` response code and a [microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) in the response body. ## Examples Content-length: 631 [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-workflowthiscreatenewversion-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-workflowthiscreatenewversion-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-delete.md | DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/wo [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-delete-workflow-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-delete-workflow-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-get.md | Title: "Get workflow (lifecycle workflow)" + Title: "Get workflow (in Lifecycle Workflows)" description: "Read the properties and relationships of a workflow object." ms.localizationpriority: medium ms.prod: "governance" doc_type: apiPageType -# Get workflow (lifecycle workflow) +# Get workflow (in Lifecycle Workflows) Namespace: microsoft.graph.identityGovernance GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId} ## Optional query parameters -This method supports the `$select` and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select` and `$expand` OData query parameters to help customize the response. The **tasks** relationship is expanded by default and `$expand` is supported by the **createdBy** and **lastModifiedBy** relationships. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [workflow](../resources/identitygovernance-workflow.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) object in the response body. ## Examples -### Request +### Example 1: Retrieve the details of a workflow ++#### Request The following is an example of a request. GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-workflow-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-workflow-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf -### Response +#### Response The following is an example of the response Content-Type: application/json } } ```+++### Example 2: Retrieve specific properties of a workflow ++#### Request ++```http +GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/c0548e6c-8849-46e8-be14-8b6d2b04957e?$select=id,displayName,executionConditions,category +``` ++#### Response ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.identityGovernance.workflow" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows(id,displayName,executionConditions,category)/$entity", + "category": "leaver", + "displayName": "Pre-Offboarding employees in the R&D department", + "id": "c0548e6c-8849-46e8-be14-8b6d2b04957e", + "executionConditions": { + "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", + "scope": { + "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet", + "rule": "(department eq 'R&D')" + }, + "trigger": { + "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger", + "timeBasedAttribute": "employeeLeaveDateTime", + "offsetInDays": -7 + } + } +} +``` |
v1.0 | Identitygovernance Workflow List Runs | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-runs.md | GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/ ## Optional query parameters -This method supports the `$select`, `$orderby`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$orderBy`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [run](../resources/identitygovernance-run.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-run-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-run-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow List Task | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-task.md | Title: "List tasks (in a lifecycle workflow)" -description: "Get a list of the task objects and their properties in a lifecycle workflow." +description: "Retrieve the details of the built-in tasks in Lifecycle Workflows." ms.localizationpriority: medium ms.prod: "governance" Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get the task resources from the tasks navigation property. +Retrieve the details of the built-in tasks in Lifecycle Workflows. ## Permissions GET /identityGovernance/lifecycleWorkflows/workflow/{workflowId}/tasks ## Optional query parameters -This method supports the `$search`, `$orderby`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$search`, `$orderBy`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [task](../resources/identitygovernance-task.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.task](../resources/identitygovernance-task.md) objects in the response body. ## Examples |
v1.0 | Identitygovernance Workflow List Taskreports | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-taskreports.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [taskReport](../resources/identitygovernance-taskreport.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.taskReport](../resources/identitygovernance-taskreport.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-taskreport-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-taskreport-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow List Userprocessingresults | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-userprocessingresults.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [userProcessingResult](../resources/identitygovernance-userprocessingresult.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-userprocessingresult-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-userprocessingresult-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow List Versions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-versions.md | GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions ## Optional query parameters -This method supports the `$select`, `$count`, `$search`, `$orderby`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$count`, `$search`, `$orderBy`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [workflowVersion](../resources/identitygovernance-workflowversion.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.workflowVersion](../resources/identitygovernance-workflowversion.md) objects in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-list-workflowversion-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-list-workflowversion-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow Restore | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-restore.md | Do not supply a request body for this method. ## Response -If successful, this action returns a `200 OK` response code and a [workflow](../resources/identitygovernance-workflow.md) in the response body. +If successful, this action returns a `200 OK` response code and a [microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) in the response body. ## Examples POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/dele [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-workflowthisrestore-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-workflowthisrestore-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflow Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-update.md | Content-length: 454 [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-update-workflow-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-update-workflow-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflowtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflowtemplate-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.workflowTemplate](../resources/identitygovernance-workflowtemplate.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-workflowtemplate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-workflowtemplate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflowversion Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflowversion-get.md | Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a [workflowVersion](../resources/identitygovernance-workflowversion.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [microsoft.graph.identityGovernance.workflowVersion](../resources/identitygovernance-workflowversion.md) object in the response body. ## Examples GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf [!INCLUDE [sample-code](../includes/snippets/go/lifecycleworkflows-get-workflowversion-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/lifecycleworkflows-get-workflowversion-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitygovernance Workflowversion List Tasks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflowversion-list-tasks.md | GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions/{vers ## Optional query parameters -This method supports the `$select`, `$top`, `$count`, `$search`, `$orderby`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$top`, `$count`, `$search`, `$orderBy`, `$expand`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [task](../resources/identitygovernance-task.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.identityGovernance.task](../resources/identitygovernance-task.md) objects in the response body. ## Examples |
v1.0 | Identityuserflow Post Userflows | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identityuserflow-post-userflows.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Listitem Delta | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/listitem-delta.md | Content-type: application/json ## See also [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview)+[Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance) [error-response]: /graph/errors |
v1.0 | Managedtenants Auditevent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-auditevent-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/auditEve [!INCLUDE [sample-code](../includes/snippets/go/get-auditevent-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-auditevent-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Cloudpcconnection Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-cloudpcconnection-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/cloudPcC [!INCLUDE [sample-code](../includes/snippets/go/get-cloudpcconnection-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-cloudpcconnection-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Cloudpcdevice Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-cloudpcdevice-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/cloudPcD [!INCLUDE [sample-code](../includes/snippets/go/get-cloudpcdevice-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-cloudpcdevice-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Cloudpcoverview Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-cloudpcoverview-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/cloudPcs [!INCLUDE [sample-code](../includes/snippets/go/get-cloudpcoverview-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-cloudpcoverview-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Conditionalaccesspolicycoverage Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-conditionalaccesspolicycoverage-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/conditio [!INCLUDE [sample-code](../includes/snippets/go/get-conditionalaccesspolicycoverage-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-conditionalaccesspolicycoverage-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Credentialuserregistrationssummary Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-credentialuserregistrationssummary-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/credenti [!INCLUDE [sample-code](../includes/snippets/go/get-credentialuserregistrationssummary-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-credentialuserregistrationssummary-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Devicecompliancepolicysettingstatesummary Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-devicecompliancepolicysettingstatesummary-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/deviceCo [!INCLUDE [sample-code](../includes/snippets/go/get-devicecompliancepolicysettingstatesummary-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-devicecompliancepolicysettingstatesummary-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Manageddevicecompliance Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-manageddevicecompliance-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/managedD [!INCLUDE [sample-code](../includes/snippets/go/get-manageddevicecompliance-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-manageddevicecompliance-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Manageddevicecompliancetrend Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-manageddevicecompliancetrend-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/managedD [!INCLUDE [sample-code](../includes/snippets/go/get-manageddevicecompliancetrend-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-manageddevicecompliancetrend-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Aggregatedpolicycompliances | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-aggregatedpolicycompliances.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/aggregat [!INCLUDE [sample-code](../includes/snippets/go/list-aggregatedpolicycompliance-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-aggregatedpolicycompliance-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Cloudpcconnections | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-cloudpcconnections.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/cloudPcC [!INCLUDE [sample-code](../includes/snippets/go/list-cloudpcconnection-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-cloudpcconnection-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Cloudpcdevices | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-cloudpcdevices.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/cloudPcD [!INCLUDE [sample-code](../includes/snippets/go/list-cloudpcdevice-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-cloudpcdevice-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Cloudpcsoverview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-cloudpcsoverview.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/cloudPcs [!INCLUDE [sample-code](../includes/snippets/go/list-cloudpcoverview-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-cloudpcoverview-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Conditionalaccesspolicycoverages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-conditionalaccesspolicycoverages.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/conditio [!INCLUDE [sample-code](../includes/snippets/go/list-conditionalaccesspolicycoverage-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-conditionalaccesspolicycoverage-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Credentialuserregistrationssummaries | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-credentialuserregistrationssummaries.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/credenti [!INCLUDE [sample-code](../includes/snippets/go/list-credentialuserregistrationssummary-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-credentialuserregistrationssummary-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Devicecompliancepolicysettingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-devicecompliancepolicysettingstatesummary.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/deviceCo [!INCLUDE [sample-code](../includes/snippets/go/list-devicecompliancepolicysettingstatesummary-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-devicecompliancepolicysettingstatesummary-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Manageddevicecompliances | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-manageddevicecompliances.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/managedD [!INCLUDE [sample-code](../includes/snippets/go/list-manageddevicecompliance-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-manageddevicecompliance-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Managementactions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementactions.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/list-managementaction-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-managementaction-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Managementactiontenantdeploymentstatuses | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementactiontenantdeploymentstatuses.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/list-managementactiontenantdeploymentstatus-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-managementactiontenantdeploymentstatus-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Managementintents | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementintents.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/list-managementintent-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-managementintent-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Managementtemplates | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-managementtemplates.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/list-managementtemplate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-managementtemplate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Myroles | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-myroles.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/myRoles [!INCLUDE [sample-code](../includes/snippets/go/list-myrole-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-myrole-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Tenantgroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantgroups.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantGr [!INCLUDE [sample-code](../includes/snippets/go/list-tenantgroup-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-tenantgroup-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Tenants | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenants.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenants [!INCLUDE [sample-code](../includes/snippets/go/list-tenant-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-tenant-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Tenantscustomizedinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantscustomizedinformation.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantsC [!INCLUDE [sample-code](../includes/snippets/go/list-tenantcustomizedinformation-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-tenantcustomizedinformation-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Tenantsdetailedinformation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenantsdetailedinformation.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantsD [!INCLUDE [sample-code](../includes/snippets/go/list-tenantdetailedinformation-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-tenantdetailedinformation-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Tenanttags | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-tenanttags.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantTa [!INCLUDE [sample-code](../includes/snippets/go/list-tenanttag-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-tenanttag-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Windowsdevicemalwarestates | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-windowsdevicemalwarestates.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/windowsD [!INCLUDE [sample-code](../includes/snippets/go/list-windowsdevicemalwarestate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-windowsdevicemalwarestate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant List Windowsprotectionstates | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-windowsprotectionstates.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/windowsP [!INCLUDE [sample-code](../includes/snippets/go/list-windowsprotectionstate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-windowsprotectionstate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managedtenant Post Tenanttags | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-post-tenanttags.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/create-tenanttag-from--go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/create-tenanttag-from--php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managementaction Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementaction-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/get-managementaction-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-managementaction-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managementactiontenantdeploymentstatus Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementactiontenantdeploymentstatus-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/get-managementactiontenantdeploymentstatus-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-managementactiontenantdeploymentstatus-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managementintent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementintent-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/get-managementintent-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-managementintent-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Managementtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managementtemplate-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/manageme [!INCLUDE [sample-code](../includes/snippets/go/get-managementtemplate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-managementtemplate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenant Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenant-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenants/ [!INCLUDE [sample-code](../includes/snippets/go/get-tenant-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-tenant-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenantcustomizedinformation Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantcustomizedinformation-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantsC [!INCLUDE [sample-code](../includes/snippets/go/get-tenantcustomizedinformation-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-tenantcustomizedinformation-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenantcustomizedinformation Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantcustomizedinformation-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/update-tenantcustomizedinformation-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/update-tenantcustomizedinformation-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenantdetailedinformation Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantdetailedinformation-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantsD [!INCLUDE [sample-code](../includes/snippets/go/get-tenantdetailedinformation-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-tenantdetailedinformation-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenantgroup Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenantgroup-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantGr [!INCLUDE [sample-code](../includes/snippets/go/get-tenantgroup-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-tenantgroup-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenanttag Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-delete.md | DELETE https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenan [!INCLUDE [sample-code](../includes/snippets/go/delete-tenanttag-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/delete-tenanttag-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenanttag Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantTa [!INCLUDE [sample-code](../includes/snippets/go/get-tenanttag-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-tenanttag-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Tenanttag Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-tenanttag-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/update-tenanttag-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/update-tenanttag-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Windowsdevicemalwarestate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-windowsdevicemalwarestate-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/windowsD [!INCLUDE [sample-code](../includes/snippets/go/get-windowsdevicemalwarestate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-windowsdevicemalwarestate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Managedtenants Windowsprotectionstate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-windowsprotectionstate-get.md | GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/windowsP [!INCLUDE [sample-code](../includes/snippets/go/get-windowsprotectionstate-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-windowsprotectionstate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Nameditem Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/nameditem-delete.md | + + Title: "Delete namedItem" +description: Delete a workbookNamedItem object ++ms.localizationpriority: medium +++# Delete namedItem ++Namespace: microsoft.graph +++Delete a [workbookNamedItem](../resources/workbooknameditem.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type | Permissions (from least to most privileged) | +|:--|:| +|Delegated (work or school account) | Files.ReadWrite.Selected, Files.ReadWrite.AppFolder, Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All, Sites.Manage.All, Sites.FullControl.All | +|Delegated (personal Microsoft account) | Files.ReadWrite, Files.ReadWrite.All | +|Application | Files.ReadWrite.All, Sites.ReadWrite.All, Sites.Manage.All, Sites.FullControl.All | ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +DELETE /me/drive/items/{id}/workbook/names/{name} +DELETE /me/drive/root:/{item-path}:/workbook/names/{name} +DELETE /me/drive/items/{id}/workbook/worksheets/{id|name}/names/{name} +DELETE /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/names/{name} +``` ++## Request headers +| Name | Description| +|:|:-| +| Authorization | Bearer {token}. Required. | +| Workbook-Session-ID | Workbook session ID that determines if changes are persisted or not. Optional.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content`. It does not return anything in the response body. +++## Example +### Request +<!-- { + "blockType": "request", + "name": "delete_nameditem" +}--> ++```http +DELETE https://graph.microsoft.com/beta/me/drive/items/{itemID}/workbook/names/{name} +``` ++### Response +Here is an example of the response. +<!-- { + "blockType": "response", + "isEmpty": true +} --> +```http +HTTP/1.1 204 No Content +``` |
v1.0 | Oauth2permissiongrant Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/oauth2permissiongrant-post.md | The following table shows the properties that are required when you create the [ | consentType | String | Indicates whether authorization is granted for the client application to impersonate all users or only a specific user. *AllPrincipals* indicates authorization to impersonate all users. *Principal* indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. | | principalId | String | The **id** of the [user](../resources/user.md) on behalf of whom the client is authorized to access the resource, when **consentType** is *Principal*. If **consentType** is *AllPrincipals* this value is null. Required when **consentType** is *Principal*. | | resourceId | String | The **id** of the resource [service principal](../resources/serviceprincipal.md) to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. |-| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **publishedPermissionScopes** property of the resource [service principal](../resources/serviceprincipal.md). | +| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **publishedPermissionScopes** property of the resource [service principal](../resources/serviceprincipal.md). Must not exceed 3850 characters in length.| | startTime | DateTimeOffset | Currently, the start time value is ignored, but a value is required. Required. | | expiryTime | DateTimeOffset | Currently, the end time value is ignored, but a value is required. Required. | |
v1.0 | Oauth2permissiongrant Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/oauth2permissiongrant-update.md | In the request body, supply the values for relevant fields that should be update | Property | Type |Description| |:|:--|:-|-|scope|String| Specifies the value of the scope claim that the resource application should expect in the OAuth 2.0 access token. | +|scope|String|A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **publishedPermissionScopes** property of the resource [service principal](../resources/serviceprincipal.md). Must not exceed 3850 characters in length.| ## Response |
v1.0 | Organization List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organization-list.md | GET https://graph.microsoft.com/beta/organization [!INCLUDE [sample-code](../includes/snippets/go/get-organization-2-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-organization-2-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Place Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/place-update.md | Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Printconnector Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/printconnector-update.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Printer Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/printer-update.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Profile Post Anniversaries | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/profile-post-anniversaries.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-personanniversary-from-profile-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - ### Response |
v1.0 | Profile Post Awards | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/profile-post-awards.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-personaward-from-profile-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - ### Response |
v1.0 | Profile Post Educationalactivities | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/profile-post-educationalactivities.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-educationalactivity-from-profile-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - |
v1.0 | Profile Post Publications | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/profile-post-publications.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-itempublication-from--powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - ### Response |
v1.0 | Reportroot Getattacksimulationrepeatoffenders | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-getattacksimulationrepeatoffenders.md | Title: "reportRoot: getAttackSimulationRepeatOffenders" description: "List repeat offender users of a tenant in attack simulation and training campaigns."-+ ms.localizationpriority: medium ms.prod: "reports" doc_type: apiPageType |
v1.0 | Reportroot Getattacksimulationsimulationusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-getattacksimulationsimulationusercoverage.md | Title: "reportRoot: getAttackSimulationSimulationUserCoverage" description: "List simulation coverage for users of a tenant in attack simulation and training campaigns."-+ ms.localizationpriority: medium ms.prod: "reports" doc_type: apiPageType |
v1.0 | Reportroot Getattacksimulationtrainingusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-getattacksimulationtrainingusercoverage.md | Title: "reportRoot: getAttackSimulationTrainingUserCoverage" description: "List training coverage for users of a tenant in attack simulation and training campaigns."-+ ms.localizationpriority: medium ms.prod: "reports" doc_type: apiPageType |
v1.0 | Riskdetection Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskdetection-get.md | Title: "Get riskDetection" description: "Retrieve the properties of a **riskdetection** object." ms.localizationpriority: medium-+ ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskdetection List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskdetection-list.md | Title: "List riskDetection" description: "Retrieve the properties of a collection of **riskDetection** object." ms.localizationpriority: medium-+ ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuser List History | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyuser-list-history.md | Title: "List history of riskyUser" description: "Retrieve the risk history" ms.localizationpriority: medium-+ ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuserhistoryitem Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyuserhistoryitem-get.md | Title: "Get history item of riskyUser" description: "Get a history item of a riskyUser object." ms.localizationpriority: medium-+ ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyusers Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyusers-confirmcompromised.md | Title: Confirm riskyUser compromised description: Confirm a riskyUser object as compromised.-+ ms.localizationpriority: medium ms.prod: identity-and-sign-in Last updated 03/20/2019 |
v1.0 | Riskyusers Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyusers-dismiss.md | Title: Dismiss riskyUser description: Dismiss the risk of a riskyUser object.-+ ms.localizationpriority: medium ms.prod: identity-and-sign-in Last updated 03/20/2019 |
v1.0 | Riskyusers Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyusers-get.md | Title: "Get riskyUser" description: "Retrieve the properties and relationships of a **riskyUser** object." ms.localizationpriority: medium-+ doc_type: apiPageType ms.prod: "identity-and-sign-in" |
v1.0 | Riskyusers List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyusers-list.md | Title: "List riskyUsers" description: "Retrieve the properties and relationships of a collection of **riskyUser** objects." ms.localizationpriority: medium-+ doc_type: apiPageType ms.prod: "identity-and-sign-in" |
v1.0 | Security Casesroot Post Ediscoverycases | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-casesroot-post-ediscoverycases.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/create-ediscoverycase-from--go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PowerShell](#tab/powershell) - # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/create-ediscoverycase-from--php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Securityreportsroot Getattacksimulationrepeatoffenders | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/securityreportsroot-getattacksimulationrepeatoffenders.md | Title: "securityReportsRoot: getAttackSimulationRepeatOffenders" -description: "List repeat offender users of a tenant in attack simulation and training campaigns." -+description: "List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns." + ms.localizationpriority: medium ms.prod: "reports" doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -List the users of a tenant who have yielded to attacks more than once in attack simulation and training campaigns. +List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns. This function supports `@odata.nextLink` for pagination. ## Permissions Do not supply a request body for this method. ## Response -If successful, this function returns a `200 OK` response code and a [attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection in the response body. +If successful, this function returns a `200 OK` response code and an [attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection in the response body. ## Examples GET https://graph.microsoft.com/beta/reports/security/getAttackSimulationRepeatO ### Response-The following is an example of the response +The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "repeatOffenceCount": 5, "attackSimulationUser": { "userId": "6fcdab00-385b-46f2-a329-b843b49e9147",- "displayName": "anadi_testing", - "email": "" + "displayName": "Reed Flores", + "email": "reed@contoso.com" } }, { "repeatOffenceCount": 638, "attackSimulationUser": { "userId": "478a22cd-aecc-41df-b995-88c8de17aaf5",- "displayName": "attacksim", - "email": "attacksim@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com" + "displayName": "Reed Flores", + "email": "reed@contoso.com" } } ] |
v1.0 | Securityreportsroot Getattacksimulationsimulationusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/securityreportsroot-getattacksimulationsimulationusercoverage.md | Title: "securityReportsRoot: getAttackSimulationSimulationUserCoverage" -description: "List simulation coverage for users of a tenant in attack simulation and training campaigns." -+description: "List training coverage for each tenant user in attack simulation and training campaigns." + ms.localizationpriority: medium ms.prod: "reports" doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -List [training coverage](../resources/attacksimulationtrainingusercoverage.md) for each user of a tenant in attack simulation and training campaigns. +List [training coverage](../resources/attacksimulationtrainingusercoverage.md) for each tenant user in attack simulation and training campaigns. This function supports `@odata.nextLink` for pagination. Do not supply a request body for this method. ## Response -If successful, this function returns a `200 OK` response code and a [attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection in the response body. +If successful, this function returns a `200 OK` response code and an [attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection in the response body. ## Examples GET https://graph.microsoft.com/beta/reports/security/getAttackSimulationSimulat ### Response-The following is an example of the response +The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "compromisedCount": 0, "attackSimulationUser": { "userId": "9a00ce98-2c83-41be-89f7-6fdff7950aa9",- "displayName": "Vamsi Krishna", - "email": "vamsi@a830edad9050849EQTPWBJZXODQ.onmicrosoft.com" + "displayName": "Reed Flores", + "email": "reed@contoso.com" } }, { |
v1.0 | Securityreportsroot Getattacksimulationtrainingusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/securityreportsroot-getattacksimulationtrainingusercoverage.md | Title: "securityReportsRoot: getAttackSimulationTrainingUserCoverage" -description: "List training coverage for users of a tenant in attack simulation and training campaigns." -+description: "List training coverage for tenant users in attack simulation and training campaigns." + ms.localizationpriority: medium ms.prod: "reports" doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -List the users of a tenant who have yielded to attacks more than once in attack simulation and training campaigns. +List training coverage for tenant users in attack simulation and training campaigns. This function supports `@odata.nextLink` for pagination. Do not supply a request body for this method. ## Response -If successful, this function returns a `200 OK` response code and a [attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection in the response body. +If successful, this function returns a `200 OK` response code and an [attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection in the response body. ## Examples GET https://graph.microsoft.com/beta/reports/security/getAttackSimulationTrainin ### Response-The following is an example of the response +The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", |
v1.0 | Serviceannouncement List Issues | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceannouncement-list-issues.md | This method supports the [OData query parameters](/graph/query-parameters) to he |Name|Description| |:|:| |Authorization|Bearer {token}. Required.|+|Prefer:<br>odata.maxpagesize={x} | Set the maximum page size preference. The maximum page size cannot be greater than 1000. If not specified, default page size is 100. Optional.| ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [serviceHealthIssue](../resources/servicehealthissue.md) objects in the response body. The response is paginated and each page contains 100 objects. +If successful, this method returns a `200 OK` response code and a collection of [serviceHealthIssue](../resources/servicehealthissue.md) objects in the response body. The response is paginated and default page size is 100. ## Example |
v1.0 | Serviceannouncement List Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceannouncement-list-messages.md | This method supports the [OData query parameters](/graph/query-parameters) to he |Name|Description| |:|:| |Authorization|Bearer {token}. Required.|+|Prefer:<br>odata.maxpagesize={x} | Set the maximum page size preference. The maximum page size cannot be greater than 1000. If not specified, the default page size is 100. Optional.| ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [serviceUpdateMessage](../resources/serviceupdatemessage.md) objects in the response body. The response is paginated and each page contains 100 objects. +If successful, this method returns a `200 OK` response code and a collection of [serviceUpdateMessage](../resources/serviceupdatemessage.md) objects in the response body. The response is paginated and default page size is 100. ## Example |
v1.0 | Serviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipal-get.md | GET https://graph.microsoft.com/beta/servicePrincipals/{id} [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) Content-type: application/json "suppressions": [ ] }>+--> |
v1.0 | Serviceprincipal List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipal-list.md | ConsistencyLevel: eventual ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Simulationautomation List Runs | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/simulationautomation-list-runs.md | Title: "List runs" description: "Get a list of the attack simulation automation runs for a tenant."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: apiPageType GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}/ru ``` ## Optional query parameters-This method supports the `$count`, `$skiptoken`, `$top`, and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. +This method supports the `$count`, `$skipToken`, `$top`, and `$select` [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. |
v1.0 | Simulationreportoverview Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/simulationreportoverview-get.md | Title: "Get simulation report overview." -description: "Get report overview for an attack simulation campaign." -+ Title: "Get simulationReportOverview" +description: "Get an overview of an attack simulation and training campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: apiPageType One of the following permissions is required to call this API. To learn more, in } --> ``` http-GET /security/attackSimulation/simulations/{id}/report/overview +GET /security/attackSimulation/simulations/{simulationId}/report/overview ``` ## Request headers If successful, this method returns a `200 OK` response code and a [simulationRep ### Request -# [HTTP](#tab/http) +The following is an example of a request. + <!-- { "blockType": "request", "name": "get_simulationreportoverview" } --> ``` http-GET https://graph.microsoft.com/beta/security/attackSimulation/simulations/{id}/report/overview +GET https://graph.microsoft.com/beta/security/attackSimulation/simulations/f1b13829-3829-f1b1-2938-b1f12938b1a/report/overview ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/beta/security/attackSimulation/simulations/{id}/ +### Response +The following is an example of the request. -### Response >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", |
v1.0 | Teamtemplatedefinition Get Teamdefinition | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/teamtemplatedefinition-get-teamdefinition.md | GET https://graph.microsoft.com/beta/teamwork/teamTemplates/com.microsoft.teams. [!INCLUDE [sample-code](../includes/snippets/go/get-teamtemplateteamdefinition-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-teamtemplateteamdefinition-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | User List Approleassignedresources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-approleassignedresources.md | + + Title: "List appRoleAssignedResources (service principals that a user has appRoleAssignments to)" +description: "Get the service principals to which the user has an app role assignment either directly or through group membership." ++ms.localizationpriority: medium +++# List appRoleAssignedResources (service principals that a user has appRoleAssignments to) +Namespace: microsoft.graph +++Get the service principals to which the user has an app role assignment either directly or through group membership. ++## 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) | User.ReadBasic.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Directory.Read.All, AppRoleAssignment.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /me/appRoleAssignedResources?$count=true +ConsistencyLevel: eventual ++GET /users/{userId}/appRoleAssignedResources?$count=true +ConsistencyLevel: eventual +``` ++## Optional query parameters +This method supports the `$count`, `$expand`, `$filter`, `$orderBy`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. The queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +| ConsistencyLevel | eventual. This header and `$count` are required when calling this API. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). | ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [servicePrincipal](../resources/serviceprincipal.md) objects in the response body. If you don't specify the `$count` query parameter and set the **ConsistencyLevel** header to `eventual`, this API returns `404 Not Found error`. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_approleassignedresources_users" +} +--> +``` http +GET https://graph.microsoft.com/beta/me/appRoleAssignedResources?$count=true&$select=displayName,accountEnabled,servicePrincipalType,signInAudience +ConsistencyLevel: eventual +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PHP](#tab/php) ++++++### Response +The following is an example of the response ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.servicePrincipal", + "isCollection": true +} --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "value": [ + { + "id": "0b372abb-b32e-459c-b263-b81ab6448df1", + "accountEnabled":true, + "displayName":"amasf", + "servicePrincipalType":"Application", + "signInAudience":"AzureADMyOrg" + } + ] +} +``` |
v1.0 | User Post Events | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-post-events.md | Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | User Sendmail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-sendmail.md | Content-type: application/json ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) |
v1.0 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-update.md | In the request body, supply the values for relevant fields that should be update |onPremisesImmutableId|String|This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the userΓÇÖs **userPrincipalName** (UPN) property. **Important:** The **$** and **_** characters cannot be used when specifying this property. | |otherMails|String collection|A list of additional email addresses for the user; for example: `["bob@contoso.com", "Robert@fabrikam.com"]`.| |passwordPolicies|String|Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two may be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`.|-|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the userΓÇÖs password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. <br><br> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. In application-only access, the calling app must be assigned the *User.ReadWrite.All* application permission and at least the *User Administrator* [Azure AD role](/azure/active-directory/roles/permissions-reference).| +|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the userΓÇÖs password. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. <br><br> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. In application-only access, the calling app must be assigned the *User.ReadWrite.All* application permission and at least the *User Administrator* [Azure AD role](/azure/active-directory/roles/permissions-reference).| |pastProjects|String collection|A list for the user to enumerate their past projects.| |postalCode|String|The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.| |preferredLanguage|String|The preferred language for the user. Should follow ISO 639-1 Code; for example `en-US`.| HTTP/1.1 204 No Content ### Example 3: Update the passwordProfile of a user to reset their password -The following example shows a request that resets the password of another user. +The following example shows a request that resets the password of another user. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. #### Request Content-type: application/json { "passwordProfile": {- "forceChangePasswordNextSignIn": false, + "forceChangePasswordNextSignIn": true, "password": "xWwvJ]6NMw+bWH-d" } } |
v1.0 | Usersimulationdetails List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/usersimulationdetails-list.md | Title: "List simulation users" -description: "List users of a tenant in an attack simulation campaign with their online actions." -+ Title: "List simulationUsers" +description: "List users of a tenant and their online actions in an attack simulation campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: apiPageType One of the following permissions is required to call this API. To learn more, in } --> ``` http-GET /security/attackSimulation/simulations/{id}/report/simulationUsers +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers ``` ## Optional query parameters-This method supports the following OData query parameters to help customize the response: `$count`, `$skiptoken`, `$top`. -Use `@odata.nextLink` for pagination. +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 are examples of their use: The following are examples of their use: } --> ``` http-GET /security/attackSimulation/simulations/{id}/report/simulationUsers?$top=1 -GET /security/attackSimulation/simulations/{id}/report/simulationUsers?$count=true +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers?$count=true +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers?$skipToken={skipToken} +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers?$top=1 ``` -For general information, see [OData query parameters](/graph/query-parameters). - ## Request headers |Name|Description| |:|:| If successful, this method returns a `200 OK` response code and a collection of ### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", If successful, this method returns a `200 OK` response code and a collection of } --> ``` http-GET https://graph.microsoft.com/beta/security/attackSimulation/simulations/{id}/report/simulationUsers +GET https://graph.microsoft.com/beta/security/attackSimulation/simulations/f1b13829-3829-f1b1-2938-b1f12938b1a/report/simulationUsers ``` # [C#](#tab/csharp) GET https://graph.microsoft.com/beta/security/attackSimulation/simulations/{id}/ +### Response +The following is an example of the response. -### Response >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-Type: application/json "reportedPhishDateTime": "2021-01-01T01:01:01.01Z", "simulationUser": { "userId": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",- "displayName": "Sample User", - "email": "sampleuser@contoso.com" + "displayName": "Reed Flores", + "email": "reed@contoso.com" } } ] |
v1.0 | Accesspackageassignment | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignment.md | In [Azure AD Entitlement Management](entitlementmanagement-overview.md), an acce | [List accessPackageAssignments](../api/entitlementmanagement-list-accesspackageassignments.md) | [accessPackageAssignment](accesspackageassignment.md) collection | Retrieve a list of **accessPackageAssignment** objects. | |[filterByCurrentUser](../api/accesspackageassignment-filterbycurrentuser.md)|[accessPackageAssignment](../resources/accesspackageassignment.md) collection|Retrieve the list of **accessPackageAssignment** objects filtered on the signed-in user.| | [reprocess](../api/accesspackageassignment-reprocess.md) | None | Automatically reevaluate and enforce a userΓÇÖs assignments for a specific access package.|-| [additionalAccess](../api/accesspackageassignment-additionalaccess.md) [accessPackageAssignment](../resources/accesspackageassignment.md) collection|Retrieve the list of **accessPackageAssignment** objects for users who have assignments to incompatible access packages.| +| [additionalAccess](../api/accesspackageassignment-additionalaccess.md) | [accessPackageAssignment](../resources/accesspackageassignment.md) collection|Retrieve the list of **accessPackageAssignment** objects for users who have assignments to incompatible access packages.| > [!NOTE] > To create or remove an access package assignment for a user, use the [create an accessPackageAssignmentRequest](../api/entitlementmanagement-post-accesspackageassignmentrequests.md) |
v1.0 | Accesspackageassignmentpolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentpolicy.md | The following is a JSON representation of the resource. "modifiedDateTime": "String (timestamp)", "questions": [ {- "@odata.type": "microsoft.graph.accessPackageMultipleChoiceQuestion" + "@odata.type": "microsoft.graph.accessPackageQuestion" } ], "requestorSettings": { |
v1.0 | Application | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/application.md | This resource supports: | api | [apiApplication](apiapplication.md) | Specifies settings for an application that implements a web API. | | appId | String | The unique identifier for the application that is assigned by Azure AD. Not nullable. Read-only. Supports `$filter` (`eq`). | |applicationTemplateId | String | Unique identifier of the applicationTemplate. Supports `$filter` (`eq`, `not`, `ne`).|-| appRoles | [appRole](approle.md) collection | The collection of roles assigned to the application. With [app role assignments](approleassignment.md), these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. | +| appRoles | [appRole](approle.md) collection | The collection of roles defined for the application. With [app role assignments](approleassignment.md), these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. | |certification|[certification](certification.md)|Specifies the certification status of the application.| | createdDateTime | DateTimeOffset | The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, and `eq` on `null` values) and `$orderBy`. | |defaultRedirectUri|String|The default redirect URI. If specified and there is no explicit redirect URI in the sign-in request for SAML and OIDC flows, Azure AD sends the token to this redirect URI. Azure AD also sends the token to this default URI in SAML IdP-initiated single sign-on. The value must match one of the configured redirect URIs for the application.| |
v1.0 | Applicationsignindetailedsummary | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/applicationsignindetailedsummary.md | Title: "applicationSignInDetailedSummary resource type - Microsoft Graph API" + Title: "applicationSignInDetailedSummary resource type" description: "Represents a detailed summary of an application sign-in." ms.localizationpriority: medium Namespace: microsoft.graph Represents a detailed summary of an application sign-in. +Inherits from [entity](../resources/entity.md). + ## Methods | Method | Return Type | Description | Represents a detailed summary of an application sign-in. |aggregatedEventDateTime|DateTimeOffset|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`.| |appDisplayName|String|Name of the application that the user signed in to.| |appId|String|ID of the application that the user signed in to.|-|id|String| A unique ID representing the sign-in activity.| +|id|String| A unique ID representing the sign-in activity. Inherited from [entity](../resources/entity.md).| |signInCount|Int64|Count of sign-ins made by the application.| |status|[signInStatus](signinstatus.md)|Details of the sign-in status.| ## Relationships-None +None. ## JSON representation The following is a JSON representation of the resource. "appDisplayName": "String", "appId": "String", "id": "String (identifier)",- "signInCount": 1024, + "signInCount": "Int64", "status": {"@odata.type": "microsoft.graph.signInStatus"} }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Assignedtraininginfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/assignedtraininginfo.md | Title: "assignedTrainingInfo resource type" -description: "Represents assigned training's information in an attack simulation and training campaign." -+description: "Represents assignment information of a training in an attack simulation and training campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.assignedTrainingInfo",- "assignedUserCount": "Integer", - "completedUserCount": "Integer", + "assignedUserCount": "Int32", + "completedUserCount": "Int32", "displayName": "String" } ``` |
v1.0 | Attacksimulationrepeatoffender | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/attacksimulationrepeatoffender.md | Title: "attackSimulationRepeatOffender resource type" -description: "Represents repeat offender user in attack simulation and training." -+description: "Represents a user in a tenant who has given way to attacks more than once across various attack simulation and training campaigns." + ms.localizationpriority: medium ms.prod: "reports" doc_type: resourcePageType Namespace: microsoft.graph Represents a user in a tenant who has given way to attacks more than once across various attack simulation and training campaigns. +## Methods +|Method|Return type|Description| +|:|:|:| +|[Get repeat offenders](../api/securityreportsroot-getattacksimulationrepeatoffenders.md)|[attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection|List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns.| + ## Properties |Property|Type|Description| |:|:|:|-|attackSimulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|User in an attack simulation and training campaign.| +|attackSimulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|The user in an attack simulation and training campaign.| |repeatOffenceCount|Int32|Number of repeat offences of the user in attack simulation and training campaigns.| ## Relationships The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.attackSimulationRepeatOffender",- "repeatOffenceCount": "Integer", "attackSimulationUser": { "@odata.type": "microsoft.graph.attackSimulationUser"- } + }, + "repeatOffenceCount": "Int32" } ``` |
v1.0 | Attacksimulationroot | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/attacksimulationroot.md | Title: "attackSimulationRoot resource type" -description: "Provides the ability to launch a realistic phishing attack that organizations can learn from." -+description: "Represents an abstract type that provides the ability to launch a realistic phishing attack that organizations can learn from." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Provides the ability to launch a realistic phishing attack that organizations can learn from. -This is an abstract type. - ## Methods |Method|Return type|Description| |:|:|:|-|[List simulations](../api/attacksimulationroot-list-simulations.md)|[simulation](../resources/simulation.md) collection|Get a list of attack simulation training campaigns for a tenant.| +|[List simulations](../api/attacksimulationroot-list-simulations.md)|[simulation](../resources/simulation.md) collection|Get a list of attack simulation campaigns for a tenant.| |[List simulationAutomations](../api/attacksimulationroot-list-simulationautomations.md)|[simulationAutomation](../resources/simulationautomation.md) collection|Get a list of attack simulation automations for a tenant.| ## Properties None. ## Relationships |Relationship|Type|Description| |:|:|:|+|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.|-|simulationAutomations|[simulationAutomation](../resources/simulationautomation.md) collection|Represents simulation automations created to run on a tenant.| ## JSON representation The following is a JSON representation of the resource. The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.attackSimulationRoot" } ```- |
v1.0 | Attacksimulationsimulationusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/attacksimulationsimulationusercoverage.md | Title: "attackSimulationSimulationUserCoverage resource type" -description: "Represents simulation coverage for a user in attack simulation and training." -+description: "Represents cumulative simulation data and results for a user in attack simulation and training." + ms.localizationpriority: medium ms.prod: "reports" doc_type: resourcePageType Namespace: microsoft.graph Represents cumulative simulation data and results for a user in attack simulation and training. +## Methods +|Method|Return type|Description| +|:|:|:| +|[Get simulation coverage for users](../api/securityreportsroot-getattacksimulationsimulationusercoverage.md)|[attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection|List [training coverage](../resources/attacksimulationtrainingusercoverage.md) for each tenant user in attack simulation and training campaigns.| + ## Properties |Property|Type|Description| |:|:|:| |attackSimulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|User in an attack simulation and training campaign.| |clickCount|Int32|Number of link clicks in the received payloads by the user in attack simulation and training campaigns.| |compromisedCount|Int32|Number of compromising actions by the user in attack simulation and training campaigns.|-|latestSimulationDateTime|DateTimeOffset|Date and time of latest attack simulation and training campaign that the user was included in.| +|latestSimulationDateTime|DateTimeOffset|Date and time of the latest attack simulation and training campaign that the user was included in.| |simulationCount|Int32|Number of attack simulation and training campaigns that the user was included in.| ## Relationships The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.attackSimulationSimulationUserCoverage",- "simulationCount": "Integer", - "latestSimulationDateTime": "String (timestamp)", - "clickCount": "Integer", - "compromisedCount": "Integer", "attackSimulationUser": { "@odata.type": "microsoft.graph.attackSimulationUser"- } + }, + "clickCount": "Int32", + "compromisedCount": "Int32", + "latestSimulationDateTime": "String (timestamp)", + "simulationCount": "Int32" } ``` |
v1.0 | Attacksimulationtrainingusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/attacksimulationtrainingusercoverage.md | Title: "attackSimulationTrainingUserCoverage resource type" -description: "Represents training coverage for a user in attack simulation and training." -+description: "Represents cumulative training data for a user in attack simulation and training." + ms.localizationpriority: medium ms.prod: "reports" doc_type: resourcePageType Namespace: microsoft.graph Represents cumulative training data for a user in attack simulation and training. +## Methods +|Method|Return type|Description| +|:|:|:| +|[Get training coverage for users](../api/securityreportsroot-getattacksimulationtrainingusercoverage.md)|[attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection|List training coverage for tenant users in attack simulation and training campaigns.| + ## Properties |Property|Type|Description| |:|:|:| |attackSimulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|User in an attack simulation and training campaign.|-|userTrainings|[userTrainingStatusInfo](../resources/usertrainingstatusinfo.md) collection|List of assigned trainings' and their statuses for the user.| +|userTrainings|[userTrainingStatusInfo](../resources/usertrainingstatusinfo.md) collection|List of assigned trainings and their statuses for the user.| ## Relationships None. The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.attackSimulationTrainingUserCoverage",+ "attackSimulationUser": { + "@odata.type": "microsoft.graph.attackSimulationUser" + }, "userTrainings": [ { "@odata.type": "microsoft.graph.userTrainingStatusInfo" }- ], - "attackSimulationUser": { - "@odata.type": "microsoft.graph.attackSimulationUser" - } + ] } ``` |
v1.0 | Attacksimulationuser | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/attacksimulationuser.md | Title: "attackSimulationUser resource type" -description: "User in an attack simulation and training campaign." -+description: "Represents a user in an attack simulation and training campaign." + ms.localizationpriority: medium ms.prod: "reports" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A user in an attack simulation and training campaign. +Represents a user in an attack simulation and training campaign. ## Properties |Property|Type|Description| |:|:|:| |displayName|String|Display name of the user.| |email|String|Email address of the user.|-|userId|String|This is the **id** property value of the [user](../resources/user.md) resource that represents the user in the Azure AD tenant.| +|userId|String|This is the **id** property value of the [user](../resources/user.md) resource that represents the user in the Azure Active Directory tenant.| ## Relationships None. |
v1.0 | Calloptions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/calloptions.md | An abstract base class that contains the optional features for a call. ## Properties -|Property |Type |Description | -|: |: |: | -|isContentSharingNotificationEnabled |Boolean |Indicates whether content sharing notifications should be enabled for the call. | +|Property |Type |Description | +|: |: |: | +| hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. | +| isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. | ## JSON representation The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.callOptions",+ "hideBotAfterEscalation": "Boolean", "isContentSharingNotificationEnabled": "Boolean" } ``` |
v1.0 | Chat | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/chat.md | A chat is a collection of [chatMessages](chatmessage.md) between one or more par |[Pin a message](../api/chat-post-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md)|Pin a chat message in a chat.| |[Unpin a message](../api/chat-delete-pinnedmessages.md)|None|Unpin a message from a chat.| ->**Note:** When using application permissions, be sure you know how you're going to get the chat ID. Because listing chats with application permissions is not supported, -not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. +>**Note:** When using application permissions, be sure you know how to get the chat ID. Because listing chats with application permissions is not supported, not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. ## Properties |
v1.0 | Conditionalaccessallexternaltenants | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/conditionalaccessallexternaltenants.md | + + Title: "conditionalAccessAllExternalTenants resource type" +description: "Represents all external tenants in the policy scope." +ms.localizationpriority: medium ++++# conditionalAccessAllExternalTenants resource type ++Namespace: microsoft.graph +++Inherits from [conditionalAccessExternalTenants](conditionalaccessexternaltenants.md) resource. Represents all external tenants in the policy scope. ++## Properties ++| Property | Type | Description | +|:-|:|:| +| membershipKind |conditionalAccessExternalTenantsMembershipKind | Represents the membership kind. Supported values are: `all`, [`enumerated`](conditionalaccessenumeratedexternaltenants.md), and `unknownFutureValue`. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.conditionalAccessAllExternalTenants" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.conditionalAccessAllExternalTenants", + "membershipKind": "String" +} +``` |
v1.0 | Conditionalaccessenumeratedexternaltenants | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/conditionalaccessenumeratedexternaltenants.md | + + Title: "conditionalAccessEnumeratedExternalTenants resource type" +description: "Represents a list of external tenants in the policy scope." +ms.localizationpriority: medium ++++# conditionalAccessEnumeratedExternalTenants resource type ++Namespace: microsoft.graph +++Represents a list of external tenants in the policy scope. ++## Properties ++| Property | Type | Description | +|:-|:|:| +| members | String collection | Represents a collection of tenant ids in the scope of Conditional Access for guests and external users policy targeting. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "optionalProperties": [ + "members" + ], + "@odata.type": "microsoft.graph.conditionalAccessEnumeratedExternalTenants", + "baseType": null +}--> ++```json +{ + "members": ["String"] +} +``` |
v1.0 | Conditionalaccessexternaltenants | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/conditionalaccessexternaltenants.md | + + Title: "conditionalAccessExternalTenants resource type" +description: "An abstract type that represents external tenants in the policy scope. This abstract type is inherited by conditionalAccessAllExternalTenants and conditionalAccessEnumeratedExternalTenants." +ms.localizationpriority: medium ++++# conditionalAccessExternalTenants resource type ++Namespace: microsoft.graph +++An abstract type that represents external tenants in the policy scope. This abstract type is inherited by conditionalAccessAllExternalTenants and conditionalAccessEnumeratedExternalTenants. ++## Properties ++| Property | Type | Description | +|:-|:|:| +| membershipKind |conditionalAccessExternalTenantsMembershipKind | Represents the membership kind. The possible values are: `all`, `enumerated`, `unknownFutureValue`. `enumerated` references an object of [conditionalAccessEnumeratedExternalTenants](conditionalaccessenumeratedexternaltenants.md) derived type. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.conditionalAccessExternalTenants" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.conditionalAccessExternalTenants", + "membershipKind": "String" +} +``` |
v1.0 | Conditionalaccessguestsorexternalusers | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/conditionalaccessguestsorexternalusers.md | + + Title: "conditionalAccessGuestsOrExternalUsers resource type" +description: "Represents internal guests or external users in the policy scope." +ms.localizationpriority: medium ++++# conditionalAccessGuestsOrExternalUsers resource type ++Namespace: microsoft.graph +++Represents internal guests and/or external users in the policy scope. ++## Properties ++| Property | Type | Description | +|:-|:|:| +| guestOrExternalUserTypes | conditionalAccessGuestOrExternalUserTypes | Represents internal guests or external user types. This is a multi-valued property. Supported values are: `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `internalGuest`, `OtherExternalUser`, `serviceProvider` and `unknownFutureValue`. | +| externalTenants | [conditionalAccessExternalTenants](conditionalaccessexternaltenants.md) | The tenant ids of the selected types of external users. It could be either all b2b tenant, or a collection of tenant ids. External tenants can be specified only when `guestOrExternalUserTypes` is not null or an empty string. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.conditionalAccessGuestsOrExternalUsers" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.conditionalAccessGuestsOrExternalUsers", + "guestOrExternalUserTypes": "String", + "externalTenants": { + "@odata.type": "microsoft.graph.conditionalAccessExternalTenants" + } +} +``` |
v1.0 | Conditionalaccessusers | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/conditionalaccessusers.md | Represents users, groups, and roles included in and excluded from the policy sco |:-|:|:| | includeUsers | String collection | User IDs in scope of policy unless explicitly excluded, or `None` or `All` or `GuestsOrExternalUsers`. | | excludeUsers | String collection | User IDs excluded from scope of policy and/or `GuestsOrExternalUsers`. |+| includeGuestsOrExternalUsers | [conditionalAccessGuestsOrExternalUsers](conditionalaccessguestsorexternalusers.md) | Internal guests or external users included in the policy scope. Optionally populated. | +| excludeGuestsOrExternalUsers | [conditionalAccessGuestsOrExternalUsers](conditionalaccessguestsorexternalusers.md) | Internal guests or external users excluded in the policy scope. Optionally populated. | | includeGroups | String collection | Group IDs in scope of policy unless explicitly excluded, or `All`. | | excludeGroups | String collection | Group IDs excluded from scope of policy. | | includeRoles | String collection | Role IDs in scope of policy unless explicitly excluded, or `All`. | The following is a JSON representation of the resource. "optionalProperties": [ "includeUsers", "excludeUsers",+ "includeGuestsOrExternalUsers", + "excludeGuestsOrExternalUsers", "includeGroups", "excludeGroups", "includeRoles", The following is a JSON representation of the resource. "excludeGroups": ["String"], "excludeRoles": ["String"], "excludeUsers": ["String"],+ "excludeGuestsOrExternalUsers": {"@odata.type": "microsoft.graph.conditionalAccessGuestOrExternalUsers"}, "includeGroups": ["String"], "includeRoles": ["String"],- "includeUsers": ["String"] + "includeUsers": ["String"], + "includeGuestsOrExternalUsers": {"@odata.type": "microsoft.graph.conditionalAccessGuestOrExternalUsers"} } ``` |
v1.0 | Consentrequests Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/consentrequests-overview.md | The following directory roles are required for a calling application. ## See also -- [Configure the admin consent workflow (preview)](/azure/active-directory/manage-apps/configure-admin-consent-workflow?preserve-view=true)+- Learn more about how to [configure the admin consent workflow (preview)](/azure/active-directory/manage-apps/configure-admin-consent-workflow). +- Understand the user and admin consent flows in the [Azure AD application consent experiences](/azure/active-directory/develop/application-consent-experience). <!-- |
v1.0 | Educationsynchronizationprofilestatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/educationsynchronizationprofilestatus.md | Title: "educationSynchronizationProfileStatus resource type" -description: "Represents the synchronization status of a school data synchronization profile. " +description: "Represents the synchronization status of a school data synchronization profile." ms.localizationpriority: medium ms.prod: "education" Represents the synchronization status of a school data [synchronization profile] | Property | Type | Description | | :-- | :-- | :-- |-| id | String | The unique identifier for the resource. (read-only) | +| errorCount | Int64 | Number of errors during synchronization. | +| id | String | The unique identifier for the resource. Read-only. | +| lastActivityDateTime | DateTimeOffset | Date and time when most recent changes were observed in the profile. | +| lastSynchronizationDateTime | DateTimeOffset | Date and time of the most recent successful synchronization. | | status | educationSynchronizationStatus | The status of a sync. The possible values are: `paused`, `inProgress`, `success`, `error`, `validationError`, `quarantined`, `unknownFutureValue`, `extracting`, `validating`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `extracting`, `validating`.|-| lastSynchronizationDateTime | DateTimeOffset | Represents the time of the most recent successful synchronization. | -| lastActivityDateTime | DateTimeOffset | Represents the time when most recent changes were observed in profile. | -| errorCount | Int | Number of errors during synchronization. | -| statusMessage | String | Status message for the current profile's synchronization stage. | +| statusMessage | String | Status message for the synchronization stage of the current profile. | ## JSON representation +The following is a JSON representation of the resource. + <!-- { "blockType": "resource", "optionalProperties": [ Represents the synchronization status of a school data [synchronization profile] ```json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/synchronizationProfiles/{id}/profileStatus/$entity",+ "errorCount": "Int64", "id": "String",- "status": { "@odata.type": "microsoft.graph.educationSynchronizationStatus" }, - "lastSynchronizationDateTime": "DateTimeOffset", "lastActivityDateTime": "DateTimeOffset",- "errorCount": "Int", + "lastSynchronizationDateTime": "DateTimeOffset", + "status": { "@odata.type": "microsoft.graph.educationSynchronizationStatus" }, "statusMessage": "String" } ``` |
v1.0 | Emailidentity | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/emailidentity.md | Title: "emailIdentity resource type" -description: "Represent email identity of a user." -+description: "Represents the email identity of a user." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represent email identity of a user. -+Represents the email identity of a user. Inherits from [identity](../resources/identity.md). Inherits from [identity](../resources/identity.md). |:|:|:| |displayName|String|Display name of the user. Inherited from [identity](../resources/identity.md).| |email|String|Email address of the user.|-|id|String|ID of the user. Inherited from [identity](../resources/identity.md).| +|id|String|The unique identifier for the user. Inherited from [identity](../resources/identity.md).| ## Relationships None. The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.emailIdentity",- "id": "String (identifier)", "displayName": "String",- "email": "String" + "email": "String", + "id": "String (identifier)" } ``` |
v1.0 | Entity | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/entity.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +Represents an entity. + ## Properties | Property | Type | Description | |:|:|:|-|id |String | Read-only. | +|id |String | The unique identifier for an entity. Read-only. | ## Relationships-None +None. ## JSON representation -Here is a JSON representation of the resource +The following is a JSON representation of the resource. <!-- { "blockType": "resource", |
v1.0 | Enums | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/enums.md | +### conditionalAccessExternalTenantsMembershipKind values ++|Member| +|:| +|all| +|enumerated| +|unknownFutureValue| ++### conditionalAccessGuestOrExternalUserTypes values ++|Member| +|:| +|none| +|internalGuest| +|b2bCollaborationGuest| +|b2bCollaborationMember| +|b2bDirectConnectUser| +|otherExternalUser| +|serviceProvider| +|unknownFutureValue| ### teamTemplateAudience values |
v1.0 | Identitygovernance Customtaskextension | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-customtaskextension.md | Defines the attributes of a customTaskExtension that allows you to integrate Lif Inherits from [customCalloutExtension](../resources/customcalloutextension.md). +For more information about using custom task extensions, refer to the links in the [see also](#see-also) section. + ## Methods |Method|Return type|Description| The following is a JSON representation of the resource. "lastModifiedDateTime": "String (timestamp)" } ```++## See also +++ [Lifecycle Workflows Custom Task Extension (Preview)](/azure/active-directory/governance/lifecycle-workflow-extensibility) |
v1.0 | Identitygovernance Lifecyclemanagementsettings | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-lifecyclemanagementsettings.md | The settings of Azure AD Lifecycle Workflows in the tenant. |Property|Type|Description| |:|:|:| |id|String|Identifier used for individually addressing Lifecycle Workflow settings.|-|workflowScheduleIntervalInHours|Int32|The interval in hours at which all [workflows](../resources/identitygovernance-workflow.md) running in the tenant should be scheduled for execution. This interval has a minimum value of 1 and a maximum value of 24.| +|workflowScheduleIntervalInHours|Int32|The interval in hours at which all [workflows](../resources/identitygovernance-workflow.md) running in the tenant should be scheduled for execution. This interval has a minimum value of 1 and a maximum value of 24. The default value is 3 hours. | ## Relationships |
v1.0 | Identitygovernance Task | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-task.md | Namespace: microsoft.graph.identityGovernance Represents the built-in tasks available for lifecycle workflows. Tasks are the actions a workflow will execute when triggered. The built-in task "Run a custom task extension" can be used to trigger [custom task extensions](../resources/identitygovernance-customtaskextension.md) when you reach the limits of the other available built-in tasks, this allows integration with Azure Logic Apps. +A workflow can have up to 25 tasks. + Inherits from [entity](../resources/entity.md). ## Methods Inherits from [entity](../resources/entity.md). |Property|Type|Description| |:|:|:| |arguments|[microsoft.graph.keyValuePair](../resources/keyvaluepair.md) collection|Arguments included within the task.|-|category|String|The category of the task. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. This property is multi-valued and the same task can apply to both `joiner` and `leaver` categories.| +|category|microsoft.graph.identityGovernance.lifecycleTaskCategory|The category of the task. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. This property is multi-valued and the same task can apply to both `joiner` and `leaver` categories.| |continueOnError|Boolean|A boolean value that determines if the failure of this task stops the subsequent workflows from running.| |description|String|A string that describes the purpose of the task for administrative use.| |displayName|String|A unique string that identifies the task. <br><br>Supports `$filter`(`eq`) and `orderBy`.| |
v1.0 | Identitygovernance Taskdefinition | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-taskdefinition.md | Inherits from [entity](../resources/entity.md). |Property|Type|Description| |:|:|:|-|category|String|The category of the HR function that the tasks created using this definition can be used with. The possible values are: `joiner`, `leaver`.| -|description|String|The description of the `taskDefinition`.| -|displayName|String|The display name of the `taskDefinition`.| -|id|String|The unique identifier for the `taskDefinition`. Inherited from [entity](../resources/entity.md).| -|parameters|[microsoft.graph.identityGovernance.parameter](../resources/identitygovernance-parameter.md) collection|The parameters that must be supplied when creating a `task`.| -|version|Int32|The version number of the `taskDefinition`. New records are pushed when we add support for new parameters.| +|category|microsoft.graph.identityGovernance.lifecycleTaskCategory|The category of the HR function that the tasks created using this definition can be used with. The possible values are: `joiner`, `leaver`. This is a multi-valued enumeration whose allowed combinations are `joiner`, `joiner,leaver`, or `leaver`. Supports `$filter` (`eq`). | +|description|String|The description of the taskDefinition.| +|displayName|String|The display name of the taskDefinition`.| +|id|String|The unique identifier for the taskDefinition. Inherited from [entity](../resources/entity.md).| +|parameters|[microsoft.graph.identityGovernance.parameter](../resources/identitygovernance-parameter.md) collection|The parameters that must be supplied when creating a workflow task object.| +|version|Int32|The version number of the taskDefinition. New records are pushed when we add support for new parameters.| ## Relationships |
v1.0 | Identitygovernance Timebasedattributetrigger | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-timebasedattributetrigger.md | Inherits from [workflowExecutionTrigger](../resources/identitygovernance-workflo |Property|Type|Description| |:|:|:|-|offsetInDays|Int32|How many days before or after the time-based attribute specified the workflow should trigger. For example, if the attribute is `employeeHireDate` and offsetInDays is -1, then the workflow should trigger one day before the employee hire date.| +|offsetInDays|Int32|How many days before or after the time-based attribute specified the workflow should trigger. For example, if the attribute is `employeeHireDate` and offsetInDays is -1, then the workflow should trigger one day before the employee hire date. The value can range between -60 and 60 days.| |timeBasedAttribute|[microsoft.graph.identityGovernance.workflowTriggerTimeBasedAttribute](../resources/identitygovernance-timebasedattributetrigger.md)|Determines which time-based identity property to reference. The possible values are: `employeeHireDate`, `employeeLeaveDateTime`, `unknownFutureValue`.| ## Relationships |
v1.0 | Identitygovernance Workflow | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-workflow.md | Namespace: microsoft.graph.identityGovernance Represents workflows created using Lifecycle Workflows. Workflows, when triggered by execution conditions, automate parts of the lifecycle management process using tasks. These tasks can either be built-in tasks, or a custom task can be called using the custom task extension which integrate with Azure Logic Apps. +You can create up to 50 workflows in a tenant. + Inherits from [workflowBase](../resources/identitygovernance-workflowbase.md). ## Methods Inherits from [workflowBase](../resources/identitygovernance-workflowbase.md). |displayName|String|The display name of the `workflow` or `workflowVersion`. <br><br>Supports `$filter`(`eq`), `orderby`, and `$search`.| |executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Conditions describing when to execute the workflow and the criteria to identify in-scope subject set.| |id|String|Identifier used for individually addressing a specific workflow. <br><br>Supports `$filter`(`eq`).|-|isEnabled|Boolean|If true, the `workflow` engine creates and processes `taskProcessingResults` on the users scoped to the workflow. <br><br>Supports `$filter`(`eq`,`ne`) and `orderby`.| -|isSchedulingEnabled|Boolean|If true, the `workflow` engine executes the workflow on the schedule defined by tenant settings. | +|isEnabled|Boolean|If `true`, the `workflow` engine creates and processes `taskProcessingResults` on the users scoped to the workflow. <br><br>Supports `$filter`(`eq`,`ne`) and `orderby`.| +|isSchedulingEnabled|Boolean|If `true`, the `workflow` engine executes the workflow on the schedule defined by [tenant settings](identitygovernance-lifecyclemanagementsettings.md). | |lastModifiedDateTime|DateTimeOffset|The date time when the `workflow` was last modified. <br><br>Supports `$filter`(`lt`,`gt`) and `$orderby`.| |nextScheduleRunDateTime|DateTimeOffset|The date time when the `workflow` is expected to run next based on the schedule interval, if there are any users matching the execution conditions. <br><br>Supports `$filter`(`lt`,`gt`) and `$orderby`. |-|version|Int32|The current version number of the workflow. Value is 1 when the workflow is first created. <br><br>Supports `$filter`(`eq`).| +|version|Int32|The current version number of the workflow. Value is `1` when the workflow is first created. <br><br>Supports `$filter`(`eq`).| ## Relationships |Relationship|Type|Description| |:|:|:|-|createdBy|[user](../resources/user.md)|The unique identifier of the Azure AD user that created the [workflow](../resources/identitygovernance-workflow.md) object. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md).| -|executionScope|[microsoft.graph.user](../resources/user.md) collection|The unique identifier of the Azure AD identity that last modified the [workflow](../resources/identitygovernance-workflow.md) object..| -|lastModifiedBy|[user](../resources/user.md)|The user who last modified the [workflow](../resources/identitygovernance-workflow.md) object. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md).| +|createdBy|[user](../resources/user.md)|The unique identifier of the Azure AD user that created the [workflow](../resources/identitygovernance-workflow.md) object. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md). Supports `$expand`.| +|executionScope|[microsoft.graph.user](../resources/user.md) collection|The unique identifier of the Azure AD identity that last modified the [workflow](../resources/identitygovernance-workflow.md) object.| +|lastModifiedBy|[user](../resources/user.md)|The user who last modified the [workflow](../resources/identitygovernance-workflow.md) object. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md). Supports `$expand`.| |runs|[microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) collection|Workflow runs.| |taskReports|[microsoft.graph.identityGovernance.taskReport](../resources/identitygovernance-taskreport.md) collection|Represents the aggregation of task execution data for tasks within a [workflow](../resources/identitygovernance-workflow.md) object.| |tasks|[microsoft.graph.identityGovernance.task](../resources/identitygovernance-task.md) collection|Represents the configured tasks to execute and their execution sequence within a [workflow](../resources/identitygovernance-workflow.md) object. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md)| |
v1.0 | Identitygovernance Workflowexecutionconditions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-workflowexecutionconditions.md | Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -This is an abstract type noting the workflow execution conditions in [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) and [workflowBase](../resources/identitygovernance-workflowbase.md) objects. Execution conditions define when a workflow will run and the user that's the target of the workflow. The following types are derived from this abstract type: +This is an abstract type noting the workflow execution conditions in [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) and [workflowBase](../resources/identitygovernance-workflowbase.md) objects. Execution conditions define when a workflow will run and rules that identify the users that are the target of the workflow. The following types are derived from this abstract type: + [onDemandExecutionOnly](../resources/identitygovernance-ondemandexecutiononly.md) + [triggerAndScopeBasedConditions](../resources/identitygovernance-triggerandscopebasedconditions.md) |
v1.0 | Identitygovernance Workflowtemplate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-workflowtemplate.md | Inherits from [entity](../resources/entity.md). |Property|Type|Description| |:|:|:|-|category|microsoft.graph.identityGovernance.lifecycleWorkflowCategory|The category of the workflow template. The possible values are: `joiner`, `leaver`.| +|category|microsoft.graph.identityGovernance.lifecycleWorkflowCategory|The category of the workflow template. The possible values are: `joiner`, `leaver`. Supports `$filter` (`eq`).| |description|String|The description of the `workflowTemplate`.| |displayName|String|The display name of the `workflowTemplate`. <br><br>Supports `orderby`.| |executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Conditions describing when to execute the workflow and the criteria to identify in-scope subject set.| |
v1.0 | Identityprotection Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identityprotection-overview.md | Title: "Use the Microsoft Graph identity protection APIs" description: "Use Microsoft Graph to query and receive information about risks detected by Azure AD Identity Protection."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: conceptualPageType |
v1.0 | Identityprotectionroot | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identityprotectionroot.md | Title: "identityProtectionRoot resource type" description: "Container for navigation properties for Microsoft Graph identity protection resources."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Incomingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/incomingcalloptions.md | Inherits from [callOptions](calloptions.md). ## Properties -|Property |Type |Description | -|: |: |: | -|isContentSharingNotificationEnabled |Boolean |The value that indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). | -+| Property | Type | Description | +|:|:--|:| +| hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | +| isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). | ## JSON representation The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.incomingCallOptions",+ "hideBotAfterEscalation": "Boolean", "isContentSharingNotificationEnabled": "Boolean" } ``` |
v1.0 | Oauth2permissiongrant | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/oauth2permissiongrant.md | Delegated permissions are sometimes referred to as "OAuth 2.0 scopes" or "scopes | consentType | String | Indicates whether authorization is granted for the client application to impersonate all users or only a specific user. *AllPrincipals* indicates authorization to impersonate all users. *Principal* indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports `$filter` (`eq` only). | | principalId | String | The **id** of the [user](user.md) on behalf of whom the client is authorized to access the resource, when **consentType** is *Principal*. If **consentType** is *AllPrincipals* this value is null. Required when **consentType** is *Principal*. Supports `$filter` (`eq` only). | | resourceId | String | The **id** of the resource [service principal](serviceprincipal.md) to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports `$filter` (`eq` only). |-| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **publishedPermissionScopes** property of the resource [service principal](serviceprincipal.md). | +| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **publishedPermissionScopes** property of the resource [service principal](serviceprincipal.md). Must not exceed 3850 characters in length.| | startTime | DateTimeOffset | Currently, the start time value is ignored, but a value is required when creating an **oAuth2PermissionGrant**. Required. | | expiryTime | DateTimeOffset | Currently, the end time value is ignored, but a value is required when creating an **oAuth2PermissionGrant**. Required. | |
v1.0 | Outgoingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/outgoingcalloptions.md | Inherits from [callOptions](calloptions.md). ## Properties -|Property |Type |Description | -|: |: |: | -|isContentSharingNotificationEnabled |Boolean |The value that indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). | +| Property | Type | Description | +|:|:--|:| +| hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | +| isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). | ## JSON representation The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.outgoingCallOptions",+ "hideBotAfterEscalation": "Boolean", "isContentSharingNotificationEnabled": "Boolean" } ``` |
v1.0 | Privilegedidentitymanagementv3 Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/privilegedidentitymanagementv3-overview.md | For more information about role settings, see [Configure Azure AD role settings ## PIM and identity security with Zero Trust -PIM APIs support organizations to adopt a Zero Trust approach to secure the identities in their organization. For more information about Zero Trust, see [Securing identity with Zero Trust](/security/zero-trust/deploy/identity). +PIM APIs support organizations to adopt a Zero Trust approach to secure the identities in their organization. For more information about Zero Trust, see [Securing identity with Zero Trust](/security/zero-trust/deploy/identity#secure-privileged-access-with-privileged-identity-management). ## Permissions and privileges The PIM API requires an Azure AD Premium P2 license. For more information, see [ + [What is Azure AD Identity Governance?](/azure/active-directory/governance/identity-governance-overview) + [What is Azure AD Privileged Identity Management?](/azure/active-directory/privileged-identity-management/pim-configure) + [Tutorial: Use the Privileged Identity Management (PIM) API to assign Azure AD roles](/graph/tutorial-assign-azureadroles)-+ You can also set up access reviews of role assignments and eligibilities that are managed through PIM. For more information, see [Tutorial: Use the Privileged Identity Management (PIM) API to assign Azure AD roles](/graph/tutorial-assign-azureadroles). ++ You can also set up access reviews of role assignments and eligibilities that are managed through PIM. For more information, see [Tutorial: Use the Privileged Identity Management (PIM) API to assign Azure AD roles](/graph/tutorial-assign-azureadroles). |
v1.0 | Recommendedaction | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/recommendedaction.md | Title: "recommendedAction resource type" description: "Represents recommended actions for a tenant based on the attack simulation and training campaign to improve its security posture."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Represents recommended actions for a tenant based on the attack simulation and t |Property|Type|Description| |:|:|:| |actionWebUrl|String|Web URL to the recommended action.|-|potentialScoreImpact|Double|Potential improvement in security score of the tenant from the recommended action.| +|potentialScoreImpact|Double|Potential improvement in the tenant security score from the recommended action.| |title|String|Title of the recommended action.| ## Relationships The following is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.recommendedAction", "actionWebUrl": "String",- "title": "String", - "potentialScoreImpact": "Double" + "potentialScoreImpact": "Double", + "title": "String" } ``` |
v1.0 | Report M365defender Reports Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/report-m365defender-reports-overview.md | Title: "Reports API overview for attack simulation training as part of Microsoft Defender for Office 365" -description: "This section describes APIs that access security reports that are part of Microsoft Defender for Office 365." +description: "This section describes reporting capabilities of Microsoft Defender for Office 365, specifically APIs that access reports on a tenant's participation in attack simulation training." ms.localizationpriority: high-+ ms.prod: "security" doc_type: resourcePageType doc_type: resourcePageType [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -This section describes reporting capabilities of Microsoft Defender for Office 365, specifically APIs that access reports on a tenant's participation in attack simulation traning. Attack simulation tranings set up benign cyberattack simulations to train users in the tenant to increase their awareness, and help identify vulnerable users. +This section describes reporting capabilities of Microsoft Defender for Office 365, specifically APIs that access reports on a tenant's participation in attack simulation training. Attack simulation trainings set up benign cyberattack simulations to train users in the tenant to increase their awareness, and help identify vulnerable users. ## What role do the attack simulation reports play in enterprise defense? Microsoft 365 Defender is a unified enterprise defense suite that helps detect s To access attack simulation training, open the Microsoft 365 Defender portal, go to **Email & collaboration** > **Attack simulation training**. - ## Authorization Microsoft Graph controls access to resources using permissions. You must specify the permissions you need in order to access reports resources. For more information, see [Microsoft Graph permissions reference](/graph/permissions-reference) and [reports permissions](/graph/permissions-reference#reports-permissions). Reports resources and APIs can open up new ways for you to engage with users and - Drill down on the methods and properties of the resources most helpful to your scenario. - Try the API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer).- |
v1.0 | Riskdetection | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/riskdetection.md | Title: "riskDetection resource type" description: "Represents all risk detections in AzureAD tenants."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Riskuseractivity | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/riskuseractivity.md | Title: "riskUserActivity resource type" description: author-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Riskyuser | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/riskyuser.md | Title: "riskyUser resource type" description: "Represents Azure AD users who are at risk. Azure AD continually evaluates user risk based on various signals and machine learning. This API provides programmatic access to all at-risk users in your Azure AD."-+ ms.localizationpriority: medium doc_type: resourcePageType ms.prod: "identity-and-sign-in" |
v1.0 | Riskyuserhistoryitem | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/riskyuserhistoryitem.md | Title: "riskyUserHistoryItem resource type" description: "Represents the risk history of Azure AD users"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Security Attacksimulationinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-attacksimulationinfo.md | Title: "attackSimulationInfo resource type" -description: "Represents threat submission attack simulation information" +description: "Represents attack simulation information for threat submission." ms.localizationpriority: medium ms.prod: "security" Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents threat submission's attack simulation information. If an email was an attack simulation email, the email threat submission would contain corresponding attack simulation information. +Represents attack simulation information for threat submission. If an email was an attack simulation email, the email threat submission would contain corresponding attack simulation information. ## Properties | Property | Type | Description | |:-|:|:-|-| attackSimDateTime | DateTimeOffset | Specifies the date time of the attack simulation. | -| attackSimDurationTime | Duration | Specifies the duration (in time) for the attack simulation | -| attackSimId | Guid | Specifies the activity id for the attack simulation. | -| attackSimUserId | String | Specifies the user id of the user who got the attack simulation email | +| attackSimDateTime | DateTimeOffset | The date and time of the attack simulation. | +| attackSimDurationTime | Duration | The duration (in time) for the attack simulation. | +| attackSimId | Guid | The activity ID for the attack simulation. | +| attackSimUserId | String | The unique identifier for the user who got the attack simulation email. | ## Relationships None. The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.security.attackSimulationInfo",- "attackSimId": "Guid", - "attackSimDateTime": "String (timestamp)", + "attackSimDateTime": "String (timestamp)", "attackSimDurationTime": "String (duration)",+ "attackSimId": "Guid", "attackSimUserId": "String" } ```- |
v1.0 | Securityreportsroot | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/securityreportsroot.md | Title: "securityReportsRoot resource type" -description: "Container for AST reports resources." -+description: "Represents an abstract type that contains resources for attack simulation and training reports." + ms.localizationpriority: medium ms.prod: "reports" doc_type: apiPageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Provides the ability to launch a realistic simulated phishing attack that organizations can learn from. -This is an abstract type. +Represents an abstract type that contains resources for attack simulation and training reports. This resource provides the ability to launch a realistic simulated phishing attack that organizations can learn from. Inherits from [entity](../resources/entity.md). ## Methods |Method|Return type|Description| |:|:|:|-|[getAttackSimulationSimulationUserCoverage](../api/securityreportsroot-getattacksimulationsimulationusercoverage.md)|[attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection|List simulation coverage for users of a tenant in attack simulation and training campaigns.| -|[getAttackSimulationTrainingUserCoverage](../api/securityreportsroot-getattacksimulationtrainingusercoverage.md)|[attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection|List training coverage for users of a tenant in attack simulation and training campaigns.| -|[getAttackSimulationRepeatOffenders](../api/securityreportsroot-getattacksimulationrepeatoffenders.md)|[attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection|List repeat offender users of a tenant in attack simulation and training campaigns| +|[Get simulation coverage for users](../api/securityreportsroot-getattacksimulationsimulationusercoverage.md)|[attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection|List [training coverage](../resources/attacksimulationtrainingusercoverage.md) for each tenant user in attack simulation and training campaigns.| +|[Get training coverage for users](../api/securityreportsroot-getattacksimulationtrainingusercoverage.md)|[attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection|List training coverage for tenant users in attack simulation and training campaigns.| +|[Get repeat offenders](../api/securityreportsroot-getattacksimulationrepeatoffenders.md)|[attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection|List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns.| ## Properties-None +None. ## Relationships None. |
v1.0 | Serviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/serviceprincipal.md | This resource supports using [delta query](/graph/delta-query-overview) to track |preferredTokenSigningKeyEndDateTime|DateTimeOffset|Specifies the expiration date of the keyCredential used for token signing, marked by **preferredTokenSigningKeyThumbprint**.| |preferredTokenSigningKeyThumbprint|String|Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. | |publishedPermissionScopes|[permissionScope](permissionscope.md) collection|The delegated permissions exposed by the application. For more information see the **oauth2PermissionScopes** property on the [application](application.md) entity's **api** property. Not nullable. <br/>**Note:** This property is named **oauth2PermissionScopes** in v1.0.|+|publisherName| String | The name of the Azure AD tenant that published the application. | |replyUrls|String collection|The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. | |samlMetadataUrl|String|The url where the service exposes SAML metadata for federation.| |samlSingleSignOnSettings|[samlSingleSignOnSettings](samlsinglesignonsettings.md)|The collection for settings related to saml single sign-on.| This resource supports using [delta query](/graph/delta-query-overview) to track "preferredSingleSignOnMode": "String", "preferredTokenSigningKeyEndDateTime": "DateTime", "preferredTokenSigningKeyThumbprint": "String",+ "publisherName": "String", "replyUrls": ["String"], "samlMetadataUrl": "String", "samlSingleSignOnSettings": "microsoft.DirectoryServices.SamlSingleSignOnSettings", |
v1.0 | Simulation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/simulation.md | Title: "simulation resource type" description: "Represents an attack simulation training campaign in a tenant."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph Represents an attack simulation training campaign in a tenant. -Attack simulation and training is a service available as part of [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/defender-for-office-365?view=o365-worldwide&preserve-view=true). This service lets users in a tenant experience a realistic benign phishing attack and learn from it. The service enables tenant administrators to simulate, assign trainings, and read derived insights into online behaviors of users in the phishing simulations. The service provides attack simulation reports that help tenants identify security knowledge gaps, so that they can further train their users to decrease their susceptibility to attacks. +Attack simulation and training is a service available as part of [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/defender-for-office-365?view=o365-worldwide&preserve-view=true). This service lets tenant users experience a realistic benign phishing attack and learn from it. The service enables tenant administrators to simulate, assign trainings, and read derived insights into online behaviors of users in the phishing simulations. The service provides attack simulation reports that help tenants identify security knowledge gaps, so that they can further train their users to decrease their susceptibility to attacks. The attack simulation and training API enables tenant administrators to list launched **simulation** exercises and trainings, and get [reports](report-m365defender-reports-overview.md) on derived insights into online behaviors of users in the phishing simulations. +Inherits from [entity](../resources/entity.md). + ## Methods |Method|Return type|Description| |:|:|:|-|[List simulations](../api/attacksimulationroot-list-simulations.md)|[simulation](../resources/simulation.md) collection|Get a list of the [simulation](../resources/simulation.md) objects and their properties.| +|[List simulations](../api/attacksimulationroot-list-simulations.md)|[simulation](../resources/simulation.md) collection|Get a list of attack simulation campaigns for a tenant.| +|[Get simulation](../api/attacksimulationroot-get-simulations.md)|[simulation](../resources/simulation.md)|Get an attack simulation campaign for a tenant.| ## Properties |Property|Type|Description| The attack simulation and training API enables tenant administrators to list lau |createdDateTime|DateTimeOffset|Date and time of creation of the attack simulation and training campaign.| |description|String|Description of the attack simulation and training campaign.| |displayName|String|Display name of the attack simulation and training campaign. Supports `$filter` and `$orderby`.|-|id|String|Unique identifier for the attack simulation and training campaign.| -|isAutomated|Boolean|Flag representing if the attack simulation and training campaign was created from a simulation automation flow. Supports `$filter` and `$orderby`. | +|id|String|Unique identifier for the attack simulation and training campaign. Inherited from [entity](../resources/entity.md).| +|isAutomated|Boolean|Flag that represents if the attack simulation and training campaign was created from a simulation automation flow. Supports `$filter` and `$orderby`. | |lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who most recently modified the attack simulation and training campaign.| |lastModifiedDateTime|DateTimeOffset|Date and time of the most recent modification of the attack simulation and training campaign.| |launchDateTime|DateTimeOffset|Date and time of the launch/start of the attack simulation and training campaign. Supports `$filter` and `$orderby`.| The attack simulation and training API enables tenant administrators to list lau |unknown| Attack type not identified. | |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, Internet-of-things devices. | +|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. | ## Relationships The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.simulation",- "id": "String (identifier)", - "displayName": "String", - "description": "String", - "attackType": "String", "attackTechnique": "String",- "status": "String", - "createdDateTime": "String (timestamp)", + "attackType": "String", + "automationId": "String", + "completionDateTime": "String (timestamp)", "createdBy": { "@odata.type": "microsoft.graph.emailIdentity" },- "lastModifiedDateTime": "String (timestamp)", + "createdDateTime": "String (timestamp)", + "description": "String", + "displayName": "String", + "id": "String (identifier)", + "isAutomated": "Boolean", "lastModifiedBy": { "@odata.type": "microsoft.graph.emailIdentity" },+ "lastModifiedDateTime": "String (timestamp)", "launchDateTime": "String (timestamp)",- "completionDateTime": "String (timestamp)", - "isAutomated": "Boolean", - "automationId": "String", "payloadDeliveryPlatform": "String", "report": { "@odata.type": "microsoft.graph.simulationReport"- } + }, + "status": "String" } ``` |
v1.0 | Simulationautomation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/simulationautomation.md | Title: "simulationAutomation resource type" description: "Represents simulation automation created to run on a tenant."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph Represents simulation automation created to run on a tenant. +Inherits from [entity](../resources/entity.md). ## Methods |Method|Return type|Description| |:|:|:|-|[List simulationAutomations](../api/attacksimulationroot-list-simulationautomations.md)|[simulationAutomation](../resources/simulationautomation.md) collection|Get a list of the [simulationAutomation](../resources/simulationautomation.md) objects and their properties.| +|[List simulationAutomations](../api/attacksimulationroot-list-simulationautomations.md)|[simulationAutomation](../resources/simulationautomation.md) collection|Get a list of attack simulation automations for a tenant.| +|[Get simulationAutomation](../api/attacksimulationroot-get-simulationautomations.md)|[simulationAutomation](../resources/simulationautomation.md)|Get an attack simulation automation for a tenant.| |[List runs](../api/simulationautomation-list-runs.md)|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|Get a list of the attack simulation automation runs for a tenant.| ## Properties Represents simulation automation created to run on a tenant. |createdDateTime|DateTimeOffset|Date and time when the attack simulation automation was created.| |description|String|Description of the attack simulation automation.| |displayName|String|Display name of the attack simulation automation. Supports `$filter` and `$orderby`.|-|id|String|Unique identifier for the attack simulation automation.| +|id|String|Unique identifier for the attack simulation automation. Inherited from [entity](../resources/entity.md).| |lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who most recently modified the attack simulation automation.| |lastModifiedDateTime|DateTimeOffset|Date and time when the attack simulation automation was most recently modified.| |lastRunDateTime|DateTimeOffset|Date and time of the latest run of the attack simulation automation.| |
v1.0 | Simulationautomationrun | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/simulationautomationrun.md | Title: "simulationAutomationRun resource type" description: "Represents a run of an attack simulation automation on a tenant."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph Represents a run of an attack simulation automation on a tenant. +Inherits from [entity](../resources/entity.md). ## Methods |Method|Return type|Description| |:|:|:|-|[List runs](../api/simulationautomation-list-runs.md)|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|Get a list of runs of attack simulation automation.| +|[List runs](../api/simulationautomation-list-runs.md)|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|Get a list of the attack simulation automation runs for a tenant.| ## Properties |Property|Type|Description| |:|:|:| |endDateTime|DateTimeOffset|Date and time when the run ends in an attack simulation automation.|-|id|String|Unique identifier for the run of an attack simulation automation.| +|id|String|Unique identifier for the run of an attack simulation automation. Inherited from [entity](../resources/entity.md).| |simulationId|String|Unique identifier for the attack simulation campaign initiated in the attack simulation automation run.| |startDateTime|DateTimeOffset|Date and time when the run starts in an attack simulation automation.|-|status|[simulationAutomationRunStatus](#simulationautomationrunstatus-values)|Status of the run of an attack simulation automation. The possible values are: `unknown`, `running`, `succeeded`, `failed`, `skipped`, `unknownFutureValue`.| +|status|[simulationAutomationRunStatus](#simulationautomationrunstatus-values)|Status of the attack simulation automation run. The possible values are: `unknown`, `running`, `succeeded`, `failed`, `skipped`, `unknownFutureValue`.| ### simulationAutomationRunStatus values |Member|Description | |:|:|-|unknown| The status of a run of a simulation automation is not defined. | -|running| The run of a simulation automation is running. | -|succeeded| The run of a simulation automation has succeeded. | -|failed| The run of a simulation automation has failed. | -|skipped| The run of a simulation automation has skipped. | +|unknown| The status of a simulation automation run is not defined. | +|running| The simulation automation run is running. | +|succeeded| The simulation automation run has succeeded. | +|failed| The simulation automation run has failed. | +|skipped| The simulation automation run has skipped. | |unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | ## Relationships |
v1.0 | Simulationevent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/simulationevent.md | Title: "simulationEvent resource type" -description: "Represents simulation event in an attack simulation and training campaign." -+description: "Represents a simulation event in an attack simulation and training campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents simulation event in an attack simulation and training campaign. +Represents a simulation event in an attack simulation and training campaign. ## Properties |Property|Type|Description| |:|:|:|-|count|Int32|Count of occurence of the simulation event in an attack simulation and training campaign.| +|count|Int32|Count of the simulation event occurrence in an attack simulation and training campaign.| |eventName|String|Name of the simulation event in an attack simulation and training campaign.| ## Relationships The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.simulationEvent",- "eventName": "String", - "count": "Integer" + "count": "Int32", + "eventName": "String" } ``` |
v1.0 | Simulationeventscontent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/simulationeventscontent.md | Title: "simulationEventsContent resource type" description: "Represents simulation events in an attack simulation and training campaign."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType |
v1.0 | Simulationreport | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/simulationreport.md | Title: "simulationReport resource type" -description: "Represents a report of an attack simulation and training campaign." -+description: "Represents a report of an attack simulation and training campaign, including an overview and users who participated in the campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a report of an attack simulation and training campaign, including an overview and users of the campaign. +Represents a report of an attack simulation and training campaign, including an overview and users who participated in the campaign. ## Properties |Property|Type|Description| |:|:|:| |overview|[simulationReportOverview](../resources/simulationreportoverview.md)|Overview of an attack simulation and training campaign.|-|simulationUsers|[userSimulationDetails](../resources/usersimulationdetails.md) collection|Represents users of a tenant and their online actions in an attack simulation and training campaign.| +|simulationUsers|[userSimulationDetails](../resources/usersimulationdetails.md) collection|The tenant users and their online actions in an attack simulation and training campaign.| ## Relationships None. |
v1.0 | Simulationreportoverview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/simulationreportoverview.md | Title: "simulationReportOverview resource type" -description: "Represents overview report of an attack simulation and training campaign." -+description: "Represents an overview report of an attack simulation and training campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents an overview of an attack simulation and training campaign. +Represents an overview report of an attack simulation and training campaign. ## Properties |Property|Type|Description| The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.simulationReportOverview",- "resolvedTargetsCount": "Integer", + "recommendedActions": [ + { + "@odata.type": "microsoft.graph.recommendedAction" + } + ], + "resolvedTargetsCount": "Int32", "simulationEventsContent": { "@odata.type": "microsoft.graph.simulationEventsContent" }, "trainingEventsContent": { "@odata.type": "microsoft.graph.trainingEventsContent"- }, - "recommendedActions": [ - { - "@odata.type": "microsoft.graph.recommendedAction" - } - ] + } } ``` |
v1.0 | Targetresource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/targetresource.md | Title: "targetResource resource complex type - Microsoft Graph API" description: "Defines the targetResource entity resource complex type of the Microsoft Graph API which supports audit log reporting organization (tenant) activity."-+ ms.localizationpriority: medium doc_type: resourcePageType ms.prod: "identity-and-access-reports" |
v1.0 | Teamtemplate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/teamtemplate.md | Namespace: microsoft.graph Represents a logical container for all the definitions and versions of the same team template. +> **Note**: This API is currently in private preview only. When it reaches public preview, we will publish a blog post announcement on the [Microsoft 365 Developer blog](https://devblogs.microsoft.com/microsoft365dev/). ++ ## Methods |Method|Return type|Description| |:|:|:| |
v1.0 | Teamtemplatedefinition | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/teamtemplatedefinition.md | Generic representation of a team template definition for a team with a specific Inherits from [entity](../resources/entity.md). +> **Note**: This API is currently in private preview only. When it reaches public preview, we will publish a blog post announcement on the [Microsoft 365 Developer blog](https://devblogs.microsoft.com/microsoft365dev/). ++ ## Methods |Method|Return type|Description| |:|:|:| |
v1.0 | Trainingeventscontent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/trainingeventscontent.md | Title: "trainingEventsContent resource type" description: "Represents training events in an attack simulation and training campaign."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.trainingEventsContent",- "trainingsAssignedUserCount": "Integer", "assignedTrainingsInfos": [ { "@odata.type": "microsoft.graph.assignedTrainingInfo" }- ] + ], + "trainingsAssignedUserCount": "Int32" } ```- |
v1.0 | User | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/user.md | This resource supports: | [invalidateAllRefreshTokens](../api/user-invalidateallrefreshtokens.md) | None | Invalidate all of the user's refresh tokens issued to applications. | | [validatePassword](../api/user-validatepassword.md)|[passwordValidationInformation](../resources/passwordvalidationinformation.md)|Validate a user's password against the organization's password validation policy and report whether the password is valid. | | **App role assignments**|||-| [List appRoleAssignments](../api/user-list-approleassignments.md) | [appRoleAssignment](approleassignment.md) collection | Get the apps and app roles which this user has been assigned. | -| [Add appRoleAssignment](../api/user-post-approleassignments.md) | [appRoleAssignment](approleassignment.md) | Assign an app role to this user. | -| [Remove appRoleAssignment](../api/user-delete-approleassignments.md) | None | Remove an app role assignment from this user. | +| [List appRoleAssignments](../api/user-list-approleassignments.md) | [appRoleAssignment](approleassignment.md) collection | Get the apps and app roles that a user has been assigned. | +| [List appRoleAssignedResources](../api/user-list-approleassignments.md) | [appRoleAssignment](approleassignment.md) collection | Get the apps that a user has an app role assignment either directly or through group membership. | +| [Add appRoleAssignment](../api/user-post-approleassignments.md) | [appRoleAssignment](approleassignment.md) | Assign an app role to a user. | +| [Remove appRoleAssignment](../api/user-delete-approleassignments.md) | None | Remove an app role assignment from a user. | | **Calendar** ||| | [Create calendar](../api/user-post-calendars.md) | [Calendar](calendar.md) | Create a new Calendar by posting to the calendars collection. | | [Create calendarGroup](../api/user-post-calendargroups.md) | [CalendarGroup](calendargroup.md) | Create a new CalendarGroup by posting to the calendarGroups collection. | |
v1.0 | Usersimulationdetails | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/usersimulationdetails.md | Title: "userSimulationDetails resource type" -description: "Represents a user of a tenant and its online actions in an attack simulation and training campaign." -+description: "Represents a user of a tenant and their online actions in an attack simulation and training campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a user of a tenant and the user's online actions in an attack simulation and training campaign. +Represents a user of a tenant and their online actions in an attack simulation and training campaign. ## Properties |Property|Type|Description| Represents a user of a tenant and the user's online actions in an attack simulat |completedTrainingsCount|Int32|Number of trainings completed by a user in an attack simulation and training campaign.| |compromisedDateTime|DateTimeOffset|Date and time of the compromising online action by a user in an attack simulation and training campaign.| |inProgressTrainingsCount|Int32|Number of trainings in progress by a user in an attack simulation and training campaign.|-|isCompromised|Boolean|Flag representing if user was compromised in an attack simulation and training campaign.| -|reportedPhishDateTime|DateTimeOffset|Date and time when user reported delivered payload as phish in the attack simulation and training campaign.| +|isCompromised|Boolean|Indicates whether a user was compromised in an attack simulation and training campaign.| +|reportedPhishDateTime|DateTimeOffset|Date and time when a user reported the delivered payload as phishing in the attack simulation and training campaign.| |simulationEvents|[userSimulationEventInfo](../resources/usersimulationeventinfo.md) collection|List of simulation events of a user in the attack simulation and training campaign.|-|simulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|User in an attack simulation and training campaign.| +|simulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|The user in an attack simulation and training campaign.| |trainingEvents|[userTrainingEventInfo](../resources/usertrainingeventinfo.md) collection|List of training events of a user in the attack simulation and training campaign.| ## Relationships The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.userSimulationDetails",- "isCompromised": "Boolean", + "assignedTrainingsCount": "Int32", + "completedTrainingsCount": "Int32", "compromisedDateTime": "String (timestamp)",+ "inProgressTrainingsCount": "Int32", + "isCompromised": "Boolean", + "reportedPhishDateTime": "String (timestamp)", "simulationEvents": [ { "@odata.type": "microsoft.graph.userSimulationEventInfo" } ],+ "simulationUser": { + "@odata.type": "microsoft.graph.attackSimulationUser" + }, "trainingEvents": [ { "@odata.type": "microsoft.graph.userTrainingEventInfo" }- ], - "assignedTrainingsCount": "Integer", - "completedTrainingsCount": "Integer", - "inProgressTrainingsCount": "Integer", - "reportedPhishDateTime": "String (timestamp)", - "simulationUser": { - "@odata.type": "microsoft.graph.attackSimulationUser" - } + ] } ``` |
v1.0 | Usersimulationeventinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/usersimulationeventinfo.md | Title: "userSimulationEventInfo resource type" -description: "Represents simulation event of a user in a tenant in an attack simulation and training campaign." -+description: "Represents a simulation event of a user in a tenant in an attack simulation and training campaign." + ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.userSimulationEventInfo",- "eventName": "String", + "browser": "String", "eventDateTime": "String (timestamp)",+ "eventName": "String", "ipAddress": "String",- "osPlatformDeviceDetails": "String", - "browser": "String" + "osPlatformDeviceDetails": "String" } ```- |
v1.0 | Usertrainingcontenteventinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/usertrainingcontenteventinfo.md | Title: "userTrainingContentEventInfo resource type" description: "Represents training event details of assigned trainings to users in an attack simulation and training campaign."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents details of a training event in an attack simulation and training campaign. +Represents training event details of assigned trainings to users in an attack simulation and training campaign. ## Properties |Property|Type|Description| Represents details of a training event in an attack simulation and training camp |contentDateTime|DateTimeOffset|Date and time of the training content playback by the user.| |ipAddress|String|IP address of the user for the training event.| |osPlatformDeviceDetails|String|The operating system, platform, and device details of the user for the training event.|-|potentialScoreImpact|Double|Potential improvement in security posture of the tenant after completion of the training by the user.| +|potentialScoreImpact|Double|Potential improvement in the tenant security posture after completion of the training by the user.| ## Relationships None. The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.userTrainingContentEventInfo",+ "browser": "String", "contentDateTime": "String (timestamp)", "ipAddress": "String", "osPlatformDeviceDetails": "String",- "browser": "String", "potentialScoreImpact": "Double" } ``` |
v1.0 | Usertrainingeventinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/usertrainingeventinfo.md | Title: "userTrainingEventInfo resource type" description: "Represents events of a training assigned to a user in an attack simulation and training campaign."-+ ms.localizationpriority: medium ms.prod: "security" doc_type: resourcePageType The following is a JSON representation of the resource. "trainingAssignedProperties": { "@odata.type": "microsoft.graph.userTrainingContentEventInfo" },- "trainingUpdatedProperties": { + "trainingCompletedProperties": { "@odata.type": "microsoft.graph.userTrainingContentEventInfo" },- "trainingCompletedProperties": { + "trainingUpdatedProperties": { "@odata.type": "microsoft.graph.userTrainingContentEventInfo" } } ```- |
v1.0 | Usertrainingstatusinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/usertrainingstatusinfo.md | Title: "userTrainingStatusInfo resource type" -description: "Represents assigned training and its status for a user in attack simulation and training." -+description: "Represents an assigned training and its status for a user in attack simulation and training." + ms.localizationpriority: medium ms.prod: "reports" doc_type: resourcePageType Represents an assigned training and its status for a user in attack simulation a |assignedDateTime|DateTimeOffset|Date and time of assignment of the training to the user.| |completionDateTime|DateTimeOffset|Date and time of completion of the training by the user.| |displayName|String|Display name of the assigned training.|-|trainingStatus|trainingStatus|Status of the training assigned to the user. Possible values are: `unknown`, `assigned`, `inProgress`, `completed`, `overdue`, `unknownFutureValue`.| +|trainingStatus|trainingStatus|The status of the training assigned to the user. Possible values are: `unknown`, `assigned`, `inProgress`, `completed`, `overdue`, `unknownFutureValue`.| ## Relationships None. The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.userTrainingStatusInfo", "assignedDateTime": "String (timestamp)", "completionDateTime": "String (timestamp)",- "trainingStatus": "String", - "displayName": "String" + "displayName": "String", + "trainingStatus": "String" } ``` |
v1.0 | Workbooknameditem | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/workbooknameditem.md | Represents a defined name for a range of cells or value. Names can be primitive |[Update](../api/nameditem-update.md) | [workbookNamedItem](workbooknameditem.md) |Update NamedItem object. | |[Range](../api/nameditem-range.md)|[workbookRange](workbookrange.md)|Returns the range object that is associated with the name. Throws an exception if the named item's type is not a range.| |[List](../api/nameditem-list.md) | [workbookNamedItem](workbooknameditem.md) collection |Get namedItem object collection. |+| [Delete](../api/nameditem-delete.md) | None | Delete a [workbookNamedItem](workbooknameditem.md) object. | ## Properties | Property | Type |Description| |
v1.0 | Accesspackageassignmentpolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accesspackageassignmentpolicy-delete.md | DELETE https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement [!INCLUDE [sample-code](../includes/snippets/go/delete-accesspackageassignmentpolicy-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PowerShell](#tab/powershell) - # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/delete-accesspackageassignmentpolicy-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Accessreviewset Post Definitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accessreviewset-post-definitions.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-inactiveguests-m365-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-allusers-m365-aadrole-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewscheduledefinition-group-multistage-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - |
v1.0 | Accessreviewset Post Historydefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accessreviewset-post-historydefinitions.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/powershell/create-accessreviewhistorydefinition-from--powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PHP](#tab/php) - |
v1.0 | Addlargegalleryviewoperation Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/addlargegalleryviewoperation-get.md | + + Title: "Get addLargeGalleryViewOperation" +description: "Get the status of an operation that adds the large gallery view to a call." ++ms.localizationpriority: medium +++# Get addLargeGalleryViewOperation ++Namespace: microsoft.graph ++Get the status of an [operation](../resources/addlargegalleryviewoperation.md) that adds the large gallery view to a call. ++## 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) | Not supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | None. | ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +GET /app/calls/{callId}/operations/{id} +GET /communications/calls/{callId}/operations/{id} +``` ++> **Note:** The `/app` path is deprecated. Going forward, use the `/communications` path. ++## Request headers ++| Name | Description | +|:--|:--| +| Authorization | Bearer {token}. Required. | ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and an [addLargeGalleryViewOperation](../resources/addlargegalleryviewoperation.md) object in the response body. ++## Example ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "get-addLargeGalleryViewOperation-1", + "sampleKeys": ["57dab8b1-894c-409a-b240-bd8beae78896", "e33176d4-836a-4fd7-b95a-d11bda52811d"] +}--> ++```msgraph-interactive +GET https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/e33176d4-836a-4fd7-b95a-d11bda52811d +``` ++### Response ++The following is an example of the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "name": "get-addLargeGalleryViewOperation-1", + "truncated": true, + "@odata.type": "microsoft.graph.addLargeGalleryViewOperation" +} --> +```http +HTTP/1.1 200 OK ++{ + "@odata.type": "#microsoft.graph.addLargeGalleryViewOperation", + "clientContext": "785f4929-92ca-497b-863f-c778c77c9758", + "id": "e33176d4-836a-4fd7-b95a-d11bda52811d", + "resultInfo": null, + "status": "completed" +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Get the status of addLargeGalleryView operation.", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +} +--> |
v1.0 | Application Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-get.md | Content-type: application/json #### Request Here is an example of the request. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_application_select" Here is an example of the request. GET https://graph.microsoft.com/v1.0/applications/7bec5fd1-a25f-474c-a6ca-5492082c6a9b?$select=id,appId,displayName,requiredResourceAccess ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ #### Response Here is an example of the response. |
v1.0 | Application List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-list.md | ConsistencyLevel: eventual ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Application Post Applications | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-post-applications.md | Create a new [application](../resources/application.md) object. > [!IMPORTANT] > Adding [**passwordCredential**](../resources/passwordcredential.md) when creating applications is not supported. Use the [addPassword](application-addpassword.md) method to add passwords or secrets for an application.-+> +> Do not share application client IDs (**appId**) in API documentation or code samples. ## 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). |
v1.0 | Application Post Calls | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-post-calls.md | If successful, this method returns a `201 Created` response code and a [call](.. > **Note:** This call needs the Calls.Initiate.All permission. -##### Request +#### Request The following example shows the request which makes a peer-to-peer call between the bot and the specified user. In this example, the media is hosted by the service. The values of authorization token, callback URL, application ID, application name, user ID, user name, and tenant ID must be replaced with actual values to make the example work. Content-Type: application/json "requestedModalities": [ "audio" ],+ "callOptions": { + "@odata.type": "#microsoft.graph.outgoingCallOptions", + "isContentSharingNotificationEnabled": true + }, "mediaConfig": { "@odata.type": "#microsoft.graph.serviceHostedMediaConfig" } Content-Type: application/json -##### Response +#### Response > **Note:** The response object shown here might be shortened for readability. Content-Type: application/json } ``` -##### Notification - establishing +#### Notification - establishing ```http POST https://bot.contoso.com/callback Content-Type: application/json ] } ```-##### Notification - established ++#### Notification - established ```http POST https://bot.contoso.com/callback Content-Type: application/json } ``` +#### Notification - content sharing started ++```http +POST https://bot.contoso.com/api/calls +Content-Type: application/json +``` ++<!-- { + "blockType": "example", + "@odata.type": "microsoft.graph.commsNotifications" +}--> +```json +{ + "@odata.type": "#microsoft.graph.commsNotifications", + "value": [ + { + "@odata.type": "#microsoft.graph.commsNotification", + "changeType": "created", + "resourceUrl": "/communications/calls/421f4c00-4436-4c3a-9d9a-c4924cf98e67/contentsharingsessions", + "resourceData": [ + { + "@odata.type": "#microsoft.graph.contentSharingSession", + "id": "F7D9EF30FF0A9BD3F64B274387FB8FF8E96B6CFBA8F87F8305A74DE99AF007BC" + } + ] + } + ] +} +``` ++#### Notification - content sharing updated ++```http +POST https://bot.contoso.com/api/calls +Content-Type: application/json +``` ++<!-- { + "blockType": "example", + "@odata.type": "microsoft.graph.commsNotifications" +}--> +```json +{ + "@odata.type": "#microsoft.graph.commsNotifications", + "value": [ + { + "@odata.type": "#microsoft.graph.commsNotification", + "changeType": "updated", + "resourceUrl": "/communications/calls/421f4c00-4436-4c3a-9d9a-c4924cf98e67/contentsharingsessions", + "resourceData": [ + { + "@odata.type": "#microsoft.graph.contentSharingSession", + "id": "F7D9EF30FF0A9BD3F64B274387FB8FF8E96B6CFBA8F87F8305A74DE99AF007BC" + } + ] + } + ] +} +``` ++#### Notification - content sharing ended ++```http +POST https://bot.contoso.com/api/calls +Content-Type: application/json +``` ++<!-- { + "blockType": "example", + "@odata.type": "microsoft.graph.commsNotifications" +}--> +```json +{ + "@odata.type": "#microsoft.graph.commsNotifications", + "value": [ + { + "@odata.type": "#microsoft.graph.commsNotification", + "changeType": "deleted", + "resourceUrl": "/communications/calls/421f4c00-4436-4c3a-9d9a-c4924cf98e67/contentsharingsessions", + "resourceData": [ + { + "@odata.type": "#microsoft.graph.contentSharingSession", + "id": "F7D9EF30FF0A9BD3F64B274387FB8FF8E96B6CFBA8F87F8305A74DE99AF007BC" + } + ] + } + ] +} +``` + ### Example 2: Create peer-to-peer VoIP call with application hosted media > **Note**: This example needs Calls.Initiate.All and Calls.AccessMedia.All permissions. -##### Request +#### Request The following example shows the request which makes a peer-to-peer call between the bot and the specified user. In this example the media is hosted locally by the application. The values of authorization token, callback url, application id, application name, user id, user name and tenant id must be replaced with actual values to make the example work. Content-Type: application/json >**Note:** For peer-to-peer calls, the expected notifications are for call state changes only. -##### Response +#### Response > **Note:** The response object shown here might be shortened for readability. Content-Type: application/json This supports up to 5 VoIP users. The example shows how to create a group call with two VoIP users. > **Note:** This example call needs the `Calls.InitiateGroupCalls.All` permission. The group call created doesn't support chat or recording. -##### Request +#### Request <!-- { "blockType": "example", Content-Type: application/json This supports up to 5 VoIP users. The example shows how to create a group call with two VoIP users. > **Note:** This example call needs the `Calls.InitiateGroupCalls.All` permission. The group call created doesn't support chat or recording. -##### Request +#### Request <!-- { "blockType": "example", This information can be obtained from the [Get Online Meetings API](../api/onlin The values of authorization token, callback url, application id, application name, user id, user name and tenant id must be replaced along with the details obtained from [Get Online Meetings API](../api/onlinemeeting-get.md) (VTC-based meetings only) with actual values to make the example work. > **Note:** This example needs the `Calls.JoinGroupCalls.All` permission. -##### Request +#### Request <!-- { "blockType": "example", Content-Type: application/json "tenantId":"86dc81db-c112-4228-9222-63f3esaa1edb" } ```-##### Response ++#### Response <!-- { "blockType": "response", Content-Type: application/json } ``` -##### Notification - establishing +#### Notification - establishing ```http POST https://bot.contoso.com/callback Content-Type: application/json } ```-##### Notification - established ++#### Notification - established ```http POST https://bot.contoso.com/callback Content-Type: application/json ] } ```-##### Notification - roster ++#### Notification - roster ```http POST https://bot.contoso.com/callback |
v1.0 | Application Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-update.md | In the request body, supply the values for relevant fields that should be update | Property | Type | Description | |:|:-|:--| | api | [apiApplication](../resources/apiapplication.md) | Specifies settings for an application that implements a web API. |-| appRoles | [appRole](../resources/approle.md) collection | The collection of application roles that an application may declare. These roles can be assigned to users, groups, or service principals. Not nullable. | +| appRoles | [appRole](../resources/approle.md) collection | The collection of roles defined for the application. These roles can be assigned to users, groups, or service principals. Not nullable. | | displayName | String | The display name for the application. | | groupMembershipClaims | String | Configures the **groups** claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values:<ul><li>`None`</li><li>`SecurityGroup`: For security groups and Azure Active Directory (Azure AD) roles</li><li>`All`: This will get all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of</li></ul> | | identifierUris | String collection | The URIs that identify the application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant. For more information, see [Application Objects and Service Principal Objects](/azure/active-directory/develop/app-objects-and-service-principals). The *any* operator is required for filter expressions on multi-valued properties. Not nullable. | |
v1.0 | Attacksimulationroot Get Simulationautomations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/attacksimulationroot-get-simulationautomations.md | + + Title: "Get simulationAutomation" +description: "Get an attack simulation automation for a tenant." ++ms.localizationpriority: medium +++# Get simulationAutomation +Namespace: microsoft.graph ++Get an attack simulation automation for a tenant. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId} +``` ++## Optional query parameters +This method supports the `$count`, `$filter`, `$orderby`, `$skip`, `$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 **displayName** and **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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$count=true +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$filter={property} eq '{property-value}' +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$filter={property} eq '{property-value}'&$top=5 +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$orderby={property} +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$skip={skipCount} +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$top=1 +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}?$select={property} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [simulationAutomation](../resources/simulationautomation.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "get_simulationautomation" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulationAutomations/fbad62b0-b32d-b6ac-9f48-d84bbea08f96 +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.simulationAutomation" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.simulationAutomation", + "id": "fbad62b0-b32d-b6ac-9f48-d84bbea08f96", + "displayName": "Reed Flores", + "description": "Sample Simulation Automation Description", + "status": "running", + "createdDateTime": "2022-01-01T01:01:01.01Z", + "createdBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastModifiedDateTime": "2022-01-01T01:01:01.01Z", + "lastModifiedBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastRunDateTime": "2022-01-01T01:01:01.01Z", + "nextRunDateTime": "2022-01-01T01:01:01.01Z" +} +``` + |
v1.0 | Attacksimulationroot Get Simulations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/attacksimulationroot-get-simulations.md | + + Title: "Get simulation" +description: "Get an attack simulation campaign for a tenant." ++ms.localizationpriority: medium +++# Get simulation +Namespace: microsoft.graph ++Get an attack simulation campaign for a tenant. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations/{simulationId} +``` ++## 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 **attackTechnique**, **attackType**, **completionDateTime**, **displayName**, **isAutomated**, **launchDateTime**, and **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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations/{simulationId}?$count=true +GET /security/attackSimulation/simulations/{simulationId}?$filter={property} eq '{property-value}' +GET /security/attackSimulation/simulations/{simulationId}?$filter={property} eq '{property-value}'&$top=5 +GET /security/attackSimulation/simulations/{simulationId}?$orderby={property} +GET /security/attackSimulation/simulations/{simulationId}?$skipToken={skipToken} +GET /security/attackSimulation/simulations/{simulationId}?$top=1 +GET /security/attackSimulation/simulations/{simulationId}?$select={property} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [simulation](../resources/simulation.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "get_simulation" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/f1b13829-3829-f1b1-2938-b1f12938b1a +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.simulation" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "f1b13829-3829-f1b1-2938-b1f12938b1f1", + "displayName": "Sample Simulation", + "description": "Sample Simulation Description", + "attackType": "social", + "attackTechnique": "credentialHarvesting", + "status": "scheduled", + "createdDateTime": "2021-01-01T01:01:01.01Z", + "createdBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastModifiedDateTime": "2021-01-01T01:01:01.01Z", + "lastModifiedBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "launchDateTime": "2021-01-01T02:01:01.01Z", + "completionDateTime": "2021-01-07T01:01:01.01Z", + "isAutomated": false, + "automationId": "f1b13829-3829-f1b1-2938-b1f12938b1ab", + "payloadDeliveryPlatform": "email" +} +``` |
v1.0 | Attacksimulationroot List Simulationautomations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/attacksimulationroot-list-simulationautomations.md | + + Title: "List simulationAutomations" +description: "Get a list of attack simulation automations for a tenant." ++ms.localizationpriority: medium +++# List simulationAutomations +Namespace: microsoft.graph ++Get a list of attack simulation automations for a tenant. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations +``` ++## Optional query parameters +This method supports the `$count`, `$filter`, `$orderby`, `$skip`, `$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 **displayName** and **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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations?$count=true +GET /security/attackSimulation/simulationAutomations?$filter={property} eq '{property-value}' +GET /security/attackSimulation/simulationAutomations?$filter={property} eq '{property-value}'&$top=5 +GET /security/attackSimulation/simulationAutomations?$orderby={property} +GET /security/attackSimulation/simulationAutomations?$skip={skipCount} +GET /security/attackSimulation/simulationAutomations?$top=1 +GET /security/attackSimulation/simulationAutomations?$select={property} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [simulationAutomation](../resources/simulationautomation.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "list_simulationautomation" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulationAutomations +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.simulationAutomation", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.simulationAutomation", + "id": "fbad62b0-b32d-b6ac-9f48-d84bbea08f96", + "displayName": "Reed Flores", + "description": "Sample Simulation Automation Description", + "status": "running", + "createdDateTime": "2022-01-01T01:01:01.01Z", + "createdBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastModifiedDateTime": "2022-01-01T01:01:01.01Z", + "lastModifiedBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastRunDateTime": "2022-01-01T01:01:01.01Z", + "nextRunDateTime": "2022-01-01T01:01:01.01Z" + } + ] +} +``` + |
v1.0 | Attacksimulationroot List Simulations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/attacksimulationroot-list-simulations.md | + + Title: "List simulations" +description: "Get a list of attack simulation campaigns for a tenant." ++ms.localizationpriority: medium +++# List simulations +Namespace: microsoft.graph ++Get a list of attack simulation campaigns for a tenant. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations +``` ++## 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 **attackTechnique**, **attackType**, **completionDateTime**, **displayName**, **isAutomated**, **launchDateTime**, and **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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations?$count=true +GET /security/attackSimulation/simulations?$filter={property} eq '{property-value}' +GET /security/attackSimulation/simulations?$filter={property} eq '{property-value}'&$top=5 +GET /security/attackSimulation/simulations?$orderby={property} +GET /security/attackSimulation/simulations?$skipToken={skipToken} +GET /security/attackSimulation/simulations?$top=1 +GET /security/attackSimulation/simulations?$select={property} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [simulation](../resources/simulation.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "list_simulation" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulations +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.simulation)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "f1b13829-3829-f1b1-2938-b1f12938b1f1", + "displayName": "Sample Simulation", + "description": "Sample Simulation Description", + "attackType": "social", + "attackTechnique": "credentialHarvesting", + "status": "scheduled", + "createdDateTime": "2021-01-01T01:01:01.01Z", + "createdBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "lastModifiedDateTime": "2021-01-01T01:01:01.01Z", + "lastModifiedBy": { + "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + }, + "launchDateTime": "2021-01-01T02:01:01.01Z", + "completionDateTime": "2021-01-07T01:01:01.01Z", + "isAutomated": false, + "automationId": "f1b13829-3829-f1b1-2938-b1f12938b1ab", + "payloadDeliveryPlatform": "email" + } + ] +} +``` + |
v1.0 | Call Addlargegalleryview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/call-addlargegalleryview.md | + + Title: "call: addLargeGalleryView" +description: "Add the large gallery view to a call." ++ms.localizationpriority: medium +++# call: addLargeGalleryView ++Namespace: microsoft.graph ++Add the large gallery view to a call. ++## 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) | Not supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.InitiateGroupCall.All | ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +POST /app/calls/{id}/addLargeGalleryView +POST /communications/calls/{id}/addLargeGalleryView +``` ++> **Note:** The `/app` path is deprecated. Going forward, use the `/communications` path. ++## Request headers +| Name | Description | +|:--|:| +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required.| ++## Request body +In the request body, provide a JSON object with the following parameter. ++| Parameter | Type | Description | +|:|:--|:| +| clientContext | String | Unique client context string that can have a maximum of 256 characters. | ++## Response +If successful, this method returns a `202 Accepted` response code and an [addLargeGalleryViewOperation](../resources/addlargegalleryviewoperation.md) object in the response body. ++## Example ++### Request ++The following example shows how to add the large gallery view to a call. ++<!-- { + "blockType": "request", + "name": "addLargeGalleryView-1", + "sampleKeys": ["57dab8b1-894c-409a-b240-bd8beae78896"] +}--> +```http +POST https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/addLargeGalleryView +Content-Type: application/json +Content-Length: 46 ++{ + "clientContext": "785f4929-92ca-497b-863f-c778c77c9758" +} +``` ++### Response ++The following is an example of the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "name": "addLargeGalleryView-1", + "truncated": true, + "@odata.type": "microsoft.graph.addLargeGalleryViewOperation" +} --> +```http +HTTP/1.1 202 ACCEPTED +Location: https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/e33176d4-836a-4fd7-b95a-d11bda52811d ++{ + "@odata.type": "#microsoft.graph.addLargeGalleryViewOperation", + "clientContext": "785f4929-92ca-497b-863f-c778c77c9758", + "id": "e33176d4-836a-4fd7-b95a-d11bda52811d", + "resultInfo": null, + "status": "running" +} +``` ++### Notification - operation completed ++```http +POST https://bot.contoso.com/api/calls +Content-Type: application/json +``` ++<!-- { + "blockType": "example", + "@odata.type": "microsoft.graph.commsNotifications" +}--> +```json +{ + "@odata.type": "#microsoft.graph.commsNotifications", + "value": [ + { + "@odata.type": "#microsoft.graph.commsNotification", + "changeType": "deleted", + "resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/e33176d4-836a-4fd7-b95a-d11bda52811d", + "resourceData": { + "@odata.type": "#microsoft.graph.addLargeGalleryViewOperation", + "@odata.id": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/e33176d4-836a-4fd7-b95a-d11bda52811d", + "clientContext": "785f4929-92ca-497b-863f-c778c77c9758", + "status": "completed" + } + } + ] +} +``` ++## See also ++- [Identify large gallery view participants in a roster](/graph/cloud-communications-identifylargegalleryview) ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "call: addLargeGalleryView", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +} +--> |
v1.0 | Call Answer | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/call-answer.md | In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description | |:--|:--|:-|-|callbackUri |String |Allows bots to provide a specific callback URI for the concurrent call to receive later notifications. If this property has not been set, the bot's global callback URI will be used instead. This must be `https`. | +| callbackUri |String |Allows bots to provide a specific callback URI for the concurrent call to receive later notifications. If this property has not been set, the bot's global callback URI will be used instead. This must be `https`. | |acceptedModalities|String collection |The list of accept modalities. Possible values are: `audio`, `video`, `videoBasedScreenSharing`. Required for answering a call. |-|mediaConfig | [appHostedMediaConfig](../resources/apphostedmediaconfig.md) or [serviceHostedMediaConfig](../resources/servicehostedmediaconfig.md) |The media configuration. (Required) | -| participantCapacity | Int | The number of participant that the application can handle for the call, for [Teams policy-based recording](/MicrosoftTeams/teams-recording-policy) scenario. | +| callOptions | [incomingCallOptions](../resources/incomingcalloptions.md) | The call options. | +| mediaConfig | [appHostedMediaConfig](../resources/apphostedmediaconfig.md) or [serviceHostedMediaConfig](../resources/servicehostedmediaconfig.md) |The media configuration. (Required) | +| participantCapacity | Int32 | The number of participant that the application can handle for the call, for [Teams policy-based recording](/microsoftteams/teams-recording-policy) scenario. | ## Response This method returns a `202 Accepted` response code. This method returns a `202 Accepted` response code. ## Examples The following example shows how to call this API. -##### Request +#### Request The following example shows the request. Content-Length: 211 "acceptedModalities": [ "audio" ],+ "callOptions": { + "@odata.type": "#microsoft.graph.incomingCallOptions", + "isContentSharingNotificationEnabled": true + }, "participantCapacity": 200 } ``` Content-Length: 211 -##### Response -Here is an example of the response. +#### Response +The following is an example of the response. <!-- { "blockType": "response", HTTP/1.1 202 Accepted ### Example 1: Answer a Peer-to-Peer VoIP call with service hosted media -##### Notification - incoming +#### Notification - incoming ```http POST https://bot.contoso.com/api/calls Content-Type: application/json } ``` -##### Request +#### Request # [HTTP](#tab/http) Content-Type: application/json -##### Response +#### Response <!-- { "blockType": "response", "truncated": true Content-Type: application/json HTTP/1.1 202 Accepted ``` -##### Notification - establishing +#### Notification - establishing ```http POST https://bot.contoso.com/api/calls Content-Type: application/json } ``` -##### Notification - established +#### Notification - established ```http POST https://bot.contoso.com/api/calls Content-Type: application/json ### Example 2: Answer VOIP call with application hosted media -##### Notification - incoming +#### Notification - incoming ```http POST https://bot.contoso.com/api/calls Content-Type: application/json } ``` -##### Request +#### Request # [HTTP](#tab/http) Content-Type: application/json -##### Response +#### Response <!-- { "blockType": "response", Content-Type: application/json HTTP/1.1 202 Accepted ``` -##### Notification - establishing +#### Notification - establishing ```http POST https://bot.contoso.com/api/calls Content-Type: application/json } ``` -##### Notification - established +#### Notification - established ```http POST https://bot.contoso.com/api/calls Content-Type: application/json } ``` +#### Notification - content sharing started ++```http +POST https://bot.contoso.com/api/calls +Content-Type: application/json +``` ++<!-- { + "blockType": "example", + "@odata.type": "microsoft.graph.commsNotifications" +}--> +```json +{ + "@odata.type": "#microsoft.graph.commsNotifications", + "value": [ + { + "@odata.type": "#microsoft.graph.commsNotification", + "changeType": "created", + "resourceUrl": "/communications/calls/421f4c00-4436-4c3a-9d9a-c4924cf98e67/contentsharingsessions/2765eb15-01f8-47c6-b12b-c32111a4a86f" + } + ] +} +``` ++#### Notification - content sharing ended ++```http +POST https://bot.contoso.com/api/calls +Content-Type: application/json +``` ++<!-- { + "blockType": "example", + "@odata.type": "microsoft.graph.commsNotifications" +}--> +```json +{ + "@odata.type": "#microsoft.graph.commsNotifications", + "value": [ + { + "@odata.type": "#microsoft.graph.commsNotification", + "changeType": "deleted", + "resourceUrl": "/communications/calls/421f4c00-4436-4c3a-9d9a-c4924cf98e67/contentsharingsessions/2765eb15-01f8-47c6-b12b-c32111a4a86f" + } + ] +} +``` + ### Example 3: Answer a policy-based recording call Under the [Policy-based recording scenario](/microsoftteams/teams-recording-policy), before a participant under policy joins a call, an incoming call notification will be sent to the bot associated with the policy. The join information can be found under the **botData** property. The bot can th When `participantCapacity` is specified in the `Answer` request for a policy-based recording notification, subsequent participant joining event belonging to the same policy group will be sent out as [participantJoiningNotification](../resources/participantJoiningNotification.md) instead of new incoming call notification, until number of participants that current call instance is handling has reached the number specified in `participantCapacity`. -Here is an example of the incoming call notification that a bot would recieve in this case. +The following is an example of the incoming call notification that a bot would receive in this case. ```json { |
v1.0 | Call List Contentsharingsessions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/call-list-contentsharingsessions.md | + + Title: "List contentSharingSessions" +description: "Retrieve a list of contentSharingSession objects in a call." ++ms.localizationpriority: medium +++# List contentSharingSessions ++Namespace: microsoft.graph ++Retrieve a list of [contentSharingSession](../resources/contentsharingsession.md) objects in a call. ++## Permissions ++| Permission type | Permissions (from least to most privileged) | +|:|:| +| Delegated (work or school account) | Not supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.Initiate.All, Calls.InitiateGroupCall.All | ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +GET /communications/calls/{id}/contentSharingSessions +``` ++## Request headers ++| Name | Description | +|:--|:--| +| Authorization | Bearer {token}. Required. | ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [contentSharingSession](../resources/contentsharingsession.md) objects in the response body. ++## Example ++### Request ++The following is an example of a request. +++<!-- { + "blockType": "request", + "name": "get-contentsharingsessions" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/communications/calls/7531d31f-d10d-44de-802f-c569dbca451c/contentSharingSessions +``` ++### Response ++The following is an example of the response. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.contentSharingSession", + "isCollection": true, + "truncated": true +}--> +```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value":[ + { + "@odata.type":"#microsoft.graph.contentSharingSession", + "id":"a7ebfb2d-871e-419c-87af-27290b22e8db" + }, + { + "@odata.type":"#microsoft.graph.contentSharingSession", + "id":"278405a3-f568-4b3e-b684-009193463064" + } + ], + "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#communications/calls('7531d31f-d10d-44de-802f-c569dbca451c')/contentSharingSessions" +} ++``` +<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "List contentSharingSessions", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +} +--> |
v1.0 | Call Logteleconferencedevicequality | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/call-logteleconferencedevicequality.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) - |
v1.0 | Channel Post Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-post-messages.md | One of the following permissions is required to call this API. To learn more, in | Permission type | Permissions (from least to most privileged) | |:|:--|-| Delegated (work or school account) | ChannelMessage.Send | +| Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All | +| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | ++> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. > **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. |
v1.0 | Chat Delete Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-delete-pinnedmessages.md | + + Title: "Unpin a message from a chat" +description: "Unpin a message from a chat." ++ms.localizationpriority: medium +++# Unpin a message from a chat +Namespace: microsoft.graph ++Unpin a message from a [chat](../resources/chat.md). ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account) | Chat.ReadWrite | +|Delegated (personal Microsoft account) | Not supported. | +|Application | Chat.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /chats/{chat-id}/pinnedMessages/{pinnedChatMessageId} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_pinnedchatmessageinfo", + "sampleKeys": ["19:cf66807577b149cca1b7af0c32eec122@thread.v2", "1616964509832"] +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/chats/19:cf66807577b149cca1b7af0c32eec122@thread.v2/pinnedMessages/1616964509832 +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++### Response +The following is an example of the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Chat Get Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-get-installedapps.md | GET https://graph.microsoft.com/v1.0/chats/19:d65713bc498c4a428c71ef9353e6ce20@t [!INCLUDE [sample-code](../includes/snippets/go/get-installedapps-in-chat-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [PowerShell](#tab/powershell) - # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/get-installedapps-in-chat-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Chat Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-get.md | GET https://graph.microsoft.com/v1.0/chats/19:meeting_ZDZlYTYxOWUtYzdlMi00ZmMxLW [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) |
v1.0 | Chat List Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-list-pinnedmessages.md | + + Title: "List pinnedChatMessages in a chat" +description: "Get a list of pinned messages in a chat." ++ms.localizationpriority: medium +++# List pinnedChatMessages in a chat +Namespace: microsoft.graph ++Get a list of [pinnedChatMessages](../resources/pinnedChatMessageInfo.md) in a [chat](../resources/chat.md). ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account) | Chat.Read, Chat.ReadWrite | +|Delegated (personal Microsoft account) | Not supported. | +|Application | ChatMessage.Read.All, Chat.Read.All, Chat.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /chats/{chat-id}/pinnedMessages +``` ++## Optional query parameters +This method supports the `$expand` [OData query parameter](/graph/query-parameters) to help customize the response. ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) objects in the response body. ++## Examples ++### Example 1: List all the pinned messages in a chat +The following example shows a request that lists all the pinned messages in a chat. ++#### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_pinnedmessage_for_chat", + "sampleKeys": ["19:d65713bc498c4a428c71ef9353e6ce20@thread.v2"] +} +--> +``` http +GET https://graph.microsoft.com/v1.0/chats/19:d65713bc498c4a428c71ef9353e6ce20@thread.v2/pinnedMessages +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++#### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.pinnedChatMessageInfo", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "1616964509832" + }, + { + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "1615971548136" + } + ] +} +``` ++### Example 2: List all the pinned messages in a chat along with the associated chat message +The following example shows a request that lists all the pinned messages in a chat along with the associated chat message. ++#### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_pinnedmessage_for_chat_expand_message", + "sampleKeys": ["19:d65713bc498c4a428c71ef9353e6ce20@thread.v2"] +} +--> +``` http +GET https://graph.microsoft.com/v1.0/chats/19:d65713bc498c4a428c71ef9353e6ce20@thread.v2/pinnedMessages?$expand=message +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++#### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.pinnedChatMessageInfo", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "1616964509832", + "message": { + "id": "1616964509832", + "replyToId": null, + "etag": "1616964509832", + "messageType": "message", + "createdDateTime": "2021-03-28T20:48:29.832Z", + "lastModifiedDateTime": "2021-03-28T20:48:29.832Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:2da4c29f6d7041eca70b638b43d45437@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "onBehalfOf": null, + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "user": { + "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", + "displayName": "Robin Kline", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "text", + "content": "Hello world" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + }, + { + "id": "1615971548136", + "message": { + "id": "1615971548136", + "replyToId": null, + "etag": "1615971548136", + "messageType": "message", + "createdDateTime": "2021-03-17T08:59:08.136Z", + "lastModifiedDateTime": "2021-03-17T08:59:08.136Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:2da4c29f6d7041eca70b638b43d45437@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "onBehalfOf": null, + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "user": { + "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", + "displayName": "Robin Kline", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "html", + "content": "<div><div><div><span><img height=\"63\" src=\"https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1615971548136/hostedContents/aWQ9eF8wLXd1cy1kOS1lNTRmNjM1NWYxYmJkNGQ3ZTNmNGJhZmU4NTI5MTBmNix0eXBlPTEsdXJsPWh0dHBzOi8vdXMtYXBpLmFzbS5za3lwZS5jb20vdjEvb2JqZWN0cy8wLXd1cy1kOS1lNTRmNjM1NWYxYmJkNGQ3ZTNmNGJhZmU4NTI5MTBmNi92aWV3cy9pbWdv/$value\" width=\"67\" style=\"vertical-align:bottom; width:67px; height:63px\"></span></div></div></div>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + } + ] +} +``` |
v1.0 | Chat Post Pinnedmessages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-post-pinnedmessages.md | + + Title: "Pin a message in a chat" +description: "Pin a chat message in the specified chat." ++ms.localizationpriority: medium +++# Pin a message in a chat +Namespace: microsoft.graph ++Pin a chat message in the specified [chat](../resources/chat.md). This API cannot create a new chat; you must use the [list chats](chat-list.md) method to retrieve the ID of an existing chat before you can pin a chat message. ++## 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) | ChatMessage.Send, Chat.ReadWrite | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Chat.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /chats/{chat-Id}/pinnedMessages +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply the ID of a chat message to pin. ++## Response ++If successful, this method returns a `201 Created` response code and a [pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) object in the response body. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_pinnedchatmessageinfo_from_", + "sampleKeys": ["19:2da4c29f6d7041eca70b638b43d45437@thread.v2"] +} +--> +``` http +POST https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/pinnedMessages +Content-Type: application/json +Content-length: 63 ++{ + "message@odata.bind":"https://graph.microsoft.com/v1.0/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages/1616964509832" +} +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.pinnedChatMessageInfo" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "1616964509832" +} +``` |
v1.0 | Chatmessage Post Replies | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chatmessage-post-replies.md | One of the following permissions is required to call this API. To learn more, in |:|:--| | Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All | +| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. |
v1.0 | Chatmessage Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chatmessage-post.md | One of the following permissions is required to call this API. To learn more, in ### Permissions for channel | Permission type | Permissions (from least to most privileged) | |:|:--|-| Delegated (work or school account) | ChannelMessage.Send | +| Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All | +| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | ++> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. > **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. |
v1.0 | Chatmessage Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chatmessage-update.md | The update only works for chats where members are Microsoft Teams users. If one ## 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) | Not supported. | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Chat.UpdatePolicyViolation.All for a chat message.</br>ChannelMessage.UpdatePolicyViolation.All for a channel message. | +### Permissions for channel +| Permission type | Permissions (from least to most privileged) | +|:|:--| +| Delegated (work or school account) | ChannelMessage.ReadWrite, Group.ReadWrite.All** | +| Delegated (personal Microsoft account) | Not supported. | +| Application | ChannelMessage.UpdatePolicyViolation.All, ChannelMessage.ReadWrite.All, Group.ReadWrite.All** | ++> **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ++### Permissions for chat +| Permission type | Permissions (from least to most privileged) | +|:|:--| +| Delegated (work or school account) | Chat.ReadWrite | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Chat.UpdatePolicyViolation.All, Chat.ReadWrite.All | ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Contentsharingsession Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/contentsharingsession-get.md | + + Title: "Get contentSharingSession" +description: "Retrieve the properties of a contentSharingSession object in a call." ++ms.localizationpriority: medium +++# Get contentSharingSession ++Namespace: microsoft.graph ++Retrieve the properties of a [contentSharingSession](../resources/contentsharingsession.md) object in a call. ++## Permissions ++| Permission type | Permissions (from least to most privileged) | +|:|:| +| Delegated (work or school account) | Not supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.Initiate.All, Calls.InitiateGroupCall.All | ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +GET /communications/calls/{id}/contentSharingSessions/{id} +``` ++## Request headers ++| Name | Description | +|:--|:--| +| Authorization | Bearer {token}. Required. | ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [contentSharingSession](../resources/contentsharingsession.md) object in the response body. ++## Example ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "get-contentSharingSession" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/communications/calls/7531d31f-d10d-44de-802f-c569dbca451c/contentSharingSessions/7e1b4346-85a6-4bdd-abe3-d11c5d420efe +``` ++### Response ++The following is an example of the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.contentSharingSession" +} --> +```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type":"#microsoft.graph.contentSharingSession", + "id":"7e1b4346-85a6-4bdd-abe3-d11c5d420efe" +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Get contentSharingSession", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +} +--> |
v1.0 | Device List Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/device-list-registeredowners.md | One of the following permissions is required to call this API. To learn more, in GET /devices/{id}/registeredOwners ``` ## Optional query parameters+ This method supports the `$search`, `$count`, and `$filter` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the directoryRoles the device is a member of. You can use `$search` on the **displayName** property. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). +When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. + ## Request headers | Name | Type | Description| |:--|:|:-| |
v1.0 | Directoryobject Checkmembergroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/directoryobject-checkmembergroups.md | Content-type: application/json "name": "directoryobject_checkmembergroups_me" }--> ```http-POST https://graph.microsoft.com/beta/me/checkMemberGroups +POST https://graph.microsoft.com/v1.0/me/checkMemberGroups Content-type: application/json { |
v1.0 | Drive Post Bundles | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/drive-post-bundles.md | This bundle can be used to share a collection of files with other users without <!-- { "blockType": "request", "name": "create-bundle" } --> ```http-POST https://graph.microsoft.com/beta/drive/bundles +POST https://graph.microsoft.com/v1.0/drive/bundles Content-Type: application/json { The request to create a new photo album is similar, although inside the bundle f <!-- { "blockType": "request", "name": "create-album" } --> ```http-POST https://graph.microsoft.com/beta/drive/bundles +POST https://graph.microsoft.com/v1.0/drive/bundles Content-Type: application/json { |
v1.0 | Driveitem Delta | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/driveitem-delta.md | When the `Prefer: hierarchicalsharing` header is provided, sharing information w In many scanning scenarios, you might be interested specifically in changes to permissions. To make it clear in the delta query response which changes are the result of permissions being changed, you can provide the `Prefer: deltashowsharingchanges` header. When this header is provided, all items that appear in the delta query response due to permission changes will have the `@microsoft.graph.sharedChanged":"True"` OData annotation. This feature is applicable to SharePoint and OneDrive for Business but not consumer OneDrive accounts. -> **Note:** The use of `Prefer: deltashowsharingchanges` header requires you to use `Prefer: deltashowremovedasdeleted` and `Prefer: deltatraversepermissiongaps`. These header values can be joined together in a single header: `Prefer: deltashowremovedasdeleted, deltatraversepermissiongaps, deltashowsharingchanges`. +> [!NOTE] +> * The use of `Prefer: deltashowsharingchanges` header requires you to use `Prefer: deltashowremovedasdeleted` and `Prefer: deltatraversepermissiongaps`. These header values can be joined together in a single header: `Prefer: deltashowremovedasdeleted, deltatraversepermissiongaps, deltashowsharingchanges`. +> +> * In order to process permissions correctly your application will need to request **Sites.FullControl.All** permissions. ++For additional guidance about scanning scenarios see [Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance). ## Error responses In addition to the resync errors detailed above, see [Error Responses][error-response] for details about how errors are returned. +## See also +[Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) +[Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance) + [error-response]: /graph/errors [item-resource]: ../resources/driveitem.md |
v1.0 | Educationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationcategory-delete.md | One of the following permissions is required to call this API. To learn more, in | Permission type | Permissions (from least to most privileged) | | :- | : | | Delegated (work or school account) | EduAssignments.ReadWriteBasic, EduAssignments.ReadWrite |-| Delegated (personal Microsoft account) | Not Supported. | -| Application | Not Supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Not supported. | ## HTTP request <!-- { "blockType": "ignored" } --> ```http-DELETE /education/classes/acdefc6b-2dc6-4e71-b1e9-6d9810ab1793/assignmentCategories/{id} +DELETE /education/classes/{id}/assignmentCategories/{id} ``` ## Request headers |
v1.0 | Educationclass Post Assignment | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationclass-post-assignment.md | One of the following permissions is required to call this API. To learn more, in |:--|:| |Delegated (work or school account) | EduAssignments.ReadWriteBasic, EduAssignments.ReadWrite | |Delegated (personal Microsoft account) | Not supported. |-|Application | Not supported. | +|Application | Not supported. | ## HTTP request <!-- { "blockType": "ignored" } --> POST https://graph.microsoft.com/v1.0/education/classes/72a7baec-c3e9-4213-a850- Content-type: application/json {- "dueDateTime": "2021-09-07T00:00:00Z", - "displayName": "Reading test 09.03 #4", + "dueDateTime": "2022-09-16T00:00:00Z", + "displayName": "Reading test 09.14", "instructions": { "contentType": "text", "content": "Read chapter 4" }, "grading": {- "@odata.type": "#microsoft.graph.educationAssignmentGradeType", + "@odata.type": "#microsoft.graph.educationAssignmentPointsGradeType", "maxPoints": 50 }, "assignTo": {- "@odata.type": "#microsoft.graph.educationAssignmentGradeType" + "@odata.type": "#microsoft.graph.educationAssignmentClassRecipient" }, "status": "draft", "allowStudentsToAddResourcesToSubmission": true Content-type: application/json In the request body, supply a JSON representation of an [educationAssignment](../resources/educationassignment.md) object. ### Response-The following is an example of the response. +The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#education/classes('72a7baec-c3e9-4213-a850-f62de0adad5f')/assignments/$entity", - "classId": "72a7baec-c3e9-4213-a850-f62de0adad5f", - "displayName": "Reading test 09.03 #5", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#education/classes('f4a941ff-9da6-4707-ba5b-0eae93cad0b4')/assignments/$entity", + "classId": "f4a941ff-9da6-4707-ba5b-0eae93cad0b4", + "displayName": "Reading test 09.14", "closeDateTime": null,- "dueDateTime": "2021-09-07T00:00:00Z", + "dueDateTime": "2022-09-16T00:00:00Z", "assignDateTime": null, "assignedDateTime": null, "allowLateSubmissions": true, "resourcesFolderUrl": null,- "createdDateTime": "2021-09-03T23:57:14.6088791Z", - "lastModifiedDateTime": "2021-09-03T23:57:14.6398613Z", + "createdDateTime": "2022-09-14T21:23:17.8898549Z", + "lastModifiedDateTime": "2022-09-14T21:23:17.9055807Z", "allowStudentsToAddResourcesToSubmission": true, "status": "draft", "notificationChannelUrl": null,- "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%2272a7baec-c3e9-4213-a850-f62de0adad5f%5C%22,%5C%22displayName%5C%22%3Anull,%5C%22assignmentIds%5C%22%3A%5B%5C%224679bc1b-90c5-45af-ae1a-d5357672ed39%5C%22%5D%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22assignment-viewer%5C%22%7D%22,%22channelId%22%3Anull%7D", + "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%22f4a941ff-9da6-4707-ba5b-0eae93cad0b4%5C%22,%5C%22displayName%5C%22%3Anull,%5C%22assignmentIds%5C%22%3A%5B%5C%22ea77e1dd-1e04-4051-967e-09129d42290f%5C%22%5D,%5C%22submissionId%5C%22%3Anull%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22assignment-viewer%5C%22%7D%22,%22channelId%22%3Anull%7D", + "addToCalendarAction": "none", "addedStudentAction": "none",- "id": "4679bc1b-90c5-45af-ae1a-d5357672ed39", + "id": "ea77e1dd-1e04-4051-967e-09129d42290f", "instructions": {- "content": "Read chapter 5", + "content": "Read chapter 4", "contentType": "text" }, "grading": { Content-type: application/json "suppressions": [] } -->-- |
v1.0 | Educationuser Post Rubrics | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationuser-post-rubrics.md | Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Group Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-delete.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | Group.ReadWrite.All | +The following conditions apply for apps to delete role-assignable groups: ++ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or a global administrator or a privileged role administrator.++ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned the Global Administrator or Privileged Role Administrator Azure AD role.+ ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-list-members.md | Title: "List members" + Title: "List group members" description: "Get a list of the group's direct members. A group can have users, organizational contacts, devices, service principals and other groups as members." ms.localizationpriority: high ms.prod: "groups" doc_type: apiPageType -# List members +# List group members Namespace: microsoft.graph GET /groups/{id}/members ## Optional query parameters -This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`. OData cast is also enabled, for example, you can cast to get just the users that are a member of the group. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group members that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Group List Owners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-list-owners.md | Title: "List owners" + Title: "List group owners" description: "Retrieve a list of the group's owners. The owners are a set of non-admin users who are allowed to modify the group object. " ms.localizationpriority: high ms.prod: "groups" doc_type: apiPageType -# List owners +# List group owners Namespace: microsoft.graph GET /groups/{id}/owners ## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter`, `$count`, `$select`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. OData cast is also enabled, for example, you can cast to get just the group owners that are users. You can use `$search` on the **displayName** and **description** properties. When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index. ## Request headers |
v1.0 | Group Post Groups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-post-groups.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | Group.Create, Group.ReadWrite.All, Directory.ReadWrite.All | +For an app create a group with owners or members while it has the *Group.Create* permission, the app must have the privileges to read the object type that it wants to assign as the group owner or member. Therefore: ++ The app can assign itself as the group's owner or member.++ To create the group with users as owners or members, the app must have at least the *User.Read.All* permission.++ To create the group with other service principals as owners or members, the app must have at least the *Application.Read.All* permission.++ To create the group with either users or service principals as owners or members, the app must have at least the *Directory.Read.All* permission.+ ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Identitycontainer Post B2xuserflows | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/identitycontainer-post-b2xuserflows.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Identityuserflowattributeassignment Setorder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/identityuserflowattributeassignment-setorder.md | If successful, this action returns a `204 No Content` response code. --> ``` http-POST https://graph.microsoft.com/beta/identity/b2xUserFlows/{id}/userAttributeAssignments/setOrder +POST https://graph.microsoft.com/v1.0/identity/b2xUserFlows/{id}/userAttributeAssignments/setOrder Content-Type: application/json { |
v1.0 | Oauth2permissiongrant Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/oauth2permissiongrant-post.md | If successful, this method returns a 200-series response code and a new [oAuth2P | consentType | String | Indicates whether authorization is granted for the client application to impersonate all users or only a specific user. *AllPrincipals* indicates authorization to impersonate all users. *Principal* indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. | | principalId | String | The **id** of the [user](../resources/user.md) on behalf of whom the client is authorized to access the resource, when **consentType** is *Principal*. If **consentType** is *AllPrincipals* this value is null. Required when **consentType** is *Principal*. | | resourceId | String | The **id** of the resource [service principal](../resources/serviceprincipal.md) to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. |-| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **oauth2PermissionScopes** property of the resource [service principal](../resources/serviceprincipal.md). | +| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **oauth2PermissionScopes** property of the resource [service principal](../resources/serviceprincipal.md). Must not exceed 3850 characters in length.| ## Example |
v1.0 | Oauth2permissiongrant Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/oauth2permissiongrant-update.md | In the request body, supply the values for relevant fields that should be update | Property | Type |Description| |:|:--|:-|-|scope|String| Specifies the value of the scope claim that the resource application should expect in the OAuth 2.0 access token. | +|scope|String|A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **publishedPermissionScopes** property of the resource [service principal](../resources/serviceprincipal.md). Must not exceed 3850 characters in length.| ## Response |
v1.0 | Participant Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/participant-delete.md | HTTP/1.1 204 No Content "name": "participant-invite-nonactive-participant" }--> ```http-POST https://graph.microsoft.com/beta/communications/calls/{id}/participants/invite +POST https://graph.microsoft.com/v1.0/communications/calls/{id}/participants/invite Content-Type: application/json Content-Length: 464 Content-Type: application/json "name": "delete-participant_before-added-to-roster" }--> ```http-DELETE https://graph.microsoft.com/beta/communications/calls/{id}/participants/{id} +DELETE https://graph.microsoft.com/v1.0/communications/calls/{id}/participants/{id} ``` # [C#](#tab/csharp) |
v1.0 | Place Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/place-update.md | Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Presence Clearpresence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/presence-clearpresence.md | The following request shows the application with ID `22553876-f5ab-4529-bffb-cfe }--> ```msgraph-interactive-POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/clearPresence +POST https://graph.microsoft.com/v1.0/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/clearPresence Content-Type: application/json { |
v1.0 | Presence Clearuserpreferredpresence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/presence-clearuserpreferredpresence.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/clearuserpreferredpresence-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/clearuserpreferredpresence-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Presence Setpresence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/presence-setpresence.md | The following request shows the application with ID `22553876-f5ab-4529-bffb-cfe }--> ```msgraph-interactive-POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setPresence +POST https://graph.microsoft.com/v1.0/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setPresence Content-Type: application/json { |
v1.0 | Presence Setuserpreferredpresence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/presence-setuserpreferredpresence.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/setuserpreferredpresence-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/setuserpreferredpresence-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Printconnector Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/printconnector-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Printer Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/printer-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/javascript/update-printer-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Go](#tab/go) --# [PowerShell](#tab/powershell) --# [PHP](#tab/php) - |
v1.0 | Riskdetection Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskdetection-get.md | Title: "Get riskDetection" description: "Read the properties and relationships of a riskDetection object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskdetection List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskdetection-list.md | Title: "List riskDetections" description: "Get a list of the riskDetection objects and their properties."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuser Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyuser-confirmcompromised.md | Title: "riskyUser: confirmCompromised" description: "Confirm a user as compromised"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuser Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyuser-dismiss.md | Title: "riskyUser: dismiss" description: "Dismiss a risky user"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuser Get Riskyuserhistoryitem | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyuser-get-riskyuserhistoryitem.md | Title: "Get history" description: "Read the properties and relationships of a riskyUserHistoryItem object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuser Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyuser-get.md | Title: "Get riskyUser" description: "Read the properties and relationships of a riskyUser object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuser List History | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyuser-list-history.md | Title: "List history" description: "Get the riskyUserHistoryItems from the history navigation property."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Riskyuser List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyuser-list.md | Title: "List riskyUsers" description: "Get a list of the riskyUser objects and their properties."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Securityreportsroot Getattacksimulationrepeatoffenders | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/securityreportsroot-getattacksimulationrepeatoffenders.md | + + Title: "securityReportsRoot: getAttackSimulationRepeatOffenders" +description: "List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns." ++ms.localizationpriority: medium +++# securityReportsRoot: getAttackSimulationRepeatOffenders +Namespace: microsoft.graph ++List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns. ++This function supports `@odata.nextLink` for pagination. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/security/getAttackSimulationRepeatOffenders +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this function returns a `200 OK` response code and an [attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "securityreportsrootthis.getattacksimulationrepeatoffenders" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/reports/security/getAttackSimulationRepeatOffenders +``` ++### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.attackSimulationRepeatOffender)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.attackSimulationRepeatOffender)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/reports/security/getAttackSimulationRepeatOffenders?$skiptoken=+RID%3", + "value": [ + { + "repeatOffenceCount": 5, + "attackSimulationUser": { + "userId": "6fcdab00-385b-46f2-a329-b843b49e9147", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + } + }, + { + "repeatOffenceCount": 638, + "attackSimulationUser": { + "userId": "478a22cd-aecc-41df-b995-88c8de17aaf5", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + } + } + ] +} ++``` + |
v1.0 | Securityreportsroot Getattacksimulationsimulationusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/securityreportsroot-getattacksimulationsimulationusercoverage.md | + + Title: "securityReportsRoot: getAttackSimulationSimulationUserCoverage" +description: "List training coverage for each tenant user in attack simulation and training campaigns." ++ms.localizationpriority: medium +++# securityReportsRoot: getAttackSimulationSimulationUserCoverage +Namespace: microsoft.graph ++List [training coverage](../resources/attacksimulationtrainingusercoverage.md) for each tenant user in attack simulation and training campaigns. ++This function supports `@odata.nextLink` for pagination. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/security/getAttackSimulationSimulationUserCoverage +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this function returns a `200 OK` response code and an [attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection in the response body. ++## Examples ++### Request +The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "securityreportsrootthis.getattacksimulationsimulationusercoverage" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/reports/security/getAttackSimulationSimulationUserCoverage +``` ++### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.attackSimulationSimulationUserCoverage)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.attackSimulationSimulationUserCoverage)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/reports/security/getAttackSimulationSimulationUserCoverage?$skiptoken=rZDNasMwEIRfxei%2bRLFWtgRxwZKsYCil0J9rcCORGlI7yHLbvH3j0pQefCqew7LMsOzHbEL%2fkbRuVzvfxTaeC6ItMpVxBKpKBkh5CcIKhLVUSLUtdaYFSbr3%2fe4%2b9Ccf4vmuefMFuW2GaH3cv3pXO5K0v3HdOf9ZEEqmP1fzuTmOfju27hKgYJbmFSjGNGCuLKRZJYEKIxApo6WQZHWzWYz0sXk5%2bmmdp%2fx78I35EEPbHQryNPgwzJKgqGiKUoK%2boACmQoFMDQdmM56uc2O4qZbt7EcwM65alPS%2fnW1DP56m0r4A", + "value": [ + { + "simulationCount": 1063, + "latestSimulationDateTime": "2022-02-10T10:45:50Z", + "clickCount": 0, + "compromisedCount": 0, + "attackSimulationUser": { + "userId": "9a00ce98-2c83-41be-89f7-6fdff7950aa9", + "displayName": "Reed Flores", + "email": "reed@contoso.com" + } + }, + { + "simulationCount": null, + "latestSimulationDateTime": null, + "clickCount": null, + "compromisedCount": null, + "attackSimulationUser": { + "userId": "e911a813-d360-4b1a-b3df-375dde934f2b", + "displayName": "no role", + "email": "" + } + } + ] +} +``` + |
v1.0 | Securityreportsroot Getattacksimulationtrainingusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/securityreportsroot-getattacksimulationtrainingusercoverage.md | + + Title: "securityReportsRoot: getAttackSimulationTrainingUserCoverage" +description: "List training coverage for tenant users in attack simulation and training campaigns." ++ms.localizationpriority: medium +++# securityReportsRoot: getAttackSimulationTrainingUserCoverage +Namespace: microsoft.graph ++List training coverage for tenant users in attack simulation and training campaigns. ++This function supports `@odata.nextLink` for pagination. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/security/getAttackSimulationTrainingUserCoverage +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this function returns a `200 OK` response code and an [attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection in the response body. ++## Examples ++### Request +The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "securityreportsrootthis.getattacksimulationtrainingusercoverage" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/reports/security/getAttackSimulationTrainingUserCoverage +``` ++### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.attackSimulationTrainingUserCoverage)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.attackSimulationTrainingUserCoverage)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/reports/security/getAttackSimulationTrainingUserCoverage?$skiptoken=+RID%3", + "value": [ + { + "userTrainings": [ + { + "assignedDateTime": "2021-07-28T07:33:47.493239Z", + "completionDateTime": null, + "trainingStatus": "assigned", + "displayName": "Phishing" + }, + { + "assignedDateTime": "2021-07-28T07:33:47.493239Z", + "completionDateTime": "2022-01-14T03:11:58Z", + "trainingStatus": "completed", + "displayName": "" + } + ], + "attackSimulationUser": { + "userId": "c5e40ca7-4c09-4801-a140-5ef733d1de0e", + "displayName": null, + "email": null + } + } + ] +} +``` |
v1.0 | Serviceannouncement List Issues | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/serviceannouncement-list-issues.md | This method supports the [OData query parameters](/graph/query-parameters) to he |Name|Description| |:|:| |Authorization|Bearer {token}. Required.|+|Prefer:<br>odata.maxpagesize={x} | Set the maximum page size preference. The maximum page size cannot be greater than 1000. If not specified, default page size is 100. Optional.| ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [serviceHealthIssue](../resources/servicehealthissue.md) objects in the response body. The response is paginated and each page contains 100 objects. +If successful, this method returns a `200 OK` response code and a collection of [serviceHealthIssue](../resources/servicehealthissue.md) objects in the response body. The response is paginated and default page size is 100. ## Example |
v1.0 | Serviceannouncement List Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/serviceannouncement-list-messages.md | This method supports the [OData query parameters](/graph/query-parameters) to he |Name|Description| |:|:| |Authorization|Bearer {token}. Required.|+|Prefer:<br>odata.maxpagesize={x} | Set the maximum page size preference. The maximum page size cannot be greater than 1000. If not specified, default page size is 100. Optional.| ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [serviceUpdateMessage](../resources/serviceupdatemessage.md) objects in the response body. The response is paginated and each page contains 100 objects. +If successful, this method returns a `200 OK` response code and a collection of [serviceUpdateMessage](../resources/serviceupdatemessage.md) objects in the response body. The response is paginated and default page size is 100. ## Example |
v1.0 | Serviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/serviceprincipal-get.md | Content-type: application/json #### Request Here is an example of the request. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_serviceprincipal_select" Here is an example of the request. GET https://graph.microsoft.com/v1.0/servicePrincipals/7408235b-7540-4850-82fe-a5f15ed019e2?$select=id,appId,displayName,appRoles,oauth2PermissionScopes ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ #### Response Here is an example of the response. |
v1.0 | Serviceprincipal List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/serviceprincipal-list.md | ConsistencyLevel: eventual ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Serviceprincipal Post Owners | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/serviceprincipal-post-owners.md | Here is an example of the request. "name": "create_directoryobject_from_serviceprincipal" }--> ```http-POST https://graph.microsoft.com/beta/servicePrincipals/{id}/owners/$ref +POST https://graph.microsoft.com/v1.0/servicePrincipals/{id}/owners/$ref Content-type: application/json { |
v1.0 | Simulationautomation List Runs | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/simulationautomation-list-runs.md | + + Title: "List runs" +description: "Get a list of the attack simulation automation runs for a tenant." ++ms.localizationpriority: medium +++# List runs +Namespace: microsoft.graph ++Get a list of the attack simulation automation runs for a tenant. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}/runs +``` ++## Optional query parameters +This method supports the `$count`, `$skipToken`, `$top`, and `$select` [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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}/runs?$count=true +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}/runs?$skipToken={skipToken} +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}/runs?$top=1 +GET /security/attackSimulation/simulationAutomations/{simulationAutomationId}/runs?$select={property} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [simulationAutomationRun](../resources/simulationautomationrun.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "list_simulationautomationrun" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulationAutomations/fbad62b0-b32d-b6ac-9f48-d84bbea08f96/runs +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.simulationAutomationRun", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.simulationAutomationRun", + "id": "ac4936a5-3865-a0ec-7254-67a22f6121e2", + "status": "succeeded", + "startDateTime": "2021-01-01T02:01:01.01Z", + "endDateTime": "2021-01-01T02:01:01.01Z", + "simulationId": "bc4936a5-3865-a0ec-7254-67a22f6121e2" + } + ] +} +``` + |
v1.0 | Simulationreportoverview Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/simulationreportoverview-get.md | + + Title: "Get simulationReportOverview" +description: "Get an overview of an attack simulation and training campaign." ++ms.localizationpriority: medium +++# Get simulationReportOverview +Namespace: microsoft.graph ++Get an overview of an attack simulation and training campaign. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations/{simulationId}/report/overview +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [simulationReportOverview](../resources/simulationreportoverview.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "get_simulationreportoverview" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/f1b13829-3829-f1b1-2938-b1f12938b1a/report/overview +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.simulationReportOverview" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "microsoft.graph.simulationReportOverview", + "resolvedTargetsCount": 1, + "simulationEventsContent": { + "compromisedRate": 100.0, + "events": [ + { + "@odata.type": "microsoft.graph.simulationEvent", + "eventName": "SuccessfullyDeliveredMail", + "count": 1 + }, + { + "@odata.type": "microsoft.graph.simulationEvent", + "eventName": "ReportedEmail", + "count": 0 + }, + { + "@odata.type": "microsoft.graph.simulationEvent", + "eventName": "EmailLinkClicked", + "count": 1 + } + ] + }, + "trainingEventsContent": { + "trainingsAssignedUserCount": 1, + "assignedTrainingsInfos": [ + { + "@odata.type": "microsoft.graph.assignedTrainingsInfo", + "assignedUserCount": 1, + "completedUserCount": 0, + "displayName": "Sample Training" + } + ] + }, + "recommendedActions": [ + { + "@odata.type": "microsoft.graph.recommendedAction", + "actionWebUrl": "https://recommendedSecurityAction.com", + "title": "Sample Recommended Security Feature", + "potentialScoreImpact": 5.0 + } + ] +} +``` + |
v1.0 | User Post Events | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/user-post-events.md | Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | User Sendmail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/user-sendmail.md | Content-type: application/json ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) |
v1.0 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/user-update.md | In the request body, supply the values for relevant fields that should be update |onPremisesImmutableId|String|This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the userΓÇÖs **userPrincipalName** (UPN) property. **Important:** The **$** and **_** characters cannot be used when specifying this property. | |otherMails|String collection |A list of additional email addresses for the user; for example: `["bob@contoso.com", "Robert@fabrikam.com"]`.| |passwordPolicies|String|Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two may be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`.|-|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the userΓÇÖs password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. This cannot be used for federated users. <br><br> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. In application-only access, the calling app must be assigned the *User.ReadWrite.All* application permission and at least the *User Administrator* [Azure AD role](/azure/active-directory/roles/permissions-reference).| +|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the userΓÇÖs password. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. This cannot be used for federated users. <br><br> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. In application-only access, the calling app must be assigned the *User.ReadWrite.All* application permission and at least the *User Administrator* [Azure AD role](/azure/active-directory/roles/permissions-reference).| |pastProjects|String collection|A list for the user to enumerate their past projects.| |postalCode|String|The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.| |preferredLanguage|String|The preferred language for the user. Should follow ISO 639-1 Code; for example `en-US`.| HTTP/1.1 204 No Content ### Example 3: Update the passwordProfile of a user to reset their password -The following example shows a request to reset the password of another user. +The following example shows a request to reset the password of another user. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. #### Request |
v1.0 | Usersimulationdetails List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/usersimulationdetails-list.md | + + Title: "List simulationUsers" +description: "List users of a tenant and their online actions in an attack simulation campaign." ++ms.localizationpriority: medium +++# List simulationUsers +Namespace: microsoft.graph ++List users of a tenant and their online actions in an attack simulation campaign. ++## 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) | AttackSimulation.Read.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | AttackSimulation.Read.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers +``` ++## 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 are examples of their use: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers?$count=true +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers?$skipToken={skipToken} +GET /security/attackSimulation/simulations/{simulationId}/report/simulationUsers?$top=1 +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [userSimulationDetails](../resources/usersimulationdetails.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "list_usersimulationdetails" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/f1b13829-3829-f1b1-2938-b1f12938b1a/report/simulationUsers +``` ++### Response ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.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 | Addlargegalleryviewoperation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/addlargegalleryviewoperation.md | + + Title: "addLargeGalleryViewOperation resource type" +description: "Describes the response format for an operation that adds the large gallery view." ++ms.localizationpriority: medium +++# addLargeGalleryViewOperation resource type ++Namespace: microsoft.graph ++Describes the response format for an operation that adds the large gallery view. ++Inherits from [commsOperation](commsoperation.md). ++## Methods ++| Method | Return Type | Description | +|:-|:-|:-| +| [Get addLargeGalleryViewOperation](../api/addlargegalleryviewoperation-get.md) | [addLargeGalleryViewOperation](addlargegalleryviewoperation.md) | Get the status of an operation that adds the large gallery view to a call. | ++## Properties ++| Property | Type | Description | +|:--|:-|:-| +| clientContext | String | The client context. | +| id | String | The ID of the server operation. Read-only. | +| resultInfo | [resultInfo](resultinfo.md) | The result information. Read-only. | +| status | operationStatus | The status of the operation. Possible values are: `notStarted`, `running`, `completed`, `failed`. Read-only. | +++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.addLargeGalleryViewOperation" +}--> +```json +{ + "clientContext": "String", + "id": "String (identifier)", + "resultInfo": {"@odata.type": "#microsoft.graph.resultInfo"}, + "status": "String" +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- { + "type": "#page.annotation", + "description": "addLargeGalleryViewOperation resource", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> |
v1.0 | Application | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/application.md | This resource supports: | api | [apiApplication](apiapplication.md) | Specifies settings for an application that implements a web API. | | appId | String | The unique identifier for the application that is assigned to an application by Azure AD. Not nullable. Read-only. Supports `$filter` (`eq`). | | applicationTemplateId | String | Unique identifier of the applicationTemplate. Supports `$filter` (`eq`, `not`, `ne`).|-| appRoles | [appRole](approle.md) collection | The collection of roles assigned to the application. With [app role assignments](approleassignment.md), these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. | +| appRoles | [appRole](approle.md) collection | The collection of roles defined for the application. With [app role assignments](approleassignment.md), these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. | |certification|[certification](certification.md)|Specifies the certification status of the application.| | createdDateTime | DateTimeOffset | The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, and `eq` on `null` values) and `$orderBy`. | | deletedDateTime | DateTimeOffset | The date and time the application was deleted. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. | |
v1.0 | Assignedtraininginfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/assignedtraininginfo.md | + + Title: "assignedTrainingInfo resource type" +description: "Represents assignment information of a training in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# assignedTrainingInfo resource type ++Namespace: microsoft.graph ++Represents assignment information of a training in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|assignedUserCount|Int32|Number of users who were assigned the training in an attack simulation and training campaign.| +|completedUserCount|Int32|Number of users who completed the training in an attack simulation and training campaign.| +|displayName|String|Display name of the training in an attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.assignedTrainingInfo" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.assignedTrainingInfo", + "assignedUserCount": "Int32", + "completedUserCount": "Int32", + "displayName": "String" +} +``` |
v1.0 | Attacksimulationrepeatoffender | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/attacksimulationrepeatoffender.md | + + Title: "attackSimulationRepeatOffender resource type" +description: "Represents a user in a tenant who has given way to attacks more than once across various attack simulation and training campaigns." ++ms.localizationpriority: medium +++# attackSimulationRepeatOffender resource type ++Namespace: microsoft.graph ++Represents a user in a tenant who has given way to attacks more than once across various attack simulation and training campaigns. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get repeat offenders](../api/securityreportsroot-getattacksimulationrepeatoffenders.md)|[attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection|List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns.| ++## Properties +|Property|Type|Description| +|:|:|:| +|attackSimulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|The user in an attack simulation and training campaign.| +|repeatOffenceCount|Int32|Number of repeat offences of the user in attack simulation and training campaigns.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.attackSimulationRepeatOffender" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.attackSimulationRepeatOffender", + "attackSimulationUser": { + "@odata.type": "microsoft.graph.attackSimulationUser" + }, + "repeatOffenceCount": "Int32" +} +``` + |
v1.0 | Attacksimulationroot | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/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." ++ms.localizationpriority: medium +++# attackSimulationRoot resource type ++Namespace: microsoft.graph ++Represents an abstract type that provides the ability to launch a realistic phishing attack that organizations can learn from. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List simulations](../api/attacksimulationroot-list-simulations.md)|[simulation](../resources/simulation.md) collection|Get a list of attack simulation campaigns for a tenant.| +|[List simulationAutomations](../api/attacksimulationroot-list-simulationautomations.md)|[simulationAutomation](../resources/simulationautomation.md) collection|Get a list of attack simulation automations for a tenant.| ++## Properties +None. ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|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.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.attackSimulationRoot", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.attackSimulationRoot" +} +``` |
v1.0 | Attacksimulationsimulationusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/attacksimulationsimulationusercoverage.md | + + Title: "attackSimulationSimulationUserCoverage resource type" +description: "Represents cumulative simulation data and results for a user in attack simulation and training." ++ms.localizationpriority: medium +++# attackSimulationSimulationUserCoverage resource type ++Namespace: microsoft.graph ++Represents cumulative simulation data and results for a user in attack simulation and training. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get simulation coverage for users](../api/securityreportsroot-getattacksimulationsimulationusercoverage.md)|[attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection|List [training coverage](../resources/attacksimulationtrainingusercoverage.md) for each tenant user in attack simulation and training campaigns.| ++## Properties +|Property|Type|Description| +|:|:|:| +|attackSimulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|User in an attack simulation and training campaign.| +|clickCount|Int32|Number of link clicks in the received payloads by the user in attack simulation and training campaigns.| +|compromisedCount|Int32|Number of compromising actions by the user in attack simulation and training campaigns.| +|latestSimulationDateTime|DateTimeOffset|Date and time of the latest attack simulation and training campaign that the user was included in.| +|simulationCount|Int32|Number of attack simulation and training campaigns that the user was included in.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.attackSimulationSimulationUserCoverage" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.attackSimulationSimulationUserCoverage", + "attackSimulationUser": { + "@odata.type": "microsoft.graph.attackSimulationUser" + }, + "clickCount": "Int32", + "compromisedCount": "Int32", + "latestSimulationDateTime": "String (timestamp)", + "simulationCount": "Int32" +} +``` + |
v1.0 | Attacksimulationtrainingusercoverage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/attacksimulationtrainingusercoverage.md | + + Title: "attackSimulationTrainingUserCoverage resource type" +description: "Represents cumulative training data for a user in attack simulation and training." ++ms.localizationpriority: medium +++# attackSimulationTrainingUserCoverage resource type ++Namespace: microsoft.graph ++Represents cumulative training data for a user in attack simulation and training. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get training coverage for users](../api/securityreportsroot-getattacksimulationtrainingusercoverage.md)|[attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection|List training coverage for tenant users in attack simulation and training campaigns.| ++## Properties +|Property|Type|Description| +|:|:|:| +|attackSimulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|User in an attack simulation and training campaign.| +|userTrainings|[userTrainingStatusInfo](../resources/usertrainingstatusinfo.md) collection|List of assigned trainings and their statuses for the user.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.attackSimulationTrainingUserCoverage" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.attackSimulationTrainingUserCoverage", + "attackSimulationUser": { + "@odata.type": "microsoft.graph.attackSimulationUser" + }, + "userTrainings": [ + { + "@odata.type": "microsoft.graph.userTrainingStatusInfo" + } + ] +} +``` + |
v1.0 | Attacksimulationuser | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/attacksimulationuser.md | + + Title: "attackSimulationUser resource type" +description: "Represents a user in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# attackSimulationUser resource type ++Namespace: microsoft.graph ++Represents a user in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Display name of the user.| +|email|String|Email address of the user.| +|userId|String|This is the **id** property value of the [user](../resources/user.md) resource that represents the user in the Azure Active Directory tenant.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.attackSimulationUser" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.attackSimulationUser", + "displayName": "String", + "email": "String", + "userId": "String" +} +``` + |
v1.0 | Call | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/call.md | https://teams.microsoft.com/l/meetup-join/19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLTh ## Methods -| Method | Return Type | Description | -|:-|:|:--| -| [Get](../api/call-get.md) | [call](call.md) | Read properties of the **call** object. | -| [Delete](../api/call-delete.md) | None | Delete or Hang-up an active **call**. | -| [KeepAlive](../api/call-keepalive.md) | None | Ensure that the call remains active. -| **Call Handling** | | | -| [Answer](../api/call-answer.md) | None | Answer an incoming call. | -| [Reject](../api/call-reject.md) | None | Reject an incoming call. | -| [Redirect](../api/call-redirect.md) | None | Redirect an incoming call. | -| [Transfer](../api/call-transfer.md) | None | Transfer a call | -| **Group Calls** | | | -| [List participants](../api/call-list-participants.md) | [participant](participant.md) collection | Get a participant object collection. | -| [Invite participants](../api/participant-invite.md) | [commsOperation](commsoperation.md) | Invite participants to the active call. | -| [Mute participant](../api/participant-mute.md) | [muteParticipantOperation](muteparticipantoperation.md) | Mute a participant in the group call. | -| **Interactive-Voice-Response** | | | -| [PlayPrompt](../api/call-playprompt.md) | [playPromptOperation](playpromptoperation.md) | Play prompt in the call. | -| [RecordResponse](../api/call-record.md) | [recordOperation](recordoperation.md) | Records a short audio response from the caller. | -| [CancelMediaProcessing](../api/call-cancelMediaProcessing.md) | [commsOperation](commsoperation.md) | Cancel media processing. | -| [SubscribeToTone](../api/call-subscribetotone.md) | [commsOperation](commsoperation.md) | Subscribe to DTMF tones. | -| **Self Participant Operations** | | | -| [Mute](../api/call-mute.md) | [muteParticipantOperation](muteparticipantoperation.md) | Mute self in the call. | -| [Unmute](../api/call-unmute.md) | [unmuteParticipantOperation](unmuteparticipantoperation.md) | Unmute self in the call. | -| [ChangeScreenSharingRole](../api/call-changescreensharingrole.md) | None | Start and stop sharing screen in the call. | -| **Recording Operations** | | | -| [UpdateRecordingStatus](../api/call-updaterecordingstatus.md) | [updateRecordingStatusOperation](updateRecordingStatusOperation.md) | Updates the recording status. | -| **Logging Operations** | | | -| [Log device quality data](../api/call-logteleconferencedevicequality.md)| [teleconferenceDeviceQuality](teleconferencedevicequality.md) | Log video teleconferencing device quality data.| +| Method | Return Type | Description | +|:-|:--|:--| +| [Get](../api/call-get.md) | [call](call.md) | Read properties of the **call** object. | +| [Delete](../api/call-delete.md) | None | Delete or Hang-up an active **call**. | +| [KeepAlive](../api/call-keepalive.md) | None | Ensure that the call remains active. | +| **Call handling** | | | +| [Answer](../api/call-answer.md) | None | Answer an incoming call. | +| [Reject](../api/call-reject.md) | None | Reject an incoming call. | +| [Redirect](../api/call-redirect.md) | None | Redirect an incoming call. | +| [Transfer](../api/call-transfer.md) | None | Transfer a call | +| **Group calls** | | | +| [List participants](../api/call-list-participants.md) | [participant](participant.md) collection | Get a participant object collection. | +| [Invite participants](../api/participant-invite.md) | [commsOperation](commsoperation.md) | Invite participants to the active call. | +| [Mute participant](../api/participant-mute.md) | [muteParticipantOperation](muteparticipantoperation.md) | Mute a participant in the group call. | +| [Add large gallery view](../api/call-addlargegalleryview.md) | [addLargeGalleryViewOperation](addlargegalleryviewoperation.md) | Add the large gallery view to a call. | +|**Interactive-voice-response** | | | +| [PlayPrompt](../api/call-playprompt.md) | [playPromptOperation](playpromptoperation.md) | Play prompt in the call. | +| [RecordResponse](../api/call-record.md) | [recordOperation](recordoperation.md) | Records a short audio response from the caller. | +| [CancelMediaProcessing](../api/call-cancelMediaProcessing.md) | [commsOperation](commsoperation.md) | Cancel media processing. | +| [SubscribeToTone](../api/call-subscribetotone.md) | [commsOperation](commsoperation.md) | Subscribe to DTMF tones. | +| **Self participant operations** | | | +| [Mute](../api/call-mute.md) | [muteParticipantOperation](muteparticipantoperation.md) | Mute self in the call. | +| [Unmute](../api/call-unmute.md) | [unmuteParticipantOperation](unmuteparticipantoperation.md) | Unmute self in the call. | +| [ChangeScreenSharingRole](../api/call-changescreensharingrole.md) | None | Start and stop sharing screen in the call. | +| **Recording Operations** | | | +| [UpdateRecordingStatus](../api/call-updaterecordingstatus.md) | [updateRecordingStatusOperation](updateRecordingStatusOperation.md) | Updates the recording status. | +| **Logging operations** | | | +| [Log device quality data](../api/call-logteleconferencedevicequality.md) | [teleconferenceDeviceQuality](teleconferencedevicequality.md) | Log video teleconferencing device quality data. | ## Properties https://teams.microsoft.com/l/meetup-join/19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLTh | : | :| :-- | | callbackUri | String | The callback URL on which callbacks will be delivered. Must be `https`. | | callChainId | String | A unique identifier for all the participant calls in a conference or a unique identifier for two participant calls in a P2P call. This needs to be copied over from `Microsoft.Graph.Call.CallChainId`. |+| callOptions | [outgoingCallOptions](outgoingcalloptions.md) | Contains the optional features for the call. | | callRoutes | [callRoute](callRoute.md) collection | The routing information on how the call was retargeted. Read-only. | | chatInfo | [chatInfo](chatinfo.md) | The chat information. Required information for joining a meeting. | | direction | callDirection | The direction of the call. The possible value are `incoming` or `outgoing`. Read-only. |-| id | String | The call id. Read-only. | +| id | String | The unique identifier for the call. Read-only. | +|incomingContext | [incomingContext](incomingContext.md) | Call context associated with an incoming call. | | mediaConfig | [appHostedMediaConfig](apphostedmediaconfig.md) or [serviceHostedMediaConfig](servicehostedmediaconfig.md) | The media configuration. Required. | | mediaState | [callMediaState](callmediastate.md) | Read-only. The call media state. | | meetingInfo | [organizerMeetingInfo](organizermeetinginfo.md) or [tokenMeetingInfo](tokenmeetinginfo.md) | The meeting information that's required for joining a meeting. |-transcription | [callTranscriptionInfo](calltranscriptioninfo.md) | The transcription information for the call. Read-only. | | myParticipantId | String | Read-only. | | requestedModalities | modality collection | The list of requested modalities. Possible values are: `unknown`, `audio`, `video`, `videoBasedScreenSharing`, `data`. | | resultInfo | [resultInfo](resultinfo.md) | The result information. For example can hold termination reason. Read-only. | transcription | [callTranscriptionInfo](calltranscriptioninfo.md) | state | callState | The call state. Possible values are: `incoming`, `establishing`, `ringing`, `established`, `hold`, `transferring`, `transferAccepted`, `redirecting`, `terminating`, `terminated`. Read-only. | | subject | String | The subject of the conversation. | | targets | [invitationParticipantInfo](participantinfo.md) collection | The targets of the call. Required information for creating peer to peer call. |-toneInfo | [toneInfo](toneinfo.md) | Read-only. | -incomingContext | [incomingContext](incomingContext.md) | Call context associated with an incoming call. | +|toneInfo | [toneInfo](toneinfo.md) | Read-only. | +|transcription | [callTranscriptionInfo](calltranscriptioninfo.md) | The transcription information for the call. Read-only. | ## Relationships -| Relationship | Type | Description | -|:--|:--|:--| -| operations | [commsOperation](commsoperation.md) collection | Read-only. Nullable. | -| participants | [participant](participant.md) collection | Read-only. Nullable. | +| Relationship | Type | Description | +|:--|:-|:| +| contentSharingSessions | [contentSharingSession](contentsharingsession.md) collection | Read-only. Nullable. | +| operations | [commsOperation](commsoperation.md) collection | Read-only. Nullable. | +| participants | [participant](participant.md) collection | Read-only. Nullable. | ## JSON representation The following is a JSON representation of the resource. "blockType": "resource", "optionalProperties": [ "callChainId",+ "callOptions", "chatInfo",+ "contentSharingSessions", "direction", "id", "incomingContext", The following is a JSON representation of the resource. { "callbackUri": "String", "callChainId": "String",+ "callOptions": {"@odata.type": "#microsoft.graph.outgoingCallOptions"}, "chatInfo": {"@odata.type": "#microsoft.graph.chatInfo"},+ "contentSharingSessions": [{ "@odata.type": "microsoft.graph.contentSharingSession" }], "direction": "String", "id": "String (identifier)", "mediaConfig": {"@odata.type": "#microsoft.graph.mediaConfig"}, |
v1.0 | Calloptions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/calloptions.md | + + Title: "callOptions resource type" +description: "Represents an abstract base class that contains the optional features for a call." ++ms.localizationpriority: medium +++# callOptions resource type ++Namespace: microsoft.graph ++Represents an abstract base class that contains the optional features for a call. ++## Properties ++|Property |Type |Description | +|: |: |: | +| hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. | +| isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. | ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.callOptions" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.callOptions", + "hideBotAfterEscalation": "Boolean", + "isContentSharingNotificationEnabled": "Boolean" +} +``` |
v1.0 | Chat | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/chat.md | A chat is a collection of [chatMessages](chatmessage.md) between one or more par |[Add tab to chat](../api/chat-post-tabs.md) | [teamsTab](teamstab.md) | Add (pin) a tab to a chat (and associated meeting).| |[Update tab in chat](../api/chat-patch-tabs.md) | [teamsTab](teamstab.md) | Update the properties of a tab in a chat (and associated meeting).| |[Remove tab from chat](../api/chat-delete-tabs.md) | None | Remove (unpin) a tab from a chat (and associated meeting).|+| **Pinned messages** ||| +|[List pinned messages](../api/chat-list-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) collection|Get a list of pinned messages in a chat.| +|[Pin a message](../api/chat-post-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md)|Pin a chat message in a chat.| +|[Unpin a message](../api/chat-delete-pinnedmessages.md)|None|Unpin a message from a chat.| ->**Note:** When using application permissions, be sure you know how you're going to get the chat ID. Because listing chats with application permissions is not supported, -not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. +>**Note:** When using application permissions, be sure you know how to get the chat ID. Because listing chats with application permissions is not supported, not all scenarios are possible. It is possible to get chat IDs with delegated permissions, and from [change notifications for /chats/getAllMessages](../api/subscription-post-subscriptions.md) with application permissions. ## Properties not all scenarios are possible. It is possible to get chat IDs with delegated pe | installedApps | [teamsAppInstallation](teamsappinstallation.md) collection | A collection of all the apps in the chat. Nullable. | | members | [conversationMember](conversationmember.md) collection | A collection of all the members in the chat. Nullable. | | messages | [chatMessage](chatmessage.md) collection | A collection of all the messages in the chat. Nullable. |+| pinnedMessages | [pinnedChatMessageInfo](pinnedchatmessageinfo.md) collection | A collection of all the pinned messages in the chat. Nullable. | | tabs | [teamsTab](teamstab.md) collection | A collection of all the tabs in the chat. Nullable. | ## JSON representation |
v1.0 | Consentrequests Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/consentrequests-overview.md | The following directory roles are required for a calling application. ## See also -- [Configure the admin consent workflow (preview)](/azure/active-directory/manage-apps/configure-admin-consent-workflow?preserve-view=true)+- Learn more about how to [configure the admin consent workflow (preview)](/azure/active-directory/manage-apps/configure-admin-consent-workflow). +- Understand the user and admin consent flows in the [Azure AD application consent experiences](/azure/active-directory/develop/application-consent-experience). <!-- |
v1.0 | Contentsharingsession | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/contentsharingsession.md | + + Title: "contentSharingSession resource type" +description: "Represents a content sharing session in a call." ++ms.localizationpriority: medium +++# contentSharingSession resource type ++Namespace: microsoft.graph ++Represents a content sharing session in a call. ++Inherits from [entity](../resources/entity.md). ++## Methods ++| Method | Return Type | Description | +|:|:-|:-| +| [Get contentSharingSession](../api/contentsharingsession-get.md ) | [contentSharingSession](contentsharingsession.md) | Retrieve the properties of a **contentSharingSession** object in a call. | +| [List contentSharingSessions](../api/call-list-contentsharingsessions.md ) | [contentSharingSession](contentsharingsession.md) collection | Retrieve a list of **contentSharingSession** objects in a call. | +++## Properties ++| Property | Type | Description | +|:|:-|:| +| id | String | Unique identifier for the content sharing session. Read-only. Inherited from [entity](../resources/entity.md). | ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.contentSharingSession" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.contentSharingSession", + "id": "String (identifier)" +} +``` |
v1.0 | Emailidentity | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/emailidentity.md | + + Title: "emailIdentity resource type" +description: "Represents the email identity of a user." ++ms.localizationpriority: medium +++# emailIdentity resource type ++Namespace: microsoft.graph ++Represents the email identity of a user. ++Inherits from [identity](../resources/identity.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Display name of the user. Inherited from [identity](../resources/identity.md).| +|email|String|Email address of the user.| +|id|String|The unique identifier for the user. Inherited from [identity](../resources/identity.md).| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.emailIdentity" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.emailIdentity", + "displayName": "String", + "email": "String", + "id": "String (identifier)" +} +``` |
v1.0 | Entity | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/entity.md | doc_type: resourcePageType Namespace: microsoft.graph +Represents an entity. + ## Properties | Property | Type |Description| |:|:--|:-|-|id|String| Read-only.| +|id|String| The unique idenfier for an entity. Read-only.| ## Relationships-None +None. ## JSON representation -Here is a JSON representation of the resource +The following is a JSON representation of the resource. <!-- { "blockType": "resource", |
v1.0 | Enums | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/enums.md | Possible values for user account types (group membership), per Windows definitio |chunkFinished| |unknownFutureValue| +### payloadDeliveryPlatform values ++|Member| +|:| +|unknown| +|sms| +|email| +|teams| +|unknownFutureValue| ++### trainingStatus values ++|Member| +|:| +|unknown| +|assigned| +|inProgress| +|completed| +|overdue| +|unknownFutureValue| + ### teamworkCallEventType values |Member| |
v1.0 | Eventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/eventmessagedetail.md | Represents details of a system event message. System messages are messages generated for events such as [members](../resources/conversationMember.md) added to a [channel](../resources/channel.md), **members** added to a [chat](../resources/chat.md), and [team](../resources/team.md) description updated. -List of events supported +### Supported events | Event | Description | | :- | :- | List of events supported | [membersDeletedEventMessageDetail](../resources/membersdeletedeventmessagedetail.md) | **Members** have been removed. | | [membersJoinedEventMessageDetail](../resources/membersjoinedeventmessagedetail.md) | **Members** have joined. | | [membersLeftEventMessageDetail](../resources/memberslefteventmessagedetail.md) | **Members** have left. |+| [messagePinnedEventMessageDetail](../resources/messagepinnedeventmessagedetail.md) | A message has been pinned. | +| [messageUnpinnedEventMessageDetail](../resources/messageunpinnedeventmessagedetail.md) | A message has been unpinned. | | [tabUpdatedEventMessageDetail](../resources/tabupdatedeventmessagedetail.md) | A tab has been updated. | | [teamArchivedEventMessageDetail](../resources/teamarchivedeventmessagedetail.md) | A **team** has been archived. | | [teamCreatedEventMessageDetail](../resources/teamcreatedeventmessagedetail.md) | A **team** has been created. | |
v1.0 | Identityprotection Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/identityprotection-overview.md | Title: "Use the Microsoft Graph identity protection APIs" description: "Use Microsoft Graph to query and receive information about risks detected by Azure AD Identity Protection."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: conceptualPageType |
v1.0 | Identityprotectionroot | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/identityprotectionroot.md | Title: "identityProtectionRoot resource type" description: "Container for navigation properties for Microsoft Graph identity protection resources."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Incomingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/incomingcalloptions.md | + + Title: "incomingCallOptions resource type" +description: "Represents a class that contains the options for an incoming call." ++ms.localizationpriority: medium +++# incomingCallOptions resource type ++Namespace: microsoft.graph ++Represents a class that contains the options for an incoming call. ++Inherits from [callOptions](calloptions.md). ++## Properties ++| Property | Type | Description | +|:|:--|:| +| hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | +| isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). | ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.incomingCallOptions" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.incomingCallOptions", + "hideBotAfterEscalation": "Boolean", + "isContentSharingNotificationEnabled": "Boolean" +} +``` |
v1.0 | Messagepinnedeventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/messagepinnedeventmessagedetail.md | + + Title: "messagePinnedEventMessageDetail resource type" +description: "Represents the details of an event message about a pinned chat message." ++ms.localizationpriority: medium +++# messagePinnedEventMessageDetail resource type ++Namespace: microsoft.graph ++Represents the details of an event message about a pinned [chatMessage](../resources/chatmessage.md). This message is generated when a chat message is pinned. ++Inherits from [eventMessageDetail](../resources/eventmessagedetail.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|eventDateTime|DateTimeOffset|Date and time when the event occurred.| +|initiator|[identitySet](../resources/identityset.md)|Initiator of the event.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.messagePinnedEventMessageDetail", + "baseType": "microsoft.graph.eventMessageDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.messagePinnedEventMessageDetail", + "eventDateTime": "String (timestamp)", + "initiator": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` ++## See also +- [Example response for an event message about a pinned chat message](/graph/system-messages/#message-pinned) +- [System messages](/graph/system-messages) |
v1.0 | Messageunpinnedeventmessagedetail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/messageunpinnedeventmessagedetail.md | + + Title: "messageUnpinnedEventMessageDetail resource type" +description: "Represents the details of an event message about an unpinned chat message." ++ms.localizationpriority: medium +++# messageUnpinnedEventMessageDetail resource type ++Namespace: microsoft.graph ++Represents the details of an event message about an unpinned [chatMessage](../resources/chatmessage.md). This message is generated when a chat message is unpinned. ++Inherits from [eventMessageDetail](../resources/eventmessagedetail.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|eventDateTime|DateTimeOffset|Date and time when the event occurred.| +|initiator|[identitySet](../resources/identityset.md)|Initiator of the event.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.messageUnpinnedEventMessageDetail", + "baseType": "microsoft.graph.eventMessageDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.messageUnpinnedEventMessageDetail", + "eventDateTime": "String (timestamp)", + "initiator": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` ++## See also +- [Example response for an event message about an unpinned chat message](/graph/system-messages/#message-unpinned) +- [System messages](/graph/system-messages) |
v1.0 | Oauth2permissiongrant | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/oauth2permissiongrant.md | Delegated permissions are sometimes referred to as "OAuth 2.0 scopes" or "scopes | consentType | String | Indicates if authorization is granted for the client application to impersonate all users or only a specific user. *AllPrincipals* indicates authorization to impersonate all users. *Principal* indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports `$filter` (`eq` only). | | principalId | String | The **id** of the [user](user.md) on behalf of whom the client is authorized to access the resource, when **consentType** is *Principal*. If **consentType** is *AllPrincipals* this value is null. Required when **consentType** is *Principal*. Supports `$filter` (`eq` only).| | resourceId | String | The **id** of the resource [service principal](serviceprincipal.md) to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports `$filter` (`eq` only). |-| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **oauth2PermissionScopes** property of the resource [service principal](serviceprincipal.md). | +| scope | String | A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, `openid User.Read GroupMember.Read.All`. Each claim value should match the **value** field of one of the delegated permissions defined by the API, listed in the **oauth2PermissionScopes** property of the resource [service principal](serviceprincipal.md). Must not exceed 3850 characters in length.| ## Relationships |
v1.0 | Outgoingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/outgoingcalloptions.md | + + Title: "outgoingCallOptions resource type" +description: "Represents a class that contains the options for an outgoing call." ++ms.localizationpriority: medium +++# outgoingCallOptions resource type ++Namespace: microsoft.graph ++Represents a class that contains the options for an outgoing call. ++Inherits from [callOptions](calloptions.md). ++## Properties ++| Property | Type | Description | +|:|:--|:| +| hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | +| isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). | ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.outgoingCallOptions" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.outgoingCallOptions", + "hideBotAfterEscalation": "Boolean", + "isContentSharingNotificationEnabled": "Boolean" +} +``` |
v1.0 | Pinnedchatmessageinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/pinnedchatmessageinfo.md | + + Title: "pinnedChatMessageInfo resource type" +description: "Represents an individual pinned message in a chat entity." ++ms.localizationpriority: medium +++# pinnedChatMessageInfo resource type ++Namespace: microsoft.graph ++Represents an individual pinned message in a [chat](chat.md). ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List pinned messages](../api/chat-list-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md) collection|Get a list of [pinnedChatMessages](../resources/pinnedChatMessageInfo.md) in a [chat](../resources/chat.md).| +|[Pin message](../api/chat-post-pinnedmessages.md)|[pinnedChatMessageInfo](../resources/pinnedchatmessageinfo.md)|Pin a chat message in the specified [chat](../resources/chat.md).| +|[Unpin message](../api/chat-delete-pinnedmessages.md)|None|Unpin a message from a [chat](../resources/chat.md).| ++## Properties +|Property|Type|Description| +|:|:|:| +| id| String| The ID of the [chatMessage](../resources/chatmessage.md). Read-only. | ++## Relationships +|Relationship|Type|Description| +|:|:|:| +| message | [chatMessage](../resources/chatmessage.md) | Represents details about the chat message that is pinned.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.pinnedChatMessageInfo", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.pinnedChatMessageInfo", + "id": "String (identifier)" +} +``` |
v1.0 | Privilegedidentitymanagementv3 Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/privilegedidentitymanagementv3-overview.md | For more information about role settings, see [Configure Azure AD role settings ## PIM and identity security with Zero Trust -PIM APIs support organizations to adopt a Zero Trust approach to secure the identities in their organization. For more information about Zero Trust, see [Securing identity with Zero Trust](/security/zero-trust/deploy/identity). +PIM APIs support organizations to adopt a Zero Trust approach to secure the identities in their organization. For more information about Zero Trust, see [Securing identity with Zero Trust](/security/zero-trust/deploy/identity#secure-privileged-access-with-privileged-identity-management). ## Permissions and privileges The PIM API requires an Azure AD Premium P2 license. For more information, see [ + [What is Azure AD Identity Governance?](/azure/active-directory/governance/identity-governance-overview) + [What is Azure AD Privileged Identity Management?](/azure/active-directory/privileged-identity-management/pim-configure) + [Tutorial: Use the Privileged Identity Management (PIM) API to assign Azure AD roles](/graph/tutorial-assign-azureadroles)-+ You can also set up access reviews of role assignments and eligibilities that are managed through PIM. For more information, see [Tutorial: Use the Privileged Identity Management (PIM) API to assign Azure AD roles](/graph/tutorial-assign-azureadroles). ++ You can also set up access reviews of role assignments and eligibilities that are managed through PIM. For more information, see [Tutorial: Use the Privileged Identity Management (PIM) API to assign Azure AD roles](/graph/tutorial-assign-azureadroles). |
v1.0 | Recommendedaction | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/recommendedaction.md | + + Title: "recommendedAction resource type" +description: "Represents recommended actions for a tenant based on the attack simulation and training campaign to improve its security posture." ++ms.localizationpriority: medium +++# recommendedAction resource type ++Namespace: microsoft.graph ++Represents recommended actions for a tenant based on the attack simulation and training campaign to improve its security posture. ++## Properties +|Property|Type|Description| +|:|:|:| +|actionWebUrl|String|Web URL to the recommended action.| +|potentialScoreImpact|Double|Potential improvement in the tenant security score from the recommended action.| +|title|String|Title of the recommended action.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.recommendedAction" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.recommendedAction", + "actionWebUrl": "String", + "potentialScoreImpact": "Double", + "title": "String" +} +``` |
v1.0 | Report M365defender Reports Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/report-m365defender-reports-overview.md | + + Title: "Reports API overview for attack simulation training as part of Microsoft Defender for Office 365" +description: "This section describes reporting capabilities of Microsoft Defender for Office 365, specifically APIs that access reports on a tenant's participation in attack simulation training." +ms.localizationpriority: high ++++# Reports API overview for attack simulation training as part of Microsoft Defender for Office 365 +++This section describes reporting capabilities of Microsoft Defender for Office 365, specifically APIs that access reports on a tenant's participation in attack simulation training. Attack simulation trainings set up benign cyberattack simulations to train users in the tenant to increase their awareness, and help identify vulnerable users. ++## What role do the attack simulation reports play in enterprise defense? ++Attack simulation reports help tenant administrators identify security knowledge gaps, so that they can further train their users to decrease their susceptibility to attacks. The attack simulation training service is part of [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/defender-for-office-365?view=o365-worldwide&preserve-view=true) which safeguards your organization against malicious threats posed by email messages, links (URLs), and collaboration tools. ++Microsoft Defender for Office 365 belongs to the [Microsoft 365 Defender](/microsoft-365/security/defender/microsoft-365-defender?view=o365-worldwide&preserve-view=true) suite which includes the following ++- [Microsoft Defender for Endpoint](/microsoft-365/security/defender-endpoint/microsoft-defender-endpoint) +- [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/overview) +- [Microsoft Defender for Identity](/defender-for-identity/) +- [Microsoft Defender for Cloud Apps](/cloud-app-security/) ++Microsoft 365 Defender is a unified enterprise defense suite that helps detect security risks, investigate attacks to an organization, and prevent harmful activities automatically. It provides a central administrators portal ([https://security.microsoft.com/](https://security.microsoft.com)) that combines protection, detection, investigation, and response to _email_, _collaboration_, _identity_, and _device_ threats. ++To access attack simulation training, open the Microsoft 365 Defender portal, go to **Email & collaboration** > **Attack simulation training**. ++## Authorization ++Microsoft Graph controls access to resources using permissions. You must specify the permissions you need in order to access reports resources. For more information, see [Microsoft Graph permissions reference](/graph/permissions-reference) and [reports permissions](/graph/permissions-reference#reports-permissions). ++## What kinds of data do the reports return? ++| Kinds of data | Resource | API | +|:- |: |:| +| Vulnerable repeat offenders in a tenant | [attackSimulationRepeatOffender](attacksimulationrepeatoffender.md) | [getAttackSimulationRepeatOffenders](../api/securityreportsroot-getattacksimulationrepeatoffenders.md) | +| Simulation data and results for each user in a tenant | [attackSimulationSimulationUserCoverage](attacksimulationsimulationusercoverage.md) | [getAttackSimulationSimulationUserCoverage](../api/securityreportsroot-getattacksimulationsimulationusercoverage.md) | +| Training coverage for each user in a tenant | [attackSimulationTrainingUserCoverage](attacksimulationtrainingusercoverage.md) | [getAttackSimulationTrainingUserCoverage](../api/securityreportsroot-getattacksimulationtrainingusercoverage.md) | ++## Next steps ++Reports resources and APIs can open up new ways for you to engage with users and manage their experiences with Microsoft Graph. To learn more: ++- Drill down on the methods and properties of the resources most helpful to your scenario. +- Try the API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). |
v1.0 | Riskdetection | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/riskdetection.md | Title: "riskDetection resource type" description: "risk detections"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Riskuseractivity | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/riskuseractivity.md | Title: "riskUserActivity resource type" description: "riskUserActivity detections"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Riskyuser | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/riskyuser.md | Title: "riskyUser resource type" description: "risky users item"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Riskyuserhistoryitem | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/riskyuserhistoryitem.md | Title: "riskyUserHistoryItem resource type" description: "risky user history item"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Roomlist | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/roomlist.md | doc_type: "resourcePageType" Namespace: microsoft.graph - Represents a group of [room](room.md) objects defined in the tenant. Derived from [place](place.md). |
v1.0 | Security Attacksimulationinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/security-attacksimulationinfo.md | + + Title: "attackSimulationInfo resource type" +description: "Represents attack simulation information for threat submission." ++ms.localizationpriority: medium +++# attackSimulationInfo resource type ++Namespace: microsoft.graph.security ++Represents attack simulation information for threat submission. If an email was an attack simulation email, the email threat submission would contain corresponding attack simulation information. ++## Properties +| Property | Type | Description | +|:-|:|:-| +| attackSimDateTime | DateTimeOffset | The date and time of the attack simulation. | +| attackSimDurationTime | Duration | The duration (in time) for the attack simulation. | +| attackSimId | Guid | The activity ID for the attack simulation. | +| attackSimUserId | String | The unique identifier for the user who got the attack simulation email. | ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.attackSimulationInfo" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.attackSimulationInfo", + "attackSimDateTime": "String (timestamp)", + "attackSimDurationTime": "String (duration)", + "attackSimId": "Guid", + "attackSimUserId": "String" +} +``` |
v1.0 | Securityreportsroot | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/securityreportsroot.md | + + Title: "securityReportsRoot resource type" +description: "Represents an abstract type that contains resources for attack simulation and training reports." ++ms.localizationpriority: medium +++# securityReportsRoot resource type ++Namespace: microsoft.graph ++Represents an abstract type that contains resources for attack simulation and training reports. This resource provides the ability to launch a realistic simulated phishing attack that organizations can learn from. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get simulation coverage for users](../api/securityreportsroot-getattacksimulationsimulationusercoverage.md)|[attackSimulationSimulationUserCoverage](../resources/attacksimulationsimulationusercoverage.md) collection|List [training coverage](../resources/attacksimulationtrainingusercoverage.md) for each tenant user in attack simulation and training campaigns.| +|[Get training coverage for users](../api/securityreportsroot-getattacksimulationtrainingusercoverage.md)|[attackSimulationTrainingUserCoverage](../resources/attacksimulationtrainingusercoverage.md) collection|List training coverage for tenant users in attack simulation and training campaigns.| +|[Get repeat offenders](../api/securityreportsroot-getattacksimulationrepeatoffenders.md)|[attackSimulationRepeatOffender](../resources/attacksimulationrepeatoffender.md) collection|List the tenant users who have yielded to attacks more than once in attack simulation and training campaigns.| ++## Properties +None. ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.securityReportsRoot", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.securityReportsRoot", +} +``` + |
v1.0 | Simulation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/simulation.md | + + Title: "simulation resource type" +description: "Represents an attack simulation training campaign in a tenant." ++ms.localizationpriority: medium +++# simulation resource type ++Namespace: microsoft.graph ++Represents an attack simulation training campaign in a tenant. ++Attack simulation and training is a service available as part of [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/defender-for-office-365?view=o365-worldwide&preserve-view=true). This service lets tenant users experience a realistic benign phishing attack and learn from it. The service enables tenant administrators to simulate, assign trainings, and read derived insights into online behaviors of users in the phishing simulations. The service provides attack simulation reports that help tenants identify security knowledge gaps, so that they can further train their users to decrease their susceptibility to attacks. ++The attack simulation and training API enables tenant administrators to list launched **simulation** exercises and trainings, and get [reports](report-m365defender-reports-overview.md) on derived insights into online behaviors of users in the phishing simulations. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List simulations](../api/attacksimulationroot-list-simulations.md)|[simulation](../resources/simulation.md) collection|Get a list of attack simulation campaigns for a tenant.| +|[Get simulation](../api/attacksimulationroot-get-simulations.md)|[simulation](../resources/simulation.md)|Get an attack simulation campaign for a tenant.| ++## Properties +|Property|Type|Description| +|:|:|:| +|attackTechnique|[simulationAttackTechnique](#simulationattacktechnique-values)|The social engineering technique used in the attack simulation and training campaign. Supports `$filter` and `$orderby`. Possible values are: `unknown`, `credentialHarvesting`, `attachmentMalware`, `driveByUrl`, `linkInAttachment`, `linkToMalwareFile`, `unknownFutureValue`. For more information on the types of social engineering attack techniques, see [simulations](/microsoft-365/security/office-365-security/attack-simulation-training-get-started?view=o365-worldwide&preserve-view=true#simulations).| +|attackType|[simulationAttackType](#simulationattacktype-values)|Attack type of the attack simulation and training campaign. Supports `$filter` and `$orderby`. Possible values are: `unknown`, `social`, `cloud`, `endpoint`, `unknownFutureValue`.| +|automationId|String|Unique identifier for the attack simulation automation.| +|completionDateTime|DateTimeOffset|Date and time of completion of the attack simulation and training campaign. Supports `$filter` and `$orderby`.| +|createdBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who created the attack simulation and training campaign.| +|createdDateTime|DateTimeOffset|Date and time of creation of the attack simulation and training campaign.| +|description|String|Description of the attack simulation and training campaign.| +|displayName|String|Display name of the attack simulation and training campaign. Supports `$filter` and `$orderby`.| +|id|String|Unique identifier for the attack simulation and training campaign. Inherited from [entity](../resources/entity.md).| +|isAutomated|Boolean|Flag that represents if the attack simulation and training campaign was created from a simulation automation flow. Supports `$filter` and `$orderby`. | +|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who most recently modified the attack simulation and training campaign.| +|lastModifiedDateTime|DateTimeOffset|Date and time of the most recent modification of the attack simulation and training campaign.| +|launchDateTime|DateTimeOffset|Date and time of the launch/start of the attack simulation and training campaign. Supports `$filter` and `$orderby`.| +|payloadDeliveryPlatform|payloadDeliveryPlatform|Method of delivery of the phishing payload used in the attack simulation and training campaign. Possible values are: `unknown`, `sms`, `email`, `teams`, `unknownFutureValue`.| +|report|[simulationReport](../resources/simulationreport.md)|Report of the attack simulation and training campaign.| +|status|[simulationStatus](#simulationstatus-values)|Status of the attack simulation and training campaign. Supports `$filter` and `$orderby`. Possible values are: `unknown`, `draft`, `running`, `scheduled`, `succeeded`, `failed`, `cancelled`, `excluded`, `unknownFutureValue`.| ++### simulationStatus values ++|Member|Description | +|:|:| +|unknown| The simulation status is not 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. | +|cancelled| The simulation is cancelled. | +|excluded| The simulation is excluded. | +|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | ++### simulationAttackTechnique values ++|Member|Description | +|:|:| +|unknown| Attack technique not defined. | +|credentialHarvesting| Attack technique that involves an end user supplying credentials. | +|attachmentMalware| Attack technique that involves an end user clicking an attachment. | +|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. | ++### simulationAttackType values ++|Member|Description | +|:|:| +|unknown| Attack type not identified. | +|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. | ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.simulation", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.simulation", + "attackTechnique": "String", + "attackType": "String", + "automationId": "String", + "completionDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.emailIdentity" + }, + "createdDateTime": "String (timestamp)", + "description": "String", + "displayName": "String", + "id": "String (identifier)", + "isAutomated": "Boolean", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.emailIdentity" + }, + "lastModifiedDateTime": "String (timestamp)", + "launchDateTime": "String (timestamp)", + "payloadDeliveryPlatform": "String", + "report": { + "@odata.type": "microsoft.graph.simulationReport" + }, + "status": "String" +} +``` +++## See also +- [Simulate a phishing attack](/microsoft-365/security/office-365-security/attack-simulation-training?view=o365-worldwide&preserve-view=true) +- [Get started using attack simulation training](/microsoft-365/security/office-365-security/attack-simulation-training-get-started?view=o365-worldwide&preserve-view=true#simulations). |
v1.0 | Simulationautomation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/simulationautomation.md | + + Title: "simulationAutomation resource type" +description: "Represents simulation automation created to run on a tenant." ++ms.localizationpriority: medium +++# simulationAutomation resource type ++Namespace: microsoft.graph ++Represents simulation automation created to run on a tenant. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List simulationAutomations](../api/attacksimulationroot-list-simulationautomations.md)|[simulationAutomation](../resources/simulationautomation.md) collection|Get a list of attack simulation automations for a tenant.| +|[Get simulationAutomation](../api/attacksimulationroot-get-simulationautomations.md)|[simulationAutomation](../resources/simulationautomation.md)|Get an attack simulation automation for a tenant.| +|[List runs](../api/simulationautomation-list-runs.md)|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|Get a list of the attack simulation automation runs for a tenant.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who created the attack simulation automation.| +|createdDateTime|DateTimeOffset|Date and time when the attack simulation automation was created.| +|description|String|Description of the attack simulation automation.| +|displayName|String|Display name of the attack simulation automation. Supports `$filter` and `$orderby`.| +|id|String|Unique identifier for the attack simulation automation. Inherited from [entity](../resources/entity.md).| +|lastModifiedBy|[emailIdentity](../resources/emailidentity.md)|Identity of the user who most recently modified the attack simulation automation.| +|lastModifiedDateTime|DateTimeOffset|Date and time when the attack simulation automation was most recently modified.| +|lastRunDateTime|DateTimeOffset|Date and time of the latest run of the attack simulation automation.| +|nextRunDateTime|DateTimeOffset|Date and time of the upcoming run of the attack simulation automation.| +|status|[simulationAutomationStatus](#simulationautomationstatus-values)|Status of the attack simulation automation. Supports `$filter` and `$orderby`. The possible values are: `unknown`, `draft`, `notRunning`, `running`, `completed`, `unknownFutureValue`.| ++### simulationAutomationStatus values ++|Member|Description | +|:|:| +|unknown| The status of the simulation automation is not defined. | +|draft| The simulation automation is in draft mode. | +|notRunning| The simulation automation is not running. | +|running| The simulation automation is running. | +|completed| The simulation automation has completed. | +|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|runs|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|A collection of simulation automation runs. | ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.simulationAutomation", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.simulationAutomation", + "createdBy": { + "@odata.type": "microsoft.graph.emailIdentity" + }, + "createdDateTime": "String (timestamp)", + "description": "String", + "displayName": "String", + "id": "String (identifier)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.emailIdentity" + }, + "lastModifiedDateTime": "String (timestamp)", + "lastRunDateTime": "String (timestamp)", + "nextRunDateTime": "String (timestamp)", + "status": "String" +} +``` + |
v1.0 | Simulationautomationrun | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/simulationautomationrun.md | + + Title: "simulationAutomationRun resource type" +description: "Represents a run of an attack simulation automation on a tenant." ++ms.localizationpriority: medium +++# simulationAutomationRun resource type ++Namespace: microsoft.graph ++Represents a run of an attack simulation automation on a tenant. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List runs](../api/simulationautomation-list-runs.md)|[simulationAutomationRun](../resources/simulationautomationrun.md) collection|Get a list of the attack simulation automation runs for a tenant.| ++## Properties +|Property|Type|Description| +|:|:|:| +|endDateTime|DateTimeOffset|Date and time when the run ends in an attack simulation automation.| +|id|String|Unique identifier for the run of an attack simulation automation. Inherited from [entity](../resources/entity.md).| +|simulationId|String|Unique identifier for the attack simulation campaign initiated in the attack simulation automation run.| +|startDateTime|DateTimeOffset|Date and time when the run starts in an attack simulation automation.| +|status|[simulationAutomationRunStatus](#simulationautomationrunstatus-values)|Status of the attack simulation automation run. The possible values are: `unknown`, `running`, `succeeded`, `failed`, `skipped`, `unknownFutureValue`.| ++### simulationAutomationRunStatus values ++|Member|Description | +|:|:| +|unknown| The status of a simulation automation run is not defined. | +|running| The simulation automation run is running. | +|succeeded| The simulation automation run has succeeded. | +|failed| The simulation automation run has failed. | +|skipped| The simulation automation run has skipped. | +|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. | ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.simulationAutomationRun", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.simulationAutomationRun", + "endDateTime": "String (timestamp)", + "id": "String (identifier)", + "simulationId": "String", + "startDateTime": "String (timestamp)", + "status": "String" +} +``` + |
v1.0 | Simulationevent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/simulationevent.md | + + Title: "simulationEvent resource type" +description: "Represents a simulation event in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# simulationEvent resource type ++Namespace: microsoft.graph ++Represents a simulation event in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|count|Int32|Count of the simulation event occurrence in an attack simulation and training campaign.| +|eventName|String|Name of the simulation event in an attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.simulationEvent" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.simulationEvent", + "count": "Int32", + "eventName": "String" +} +``` + |
v1.0 | Simulationeventscontent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/simulationeventscontent.md | + + Title: "simulationEventsContent resource type" +description: "Represents simulation events in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# simulationEventsContent resource type ++Namespace: microsoft.graph ++Represents simulation events in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|compromisedRate|Double|Actual percentage of users who fell for the simulated attack in an attack simulation and training campaign.| +|events|[simulationEvent](../resources/simulationevent.md) collection|List of simulation events in an attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.simulationEventsContent" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.simulationEventsContent", + "compromisedRate": "Double", + "events": [ + { + "@odata.type": "microsoft.graph.simulationEvent" + } + ] +} +``` |
v1.0 | Simulationreport | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/simulationreport.md | + + Title: "simulationReport resource type" +description: "Represents a report of an attack simulation and training campaign, including an overview and users who participated in the campaign." ++ms.localizationpriority: medium +++# simulationReport resource type ++Namespace: microsoft.graph ++Represents a report of an attack simulation and training campaign, including an overview and users who participated in the campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|overview|[simulationReportOverview](../resources/simulationreportoverview.md)|Overview of an attack simulation and training campaign.| +|simulationUsers|[userSimulationDetails](../resources/usersimulationdetails.md) collection|The tenant users and their online actions in an attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.simulationReport" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.simulationReport", + "overview": { + "@odata.type": "microsoft.graph.simulationReportOverview" + }, + "simulationUsers": [ + { + "@odata.type": "microsoft.graph.userSimulationDetails" + } + ] +} +``` + |
v1.0 | Simulationreportoverview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/simulationreportoverview.md | + + Title: "simulationReportOverview resource type" +description: "Represents an overview report of an attack simulation and training campaign." ++ms.localizationpriority: medium +++# simulationReportOverview resource type ++Namespace: microsoft.graph ++Represents an overview report of an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|recommendedActions|[recommendedAction](../resources/recommendedaction.md) collection|List of recommended actions for a tenant to improve its security posture based on the attack simulation and training campaign attack type.| +|resolvedTargetsCount|Int32|Number of valid users in the attack simulation and training campaign.| +|simulationEventsContent|[simulationEventsContent](../resources/simulationeventscontent.md)|Summary of simulation events in the attack simulation and training campaign.| +|trainingEventsContent|[trainingEventsContent](../resources/trainingeventscontent.md)|Summary of assigned trainings in the attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.simulationReportOverview" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.simulationReportOverview", + "recommendedActions": [ + { + "@odata.type": "microsoft.graph.recommendedAction" + } + ], + "resolvedTargetsCount": "Int32", + "simulationEventsContent": { + "@odata.type": "microsoft.graph.simulationEventsContent" + }, + "trainingEventsContent": { + "@odata.type": "microsoft.graph.trainingEventsContent" + } +} +``` |
v1.0 | Trainingeventscontent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/trainingeventscontent.md | + + Title: "trainingEventsContent resource type" +description: "Represents training events in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# trainingEventsContent resource type ++Namespace: microsoft.graph ++Represents training events in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|assignedTrainingsInfos|[assignedTrainingInfo](../resources/assignedtraininginfo.md) collection|List of assigned trainings and their information in an attack simulation and training campaign.| +|trainingsAssignedUserCount|Int32|Number of users who were assigned trainings in an attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.trainingEventsContent" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trainingEventsContent", + "assignedTrainingsInfos": [ + { + "@odata.type": "microsoft.graph.assignedTrainingInfo" + } + ], + "trainingsAssignedUserCount": "Int32" +} +``` |
v1.0 | Usersimulationdetails | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/usersimulationdetails.md | + + Title: "userSimulationDetails resource type" +description: "Represents a user of a tenant and their online actions in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# userSimulationDetails resource type ++Namespace: microsoft.graph ++Represents a user of a tenant and their online actions in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|assignedTrainingsCount|Int32|Number of trainings assigned to a user in an attack simulation and training campaign.| +|completedTrainingsCount|Int32|Number of trainings completed by a user in an attack simulation and training campaign.| +|compromisedDateTime|DateTimeOffset|Date and time of the compromising online action by a user in an attack simulation and training campaign.| +|inProgressTrainingsCount|Int32|Number of trainings in progress by a user in an attack simulation and training campaign.| +|isCompromised|Boolean|Indicates whether a user was compromised in an attack simulation and training campaign.| +|reportedPhishDateTime|DateTimeOffset|Date and time when a user reported the delivered payload as phishing in the attack simulation and training campaign.| +|simulationEvents|[userSimulationEventInfo](../resources/usersimulationeventinfo.md) collection|List of simulation events of a user in the attack simulation and training campaign.| +|simulationUser|[attackSimulationUser](../resources/attacksimulationuser.md)|User in an attack simulation and training campaign.| +|trainingEvents|[userTrainingEventInfo](../resources/usertrainingeventinfo.md) collection|List of training events of a user in the attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.userSimulationDetails" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userSimulationDetails", + "assignedTrainingsCount": "Int32", + "completedTrainingsCount": "Int32", + "compromisedDateTime": "String (timestamp)", + "inProgressTrainingsCount": "Int32", + "isCompromised": "Boolean", + "reportedPhishDateTime": "String (timestamp)", + "simulationEvents": [ + { + "@odata.type": "microsoft.graph.userSimulationEventInfo" + } + ], + "simulationUser": { + "@odata.type": "microsoft.graph.attackSimulationUser" + }, + "trainingEvents": [ + { + "@odata.type": "microsoft.graph.userTrainingEventInfo" + } + ] +} +``` |
v1.0 | Usersimulationeventinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/usersimulationeventinfo.md | + + Title: "userSimulationEventInfo resource type" +description: "Represents a simulation event of a user in a tenant in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# userSimulationEventInfo resource type ++Namespace: microsoft.graph ++Represents a simulation event of a user in a tenant in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|browser|String|Browser information from where the simulation event was initiated by a user in an attack simulation and training campaign.| +|eventDateTime|DateTimeOffset|Date and time of the simulation event by a user in an attack simulation and training campaign.| +|eventName|String|Name of the simulation event by a user in an attack simulation and training campaign.| +|ipAddress|String|IP address from where the simulation event was initiated by a user in an attack simulation and training campaign.| +|osPlatformDeviceDetails|String|The operating system, platform, and device details from where the simulation event was initiated by a user in an attack simulation and training campaign.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.userSimulationEventInfo" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userSimulationEventInfo", + "browser": "String", + "eventDateTime": "String (timestamp)", + "eventName": "String", + "ipAddress": "String", + "osPlatformDeviceDetails": "String" +} +``` |
v1.0 | Usertrainingcontenteventinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/usertrainingcontenteventinfo.md | + + Title: "userTrainingContentEventInfo resource type" +description: "Represents training event details of assigned trainings to users in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# userTrainingContentEventInfo resource type ++Namespace: microsoft.graph ++Represents training event details of assigned trainings to users in an attack simulation and training campaign. ++## Properties +|Property|Type|Description| +|:|:|:| +|browser|String|Browser of the user from where the training event was generated.| +|contentDateTime|DateTimeOffset|Date and time of the training content playback by the user.| +|ipAddress|String|IP address of the user for the training event.| +|osPlatformDeviceDetails|String|The operating system, platform, and device details of the user for the training event.| +|potentialScoreImpact|Double|Potential improvement in the tenant security posture after completion of the training by the user.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.userTrainingContentEventInfo" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userTrainingContentEventInfo", + "browser": "String", + "contentDateTime": "String (timestamp)", + "ipAddress": "String", + "osPlatformDeviceDetails": "String", + "potentialScoreImpact": "Double" +} +``` + |
v1.0 | Usertrainingeventinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/usertrainingeventinfo.md | + + Title: "userTrainingEventInfo resource type" +description: "Represents events of a training assigned to a user in an attack simulation and training campaign." ++ms.localizationpriority: medium +++# userTrainingEventInfo resource type ++Namespace: microsoft.graph ++Represents events of a training assigned to a user in an attack simulation and training campaign. Training events include assigning the training, updating the training in progress, and completing the training. ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|Display name of the training.| +|latestTrainingStatus|trainingStatus|Latest status of the training assigned to the user. Possible values are: `unknown`, `assigned`, `inProgress`, `completed`, `overdue`, `unknownFutureValue`.| +|trainingAssignedProperties|[userTrainingContentEventInfo](../resources/usertrainingcontenteventinfo.md)|Event details of the training when it was assigned to the user.| +|trainingCompletedProperties|[userTrainingContentEventInfo](../resources/usertrainingcontenteventinfo.md)|Event details of the training when it was completed by the user.| +|trainingUpdatedProperties|[userTrainingContentEventInfo](../resources/usertrainingcontenteventinfo.md)|Event details of the training when it was updated/in-progress by the user.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.userTrainingEventInfo" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userTrainingEventInfo", + "displayName": "String", + "latestTrainingStatus": "String", + "trainingAssignedProperties": { + "@odata.type": "microsoft.graph.userTrainingContentEventInfo" + }, + "trainingCompletedProperties": { + "@odata.type": "microsoft.graph.userTrainingContentEventInfo" + }, + "trainingUpdatedProperties": { + "@odata.type": "microsoft.graph.userTrainingContentEventInfo" + } +} +``` |
v1.0 | Usertrainingstatusinfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/usertrainingstatusinfo.md | + + Title: "userTrainingStatusInfo resource type" +description: "Represents an assigned training and its status for a user in attack simulation and training." ++ms.localizationpriority: medium +++# userTrainingStatusInfo resource type ++Namespace: microsoft.graph ++Represents an assigned training and its status for a user in attack simulation and training. ++## Properties +|Property|Type|Description| +|:|:|:| +|assignedDateTime|DateTimeOffset|Date and time of assignment of the training to the user.| +|completionDateTime|DateTimeOffset|Date and time of completion of the training by the user.| +|displayName|String|Display name of the assigned training.| +|trainingStatus|trainingStatus|The status of the training assigned to the user. Possible values are: `unknown`, `assigned`, `inProgress`, `completed`, `overdue`, `unknownFutureValue`.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.userTrainingStatusInfo" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userTrainingStatusInfo", + "assignedDateTime": "String (timestamp)", + "completionDateTime": "String (timestamp)", + "displayName": "String", + "trainingStatus": "String" +} +``` + |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/toc.yml | a/api-reference/v1.0/toc.yml items: - name: Get operation status href: api/longrunningoperation-get.md - name: Temporary Access Pass+ displayName: TAP href: resources/temporaryaccesspassauthenticationmethod.md items: - name: List items: href: api/reportroot-getyammergroupsactivitygroupcounts.md - name: Get activity counts href: api/reportroot-getyammergroupsactivitycounts.md+ - name: Microsoft Defender for Office 365 security reports + items: + - name: Attack simulation reports + displayname: Attack simulation and training + href: resources/report-m365defender-reports-overview.md + - name: Repeat offender + items: + - name: Repeat offender + href: resources/attacksimulationrepeatoffender.md + - name: Get repeat offenders + href: api/securityreportsroot-getattacksimulationrepeatoffenders.md + - name: Simulation data + items: + - name: Simulation user coverage + href: resources/attacksimulationsimulationusercoverage.md + - name: Get simulation coverage for users + href: api/securityreportsroot-getattacksimulationsimulationusercoverage.md + - name: Training data + items: + - name: Training user coverage + href: resources/attacksimulationtrainingusercoverage.md + - name: Get training coverage for users + href: api/securityreportsroot-getattacksimulationtrainingusercoverage.md - name: Search displayname: Microsoft Search API items: items: href: api/securescorecontrolprofile-update.md - name: Errors href: resources/security-error-codes.md+ - name: Attack simulation and training + items: + - name: Simulations + items: + - name: Simulation + href: resources/simulation.md + - name: List + href: api/attacksimulationroot-list-simulations.md + - name: Get + href: api/attacksimulationroot-get-simulations.md + - name: List simulation users + href: api/usersimulationdetails-list.md + - name: Get simulation overview + href: api/simulationreportoverview-get.md + - name: Simulation automation + items: + - name: Simulation automation + href: resources/simulationautomation.md + - name: List + href: api/attacksimulationroot-list-simulationautomations.md + - name: Get + href: api/attacksimulationroot-get-simulationautomations.md + - name: Simulation automation run + items: + - name: Simulation automation run + href: resources/simulationautomationrun.md + - name: List + href: api/simulationautomation-list-runs.md + - name: Reports + items: + - name: Attack simulation reports + displayname: Attack simulation and training + href: resources/report-m365defender-reports-overview.md + - name: Repeat offenders + items: + - name: Repeat offender + href: resources/attacksimulationrepeatoffender.md + - name: Get repeat offenders + href: api/securityreportsroot-getattacksimulationrepeatoffenders.md + - name: Simulation data + items: + - name: Simulation user coverage + href: resources/attacksimulationsimulationusercoverage.md + - name: Get simulation coverage for users + href: api/securityreportsroot-getattacksimulationsimulationusercoverage.md + - name: Training data + items: + - name: Training user coverage + href: resources/attacksimulationtrainingusercoverage.md + - name: Get training coverage for users + href: api/securityreportsroot-getattacksimulationtrainingusercoverage.md - name: Sites and lists displayName: SharePoint, OneDrive, OneDrive for Business, OneDrive business, OneDrive personal items: items: - name: Log teleconference device quality data href: api/call-logteleconferencedevicequality.md - name: Content sharing session+ href: resources/contentsharingsession.md items: - name: Change screen sharing role href: api/call-changescreensharingrole.md+ - name: List + href: api/call-list-contentsharingsessions.md + - name: Get + href: api/contentsharingsession-get.md - name: IVR scenarios href: resources/calls-api-ivr-overview.md items: items: href: api/call-cancelmediaprocessing.md - name: Subscribe to tone href: api/call-subscribetotone.md+ - name: Large gallery view operation + items: + - name: Add large gallery view + href: api/call-addlargegalleryview.md + - name: Add large gallery view operation + href: resources/addlargegalleryviewoperation.md + items: + - name: Get large gallery view operation status + href: api/addlargegalleryviewoperation-get.md - name: Participant href: resources/participant.md items: items: href: api/chat-post-messages.md - name: Get chat between user and app href: api/userscopeteamsappinstallation-get-chat.md+ - name: List pinned messages + href: api/chat-list-pinnedmessages.md + - name: Pin message + href: api/chat-post-pinnedmessages.md + - name: Unpin message + href: api/chat-delete-pinnedmessages.md - name: Chat message href: resources/chatmessage.md items: items: href: api/chats-getallmessages.md - name: Get hosted content href: api/chatmessagehostedcontent-get.md+ - name: List pinned messages + href: api/chat-list-pinnedmessages.md + - name: Pin message + href: api/chat-post-pinnedmessages.md + - name: Unpin message + href: api/chat-delete-pinnedmessages.md + - name: Pinned chat message + href: resources/pinnedchatmessageinfo.md + items: + - name: List pinned messages + href: api/chat-list-pinnedmessages.md + - name: Pin message + href: api/chat-post-pinnedmessages.md + - name: Unpin message + href: api/chat-delete-pinnedmessages.md - name: Team href: resources/team.md items: |