Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
v1.0 | Accesspackageassignmentpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentpolicy-update.md | Content-Type: application/json [!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 | Accesspackagecatalog Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackagecatalog-delete.md | DELETE https://graph.microsoft.com/beta/identityGovernance/entitlementManagement [!INCLUDE [sample-code](../includes/snippets/go/delete-accesspackagecatalog-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-accesspackagecatalog-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Administrativeunit Post Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-post-members.md | POST /administrativeUnits/{id}/members In the request body, provide the `id` of a [user](../resources/user.md), [group](../resources/group.md), [device](../resources/device.md), or [directoryObject](../resources/directoryobject.md) to be added. ### Creating a new group-The following table shows the properties of the [group](../resources/group.md) resource to specify when you create a group in the administrative unit. +The following table shows the properties of the [group](../resources/group.md) resource to specify when you create a group in the administrative unit. | Property | Type | Description| |:|:--|:-| The following table shows the properties of the [group](../resources/group.md) r If successful, adding an existing object (using `$ref`) returns `204 No Content` response code. It does not return anything in the response body. -When creating a new group (without `$ref`), this method returns a `201 Created` response code and a [group](../resources/group.md) object in the response body. The response includes only the default properties of the group. +When creating a new group (without `$ref`), this method returns a `201 Created` response code and a [group](../resources/group.md) object in the response body. The response includes only the default properties of the group. You must supply the `"@odata.type" : "#microsoft.graph.group"` line in the request body to explicitly identify the new member as a group. A request body without the correct @odata.type returns a `400 Bad Request` error message. ## Examples ### Example 1: Add an existing user or group HTTP/1.1 204 No Content ``` ### Example 2: Create a new group-The following example creates a new group in the administrative unit. +The following example creates a new group in the administrative unit. You must supply the `"@odata.type" : "#microsoft.graph.group"` line in the request body to explicitly identify the new member as a group. A request body without the correct @odata.type returns a `400 Bad Request` error message. #### Request The following is an example of the request. The following is an example of the request. ``` http POST https://graph.microsoft.com/beta/administrativeUnits/{id}/members Content-type: application/json-Content-length: 244 {- "@odata.type": "#Microsoft.Graph.Group", + "@odata.type": "#microsoft.graph.group", "description": "Self help community for golf", "displayName": "Golf Assist", "groupTypes": [ |
v1.0 | Appcatalogs List Teamsapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appcatalogs-list-teamsapps.md | Namespace: microsoft.graph List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog. This includes apps from the Microsoft Teams store, as well as apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. -> [!NOTE] -> The `id` of a **teamsApp** resource is generated by the server and is not the same as the `id` specified in a Teams app manifest. The `id` provided by the developer as part of the Teams app manifest is stamped as the `externalId` in the **teamsApp** resource. +> [!NOTE] +> In general, the `id` of a **teamsApp** resource is generated by the server. It is not the same as the `id` specified in a Teams app manifest, unless its `distributionMethod` is *store*. For other cases, the `id` provided by the developer as part of the Teams app manifest is stamped as the `externalId` in the teamsApp resource. ## Permissions |
v1.0 | Application Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-delete.md | DELETE https://graph.microsoft.com/beta/applications/{id} [!INCLUDE [sample-code](../includes/snippets/go/delete-application-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-application-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Application Post Onlinemeetings | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-onlinemeetings.md | The following is an example of the response. } ``` -<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- -{ - "type": "#page.annotation", - "description": "Create onlineMeeting", - "keywords": "", - "section": "documentation", - "tocPath": "", - "suppressions": [ - ] -} >- ### 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 The following is an example of a request. >**Note:** The passcode is automatically generated and a custom passcode is not supported. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create-online-meeting-with-passcode" +}--> + ```http POST https://graph.microsoft.com/beta/me/onlineMeetings Content-Type: application/json Content-Type: application/json } ``` +# [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. The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- {- "blockType": "example", + "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.onlineMeeting" } --> Content-Type: application/json ### 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 The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create-online-meeting-without-passcode" +}--> + ```http POST https://graph.microsoft.com/beta/me/onlineMeetings Content-Type: application/json Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ or ```http The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- {- "blockType": "example", + "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.onlineMeeting" } --> Content-Type: application/json } } ```++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2015-10-25 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Create onlineMeeting", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + ] +} +--> |
v1.0 | Businessscenario Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenario-get.md | + + Title: "Get businessScenario" +description: "Read the properties and relationships of a businessScenario object." ++ms.localizationpriority: medium +++# Get businessScenario ++Namespace: microsoft.graph +++Read the properties and relationships of a [businessScenario](../resources/businessscenario.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)|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.Read.All, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For a specific business scenario based on its ID (primary key): ++``` http +GET /solutions/businessScenarios/{businessScenarioId} +``` ++For a specific business scenario based on its unique name: ++``` http +GET /solutions/businessScenarios(uniqueName='{uniqueName}') +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [businessScenario](../resources/businessscenario.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "get_businessscenario", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d +``` ++### 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.businessScenario" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenario", + "id": "c5d514e6c6864911ac46c720affb6e4d", + "displayName": "Contoso Order Tracking", + "uniqueName": "com.contoso.apps.ordertracking", + "ownerAppIds": [ + "44109254-4b2b-7a33-76ee-c890a167b295" + ] +} +``` |
v1.0 | Businessscenario Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenario-update.md | + + Title: "Update businessScenario" +description: "Update the properties of a businessScenario object." ++ms.localizationpriority: medium +++# Update businessScenario ++Namespace: microsoft.graph +++Update the properties of a [businessScenario](../resources/businessscenario.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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For a specific business scenario based on its ID (primary key): ++``` http +PATCH /solutions/businessScenarios/{businessScenarioId} +``` ++For a specific business scenario based on its unique name: ++``` http +PATCH /solutions/businessScenarios(uniqueName='{uniqueName}') +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|displayName|String|Display name of the scenario. Required.| +|ownerAppIds|String collection|Identifiers of applications that are authorized to work with this scenario. The application that creates the scenario will be automatically added to the list. Optional.| ++## Response ++If successful, this method returns a `200 OK` response code and an updated [businessScenario](../resources/businessscenario.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "update_businessscenario", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d +Content-Type: application/json ++{ + "ownerAppIds": [ + "44109254-4b2b-7a33-76ee-c890a167b295", "13eb9d8b-1d63-4153-9417-3a69ab200a78" + ] +} +``` ++### 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.businessScenario" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenario", + "id": "c5d514e6c6864911ac46c720affb6e4d", + "displayName": "Contoso Order Tracking", + "uniqueName": "com.contoso.apps.ordertracking", + "ownerAppIds": [ + "44109254-4b2b-7a33-76ee-c890a167b295", "13eb9d8b-1d63-4153-9417-3a69ab200a78" + ] +} +``` |
v1.0 | Businessscenarioplanner Delete Tasks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenarioplanner-delete-tasks.md | + + Title: "Delete businessScenarioTask" +description: "Delete a businessScenarioTask object." ++ms.localizationpriority: medium +++# Delete businessScenarioTask ++Namespace: microsoft.graph +++Delete a [businessScenarioTask](../resources/businessscenariotask.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)|BusinessScenarioData.ReadWrite.OwnedBy| +|Delegated (personal Microsoft account)|Not supported.| +|Application| BusinessScenarioData.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /solutions/businessScenarios/{businessScenarioId}/planner/tasks/{businessScenarioTaskId} +``` ++## 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. +<!-- { + "blockType": "request", + "name": "delete_businessscenariotask", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "pmc1rS1Io0C3rXQhyXIsNmUAOeIi"] +} +--> +``` http +DELETE https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks/pmc1rS1Io0C3rXQhyXIsNmUAOeIi +``` ++### Response ++The following is an example of the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Businessscenarioplanner Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenarioplanner-get.md | + + Title: "Get businessScenarioPlanner" +description: "Read the properties and relationships of a businessScenarioPlanner object." ++ms.localizationpriority: medium +++# Get businessScenarioPlanner ++Namespace: microsoft.graph +++Read the properties and relationships of a [businessScenarioPlanner](../resources/businessscenarioplanner.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)|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.Read.All, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/businessScenarios/{businessScenarioId}/planner +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [businessScenarioPlanner](../resources/businessscenarioplanner.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "get_businessscenarioplanner", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner +``` ++### 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.businessScenarioPlanner" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenarioPlanner", + "id": "54379e10-f935-5776-7a30-445837f15655" +} +``` |
v1.0 | Businessscenarioplanner Getplan | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenarioplanner-getplan.md | + + Title: "businessScenarioPlanner: getPlan" +description: "Get information about the plannerPlan mapped to a given target." ++ms.localizationpriority: medium +++# businessScenarioPlanner: getPlan ++Namespace: microsoft.graph +++Get information about the [plannerPlan](../resources/plannerplan.md) mapped to a given target. If a **plannerPlan** doesn't exist for the specified target at the time of the request, a new plan will be created for the [businessScenario](../resources/businessscenario.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)|BusinessScenarioData.Read.OwnedBy, BusinessScenarioData.ReadWrite.OwnedBy| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioData.Read.OwnedBy, BusinessScenarioData.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/businessScenarios/{businessScenarioId}/planner/getPlan +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the parameters. ++The following table shows the parameter that can be used with this action. ++|Parameter|Type|Description| +|:|:|:| +|target|[businessScenarioTaskTargetBase](../resources/businessscenariotasktargetbase.md)|Target for which to get the plan information.| ++## Response ++If successful, this action returns a `200 OK` response code and a [businessScenarioPlanReference](../resources/businessscenarioplanreference.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "businessscenarioplannerthis.getplan", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/getPlan +Content-Type: application/json ++{ + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + } +} +``` ++### 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.businessScenarioPlanReference" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenarioPlanReference", + "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi", + "title": "Order Tracking" +} +``` |
v1.0 | Businessscenarioplanner List Tasks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenarioplanner-list-tasks.md | + + Title: "List businessScenarioTasks" +description: "Get a list of the businessScenarioTask objects and their properties." ++ms.localizationpriority: medium +++# List businessScenarioTasks +Namespace: microsoft.graph +++Get a list of the [businessScenarioTask](../resources/businessscenariotask.md) objects and their properties. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|BusinessScenarioData.Read.OwnedBy, BusinessScenarioData.ReadWrite.OwnedBy| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioData.Read.OwnedBy, BusinessScenarioData.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/businessScenarios/{businessScenarioId}/planner/tasks +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). You can query tasks with their context ID or location as filters. ++## 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 [businessScenarioTask](../resources/businessscenariotask.md) objects in the response body. ++## Examples ++### Example 1: Get all tasks for a scenario ++The following example shows a request that gets all tasks related to a scenario. ++#### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_businessscenariotask", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks +``` ++#### 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.businessScenarioTask)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.businessScenarioTask", + "title": "Customer order #12010", + "percentComplete": 0, + "priority": 5, + "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi", + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + }, + "businessScenarioProperties": { + "externalObjectId": "Order#12010", + "externalContextId": "Warehouse-CA-36", + "externalObjectVersion": "000001", + "webUrl": "https://ordertracking.contoso.com/view?id=12010", + "externalBucketId": "deliveryBucket" + } + } + ] +} +``` ++### Example 2: Get tasks associated with a specific externalContextId ++The following example shows a request that gets all tasks associated with a specific context. ++#### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_businessscenariotask", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks?$filter=businessScenarioProperties/externalContextId eq 'Warehouse-CA-36' +``` ++#### 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.businessScenarioTask)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.businessScenarioTask", + "title": "Customer order #12010", + "percentComplete": 0, + "priority": 5, + "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi", + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + }, + "businessScenarioProperties": { + "externalObjectId": "Order#12010", + "externalContextId": "Warehouse-CA-36", + "externalObjectVersion": "000001", + "webUrl": "https://ordertracking.contoso.com/view?id=12010", + "externalBucketId": "deliveryBucket" + } + } + ] +} +``` ++### Example 3: Get scenario tasks created in a specific group ++The following example shows a request that gets all tasks created in a specific [group](../resources/group.md). ++#### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_businessscenariotask", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks?$filter=location/microsoft.graph.businessScenarioGroupTarget/groupId eq '7a339254-4b2b-4410-b295-c890a16776ee' +``` ++#### 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.businessScenarioTask)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.businessScenarioTask", + "title": "Customer order #12010", + "percentComplete": 0, + "priority": 5, + "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi", + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + }, + "businessScenarioProperties": { + "externalObjectId": "Order#12010", + "externalContextId": "Warehouse-CA-36", + "externalObjectVersion": "000001", + "webUrl": "https://ordertracking.contoso.com/view?id=12010", + "externalBucketId": "deliveryBucket" + } + } + ] +} +``` |
v1.0 | Businessscenarioplanner Post Tasks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenarioplanner-post-tasks.md | + + Title: "Create businessScenarioTask" +description: "Create a new businessScenarioTask object." ++ms.localizationpriority: medium +++# Create businessScenarioTask ++Namespace: microsoft.graph +++Create a new [businessScenarioTask](../resources/businessscenariotask.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)|BusinessScenarioData.ReadWrite.OwnedBy| +|Delegated (personal Microsoft account)|Not supported.| +|Application| BusinessScenarioData.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/businessScenarios/{businessScenarioId}/planner/tasks +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body ++In the request body, supply a JSON representation of the [businessScenarioTask](../resources/businessscenariotask.md) object. ++You can specify the following properties when you create a **businessScenarioTask**. ++|Property|Type|Description| +|:|:|:| +|appliedCategories|[plannerAppliedCategories](../resources/plannerappliedcategories.md)|The categories to which the task has been applied. For possible values, see [plannerAppliedCategories](../resources/plannerappliedcategories.md). Inherited from [plannerTask](../resources/plannertask.md).| +|assigneePriority|String|Hint used to order items of this type in a list view. For details about the supported format, see [Using order hints in Planner](../resources/planner-order-hint-format.md). Inherited from [plannerTask](../resources/plannertask.md).| +|assignments|[plannerAssignments](../resources/plannerassignments.md)|The set of assignees the task is assigned to. Inherited from [plannerTask](../resources/plannertask.md).| +|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. The [format validation](../resources/tasks-identifiers-disclaimer.md) is done on the service. Inherited from [plannerTask](../resources/plannertask.md).| +|businessScenarioProperties|[businessScenarioProperties](../resources/businessscenarioproperties.md)|Scenario-specific properties of the task. **externalObjectId** and **externalBucketId** properties must be specified when creating a task. Required.| +|conversationThreadId|String|Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the **group**. Inherited from [plannerTask](../resources/plannertask.md).| +|dueDateTime|DateTimeOffset|Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [plannerTask](../resources/plannertask.md).| +|orderHint|String|Hint used to order items of this type in a list view. For details about the supported format, see [Using order hints in Planner](../resources/planner-order-hint-format.md). Inherited from [plannerTask](../resources/plannertask.md).| +|percentComplete|Int32|Percentage of task completion. When set to `100`, the task is considered completed. Inherited from [plannerTask](../resources/plannertask.md).| +|planId|String|Identifier of the plan to which the task belongs. Inherited from [plannerTask](../resources/plannertask.md).| +|priority|Int32|Priority of the task. Valid range of values is between `0` and `10` (inclusive), with increasing value being lower priority (`0` has the highest priority and `10` has the lowest priority). Currently, Planner interprets values `0` and `1` as "urgent", `2`, `3`, and `4` as "important", `5`, `6`, and `7` as "medium", and `8`, `9`, and `10` as "low". Currently, Planner sets the value `1` for "urgent", `3` for "important", `5` for "medium", and `9` for "low". Inherited from [plannerTask](../resources/plannertask.md).| +|startDateTime|DateTimeOffset|Date and time at which the task starts. 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`. Inherited from [plannerTask](../resources/plannertask.md).| +|target|[businessScenarioTaskTargetBase](../resources/businessscenariotasktargetbase.md)|Target of the task that specifies where the task should be placed. Required.| +|title|String|Title of the task. Inherited from [plannerTask](../resources/plannertask.md).| ++## Response ++If successful, this method returns a `201 Created` response code and a [businessScenarioTask](../resources/businessscenariotask.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "create_businessscenariotask_from_", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenarioTask", + "title": "Customer order #12010", + "percentComplete": 0, + "priority": 5, + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + }, + "businessScenarioProperties": { + "externalObjectId": "Order#12010", + "externalContextId": "Warehouse-CA-36", + "externalObjectVersion": "000001", + "webUrl": "https://ordertracking.contoso.com/view?id=12010", + "externalBucketId": "deliveryBucket" + } +} +``` ++### 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.businessScenarioTask" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenarioTask", + "title": "Customer order #12010", + "percentComplete": 0, + "priority": 5, + "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi", + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + }, + "businessScenarioProperties": { + "externalObjectId": "Order#12010", + "externalContextId": "Warehouse-CA-36", + "externalObjectVersion": "000001", + "webUrl": "https://ordertracking.contoso.com/view?id=12010", + "externalBucketId": "deliveryBucket" + } +} +``` |
v1.0 | Businessscenariotask Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenariotask-get.md | + + Title: "Get businessScenarioTask" +description: "Read the properties and relationships of a businessScenarioTask object." ++ms.localizationpriority: medium +++# Get businessScenarioTask ++Namespace: microsoft.graph +++Read the properties and relationships of a [businessScenarioTask](../resources/businessscenariotask.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)|BusinessScenarioData.Read.OwnedBy, BusinessScenarioData.ReadWrite.OwnedBy| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioData.Read.OwnedBy, BusinessScenarioData.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/businessScenarios/{businessScenarioId}/planner/tasks/{businessScenarioTaskId} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [businessScenarioTask](../resources/businessscenariotask.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "get_businessscenariotask", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "pmc1rS1Io0C3rXQhyXIsNmUAOeIi"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks/pmc1rS1Io0C3rXQhyXIsNmUAOeIi +``` ++### 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.businessScenarioTask" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "title": "Customer order #12010", + "percentComplete": 0, + "priority": 5, + "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi", + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + }, + "businessScenarioProperties": { + "externalObjectId": "Order#12010", + "externalContextId": "Warehouse-CA-36", + "externalObjectVersion": "000001", + "webUrl": "https://ordertracking.contoso.com/view?id=12010", + "externalBucketId": "deliveryBucket" + } +} +``` |
v1.0 | Businessscenariotask Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/businessscenariotask-update.md | + + Title: "Update businessScenarioTask" +description: "Update the properties of a businessScenarioTask object." ++ms.localizationpriority: medium +++# Update businessScenarioTask ++Namespace: microsoft.graph +++Update the properties of a [businessScenarioTask](../resources/businessscenariotask.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)|BusinessScenarioData.ReadWrite.OwnedBy| +|Delegated (personal Microsoft account)|Not supported.| +|Application| BusinessScenarioData.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /solutions/businessScenarios/{businessScenarioId}/planner/tasks/{businessScenarioTaskId} +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|appliedCategories|[plannerAppliedCategories](../resources/plannerappliedcategories.md)|The categories to which the task has been applied. For possible values, see [plannerAppliedCategories](../resources/plannerappliedcategories.md). Inherited from [plannerTask](../resources/plannertask.md).| +|assigneePriority|String|Hint used to order items of this type in a list view. For details about the supported format, see [Using order hints in Planner](../resources/planner-order-hint-format.md). Inherited from [plannerTask](../resources/plannertask.md).| +|assignments|[plannerAssignments](../resources/plannerassignments.md)|The set of assignees the task is assigned to. Inherited from [plannerTask](../resources/plannertask.md).| +|bucketId|String|Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. The [format validation](../resources/tasks-identifiers-disclaimer.md) is done on the service. Inherited from [plannerTask](../resources/plannertask.md). | +|businessScenarioProperties|[businessScenarioProperties](../resources/businessscenarioproperties.md)|Scenario-specific properties of the task. Optional.| +|conversationThreadId|String|Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the **group**. Inherited from [plannerTask](../resources/plannertask.md).| +|dueDateTime|DateTimeOffset|Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [plannerTask](../resources/plannertask.md).| +|orderHint|String|Hint used to order items of this type in a list view. For details about the supported format, see [Using order hints in Planner](../resources/planner-order-hint-format.md). Inherited from [plannerTask](../resources/plannertask.md).| +|percentComplete|Int32|Percentage of task completion. When set to `100`, the task is considered completed. Inherited from [plannerTask](../resources/plannertask.md). | +|planId|String|Identifier of the plan to which the task belongs. Inherited from [plannerTask](../resources/plannertask.md).| +|priority|Int32|Priority of the task. Valid range of values is between `0` and `10` (inclusive), with increasing value being lower priority (`0` has the highest priority and `10` has the lowest priority). Currently, Planner interprets values `0` and `1` as "urgent", `2`, `3`, and `4` as "important", `5`, `6`, and `7` as "medium", and `8`, `9`, and `10` as "low". Currently, Planner sets the value `1` for "urgent", `3` for "important", `5` for "medium", and `9` for "low". Inherited from [plannerTask](../resources/plannertask.md).| +|startDateTime|DateTimeOffset|Date and time at which the task starts. 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`. Inherited from [plannerTask](../resources/plannertask.md).| +|target|[businessScenarioTaskTargetBase](../resources/businessscenariotasktargetbase.md)|Target of the task that specifies where the task should be placed. Optional.| +|title|String|Title of the task. Inherited from [plannerTask](../resources/plannertask.md).| ++## Response ++If successful, this method returns a `200 OK` response code and an updated [businessScenarioTask](../resources/businessscenariotask.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "update_businessscenariotask", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "pmc1rS1Io0C3rXQhyXIsNmUAOeIi"] +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks/pmc1rS1Io0C3rXQhyXIsNmUAOeIi +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenarioTask", + "title": "Customer order #12010", + "percentComplete": 20, + "priority": 1, + "businessScenarioProperties": { + "externalObjectVersion": "000003" + } +} +``` ++### 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.businessScenarioTask" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenarioTask", + "title": "Customer order #12010", + "percentComplete": 20, + "priority": 1, + "id": "pmc1rS1Io0C3rXQhyXIsNmUAOeIi", + "target": { + "@odata.type": "microsoft.graph.businessScenarioGroupTarget", + "taskTargetKind": "group", + "groupId": "7a339254-4b2b-4410-b295-c890a16776ee" + }, + "businessScenarioProperties": { + "externalObjectId": "Order#12010", + "externalContextId": "Warehouse-CA-36", + "externalObjectVersion": "000003", + "webUrl": "https://ordertracking.contoso.com/view?id=12010", + "externalBucketId": "deliveryBucket" + } +} +``` ++## See also ++* [Update the task details associated with a scenario task](plannertaskdetails-update.md). |
v1.0 | Call Transfer | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-transfer.md | Content-Length: 430 [!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 | Certificatebasedauthconfiguration Post Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | Organization.ReadWrite.All | +For delegated scenarios, the calling user must have the *Global Administrator* [Azure AD role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Channel Get Filesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/channel-get-filesfolder.md | Namespace: microsoft.graph Get the metadata for the location where the files of a [channel](../resources/channel.md) are stored. +> [!NOTE] +> Some special characters in the channel name will cause this API to return an error. For details, see [Known issues](/graph/known-issues#create-channel). + ## 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 | Channel Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/channel-get.md | GET /teams/{team-id}/channels/{channel-id} ## Optional query parameters -This method supports the `$filter`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter` and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers |
v1.0 | Channel List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/channel-list.md | Namespace: microsoft.graph Retrieve the list of [channels](../resources/channel.md) in this [team](../resources/team.md). -This method supports federation. Any shared channel that the request initiator belongs to will be included in the response. +>**Note:** Guest users can't see private or shared channels that they aren't members of in the response for this API. + ## Permissions GET /teams/{team-id}/channels ``` ## Optional query parameters-This method supports the `$filter`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter` and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. ### Use $select for better performance Populating the **email** and **moderationSettings** properties for a channel is an expensive operation that results in slow performance. Use `$select` to exclude the **email** and **moderationSettings** properties to improve performance. |
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 |:|:--| | Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | +| Application | Teamwork.Migrate.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 | Channel Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/channel-post.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new [channel](../resources/channel.md) in a team, as specified in the request body. -> **Note:** You can add a maximum of 200 members when you create a private channel. +Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams. ++You can add a maximum of 200 members when you create a private channel. ++> [!NOTE] +> Some special characters in the channel name will cause the [Get filesFolder](/graph/api/channel-get-filesfolder) API to return an error. For details, see [Known issues](/graph/known-issues#create-channel). ## Permissions Content-type: application/json [!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 | Cloudpc Retrypartneragentinstallation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpc-retrypartneragentinstallation.md | The following is an example of a request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/831dd62e-cfa1-4d49-a3b4-58d4e9920f8e/retryPartnerAgentInstallation ```++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++ |
v1.0 | Cloudpcreports Getshareduselicenseusagereport | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcreports-getshareduselicenseusagereport.md | + + Title: "cloudPcReports: getSharedUseLicenseUsageReport" +description: "Get the shared use license usage reports, such as servicePlanId, licenseCount, and claimedLicenseCount, for real-time, 7 days, or 28 days trend." ++ms.localizationpriority: medium +++# cloudPcReports: getSharedUseLicenseUsageReport ++Namespace: microsoft.graph +++Get the shared use license usage reports, such as **servicePlanId**, **licenseCount**, and **claimedLicenseCount**, for real-time, 7 days, or 28 days trend. ++## 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) | CloudPC.Read.All, CloudPC.ReadWrite.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | CloudPC.Read.All, CloudPC.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/virtualEndpoint/reports/getSharedUseLicenseUsageReport +``` ++## Request headers ++| Name | Description | +| : | :-- | +| Authorization | Bearer {token}. Required. | +| Content-Type | application/json. Required. | ++## Request body ++In the request body, supply a JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++| Parameter | Type | Description | +| : | :- | :- | +| reportName | String | Specifies the report name. | +| filter | String | OData filter syntax. Supported filters include `and`, `or`, `lt`, `le`, `gt`, `ge`, and `eq`. | +| select | String collection | OData select syntax. Represents the selected columns of the reports. | +| search | String | Specifies a string to search. | +| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the **select** parameter. | +| orderBy | String collection | Specifies how to sort the reports. | +| skip | Int32 | The number of records to skip. | +| top | Int32 | The number of top records to return. | ++## Response ++If successful, this action returns a `200 OK` response code and a Stream in the response body. ++## Examples ++### Request ++The following is an example of a request. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudpcreportsthis.getSharedUseLicenseUsageReport" +} +--> +``` http +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getSharedUseLicenseUsageReport +Content-Type: application/json +Content-length: 199 ++{ + "reportName": "SharedUseLicenseUsageReport", + "filter": "ServicePlanId eq '2d1d344e-d10c-41bb-953b-b3a47521dca0' and DateTimeUTC gt datetime'2022-11-30'", + "select":["ServicePlanId", "LicenseCount", "ClaimedLicenseCount", "DateTimeUTC"], + "skip": 0, + "top": 100 +} +``` ++# [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": "Edm.Stream" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/octet-stream ++{ + "TotalRowCount": 2, + "Schema": [ + { + "name": "ServicePlanId", + "type": "String" + }, + { + "name": "LicenseCount", + "type": "Int32" + }, + { + "name": "ClaimedLicenseCount", + "type": "Int32" + }, + { + "name": "DateTimeUTC", + "type": "DateTime" + } + ], + "Values": [ + [ + "2d1d344e-d10c-41bb-953b-b3a47521dca0", 100, 10, "2022-12-02T00:00:00" + ], + [ + "2d1d344e-d10c-41bb-953b-b3a47521dca0", 100, 11, "2022-12-01T00:00:00" + ] + ] +} +``` |
v1.0 | Connectedorganization List Internalsponsors | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectedorganization-list-internalsponsors.md | GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/co [!INCLUDE [sample-code](../includes/snippets/go/connectedorganization-get-internalsponsors-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/connectedorganization-get-internalsponsors-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Device Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-get.md | GET https://graph.microsoft.com/beta/devices/6a59ea83-02bd-468f-a40b-f2c3d182198 [!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 | Devicemanagement Alertrecord Getportalnotifications | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/devicemanagement-alertrecord-getportalnotifications.md | Namespace: microsoft.graph.deviceManagement [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of all portal notifications that one or more users can access. +Get a list of all notifications that one or more users can access, from the Microsoft Endpoint Manager admin center. ## Permissions |
v1.0 | Devicemanagement Alertrecord Setportalnotificationassent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/devicemanagement-alertrecord-setportalnotificationassent.md | Namespace: microsoft.graph.deviceManagement [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Set a single portal notification status to published by modifying the **isPortalNotificationSent** property to `true` for the user specified in the request. +Set the status of the specified notification on the Microsoft EndPoint Manager admin center as sent, by modifying the **isPortalNotificationSent** property to `true`. ## Permissions |
v1.0 | Directoryrole Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-get.md | GET https://graph.microsoft.com/beta/directoryRoles/fe8f10bf-c9c2-47eb-95cb-c26c [!INCLUDE [sample-code](../includes/snippets/go/get-directoryrole-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-directoryrole-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Domain Post Federationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/domain-post-federationconfiguration.md | Title: "Create federationConfiguration" description: "Create a new internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Dynamics Customer Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/dynamics-customer-delete.md | Title: Delete customers -description: Deletes a customers object from Dynamics 365 Business Central. -+ Title: "Delete customers" +description: "Delete a customers object from Dynamics 365 Business Central." + documentationcenter: ''-+ ms.localizationpriority: medium ms.prod: "dynamics-365-business-central" doc_type: apiPageType This method supports the [OData Query Parameters](/graph/query-parameters) to he Do not supply a request body for this method. ## Response-If successful, this method returns ```204 No Content``` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example -**Request** +### Request -Here is an example of the request. +The following is an example of the request. ```http DELETE https://graph.microsoft.com/beta/financials/companies/{id}/customers/{id} ``` -**Response** +### Response -Here is an example of the response. +The following is an example of the response. ```http HTTP/1.1 204 No Content ```--- |
v1.0 | Educationassignment Delete Rubric | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-delete-rubric.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Delete an [educationRubric](../resources/educationrubric.md) from an [educationAssignment](../resources/educationassignment.md).-This method does not delete the rubric itself. ++This method does not delete the rubric itself and can only be performed by teachers. ## Permissions |
v1.0 | Educationassignment Get Rubric | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-get-rubric.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get the [educationRubric](../resources/educationrubric.md) object attached to an [educationAssignment](../resources/educationassignment.md), if one exists. +Get the [educationRubric](../resources/educationrubric.md) object attached to an [educationAssignment](../resources/educationassignment.md), if one exists. Only teachers, students, and applications with application permissions can perform this operation. ## Permissions |
v1.0 | Educationassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get the properties and relationships of an [assignment](../resources/educationassignment.md). +Get the properties and relationships of an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. Students can only see assignments assigned to them; teachers and applications with application permissions can see all assignments in a class. |
v1.0 | Educationassignment List Categories | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-list-categories.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -List all the categories associated with an [assignment](../resources/educationassignment.md). +List all the categories associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. ## 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 | Educationassignment List Resources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-list-resources.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get all the [educationAssignmentResource](../resources/educationassignmentresource.md) objects associated with an [assignment](../resources/educationassignment.md). +Get all the [educationAssignmentResource](../resources/educationassignmentresource.md) objects associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. ## 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 | Educationassignment List Submissions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-list-submissions.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -List all the [submissions](../resources/educationsubmission.md) associated with an [assignment](../resources/educationassignment.md). +List all the [submissions](../resources/educationsubmission.md) associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. A teacher or an application with application permissions can get all the **submissions**, a student can only get **submissions** that they are associated with. |
v1.0 | Educationassignment Post Categories | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-post-categories.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Add one or more existing [educationCategory](../resources/educationcategory.md) objects to this [educationAssignment](../resources/educationassignment.md). +Add one or more existing [educationCategory](../resources/educationcategory.md) objects to this [educationAssignment](../resources/educationassignment.md). Only teachers and students can perform this operation. ## 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 | Educationassignment Post Resources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-post-resources.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create an [assignment resource](../resources/educationassignmentresource.md). You can create the following types of assignment resources: +Create an [assignment resource](../resources/educationassignmentresource.md). Only teachers can perform this operation. ++You can create the following types of assignment resources: - [educationFileResource](../resources/educationfileresource.md) - [educationExcelResource](../resources/educationexcelresource.md) Create an [assignment resource](../resources/educationassignmentresource.md). Yo - [educationMediaResource](../resources/educationmediaresource.md) - [educationTeamsAppResource](../resources/educationteamsappresource.md) -Every resource has an @odata.type property to indicate which type of resource is being created. +Every resource has an **@odata.type** property to indicate which type of resource is being created. > [!IMPORTANT] > Before you can upload an assignment resource, you must [set up the resources folder](../api/educationassignment-setupresourcesfolder.md) for the [educationAssignment](../resources/educationassignment.md) to upload the files to. The following is an example of the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.educationMediaResource" + "@odata.type": "microsoft.graph.educationTeamsAppResource" } --> ```http HTTP/1.1 201 Created |
v1.0 | Educationassignment Put Rubric | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-put-rubric.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Attach an existing [educationRubric](../resources/educationrubric.md) object to an [educationAssignment](../resources/educationassignment.md). +Attach an existing [educationRubric](../resources/educationrubric.md) object to an [educationAssignment](../resources/educationassignment.md). Only teachers can perform this operation. ## Permissions |
v1.0 | Educationassignment Remove Category | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-remove-category.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Remove an [educationCategory](../resources/educationcategory.md) from an [educationAssignment](../resources/educationassignment.md). +Remove an [educationCategory](../resources/educationcategory.md) from an [educationAssignment](../resources/educationassignment.md). Only teachers can perform this operation. ## 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 | Educationassignment Setupfeedbackresourcesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-setupfeedbackresourcesfolder.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a SharePoint folder to upload feedback files for a given [educationSubmission](../resources/educationsubmission.md). +Create a SharePoint folder to upload feedback files for a given [educationSubmission](../resources/educationsubmission.md). Only teachers can perform this operation. The teacher determines the resources to upload in the feedback resources folder of a submission. |
v1.0 | Educationassignment Setupresourcesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignment-setupresourcesfolder.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a SharePoint folder to upload files for a given [educationAssignment](../resources/educationassignment.md). +Create a SharePoint folder to upload files for a given [educationAssignment](../resources/educationassignment.md). Only teachers can perform this operation. -The teacher determines the resources to upload in the assignment's folder. +The teacher determines the resources to upload in the assignment's folder. ## 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 | Educationassignmentdefaults Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignmentdefaults-get.md | Namespace: microsoft.graph Read the properties and relationships of an [educationAssignmentDefaults](../resources/educationassignmentdefaults.md) object. -These are the class-level assignment defaults respected by new [assignments](../resources/educationassignment.md) created in the class. Callers can continue to specify custom values on each **assignment** creation if they don't want the default behaviors. +These are the class-level assignment defaults respected by new [assignments](../resources/educationassignment.md) created in the class. Callers can continue to specify custom values on each **assignment** creation if they don't want the default behaviors. Only teachers can perform this operation. ## 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 | Educationassignmentresource Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignmentresource-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get the properties of an [education assignment resource](../resources/educationassignmentresource.md) associated with an [assignment](../resources/educationassignment.md). +Get the properties of an [education assignment resource](../resources/educationassignmentresource.md) associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. ## 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 | Educationassignmentsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationassignmentsettings-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the properties and relationships of an [educationAssignmentSettings](../resources/educationassignmentsettings.md) object. +Read the properties and relationships of an [educationAssignmentSettings](../resources/educationassignmentsettings.md) object. Only teachers can perform this operation. ## 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 | Educationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationcategory-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Delete an existing category. +Delete an existing category. Only teachers can perform this operation. ## Permissions |
v1.0 | Educationcategory Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationcategory-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve an [educationCategory](../resources/educationcategory.md) object. +Retrieve an [educationCategory](../resources/educationcategory.md) object. Only teachers, students, and applications with application permissions can perform this operation. ## Permissions |
v1.0 | Educationclass List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationclass-list-assignments.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a list of assignment objects. +Retrieve a list of assignment objects. Only teachers, students, and applications with application permissions can perform this operation. A teacher or an application executing with application permissions can see all assignment objects for the class. Students can only see assignments that are assigned to them. |
v1.0 | Educationclass List Categories | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationclass-list-categories.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a list of [educationCategory](../resources/educationcategory.md) objects. +Retrieve a list of [educationCategory](../resources/educationcategory.md) objects. Only teachers can perform this operation. ## Permissions |
v1.0 | Educationclass Post Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationclass-post-assignments.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new assignment. +Create a new assignment. Only teachers in a class can create an assignment. Assignments start in the Draft state, which means that students will not see the assignment until publication. Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/go/create-educationassignment-from-educationclass-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-educationassignment-from-educationclass-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Educationclass Post Category | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationclass-post-category.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Creates a new [educationCategory](../resources/educationcategory.md) on an [educationClass](../resources/educationclass.md). +Creates a new [educationCategory](../resources/educationcategory.md) on an [educationClass](../resources/educationclass.md). Only teachers can perform this operation. ## 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 | Educationoutcome Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationoutcome-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of an [educationOutcome](../resources/educationoutcome.md) object. +Update the properties of an [educationOutcome](../resources/educationoutcome.md) object. Only teachers can perform this operation. ## Permissions |
v1.0 | Educationrubric Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationrubric-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Delete an [educationRubric](../resources/educationrubric.md) object. +Delete an [educationRubric](../resources/educationrubric.md) object. Only teachers can perform this operation. ## Permissions |
v1.0 | Educationrubric Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationrubric-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the properties and relationships of an [educationRubric](../resources/educationrubric.md) object. +Retrieve the properties and relationships of an [educationRubric](../resources/educationrubric.md) object. Only teachers and students can perform this operation. ## Permissions |
v1.0 | Educationrubric Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationrubric-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of an [educationRubric](../resources/educationrubric.md) object. +Update the properties of an [educationRubric](../resources/educationrubric.md) object. Only teachers can perform this operation. Updating a rubric attached to an assignment (`PATCH /education/classes/{id}/assignments/{id}/rubric`) is only possible before the assignment is published, and what is updated is actually the original rubric that exists under `/education/users/{id}/rubrics`. After the assignment is published, an immutable copy of the rubric is made that is attached to that specific assignment. That rubric can be retrieved using [GET /education/classes/{id}/assignments/{id}/rubric](educationrubric-get.md), but it cannot be updated. |
v1.0 | Educationschool List Users | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationschool-list-users.md | GET https://graph.microsoft.com/beta/education/schools/10002/users [!INCLUDE [sample-code](../includes/snippets/go/educationschool-get-users-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/educationschool-get-users-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Educationsubmission Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a particular [submission](../resources/educationsubmission.md). +Retrieve a particular [submission](../resources/educationsubmission.md). Only teachers, students, and applications with application permissions can perform this operation. A **submission** object represents a student's work for an [assignment](../resources/educationassignment.md). Resources associated with the **submission** represent this work. |
v1.0 | Educationsubmission List Outcomes | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-list-outcomes.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a list of [educationOutcome](../resources/educationoutcome.md) objects. There are four types of outcomes: **educationPointsOutcome**, **educationFeedbackOutcome**, **educationRubricOutcome**, and **educationFeedbackResourceOutcome**. +Retrieve a list of [educationOutcome](../resources/educationoutcome.md) objects. There are four types of outcomes: **educationPointsOutcome**, **educationFeedbackOutcome**, **educationRubricOutcome**, and **educationFeedbackResourceOutcome**. Only teachers, students, and applications with application permissions can perform this operation. A submission for a credit assignment (one that has no point value and no rubric) will have an [educationFeedbackOutcome](../resources/educationpointsoutcome.md). (It might also return an [educationPointsOutcome](../resources/educationpointsoutcome.md), but that outcome is ignored.) |
v1.0 | Educationsubmission List Resources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-list-resources.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -List the resources associated with a submission. +List the resources associated with a submission. Only teachers, students, and applications with application permissions can perform this operation. The [educationSubmissionResource](../resources/educationsubmissionresource.md) object is a wrapper around the actual resource object the student is working on. The wrapper also includes a pointer to the resources on the assignment if this was copied from the assignment during the assign process. These resources are the working copy of the assignment. The **submittedResources** are the resources that have officially been submitted to be graded. |
v1.0 | Educationsubmission List Submittedresources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-list-submittedresources.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -List the [educationSubmissionResource](../resources/educationsubmissionresource.md) objects that have officially been submitted for grading. The student who owns the submission cannot change the submitted list without resubmitting the assignment. This is a wrapper around the real resource and can contain a pointer back to the actual assignment resource if this resource was copied from the assignment. +List the [educationSubmissionResource](../resources/educationsubmissionresource.md) objects that have officially been submitted for grading. Only teachers, students, and applications with application permissions can perform this operation. ++The student who owns the submission cannot change the submitted list without resubmitting the assignment. This is a wrapper around the real resource and can contain a pointer back to the actual assignment resource if this resource was copied from the assignment. ## 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 | Educationsubmission Post Resources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-post-resources.md | Namespace: microsoft.graph Add a [educationSubmissionResource](../resources/educationsubmissionresource.md) to a submission resource list. -Only the student assigned to the submission can perform this operation. +Only teachers and students can perform this operation. -The operation will not succeed if the **allowStudentsToAddResources** flag is not set to `true`. +The operation will not succeed if the **allowStudentsToAddResources** flag is not set to `true`. To create a new file-based resource, upload the file to the resources folder associated with the submission. If the file doesn't exist or is not in that folder, the POST request will fail. |
v1.0 | Educationsubmission Setupresourcesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-setupresourcesfolder.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Trigger the creation of the SharePoint resource folder where all file-based resources (Word, Excel, and so on) should be uploaded for a given submission. +Trigger the creation of the SharePoint resource folder where all file-based resources (Word, Excel, and so on) should be uploaded for a given submission. Only teachers and students can perform this operation. Note that files must be located in this folder in order to be added as resources. Only a student in the class can determine what files to upload in a given submission-level resource folder. |
v1.0 | Educationsubmission Submit | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-submit.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Indicate that a student is done with the work and is ready to hand in the assignment. +Indicate that a student is done with the work and is ready to hand in the assignment. Only teachers, students, and applications with application permissions can perform this operation. This method changes the status of the submission from `working` to `submitted`. During the submit process, all the resources are copied to the **submittedResources** bucket. The teacher will be looking at the submitted resources list for grading. |
v1.0 | Educationsubmission Unsubmit | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmission-unsubmit.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Indicate that a student wants to work on the submitted assignment after it was turned in. +Indicate that a student wants to work on the submitted assignment after it was turned in. Only teachers, students, and applications with application permissions can perform this operation. This method changes the status of the submission from `submitted` to `working`. During the submit process, all the resources are copied from **submittedResources** to **workingResources**. The teacher will be looking at the working resources list for grading. |
v1.0 | Educationsubmissionresource Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmissionresource-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Deletes an [educationSubmissionResource](../resources/educationsubmissionresource.md) from the submission. This can only be done by the student. If the resource was copied from the assignment, a new copy of the resource will be created after the current copy is deleted. This allows you to "reset" the resource to its original state. If the resource was not copied from the assignment but was added from the student, the resource is simply deleted. +Delete an [educationSubmissionResource](../resources/educationsubmissionresource.md) from the submission. Only teachers and students can perform this operation. ++If the resource was copied from the assignment, a new copy of the resource will be created after the current copy is deleted. This allows you to "reset" the resource to its original state. If the resource was not copied from the assignment but was added from the student, the resource is simply deleted. ## 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 | Educationsubmissionresource Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmissionresource-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the properties of a specific resource associated with a [submission](../resources/educationsubmissionresource.md). +Retrieve the properties of a specific resource associated with a [submission](../resources/educationsubmissionresource.md). Only teachers, students, and applications with application permissions can perform this operation. This resource is in the "working" resource list and should be considered work in process by a student. This resource is wrapped with a possible pointer back to the assignment resource if it was copied from the assignment. |
v1.0 | Educationsubmittedsubmissionresource Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationsubmittedsubmissionresource-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a [submitted resource](../resources/educationsubmissionresource.md). +Retrieve a [submitted resource](../resources/educationsubmissionresource.md). Only teachers, students, and applications with application permissions can perform this operation. Resources will be available to a teacher or an application with application permissions after a student submits it, and will be available to the student after the teacher releases the submission. Note that teachers can leave notes in some resources. |
v1.0 | Educationuser List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationuser-list-assignments.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Returns a list of assignments assigned to a user for all classes. +Returns a list of assignments assigned to a user for all classes. Only teachers, students, and applications with application permissions can perform this operation. This utility namespace allows a caller to find all the assignments belonging to a student or a teacher in a single call rather than having to request assignments from each class. The assignment list contains what is needed to get the detailed information for the assignment from within the class namespace. All other operations on the assignment should use the class namespace. |
v1.0 | Emailauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-delete.md | Title: "Delete emailAuthenticationMethodConfiguration" description: "Deletes an emailAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "apiPageType" |
v1.0 | Emailauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-get.md | Title: "Get emailAuthenticationMethodConfiguration" description: "Read the properties and relationships of an emailAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "apiPageType" Content-Type: application/json "id": "Email", "state": "enabled", "allowExternalIdToUseEmailOtp": "default",- "includeTargets": [] + "includeTargets": [], + "excludeTargets": [] } ``` |
v1.0 | Emailauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-update.md | Title: "Update emailAuthenticationMethodConfiguration" description: "Update the properties of an emailAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "apiPageType" |
v1.0 | Entitlementmanagement Post Accesspackageassignmentpolicies | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackageassignmentpolicies.md | Content-type: application/json [!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 #### Request -In the following example, the pre-defined **customAccessPackageWorkflowExtension** object is triggered when an access package assigned request is created and when it's granted. +In the following example, the pre-defined **customAccessPackageWorkflowExtension** object is triggered when an access package assigned request is created and when it's granted. The identifier provided within the **customExtension** field is the **customAccessPackageWorkflowExtension** object's ID. # [HTTP](#tab/http) Content-type: application/json { "stage": "assignmentRequestCreated", "customExtension": {- "id": "219f57b6-7983-45a1-be01-2c228b7a43f8" //customAccessPackageWorkflowExtension.id + "id": "219f57b6-7983-45a1-be01-2c228b7a43f8" } }, { |
v1.0 | Entitlementmanagement Post Accesspackageassignmentrequests | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackageassignmentrequests.md | Content-type: application/json [!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 [!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 | Entitlementmanagement Post Accesspackageresourcerequests | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackageresourcerequests.md | Content-type: application/json [!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 | Fido2authenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-delete.md | Title: "Delete fido2AuthenticationMethodConfiguration" description: "Delete a fido2AuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "apiPageType" |
v1.0 | Fido2authenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-get.md | Title: "Get fido2AuthenticationMethodConfiguration" description: "Read the properties and relationships of a fido2AuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "apiPageType" Content-type: application/json "id": "all_users", "isRegistrationRequired": false }- ] + ], + "excludeTargets": [] } ``` |
v1.0 | Fido2authenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-update.md | Title: "Update fido2AuthenticationMethodConfiguration" description: "Update the properties of a fido2AuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "apiPageType" |
v1.0 | Governanceroleassignmentrequest Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignmentrequest-post.md | Content-type: application/json [!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 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-members.md | Get a list of the group's direct members. A group can have users, contacts, devi When a group contains more than 100 members, Microsoft Graph returns a `@odata.nextLink` property in the response that contains a URL to the next page of results. If that property is present, continue making additional requests with the `@odata.nextLink` URL in each response, until all the results are returned, as described in [paging Microsoft Graph data in your app](/graph/paging). +An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. + ## 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). Do not supply a request body for this method. If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. +An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. For example, `/groups/{id}}/members/microsoft.graph.group` when the group is a Microsoft 365 group will return this error, because Microsoft 365 groups cannot have other groups as members. + ## Examples ### Example 1: Get the direct membership in a group |
v1.0 | Group List Transitivemembers | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-transitivemembers.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of the group's members. A group can have users, contacts, devices, service principals, and other groups as members. This operation is transitive and will also return a flat list of all nested members. +Get a list of the group's members. A group can different object types as members. For more information about supported member types for different groups, see [Group membership](../resources/groups-overview.md#group-membership). ++This operation is transitive and returns a flat list of all nested members. An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. ## Permissions Do not supply a request body for this method. If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. + An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. For example, `/groups/{id}}/transitiveMembers/microsoft.graph.group` when the group is a Microsoft 365 group will return this error, because Microsoft 365 groups cannot have other groups as members. + ## Examples ### Example 1: Get the transitive membership of a group Content-type: application/json The following is an example of the request. -# [HTTP](#tab/http) - <!-- { "blockType": "ignored", "name": "get_group_transitivemembers_count" GET https://graph.microsoft.com/beta/groups/{id}/transitiveMembers/$count ConsistencyLevel: eventual ``` -# [C#](#tab/csharp) ---# [JavaScript](#tab/javascript) ---# [Objective-C](#tab/objc) ---# [Java](#tab/java) ----- #### Response The following is an example of the response. <!-- {- "blockType": "response", + "blockType": "response" } -->- ```http HTTP/1.1 200 OK Content-type: text/plain |
v1.0 | Group Post Groups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-groups.md | Content-type: application/json The following is an example of the request. The calling user must be assigned the _RoleManagement.ReadWrite.Directory_ permission to set the **isAssignableToRole** property or update the membership of such groups. -**NOTE:** A group with **isAssignableToRole** property set to `true` cannot be of dynamic membership type. For more information, see [Using a group to manage Azure AD role assignments](https://go.microsoft.com/fwlink/?linkid=2103037). +A group with **isAssignableToRole** property set to `true` cannot be of dynamic membership type, its **securityEnabled** must be set to `true`, and **visibility** can only be `Private`. # [HTTP](#tab/http) |
v1.0 | Group Post Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-members.md | Namespace: microsoft.graph Add a member to a security or Microsoft 365 group through the **members** navigation property. -The following table shows the types of members that can be added to either security groups or Microsoft 365 groups. --| Object type | Member of security group | Member of Microsoft 365 group | -|-|-|-| -| User | ![Can be group member][Yes] | ![Can be group member][Yes] | -| Security group | ![Can be group member][Yes] | ![Cannot be group member][No] | -| Microsoft 365 group | ![Cannot be group member][No] | ![Cannot be group member][No] | -| Device | ![Can be group member][Yes] | ![Cannot be group member][No] | -| Service principal | ![Can be group member][Yes] | ![Cannot be group member][No] | -| Organizational contact | ![Can be group member][Yes] | ![Cannot be group member][No] | - ## Permissions |
v1.0 | Grouplifecyclepolicy Post Grouplifecyclepolicies | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/grouplifecyclepolicy-post-grouplifecyclepolicies.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/go/create-grouplifecyclepolicy-from-group-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-grouplifecyclepolicy-from-group-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Horizontalsection Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/horizontalsection-get.md | GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!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) + GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!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 | Horizontalsection List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/horizontalsection-list.md | GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!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 | Horizontalsectioncolumn Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/horizontalsectioncolumn-get.md | GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!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) + GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!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 | Horizontalsectioncolumn List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/horizontalsectioncolumn-list.md | GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!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 Lifecycleworkflowscontainer List Taskdefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md | GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskD [!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 | 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** |authenticationConfiguration|[microsoft.graph.customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for the `customTaskExtension`.| |clientConfiguration|[microsoft.graph.customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|The client configuration for a custom extension.| |description|String|The description of the `customTaskExtension`.|-|displayName|String|The display name of the `customTaskExtension`.| +|displayName|String|A unique string that identifies the `customTaskExtension`.| |endpointConfiguration|[microsoft.graph.customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The endpoint configuration for a custom extension. Optional.| |callbackConfiguration|[microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration](../resources/identitygovernance-customtaskextensioncallbackconfiguration.md)|The callback configuration for a custom extension. Optional.| |
v1.0 | Internaldomainfederation Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/internaldomainfederation-delete.md | Title: "Delete internalDomainFederation" description: "Deletes an internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Internaldomainfederation Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/internaldomainfederation-get.md | Title: "Get internalDomainFederation" description: "Read the properties and relationships of an internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Internaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/internaldomainfederation-update.md | Title: "Update internalDomainFederation" description: "Update the properties of an internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Listitem Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/listitem-delete.md | DELETE https://graph.microsoft.com/beta/sites/{site-id}/lists/{list-id}/items/{i [!INCLUDE [sample-code](../includes/snippets/go/delete-item-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-item-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Meetingattendancereport Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/meetingattendancereport-get.md | GET /users/{userId}/onlineMeetings/{meetingId}/meetingAttendanceReport > >- The `/meetingAttendanceReport` path is deprecated. Going forward, use the `/attendanceReports` path to retrieve attendance reports for an online meeting. >- The `/meetingAttendanceReport` path will remain in beta for backward compatibility. However, to get the same response, you need to add the `expand` query option. For details, see the [Optional query parameters](#optional-query-parameters) section.+>- The **attendanceRecords** property does not return information about a breakout room. ## Optional query parameters |
v1.0 | Messagerule Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/messagerule-delete.md | DELETE https://graph.microsoft.com/beta/me/mailfolders/inbox/messagerules('AQAAA [!INCLUDE [sample-code](../includes/snippets/go/delete-messagerule-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-messagerule-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Microsoftauthenticatorauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-delete.md | Title: "Delete microsoftAuthenticatorAuthenticationMethodConfiguration" description: "Deletes a microsoftAuthenticatorAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Microsoftauthenticatorauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-get.md | Title: "Get microsoftAuthenticatorAuthenticationMethodConfiguration" description: "Read the properties and relationships of a microsoftAuthenticatorAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType Content-Type: application/json "authenticationMode": "any", } ],+ "excludeTargets": [], + "isSoftwareOathEnabled": true, "featureSettings": { "numberMatchingRequiredState" : { "state": "enabled", |
v1.0 | Microsoftauthenticatorauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-update.md | Title: "Update microsoftAuthenticatorAuthenticationMethodConfiguration" description: "Update the properties of a microsoftAuthenticatorAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Onlinemeeting Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/onlinemeeting-get.md | The following is an example of the response. ``` ### Example 3: Retrieve an online meeting by joinWebUrl-You can retrieve meeting information via JoinWebUrl by using either a user or application token. This option is available to support use cases where the meeting ID isn't known but the JoinWebUrl is, such as when a user creates a meeting (for example in the Microsoft Teams client), and a seperate application needs to retrieve meeting details as a follow-up action. +You can retrieve meeting information via JoinWebUrl by using either a user or application token. This option is available to support use cases where the meeting ID isn't known but the JoinWebUrl is, such as when a user creates a meeting (for example in the Microsoft Teams client), and a separate application needs to retrieve meeting details as a follow-up action. #### Request The following is an example of the response. ``` ### Example 4: Retrieve an online meeting by joinMeetingId+ You can retrieve meeting information via the **joinMeetingId** by using either a user or an application token. #### Request -The following request uses a user token. -<!-- { "blockType": "ignored" } --> -```http +The following is an example of a request that uses a user (delegated) token. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get-an-online-meeting-by-joinmeetingid" +} --> +```msgraph-interactive GET https://graph.microsoft.com/beta/me/onlineMeetings?$filter=joinMeetingIdSettings/joinMeetingId%20eq%20'1234567890' ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ The following request uses an app token. <!-- { "blockType": "ignored" } --> ```http GET https://graph.microsoft.com/beta/users/dc17674c-81d9-4adb-bfb2-8f6a442e4622/ The following is an example of the response. -> **Note:** The response object shown here might be shortened for readability. +> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.onlineMeeting" +} --> +```http +HTTP/1.1 200 OK +Content-Type: application/json -```json { "value": [ { |
v1.0 | Onpremisesdirectorysynchronization Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/onpremisesdirectorysynchronization-get.md | If successful, this method returns a `200 OK` response code and an [onPremisesDi ### Request The following is an example of a request.++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_onpremisesdirectorysynchronization" The following is an example of a request. GET https://graph.microsoft.com/beta/directory/onPremisesSynchronization/{id} ``` +# [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 |
v1.0 | Onpremisesdirectorysynchronization Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/onpremisesdirectorysynchronization-update.md | If successful, this method returns a `204 No Content` response code. ### Request The following is an example of a request.++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_onpremisesdirectorysynchronization" Content-length: 293 } ``` +# [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 |
v1.0 | Opentypeextension Post Opentypeextension | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/opentypeextension-post-opentypeextension.md | POST /groups/{groupId}/events/{eventId}/extensions POST /groups/{groupId}/threads/{threadId}/posts/{postId}/extensions POST /users/{userId|userPrincipalName}/messages/{messageId}/extensions POST /organization/{organizationId}/extensions-POST /users/{userIdd|userPrincipalName}/contacts/{contactId}/extensions +POST /users/{userId|userPrincipalName}/contacts/{contactId}/extensions POST /users/{userId|userPrincipalName}/extensions POST /users/{userId|userPrincipalName}/todo/lists/{listId}/tasks/{taskId}/extensions POST /users/{userId|userPrincipalName}/todo/lists/{listId}/extensions Content-Type: application/json [!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 | Phoneauthenticationmethod Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/phoneauthenticationmethod-get.md | GET https://graph.microsoft.com/beta/me/authentication/phoneMethods/3179e48a-750 [!INCLUDE [sample-code](../includes/snippets/go/get-phoneauthenticationmethod-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-phoneauthenticationmethod-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Planner Post Plans | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/planner-post-plans.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) | Tasks.ReadWrite, Group.ReadWrite.All | +| Delegated (work or school account) | Tasks.ReadWrite, Group.ReadWrite.All | | Delegated (personal Microsoft account) | Not supported. | | Application | Not supported. | POST /planner/plans ## Request body In the request body, supply a JSON representation of [plannerPlan](../resources/plannerplan.md) object.-The **plannerPlan** container property must be set. ++The following table shows the properties that are required when you create a [plannerPlan](../resources/plannerplan.md). ++|Property|Type|Description| +|:|:|:| +|container|[plannerPlanContainer](../resources/plannerplancontainer.md)|Identifies the container of the plan. Specify only the **url**, the **containerId** and **type**, or all properties. After it is set, this property canΓÇÖt be updated.| +|title|String|The title of the plan.| >**Note:** If the container is a Microsoft 365 group, the user who is creating the plan must be a member of the group that will contain the plan. When you create a new group by using [Create group](../api/group-post-groups.md), you are not added to the group as a member. After the group is created, add yourself as a member by using [group post members](../api/group-post-members.md). ## Response -If successful, this method returns `201 Created` response code and [plannerPlan](../resources/plannerplan.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [plannerPlan](../resources/plannerplan.md) object in the response body. -This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 400, 403 and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). +This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 400, 403, and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). ## Example ### Request -Here is an example of the request. +The following is an example of the request. # [HTTP](#tab/http) <!-- { Content-type: application/json ### Response -Here 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. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, Content-type: application/json ] } -->-- |
v1.0 | Plannerassignedtotaskboardtaskformat Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerassignedtotaskboardtaskformat-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of **plannerAssignedToTaskBoardTaskFormat** 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). One of the following permissions is required to call this API. To learn more, in ```http GET /planner/tasks/{id}/assignedToTaskBoardFormat ```+ ## Request headers | Name |Description| |:-|:-| Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [plannerAssignedToTaskBoardTaskFormat](../resources/plannerassignedtotaskboardtaskformat.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [plannerAssignedToTaskBoardTaskFormat](../resources/plannerassignedtotaskboardtaskformat.md) object in the response body. This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 403 and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). ## Example-##### Request -Here is an example of the request. +### Request +The following is an example of the request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/planner/tasks/01gzSlKkIUSUl6DF_EilrmQAKDhh/ -##### Response -Here is an example of the response. Note: The response object shown here might be shortened for readability. +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, Content-type: application/json ] } -->-- |
v1.0 | Plannerplanconfiguration Delete Localizations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplanconfiguration-delete-localizations.md | + + Title: "Delete plannerPlanConfigurationLocalization" +description: "Delete a plannerPlanConfigurationLocalization object." ++ms.localizationpriority: medium +++# Delete plannerPlanConfigurationLocalization ++Namespace: microsoft.graph +++Delete a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application| BusinessScenarioConfig.ReadWrite.OwnedBy | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For a specific localization based on a business scenario ID and a localization ID: ++``` http +DELETE /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} +``` ++For a specific localization based on the unique name of a business scenario and a localization ID: ++``` http +DELETE /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} +``` ++## 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. +<!-- { + "blockType": "request", + "name": "delete_plannerplanconfigurationlocalization", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "en-us"] +} +--> +``` http +DELETE https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us +``` ++### Response ++The following is an example of the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Plannerplanconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplanconfiguration-get.md | + + Title: "Get plannerPlanConfiguration" +description: "Read the properties and relationships of a plannerPlanConfiguration object." ++ms.localizationpriority: medium +++# Get plannerPlanConfiguration ++Namespace: microsoft.graph +++Read the properties and relationships of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.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)|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.Read.All, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "get_plannerplanconfiguration", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration +``` ++### 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.plannerPlanConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfiguration", + "id": "afdd911ee3db44b69cc28373a6192e94", + "defaultLanguage": "en-us", + "buckets": [ + { + "externalBucketId": "deliveryBucket" + }, + { + "externalBucketId": "storePickupBucket" + }, + { + "externalBucketId": "specialOrdersBucket" + }, + { + "externalBucketId": "returnProcessingBucket" + } + ] +} +``` |
v1.0 | Plannerplanconfiguration List Localizations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplanconfiguration-list-localizations.md | + + Title: "List plannerPlanConfigurationLocalizations" +description: "Get a list of the plannerPlanConfigurationLocalization objects and their properties." ++ms.localizationpriority: medium +++# List plannerPlanConfigurationLocalizations ++Namespace: microsoft.graph +++Get a list of the [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) objects and their properties. ++## Permissions ++One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.Read.All, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For localizations based on a business scenario ID: ++``` http +GET /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations +``` ++For localizations based on the unique name of a business scenario: ++``` http +GET /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) objects in the response body. ++## Examples ++### Example 1: Get all localizations ++The following example shows a request that gets all localized names for a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md). ++#### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_plannerplanconfigurationlocalization", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations +``` ++#### 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.plannerPlanConfigurationLocalization)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "id": "en-us", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] + }, + { + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "id": "pt-br", + "languageTag": "pt-br", + "planTitle": "Acompanhamento de pedidos", + "buckets": [ + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "deliveryBucket", + "name": "Entregas" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "storePickupBucket", + "name": "Retirada na loja" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "specialOrdersBucket", + "name": "Pedidos especiais" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "returnProcessingBucket", + "name": "Devoluções" + } + ] + } + ] +} +``` ++### Example 2: Get localization for a specific language tag ++The following example shows a request that gets all localized names for a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) for a specific language. ++#### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_plannerplanconfigurationlocalization", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations?$filter=languageTag eq 'en-us' +``` ++#### 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.plannerPlanConfigurationLocalization)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "id": "en-us", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] + } + ] +} +``` |
v1.0 | Plannerplanconfiguration Post Localizations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplanconfiguration-post-localizations.md | + + Title: "Create plannerPlanConfigurationLocalization" +description: "Create a new plannerPlanConfigurationLocalization object." ++ms.localizationpriority: medium +++# Create plannerPlanConfigurationLocalization ++Namespace: microsoft.graph +++Create a new [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application| BusinessScenarioConfig.ReadWrite.OwnedBy | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For a specific localization based on a business scenario ID: ++``` http +POST /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations +``` ++For a specific localization based on the unique name of a business scenario: ++``` http +POST /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body ++In the request body, supply a JSON representation of the [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object. ++You can specify the following properties when you create a **plannerPlanConfigurationLocalization**. ++|Property|Type|Description| +|:|:|:| +|buckets|[plannerPlanConfigurationBucketLocalization](../resources/plannerplanconfigurationbucketlocalization.md) collection|Localizations for buckets specified in the [plannerPlanConfiguration](../resources/plannerplanconfiguration.md). Required.| +|languageTag|String|The code for the language the localized data is intended for. Required.| +|planTitle|String|Localized title of the plan. Required.| ++## Response ++If successful, this method returns a `201 Created` response code and a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. ++<!-- { + "blockType": "request", + "name": "create_plannerplanconfigurationlocalization_from_", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] +} +``` ++### 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.plannerPlanConfigurationLocalization" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "id": "en-us", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] +} +``` |
v1.0 | Plannerplanconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplanconfiguration-update.md | + + Title: "Update plannerPlanConfiguration" +description: "Update the properties of a plannerPlanConfiguration object for a businessScenario." ++ms.localizationpriority: medium +++# Update plannerPlanConfiguration ++Namespace: microsoft.graph +++Update the properties of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object for a [businessScenario](../resources/businessscenario.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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For the plan configuration based on a business scenario ID: ++``` http +PATCH /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration +``` ++For the plan configuration based on the unique name of a business scenario: ++``` http +PATCH /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|defaultLanguage|String|The language that should be used for creating plans when no language has been specified. Required.| +|buckets|[plannerPlanConfigurationBucketDefinition](../resources/plannerplanconfigurationbucketdefinition.md) collection|Buckets that will be available in the plan. Required.| ++## Response ++If successful, this method returns a `200 OK` response code and an updated [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "update_plannerplanconfiguration", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfiguration", + "defaultLanguage": "en-us", + "buckets": [ + { + "externalBucketId": "deliveryBucket" + }, + { + "externalBucketId": "storePickupBucket" + }, + { + "externalBucketId": "specialOrdersBucket" + }, + { + "externalBucketId": "returnProcessingBucket" + } + ] +} +``` ++### 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.plannerPlanConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfiguration", + "id": "afdd911ee3db44b69cc28373a6192e94", + "defaultLanguage": "en-us", + "buckets": [ + { + "externalBucketId": "deliveryBucket" + }, + { + "externalBucketId": "storePickupBucket" + }, + { + "externalBucketId": "specialOrdersBucket" + }, + { + "externalBucketId": "returnProcessingBucket" + } + ] +} +``` |
v1.0 | Plannerplanconfigurationlocalization Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplanconfigurationlocalization-get.md | + + Title: "Get plannerPlanConfigurationLocalization" +description: "Read the properties and relationships of a plannerPlanConfigurationLocalization object." ++ms.localizationpriority: medium +++# Get plannerPlanConfigurationLocalization ++Namespace: microsoft.graph +++Read the properties and relationships of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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)|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.Read.All, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For a specific localization based on a business scenario ID and a localization ID: ++``` http +GET /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} +``` ++For a specific localization based on the unique name of a business scenario and a localization ID: ++``` http +GET /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "get_plannerplanconfigurationlocalization", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "en-us"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us +``` ++### 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.plannerPlanConfigurationLocalization" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "id": "en-us", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] +} +``` |
v1.0 | Plannerplanconfigurationlocalization Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplanconfigurationlocalization-update.md | + + Title: "Update plannerPlanConfigurationLocalization" +description: "Update the properties of a plannerPlanConfigurationLocalization object." ++ms.localizationpriority: medium +++# Update plannerPlanConfigurationLocalization ++Namespace: microsoft.graph +++Update the properties of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++For a specific localization based on a business scenario ID and a localization ID: ++``` http +PATCH /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} +``` ++For a specific localization based on the unique name of a business scenario and a localization ID: ++``` http +PATCH /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|buckets|[plannerPlanConfigurationBucketLocalization](../resources/plannerplanconfigurationbucketlocalization.md) collection|Localizations for buckets specified in the [plannerPlanConfiguration](../resources/plannerplanconfiguration.md). Optional.| +|planTitle|String|Localized title of the plan. Optional.| ++## Response ++If successful, this method returns a `200 OK` response code and an updated [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "update_plannerplanconfigurationlocalization", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "en-us"] +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "planTitle": "Order Tracking", + "buckets": [ + { + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] +} +``` ++### 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.plannerPlanConfigurationLocalization" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "id": "en-us", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] +} +``` |
v1.0 | Plannertaskconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannertaskconfiguration-get.md | + + Title: "Get plannerTaskConfiguration" +description: "Read the properties and relationships of a plannerTaskConfiguration object." ++ms.localizationpriority: medium +++# Get plannerTaskConfiguration ++Namespace: microsoft.graph +++Read the properties and relationships of a [plannerTaskConfiguration](../resources/plannertaskconfiguration.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)|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.Read.All, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/businessScenarios/{businessScenarioId}/planner/taskConfiguration +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [plannerTaskConfiguration](../resources/plannertaskconfiguration.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "get_plannertaskconfiguration", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/taskConfiguration +``` ++### 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.plannerTaskConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerTaskConfiguration", + "id": "52be01e6291f403aa49f2b9f5288ab48", + "editPolicy": { + "rules": [ + { + "defaultRule": "block", + "role": { + "@odata.type": "#microsoft.graph.plannerRelationshipBasedUserType", + "roleKind": "relationship", + "role": "defaultRules" + }, + "propertyRule": { + "move": [], + "delete": [], + "title": [], + "notes": [], + "priority": [], + "startDate": [], + "dueDate": [], + "percentComplete": ["allow"], + "order": [], + "previewType": [], + "ruleKind": "taskRule", + "references": null, + "checkLists": null, + "assignments": { + "defaultRules": ["addSelf"], + "overrides": [] + }, + "appliedCategories": null + } + }, + { + "defaultRule": "block", + "role": { + "@odata.type": "#microsoft.graph.plannerRelationshipBasedUserType", + "roleKind": "relationship", + "role": "taskAssignees" + }, + "propertyRule": { + "move": [], + "delete": [], + "title": [], + "notes": [], + "priority": [], + "startDate": ["allow"], + "dueDate": ["allow"], + "percentComplete": ["allow"], + "order": ["allow"], + "previewType": [], + "ruleKind": "taskRule", + "references": { + "defaultRules": ["allow"], + "overrides": [ + { + "name": "userCreated", + "rules": ["allow"] + }, + { + "name": "applicationCreated", + "rules": ["block"] + } + ] + }, + "checkLists": { + "defaultRules": ["allow"], + "overrides": [ + { + "name": "userCreated", + "rules": ["allow"] + }, + { + "name": "applicationCreated", + "rules": ["check"] + } + ] + }, + "assignments": { + "defaultRules": ["block"], + "overrides": [ + { + "name": "userCreated", + "rules": ["removeSelf"] + }, + { + "name": "applicationCreated", + "rules": ["check"] + } + ] + }, + "appliedCategories": { + "defaultRules": [ + "allow" + ], + "overrides": [] + } + } + } + ] + } +} +``` |
v1.0 | Plannertaskconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannertaskconfiguration-update.md | + + Title: "Update plannerTaskConfiguration" +description: "Update the properties of a plannerTaskConfiguration object." ++ms.localizationpriority: medium +++# Update plannerTaskConfiguration ++Namespace: microsoft.graph +++Update the properties of a [plannerTaskConfiguration](../resources/plannertaskconfiguration.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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /solutions/businessScenarios/{businessScenarioId}/planner/taskConfiguration +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|editPolicy|[plannerTaskPolicy](../resources/plannertaskpolicy.md)|Policy configuration for tasks created for a [businessScenario](../resources/businessscenario.md) when they are being changed outside of the scenario. Optional.| ++## Response ++If successful, this method returns a `200 OK` response code and an updated [plannerTaskConfiguration](../resources/plannertaskconfiguration.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "update_plannertaskconfiguration", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/taskConfiguration +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerTaskConfiguration", + "editPolicy": { + "rules": [ + { + "defaultRule": "block", + "role": { + "@odata.type": "#microsoft.graph.plannerRelationshipBasedUserType", + "roleKind": "relationship", + "role": "defaultRules" + }, + "propertyRule": { + "percentComplete": ["allow"], + "ruleKind": "taskRule", + "assignments": { + "defaultRules": ["addSelf"], + "overrides": [] + } + } + }, + { + "defaultRule": "block", + "role": { + "@odata.type": "#microsoft.graph.plannerRelationshipBasedUserType", + "roleKind": "relationship", + "role": "taskAssignees" + }, + "propertyRule": { + "startDate": ["allow"], + "dueDate": ["allow"], + "percentComplete": ["allow"], + "order": ["allow"], + "ruleKind": "taskRule", + "references": { + "defaultRules": ["allow"], + "overrides": [ + { + "name": "userCreated", + "rules": ["allow"] + }, + { + "name": "applicationCreated", + "rules": ["block"] + } + ] + }, + "checkLists": { + "defaultRules": ["allow"], + "overrides": [ + { + "name": "userCreated", + "rules": ["allow"] + }, + { + "name": "applicationCreated", + "rules": ["check"] + } + ] + }, + "assignments": { + "defaultRules": ["block"], + "overrides": [ + { + "name": "userCreated", + "rules": ["removeSelf"] + }, + { + "name": "applicationCreated", + "rules": ["check"] + } + ] + }, + "appliedCategories": { + "defaultRules": [ + "allow" + ], + "overrides": [] + } + } + } + ] + } +} +``` ++### 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.plannerTaskConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.plannerTaskConfiguration", + "id": "52be01e6291f403aa49f2b9f5288ab48", + "editPolicy": { + "rules": [ + { + "defaultRule": "block", + "role": { + "@odata.type": "#microsoft.graph.plannerRelationshipBasedUserType", + "roleKind": "relationship", + "role": "defaultRules" + }, + "propertyRule": { + "move": [], + "delete": [], + "title": [], + "notes": [], + "priority": [], + "startDate": [], + "dueDate": [], + "percentComplete": ["allow"], + "order": [], + "previewType": [], + "ruleKind": "taskRule", + "references": null, + "checkLists": null, + "assignments": { + "defaultRules": ["addSelf"], + "overrides": [] + }, + "appliedCategories": null + } + }, + { + "defaultRule": "block", + "role": { + "@odata.type": "#microsoft.graph.plannerRelationshipBasedUserType", + "roleKind": "relationship", + "role": "taskAssignees" + }, + "propertyRule": { + "move": [], + "delete": [], + "title": [], + "notes": [], + "priority": [], + "startDate": ["allow"], + "dueDate": ["allow"], + "percentComplete": ["allow"], + "order": ["allow"], + "previewType": [], + "ruleKind": "taskRule", + "references": { + "defaultRules": ["allow"], + "overrides": [ + { + "name": "userCreated", + "rules": ["allow"] + }, + { + "name": "applicationCreated", + "rules": ["block"] + } + ] + }, + "checkLists": { + "defaultRules": ["allow"], + "overrides": [ + { + "name": "userCreated", + "rules": ["allow"] + }, + { + "name": "applicationCreated", + "rules": ["check"] + } + ] + }, + "assignments": { + "defaultRules": ["block"], + "overrides": [ + { + "name": "userCreated", + "rules": ["removeSelf"] + }, + { + "name": "applicationCreated", + "rules": ["check"] + } + ] + }, + "appliedCategories": { + "defaultRules": [ + "allow" + ], + "overrides": [] + } + } + } + ] + } +} +``` |
v1.0 | Presence Setstatusmessage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/presence-setstatusmessage.md | + + Title: "presence: setStatusMessage" +description: "Set a presence status message for a user." ++ms.localizationpriority: medium +++# presence: setStatusMessage ++Namespace: microsoft.graph +++Set a presence status message for a user. An optional expiration date and time can be supplied. ++## Permissions +The following permission is required to call the 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) | Presence.ReadWrite | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Not supported. | ++## HTTP Request +<!-- { "blockType": "ignored" } --> +```http +POST /users/{userId}/presence/setStatusMessage +``` ++## 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 parameters. ++| Parameter | Type | Description | +| | |- | +| `statusMessage` | [microsoft.graph.presenceStatusMessage](../resources/presencestatusmessage.md) |It can be set to display the presence status message of a user. | ++## Response +If successful, this method returns a `200 OK` response code. ++## Examples ++### Example 1: Set status message with expiry date ++The following request sets the presence status message as "Hey I'm currently in a meeting." for user `fa8bf3dc-eca7-46b7-bad1-db199b62afc3`, with the expiration on `2022-10-18 at 17:05:33.2079781 Pacific Standard Time`. ++#### Request +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "setstatusmessage" +}--> ++```http +POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setStatusMessage +Content-Type: application/json ++{ + "statusMessage": { + "message": { + "content": "Hey I'm currently in a meeting.", + "contentType": "text" + }, + "expiryDateTime": { + "dateTime": "2022-10-18T17:05:33.2079781", + "timeZone": "Pacific Standard Time" + } + } +} +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++++#### Response ++<!-- { + "blockType": "response", + "name": "setstatusmessage", + "truncated": true +} --> +```http +HTTP/1.1 200 OK +``` ++### Example 2: Get status message of another user ++The following request sets the presence status message as "Hey I'm currently in a meeting." for user `fa8bf3dc-eca7-46b7-bad1-db199b62afc3`. Then presence for user `fa8bf3dc-eca7-46b7-bad1-db199b62afc3` is obtained on behalf of other user via a [getPresence](presence-get.md) request. ++#### Set status message: request +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "setstatusmessage-another-user" +}--> +```http +POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setStatusMessage +Content-Type: application/json ++{ + "statusMessage": { + "message": { + "content": "Hey I am available now", + "contentType": "text" + } + } +} +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++++#### Set status message: response ++<!-- { + "blockType": "response", + "name": "setstatusmessage-another-user", + "truncated": true +} --> +```http +HTTP/1.1 200 OK +``` ++#### Get another user presence: request +This request should be executed on behalf of another user. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "setstatusmessage-another-user-get-presence" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++++#### Get another user presence: response +Since this presence request does not qualify as a [self presence](presence-get.md#example-1-get-your-own-presence-information) request, `statusMessage.expiryDateTime` and `statusMessage.publishedDateTime` properties are not included in the response body. ++<!-- { + "blockType": "response", + "name": "setstatusmessage-another-user-get-presence", + "@odata.type": "microsoft.graph.presence", + "truncated":"true" +} --> +```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "fa8bf3dc-eca7-46b7-bad1-db199b62afc3", + "availability": "Available", + "activity": "Available", + "outOfOfficeSettings": { + "message": null, + "isOutOfOffice": false + }, + "statusMessage": { + "message": { + "content": "Hey I am available now", + "contentType": "text" + } + } +} +``` |
v1.0 | Print List Connectors | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/print-list-connectors.md | Title: List printConnectors -description: Retrieve a list of connectors. -+ Title: "List printConnectors" +description: "Retrieve a list of connectors." + ms.localizationpriority: medium doc_type: apiPageType To use the Universal Print service, the user or app's tenant must have an active |Permission type | Permissions (from least to most privileged) | |:|:--| |Delegated (work or school account)| PrintConnector.Read.All, PrintConnector.ReadWrite.All |-|Delegated (personal Microsoft account)|Not Supported.| -|Application| Not Supported. | +|Delegated (personal Microsoft account)|Not supported.| +|Application| Not supported. | ## HTTP request <!-- { "blockType": "ignored" } --> GET /print/connectors This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ### Exceptions-Some operators are not supported: `$count`, `$search`, `$filter`. +The following operators are not supported: `$count`, `$search`, `$filter`. ## Request headers | Name |Description| Some operators are not supported: `$count`, `$search`, `$filter`. ## Request body Do not supply a request body for this method.+ ## Response-If successful, this method returns a `200 OK` response code and collection of [printConnector](../resources/printconnector.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [printConnector](../resources/printconnector.md) objects in the response body. + ## Example+ ### Request+ The following is an example of the request. # [HTTP](#tab/http) |
v1.0 | Privilegedapproval Post Privilegedapproval | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedapproval-post-privilegedapproval.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/go/create-privilegedapproval-from-privilegedapproval-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-privilegedapproval-from-privilegedapproval-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Reportroot Getcredentialuserregistrationcount | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-getcredentialuserregistrationcount.md | GET https://graph.microsoft.com/beta/reports/getCredentialUserRegistrationCount [!INCLUDE [sample-code](../includes/snippets/go/reportroot-getcredentialuserregistrationcount-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/reportroot-getcredentialuserregistrationcount-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
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 Previously updated : 03/20/2019 doc_type: apiPageType # riskyUser: confirmCompromised |
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 Previously updated : 03/20/2019 doc_type: apiPageType |
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 | Search Query | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-query.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) | Mail.Read, Calendars.Read, Files.Read.All, Sites.Read.All, ExternalItem.Read.All, Acronym.Read.All, Bookmark.Read.All, ChannelMessage.Read.All, Chat.Read | +| Delegated (work or school account) | Mail.Read, Calendars.Read, Files.Read.All, Sites.Read.All, ExternalItem.Read.All, Acronym.Read.All, Bookmark.Read.All, ChannelMessage.Read.All, Chat.Read, QnA.Read.All | | Delegated (personal Microsoft account) | Not supported. | | Application | Files.Read.All, Sites.Read.All | |
v1.0 | Security Ediscoverysearch Purgedata | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-ediscoverysearch-purgedata.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Permanently delete Microsoft Teams messages contained in a [eDiscovery search](../resources/security-ediscoverysearch.md). +Delete Microsoft Teams messages contained in a [eDiscovery search](../resources/security-ediscoverysearch.md). >**Note:** This request purges Teams data only. It does not purge other types of data such as mailbox items. |
v1.0 | Security Emailthreatsubmissionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-emailthreatsubmissionpolicy-update.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/go/update-emailthreatsubmissionpolicy-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-emailthreatsubmissionpolicy-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Incident Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-incident-get.md | Content-type: application/json "determination": "MultiStagedAttack", "status": "Active", "severity": "Medium",- "tags": [ + "customTags": [ "Demo" ], "comments": [ |
v1.0 | Security Incident Post Comments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-incident-post-comments.md | ms.prod: "security" doc_type: apiPageType -# Create comment for incident +# Create comment Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] |
v1.0 | Security Incident Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-incident-update.md | PATCH /security/incidents/{incidentId} |classification|microsoft.graph.security.alertClassification|The specification for the incident. Possible values are: `unknown`, `falsePositive`, `truePositive`, `informationalExpectedActivity`, `unknownFutureValue`.| |determination|microsoft.graph.security.alertDetermination|Specifies the determination of the incident. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedUser`, `phishing`, `maliciousUserActivity`, `clean`, `insufficientData`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| |status|microsoft.graph.security.incidentStatus|The status of the incident. Possible values are: `active`, `resolved`, `redirected`, `unknownFutureValue`.|-|tags|String collection|Array of custom tags associated with an incident.| +|customTags|String collection|Array of custom tags associated with an incident.| ## Response Content-Type: application/json { "classification": "TruePositive", "determination": "MultiStagedAttack",- "tags": [ + "customTags": [ "Demo" ] } Content-Type: application/json "determination": "MultiStagedAttack", "status": "Active", "severity": "Medium",- "tags": [ + "customTags": [ "Demo" ], "comments": [ |
v1.0 | Security List Incidents | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-list-incidents.md | If successful, this method returns a `200 OK` response code and a collection of ## Examples ### Example 1: List all incidents-### Request +#### Request # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/security/incidents -### Response +#### Response >**Note:** The response object shown here might be shortened for readability. <!-- { Content-Type: application/json "determination": "MultiStagedAttack", "status": "Active", "severity": "Medium",- "tags": [ + "customTags": [ "Demo" ], "comments": [ Content-Type: application/json } ``` -### Example 2: List all incidents with their alerts. -### Request +### Example 2: List all incidents with their alerts +#### Request # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/security/incidents?$expand=alerts -### Response +#### Response >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", |
v1.0 | Security Security Runhuntingquery | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-security-runhuntingquery.md | Namespace: microsoft.graph.security Queries a specified set of event, activity, or entity data supported by Microsoft 365 Defender to proactively look for specific threats in your environment. -This is the method for advanced hunting in Microsoft 365 Defender. This method includes a query in Kusto Query Language (KQL). It specifies a data table in the [advanced hunting schema](/microsoft-365/security/defender/advanced-hunting-schema-tables?view=o365-worldwide) and a piped sequence of operators to filter or search that data, and format the query output in specific ways. +This is the method for advanced hunting in Microsoft 365 Defender. This method includes a query in Kusto Query Language (KQL). It specifies a data table in the [advanced hunting schema](/microsoft-365/security/defender/advanced-hunting-schema-tables?view=o365-worldwide&preserve-view=true) and a piped sequence of operators to filter or search that data, and format the query output in specific ways. -Find out more about [hunting for threats across devices, emails, apps, and identities](/microsoft-365/security/defender/advanced-hunting-query-emails-devices?view=o365-worldwide). Learn about [KQL](/azure/data-explorer/kusto/query/). +Find out more about [hunting for threats across devices, emails, apps, and identities](/microsoft-365/security/defender/advanced-hunting-query-emails-devices?view=o365-worldwide&preserve-view=true). Learn about [KQL](/azure/data-explorer/kusto/query/). -For information on using advanced hunting in the [Microsoft 365 Defender portal](/microsoft-365/security/defender/microsoft-365-defender-portal?view=o365-worldwide), see [Proactively hunt for threats with advanced hunting in Microsoft 365 Defender](/microsoft-365/security/defender/advanced-hunting-overview?view=o365-worldwide). +For information on using advanced hunting in the [Microsoft 365 Defender portal](/microsoft-365/security/defender/microsoft-365-defender-portal?view=o365-worldwide&preserve-view=true), see [Proactively hunt for threats with advanced hunting in Microsoft 365 Defender](/microsoft-365/security/defender/advanced-hunting-overview?view=o365-worldwide&preserve-view=true). ## 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). If successful, this action returns a `200 OK` response code and a [huntingQueryR ### Request This example specifies a KQL query which does the following:-- Looks into the [DeviceProcessEvents](/microsoft-365/security/defender/advanced-hunting-deviceprocessevents-table?view=o365-worldwide) table in the advanced hunting schema.+- Looks into the [DeviceProcessEvents](/microsoft-365/security/defender/advanced-hunting-deviceprocessevents-table?view=o365-worldwide&preserve-view=true) table in the advanced hunting schema. - Filters on the condition that the event is initiated by the powershell.exe process. - Specifies the output of 3 columns from the same table for each row: `Timestamp`, `FileName`, `InitiatingProcessFileName`. - Sorts the output by the `Timestamp` value. |
v1.0 | Securityaction Cancelsecurityaction | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/securityaction-cancelsecurityaction.md | POST https://graph.microsoft.com/beta/security/securityActions/{id}/cancelSecuri [!INCLUDE [sample-code](../includes/snippets/go/securityaction-cancelsecurityaction-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/securityaction-cancelsecurityaction-php-snippets.md)] [!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/beta/api/serviceprincipal-post-owners.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Add an owner for the [servicePrincipal](../resources/serviceprincipal.md). +Add an owner for the [servicePrincipal](../resources/serviceprincipal.md). Service principal owners can be users, the service principal itself, or other service principals. ## 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 | Sitepage Getwebpartsbyposition | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/sitepage-getwebpartsbyposition.md | Title: 'sitepage: get webparts by position' -description: 'Get a collection of webParts by position information' + Title: "sitepage: getWebPartsByPosition" +description: "Get a collection of webParts by position information" ms.localizationpriority: medium ms.prod: sharepoint doc_type: apiPageType -# sitepage: get webparts by position +# sitepage: getWebPartsByPosition Namespace: microsoft.graph |
v1.0 | Smsauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-delete.md | Title: "Delete smsAuthenticationMethodConfiguration" description: "Delete a smsAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Smsauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-get.md | Title: "Get smsAuthenticationMethodConfiguration" description: "Read the properties and relationships of a smsAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType Content-Type: application/json "isRegistrationRequired": false, "isUsableForSignIn": true }- ] + ], + "excludeTargets": [] } ``` |
v1.0 | Smsauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-update.md | Title: "Update smsAuthenticationMethodConfiguration" description: "Update the properties of a smsAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType The following table shows the properties that are required when you update the [ ## Response -If successful, this method returns a `200 OK` response code and an updated [smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.md) object in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Examples 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, - "@odata.type": "microsoft.graph.smsAuthenticationMethodConfiguration" + "truncated": true } --> ``` http-HTTP/1.1 200 OK -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration", - "id": "713980c7-80c7-7139-c780-3971c7803971", - "state": "String" -} +HTTP/1.1 204 No Content ``` |
v1.0 | Softwareoathauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethodconfiguration-delete.md | + + Title: "Delete softwareOathAuthenticationMethodConfiguration" +description: "Delete a softwareOathAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium +++# Delete softwareOathAuthenticationMethodConfiguration +Namespace: microsoft.graph +++Revert the [third-party software Oath authentication method policy](../resources/softwareoathauthenticationmethodconfiguration.md) to its default configuration. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|Policy.ReadWrite.AuthenticationMethod| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.ReadWrite.AuthenticationMethod| ++For delegated scenarios, the administrator needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles): ++* Authentication Policy Administrator +* Global Administrator ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/softwareOath +``` ++## 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_softwareoathauthenticationmethodconfiguration" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/softwareOath +``` ++# [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 | Softwareoathauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethodconfiguration-get.md | + + Title: "Get softwareOathAuthenticationMethodConfiguration" +description: "Read the properties and relationships of a softwareOathAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium +++# Get softwareOathAuthenticationMethodConfiguration +Namespace: microsoft.graph +++Read the properties and relationships of a [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object, which represents the third-party software OATH authentication method policy for the Azure AD 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)|Policy.Read.All, Policy.ReadWrite.AuthenticationMethod| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.Read.All, Policy.ReadWrite.AuthenticationMethod| ++For delegated scenarios, the administrator needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles): ++* Global Reader +* Authentication Policy Administrator +* Global Administrator ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/softwareOath +``` ++## 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 [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object in the response body. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_softwareoathauthenticationmethodconfiguration" +} +--> +``` http +GET https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/softwareOath +``` ++# [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.softwareOathAuthenticationMethodConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.softwareOathAuthenticationMethodConfiguration", + "id": "SoftwareOath", + "state": "enabled", + "includeTargets": [ + { + "targetType": "group", + "id": "all_users", + "isRegistrationRequired": false + } + ], + "excludeTargets": [] + } +} +``` + |
v1.0 | Softwareoathauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethodconfiguration-update.md | + + Title: "Update softwareOathAuthenticationMethodConfiguration" +description: "Update the properties of a softwareOathAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium +++# Update softwareOathAuthenticationMethodConfiguration +Namespace: microsoft.graph +++Update the properties of a [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object, which represents the third-party software OATH authentication method policy for the Azure AD 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)|Policy.ReadWrite.AuthenticationMethod| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.ReadWrite.AuthenticationMethod| ++For delegated scenarios, the administrator needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles): ++* Authentication Policy Administrator +* Global Administrator ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/softwareOath +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object with the values of fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. ++For the list of properties, see [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md). ++>**Note:** The `@odata.type` property with a value of `#microsoft.graph.softwareOathAuthenticationMethodConfiguration` must be included in the body. ++## Response ++If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_softwareoathauthenticationmethodconfiguration" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/softwareOath +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.softwareOathAuthenticationMethodConfiguration", + "state": "disabled" +} +``` ++# [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 | Solutionsroot Delete Businessscenarios | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/solutionsroot-delete-businessscenarios.md | + + Title: "Delete businessScenario" +description: "Delete a businessScenario object." ++ms.localizationpriority: medium +++# Delete businessScenario ++Namespace: microsoft.graph +++Delete a [businessScenario](../resources/businessscenario.md) object. The deletion of a scenario causes all data associated with the scenario to be deleted. ++## 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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application| BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /solutions/businessScenarios/{businessScenarioId} +``` ++## 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. +<!-- { + "blockType": "request", + "name": "delete_businessscenario", + "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] +} +--> +``` http +DELETE https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d +``` ++### Response ++The following is an example of the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Solutionsroot List Businessscenarios | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/solutionsroot-list-businessscenarios.md | + + Title: "List businessScenarios" +description: "Get a list of all businessScenario objects in an organization." ++ms.localizationpriority: medium +++# List businessScenarios ++Namespace: microsoft.graph +++Get a list of all [businessScenario](../resources/businessscenario.md) objects in an organization. ++## 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)|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.Read.All, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|BusinessScenarioConfig.Read.OwnedBy, BusinessScenarioConfig.ReadWrite.OwnedBy| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/businessScenarios +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body ++Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [businessScenario](../resources/businessscenario.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "list_businessscenario" +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/businessScenarios +``` ++### 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.businessScenario)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.businessScenario", + "id": "c5d514e6c6864911ac46c720affb6e4d", + "displayName": "Contoso Order Tracking", + "uniqueName": "com.contoso.apps.ordertracking", + "ownerAppIds": [ + "44109254-4b2b-7a33-76ee-c890a167b295" + ] + } + ] +} +``` |
v1.0 | Solutionsroot Post Businessscenarios | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/solutionsroot-post-businessscenarios.md | + + Title: "Create businessScenario" +description: "Create a new businessScenario object." ++ms.localizationpriority: medium +++# Create businessScenario +Namespace: microsoft.graph +++Create a new [businessScenario](../resources/businessscenario.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)|BusinessScenarioConfig.ReadWrite.OwnedBy, BusinessScenarioConfig.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application| BusinessScenarioConfig.ReadWrite.OwnedBy | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/businessScenarios +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body ++In the request body, supply a JSON representation of the [businessScenario](../resources/businessscenario.md) object. ++You can specify the following properties when you create a **businessScenario**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Display name of the scenario. Required.| +|uniqueName|String|Unique name of the scenario. To avoid conflicts, the recommended value for the unique name is a reverse domain name format, owned by the author of the scenario. For example, a scenario authored by *Contoso.com* would have a unique name that starts with `com.contoso`. Required.| +|ownerAppIds|String collection|Identifiers of applications that are authorized to work with this scenario. The application that creates the scenario will be automatically added to the list. Optional.| ++## Response ++If successful, this method returns a `201 Created` response code and a [businessScenario](../resources/businessscenario.md) object in the response body. ++## Examples ++### Request ++The following is an example of a request. +<!-- { + "blockType": "request", + "name": "create_businessscenario_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/solutions/businessScenarios +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenario", + "displayName": "Contoso Order Tracking", + "uniqueName": "com.contoso.apps.ordertracking" +} +``` ++### 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.businessScenario" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.businessScenario", + "id": "c5d514e6c6864911ac46c720affb6e4d", + "displayName": "Contoso Order Tracking", + "uniqueName": "com.contoso.apps.ordertracking", + "ownerAppIds": [ + "44109254-4b2b-7a33-76ee-c890a167b295" + ] +} +``` |
v1.0 | Team List Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-list-installedapps.md | GET https://graph.microsoft.com/beta/teams/6903fa93-605b-43ef-920e-77c4729f8258/ [!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 | Team Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-post.md | Content-Type: application/json [!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) |
v1.0 | Teamworkdeviceconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/teamworkdeviceconfiguration-get.md | If successful, this method returns a `200 OK` response code and a [teamworkDevic ### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/teamwork/devices/e19229ed-29ed-e192-ed29-92 +### Response +The following is an example of the response. -### Response >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", |
v1.0 | Teamworkdevicehealth Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/teamworkdevicehealth-get.md | If successful, this method returns a `200 OK` response code and a [teamworkDevic ### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/teamwork/devices/d8214fe3-4fe3-d821-e34f-21 ### Response++The following is an example of the response. + >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", |
v1.0 | Temporaryaccesspassauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/temporaryaccesspassauthenticationmethodconfiguration-get.md | Content-Type: application/json "id": "all_users", "isRegistrationRequired": false }- ] + ], + "excludeTargets": [] } ``` |
v1.0 | Timecard List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/timecard-list.md | GET https://graph.microsoft.com/beta/teams/fd15cad8-80f6-484f-9666-3caf695fbf32/ [!INCLUDE [sample-code](../includes/snippets/go/timecard-list-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/timecard-list-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Todotask Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/todotask-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/update-todotask-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-todotask-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Unifiedroledefinition Assignedprincipals | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedroledefinition-assignedprincipals.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application|RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory| -If the caller does not have the permission to read properties for some of the objects included in the result set, the response will follow the [limited information returned for inaccessible member objects](/graph/permissions-reference#limited-information-returned-for-inaccessible-member-objects) pattern. +If the caller does not have the permission to read properties for some of the objects included in the result set, the response will follow the [limited information returned for inaccessible member objects](/graph/permissions-overview#limited-information-returned-for-inaccessible-member-objects) pattern. To read the properties that may require permissions for the object, grant the permissions to retrieve information about the object. For more information, see permissions for [users](user-list.md#permissions), [groups](group-list.md#permissions), and [service principals](serviceprincipal-list.md#permissions). |
v1.0 | User Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-get.md | Title: "Get a user" + Title: "Get user" description: "Retrieve the properties and relationships of user object." ms.localizationpriority: high ms.prod: "users" doc_type: apiPageType -# Get a user +# Get user Namespace: microsoft.graph Content-type: application/json "customSecurityAttributes": null } ```+### Example 5: Use `$filter` to retrieve specific users based on a property value -### Example 5: Get the value of a schema extension for a user +This example shows how to use the `$filter` query parameter along with the `endswith` clause to retrieve a user with a specific value in the **mail** attribute. This request filters and returns all users with a mail address ending with contoso.com. ++#### Request +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_user_filter" +} --> +```msgraph-interactive +GET https://graph.microsoft.com/beta/users?$count=true&ConsistencyLevel=eventual&$filter=endsWith(mail,'@contoso.com') +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++#### Response ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.user", + "name": "get_user_filter" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#users", + "@odata.count": 1350, + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users?$count=true&$filter=endsWith(mail,'@contoso.com')&ConsistencyLevel=eventual&$skiptoken=m~AQAnOzEyN2NjN2I3NTQzYzQ0YzA4NjlhYjU5MzUzYmNhNGI2OzswOzA7", + "value": [ + { + "businessPhones": [], + "displayName": "Phantom Space", + "givenName": "Space", + "jobTitle": null, + "mail": "Space.Phantom@cloudezzy.com", + "mobilePhone": null, + "officeLocation": null, + "preferredLanguage": null, + "surname": "Phantom", + "userPrincipalName": "Space.Phantom@contoso.com", + "id": "00111916-c5c5-4dd2-9e31-aab96af7511e" + } + ] +} +``` ++### Example 6: Get the value of a schema extension for a user In this example, the ID of the schema extension is `ext55gb1l09_msLearnCourses`. Content-type: application/json } ``` --- ## See also - [Add custom data to resources using extensions](/graph/extensibility-overview) |
v1.0 | User List Mailfolders | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-mailfolders.md | If successful, this method returns a `200 OK` response code and collection of [m This example includes a **mailSearchFolder** object in the response. The mail search folder is a child folder under the Inbox with the display name "Weekly digests". #### Request-Here is an example of the request. +The following is an example of the request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/me/mailFolders #### Response-Here 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. <!-- { GET https://graph.microsoft.com/beta/me/mailFolders/?includeHiddenFolders=true #### Response-Here is an example of the response. +The following is an example of the response. >**Note:** The response object shown here is shortened for readability, and doesn't include all the default folders in a user mailbox. <!-- { |
v1.0 | User List Manager | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-manager.md | GET https://graph.microsoft.com/beta/users/{id|userPrincipalName}/manager [!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 | User Sendmail | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-sendmail.md | Content-type: application/json [!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 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-update.md | Namespace: microsoft.graph Update the properties of a [user](../resources/user.md) object. Not all properties can be updated by Member or Guest users with their default permissions without Administrator roles. [Compare member and guest default permissions](/azure/active-directory/fundamentals/users-default-permissions?context=graph/context#compare-member-and-guest-default-permissions) to see properties they can manage. ## Permissions-One of the following pefrmissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +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) | |:--|:| |
v1.0 | Userteamwork List Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/userteamwork-list-installedapps.md | GET https://graph.microsoft.com/beta/users/{id}/teamwork/installedApps [!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 | Verticalsection Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/verticalsection-get.md | GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) ++# [PHP](#tab/php) + GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/canvasLa [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) ++# [PHP](#tab/php) + |
v1.0 | Virtualendpoint List Supportedregions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/virtualendpoint-list-supportedregions.md | Content-Type: application/json "id": "109919f3-19f3-1099-f319-9910f3199910", "displayName": "Demo-1", "regionStatus": "available",- "supportedSolution": "windows365" + "supportedSolution": "windows365", + "regionGroup": "usCentral" } ] } |
v1.0 | Voiceauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/voiceauthenticationmethodconfiguration-delete.md | + + Title: "Delete voiceAuthenticationMethodConfiguration" +description: "Delete a voiceAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium +++# Delete voiceAuthenticationMethodConfiguration +Namespace: microsoft.graph +++Revert the [voice call authentication method policy](../resources/voiceauthenticationmethodconfiguration.md) to its default configuration. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|Policy.ReadWrite.AuthenticationMethod| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.ReadWrite.AuthenticationMethod| ++For delegated scenarios, the administrator needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles): ++* Authentication Policy Administrator +* Global Administrator ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/voice +``` ++## 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_voiceauthenticationmethodconfiguration" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/voice +``` ++# [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 | Voiceauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/voiceauthenticationmethodconfiguration-get.md | + + Title: "Get voiceAuthenticationMethodConfiguration" +description: "Read the properties and relationships of a voiceAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium +++# Get voiceAuthenticationMethodConfiguration +Namespace: microsoft.graph +++Read the properties and relationships of a [voiceAuthenticationMethodConfiguration](../resources/voiceauthenticationmethodconfiguration.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)|Policy.Read.All, Policy.ReadWrite.AuthenticationMethod| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.Read.All, Policy.ReadWrite.AuthenticationMethod| ++For delegated scenarios, the administrator needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles): ++* Global Reader +* Authentication Policy Administrator +* Global Administrator ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/voice +``` ++## 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 [voiceAuthenticationMethodConfiguration](../resources/voiceauthenticationmethodconfiguration.md) object in the response body. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_voiceauthenticationmethodconfiguration" +} +--> +``` http +GET https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/voice +``` ++# [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.voiceAuthenticationMethodConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.voiceAuthenticationMethodConfiguration", + "id": "Voice", + "state": "enabled", + "includeTargets": [ + { + "targetType": "group", + "id": "all_users", + "isRegistrationRequired": false + } + ], + "excludeTargets": [], + "isOfficePhoneAllowed": "true" + } +} +``` + |
v1.0 | Voiceauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/voiceauthenticationmethodconfiguration-update.md | + + Title: "Update voiceAuthenticationMethodConfiguration" +description: "Update the properties of a voiceAuthenticationMethodConfiguration object." ++ms.localizationpriority: medium +++# Update voiceAuthenticationMethodConfiguration +Namespace: microsoft.graph +++Update the properties of a [voiceAuthenticationMethodConfiguration](../resources/voiceauthenticationmethodconfiguration.md) object, which represents the voice call authentication method policy for the Azure AD 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)|Policy.ReadWrite.AuthenticationMethod| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Policy.ReadWrite.AuthenticationMethod| ++For delegated scenarios, the administrator needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles): ++* Authentication Policy Administrator +* Global Administrator ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/voice +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [voiceAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object with the values of fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. ++For the list of properties, see [voiceAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md). ++>**Note:** The `@odata.type` property with a value of `#microsoft.graph.voiceAuthenticationMethodConfiguration` must be included in the body. ++## Response ++If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_voiceauthenticationmethodconfiguration" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/voice +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.voiceAuthenticationMethodConfiguration", + "isOfficePhoneAllowed": "false" +} +``` ++# [JavaScript](#tab/javascript) ++# [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 | Webpart Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/webpart-get.md | If successful, this method returns a `200 OK` response code and a [standardWebPa The following is an example of a request. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_webpart" } --> -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/webParts/{webPartId} ``` +# [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 |
v1.0 | Webpart Getposition | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/webpart-getposition.md | If successful, this method returns a `200 OK` response code and a [webPartPositi The following is an example of a request. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "getposition_webpart" } --> -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/webParts/{webPartId}/getPositionOfWebPart ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PHP](#tab/php) ++++ ### Response The following is an example of the response |
v1.0 | Windowsupdates Deployment Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/windowsupdates-deployment-update.md | PATCH /admin/windows/updates/deployments/{deploymentId} ## Request body In the request body, supply a JSON representation of the [deployment](../resources/windowsupdates-deployment.md) object. -The following table shows the properties that can be set when you update the [deployment](../resources/windowsupdates-deployment.md). +The following table shows the properties that can be set when you update a [deployment](../resources/windowsupdates-deployment.md). |Property|Type|Description| |:|:|:| If successful, this method returns a `202 Accepted` response code and an updated ## Examples -### Example: Pause a deployment +### Example 1: Pause a deployment -In this example, the deployment is paused by updating the `requestedValue` of the deployment `state`. +In this example, the deployment is paused by updating the **requestedValue** of the deployment **state**. #### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json #### Response +The following is an example of the response. + <!-- { "blockType": "response", "truncated": true, Content-Type: application/json } ``` -### Example: Update deployment settings to add a monitoring rule +### Example 2: Update deployment settings to add a monitoring rule -In this example, the `settings` property of the deployment is updated to add a monitoring rule. +In this example, the **settings** property of the deployment is updated to add a monitoring rule. #### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json #### Response +The following is an example of the response. + <!-- { "blockType": "response", "truncated": true, |
v1.0 | Workbook Createsession | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/workbook-createsession.md | If successful, this method returns a `201 Created` response code and a [workbook ### Example 1: Session creation with long-running operation pattern #### Request++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_excel_session_with_long_running" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++++ #### Response >**Note:** The response object shown here might be shortened for readability. <!-- { |
v1.0 | X509certificateauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-get.md | Content-Type: application/json "id": "all_users", "isRegistrationRequired": false }- ] + ], + "excludeTargets": [] } ``` |
v1.0 | X509certificateauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-update.md | The following properties can be updated. ## Response -If successful, this method returns a `204 No Content` response code and an updated [x509CertificateAuthenticationMethodConfiguration](../resources/x509certificateauthenticationmethodconfiguration.md) object in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Examples |
v1.0 | Authenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationmethodconfiguration.md | The following authentication methods are derived from the **authenticationMethod ## Properties |Property|Type|Description| |:|:|:|+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from a policy.| |id|String|The policy name.| |state|authenticationMethodState|The state of the policy. Possible values are: `enabled`, `disabled`.| |
v1.0 | Authenticationmethods Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationmethods-overview.md | ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "conceptualPageType" Last updated : 10/21/2022 # Azure AD authentication methods API overview |
v1.0 | Authenticationmethods Usage Insights Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationmethods-usage-insights-overview.md | ms.localizationpriority: medium ms.prod: "identity-and-access-reports" doc_type: "conceptualPageType" Last updated : 01/25/2022 # Working with the authentication methods usage report API |
v1.0 | Authenticationmethodspolicies Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationmethodspolicies-overview.md | ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "conceptualPageType" Last updated : 02/05/2022 # Azure AD authentication methods policies API overview |
v1.0 | Authenticationmethodspolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationmethodspolicy.md | Defines authentication methods and the users that are allowed to use them to sig |id|String|The identifier of the policy. Inherited from [entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|The date and time of the last update to the policy.| |policyVersion|String|The version of the policy in use.|+|policyMigrationState|authenticationMethodsPolicyMigrationState|The state of migration of the authentication methods policy from the legacy multifactor authentication and self-service password reset (SSPR) policies. The possible values are: <br/><li>`premigration` - means the authentication methods policy is used for authentication only, legacy policies are respected. <li>`migrationInProgress` - means the authentication methods policy is used for both authenication and SSPR, legacy policies are respected. <li>`migrationComplete` - means the authentication methods policy is used for authentication and SSPR, legacy policies are ignored. <li>`unknownFutureValue` - Evolvable enumeration sentinel value. Do not use. | +|reconfirmationInDays|Int32|Days before the user will be asked to reconfirm their method. | |registrationEnforcement|[registrationEnforcement](../resources/registrationenforcement.md)|Enforce registration at sign-in time. This property can be used to remind users to set up targeted authentication methods.| ## Relationships |
v1.0 | Authenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationmethodtarget.md | Title: "authenticationMethodTarget resource type" -description: "A collection of users or groups enabled to use an authentication method as part of an authentication method policy." +description: "A collection of groups that are enabled to use an authentication method as part of an authentication method policy." ms.localizationpriority: medium ms.prod: "identity-and-sign-in" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A collection of users or groups enabled to use an authentication method as part of an authentication method policy in Azure AD. Inherits from [entity](entity.md). +A collection of groups that are enabled to use an authentication method as part of an authentication method policy in Azure AD. Inherits from [entity](entity.md). ## Properties A collection of users or groups enabled to use an authentication method as part |:|:|:| |id|String|Object identifier of an Azure AD user or group.| |isRegistrationRequired|Boolean|Determines if the user is enforced to register the authentication method.|-|targetType|authenticationMethodTargetType| Possible values are: `user`, `group`, and `unknownFutureValue`.| +|targetType|authenticationMethodTargetType| Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets will remain but we recommend to move the individual users to a targeted group.| |useForSignIn|Boolean|Determines if the authentication method can be used to sign in to Azure AD.| ## Relationships |
v1.0 | Authenticationstrengths Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationstrengths-overview.md | ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "conceptualPageType" Last updated : 12/10/2022 # Azure AD authentication strengths API overview |
v1.0 | Azure Ad Auditlog Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/azure-ad-auditlog-overview.md | ms.localizationpriority: high doc_type: conceptualPageType ms.prod: "identity-and-access-reports" Last updated : 09/16/2022 # Activity reports API overview |
v1.0 | Azure Ad Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/azure-ad-overview.md | ms.localizationpriority: high doc_type: conceptualPageType ms.prod: "identity-and-access" Last updated : 11/29/2022 # Working with Azure Active Directory resources in Microsoft Graph The following table lists some common use cases for Azure AD resources. | Manage and monitor time-bound privileged access to directory and Azure resources for administrators and IT professionals with Privileged Identity Management (PIM). | [Privileged Identity Management API](../resources/privilegedidentitymanagement-root.md) | [What is Azure AD Privileged Identity Management?](/azure/active-directory/active-directory-privileged-identity-management-configure)| | Monitor identity risk events like users signing in from malware-infected devices or from unfamiliar locations. | [Identity Protection Service API](../resources/identityprotection-overview.md) | [Azure Active Directory Identity Protection](/azure/active-directory/active-directory-identityprotection)<br/><br/>[Azure Active Directory risk events](/azure/active-directory/active-directory-reporting-risk-events) | | **Manage devices** | | |-| Manage devices registered in the organization. Devices are registered to users and include items like laptops, desktops, tablets, and mobile phones. Devices are typically created in the cloud using the Device Registration Service or by Microsoft Intune. They're used by conditional access policies for multifactor authentication. | [device](../resources/device.md) | [Getting started with Azure Active Directory device registration](/azure/active-directory/active-directory-device-registration-overview) | +| Manage devices registered in the organization. Devices are registered to users and include items like laptops, desktops, tablets, and mobile phones. Devices are typically created in the cloud using the Device Registration Service or by Microsoft Intune. They're used by conditional access policies for multifactor authentication. | [device](../resources/device.md) | [Getting started with Azure Active Directory device registration](/mem/intune/enrollment/).<br/><br/>[What is Intune?](/mem/intune/fundamentals/what-is-intune)<br/><br/>[Enroll devices for management in Intune](/mem/intune/enrollment/) | | **App management** | | | | Manage app configuration in a developer tenant. | [application](../resources/application.md) | [Application and service principal objects in Azure Active Directory](/azure/active-directory/develop/active-directory-application-objects) | | Manage apps installed in a tenant. | [servicePrinicpal](../resources/serviceprincipal.md) | [Application and service principal objects in Azure Active Directory](/azure/active-directory/develop/active-directory-application-objects) | |
v1.0 | Businessscenario Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenario-overview.md | + + Title: "Use the business scenarios API in Microsoft Graph (preview)" +description: "The business scenarios API allows for the creation and management of business scenarios that configure and manage the integration of data into Microsoft Graph." ++ms.localizationpriority: medium +++# Use the business scenarios API in Microsoft Graph (preview) +++The business scenarios API allows for the creation and management of business scenarios that configure and manage the integration of data into Microsoft Graph. ++## Structure of a business scenario ++A business scenario is represented by the [businessScenario](businessscenario.md) entity. A **businessScenario** resource specifies general information about the scenario, the apps that use that scenario, and configurations for entities that apps can manage to support the scenario. Apps can identify the instance of **businessScenario** by the **uniqueName** property using a reverse domain name format. ++### Entities available in business scenarios ++The business scenarios API is designed to allow Microsoft Graph services to extend it to support service-specific scenarios that are specific to customers. ++Currently, [Planner](businessscenario-planner-overview.md) has extended the API. The API supports custom scenario data for Planner in the [businessScenarioTask](businessscenariotask.md) entity. ++## Creating a business scenario ++Business scenarios can be created by applications using the delegated permission `BusinessScenarioConfig.ReadWrite.OwnedBy`. Creating a business scenario requires specifying a display name and a unique name. The unique name should be in the reverse DNS format to prevent conflict between independent scenarios. The reverse DNS format takes the domain name the scenario creator owns and reverses it. For example, if a developer who owns `apps.contoso.com` creates a scenario, the unique name of the scenario should start with `com.contoso.apps`. Then further segments can be added to differentiate scenarios or groups of scenarios; for example, `com.contoso.apps.customerSupport.ticketManagement`. The unique name of the scenario must be distinct from every other scenario deployed in a tenant. ++For more information, see [Create businessScenario](../api/solutionsroot-post-businessscenarios.md). ++## Configuring behaviors for entities ++Each service supported through business scenarios provides configurations in the scenario. Applications need to have the `BusinessScenarioConfig.Read.OwnedBy` permission to be able to access these configurations, and the `BusinessScenarioConfig.ReadWrite.OwnedBy` permission to be able to change them. Each configuration is specific for the service. For more details, see the following service-specific topics: ++* [Planner](businessscenario-planner-overview.md) provides the following configurations: + * [plannerPlanConfiguration](plannerplanconfiguration.md) + * [plannerTaskConfiguration](plannertaskconfiguration.md) ++## Creating and managing data for a business scenario ++Each service supported through business scenarios provides access to data within a scenario. Applications need to be listed as an owner in a scenario to work with the data in the scenario. Applications also need to have the `BusinessScenarioData.Read.OwnedBy` permission to be able to read the data, and the `BusinessScenarioData.ReadWrite.OwnedBy` permission to be able to create new data, or to modify previously created data. For more details, see the following service-specific topics: ++* [Planner](businessscenario-planner-overview.md), with the following supported entities: + * [businessScenarioTask](businessscenariotask.md) ++## Deleting a business scenario ++Applications that own a business scenario can delete the scenario if they have the `BusinessScenarioConfig.ReadWrite.OwnedBy` permission. Deleting the scenario removes all the data associated with the scenario as well. ++For more information, see [Delete businessScenario](../api/solutionsroot-delete-businessscenarios.md). ++## Common use cases ++| Use cases | REST resources | See also | +|:-|:|:| +|Create, read, update, and delete business scenarios|[businessScenario](businessscenario.md)|[Methods of businessScenario](businessscenario.md#methods)| +|Configure business scenarios for Planner| [plannerPlanConfiguration](plannerplanconfiguration.md) [plannerTaskConfiguration](plannertaskconfiguration.md)|[Methods of plannerPlanConfiguration](plannerplanconfiguration.md#methods) [Methods of plannerTaskConfiguration](plannertaskconfiguration.md#methods)| +|Create, read, update, and delete business scenario tasks in Planner| [businessScenarioTask](businessscenariotask.md)| [businessScenarioTask](businessscenariotask.md#methods)| ++## What's new ++Find out about the [latest new features and updates](/graph/whats-new-overview) for this API set. ++## Next steps ++The business scenarios API allows apps to model and integrate real work business processes with a Microsoft 365 service over 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). ++Need more ideas? See [how some of our partners are using Microsoft Graph](https://developer.microsoft.com/graph/partners). |
v1.0 | Businessscenario Planner Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenario-planner-overview.md | + + Title: "Use the business scenarios API in Microsoft Graph to integrate with Planner (preview)" +description: "Learn how to use the business scenarios in Microsoft Graph to integrate with Planner." ++ms.localizationpriority: medium +++# Use the business scenarios API in Microsoft Graph to integrate with Planner (preview) +++The [business scenarios API](businessscenario-overview.md) allows creating Planner tasks with scenario-controlled policies, in a specified target. ++## Planner configuration ++Using the business scenarios API, apps can configure Planner entities in two ways. First is the plan configuration which defines the elements of the plans created to host scenario tasks. Second is the task configuration which controls how created tasks behave for users and applications. ++### Plan configuration ++Plan configuration is represented by the [plannerPlanConfiguration](plannerplanconfiguration.md) entity. In plan configuration, the application can configure the buckets that appear in the plan, the order of these buckets, as well as the title of the plan and the name of the buckets. Each bucket is identified by an external ID, which can be used when creating tasks or updating the tasks to put them in the correct bucket. The buckets configured in the plan configuration do not specify any names to be used, instead this information is part of the localized names. Plan configuration also specifies localized names for the plan and the buckets as well as the default language code. Currently, created items will use the default language. ++### Task configuration ++Task configuration is represented by the [plannerTaskConfiguration](plannertaskconfiguration.md) entity. In task configuration, the application can configure the policies that restrict the access to the applications and users that will use the tasks managed by the scenario. The policies are grouped by [roles](plannerrelationshipbasedusertype.md). Each role identifies a group of callers, and each group can have different rules specified for them. The rules that apply to a specific call are picked in the following order. Only the first specified rules will apply, and the rules only apply when the request is modifying a task. ++- `taskAssignees`: Applies if the target task is assigned to the user making the call. +- `groupOwners`: Applies if the user making the call is an owner of the container that the plan of the target task is in. +- `groupMembers`: Applies if the user making the call is a member of the container that the plan of the task is in. +- `applications`: Applies if the caller is application permissions, therefore the call isn't associated with a user. +- `defaultRules`: Applies when none of the other conditions match. ++>**Note:** These rules restrict what the caller can do, but they cannot allow the caller to perform operations that they would otherwise not be permitted to. ++Each role specifies a default rule, and rules for specific actions and fields on task. The default rule must be either `allow` or `block`. If an action or field doesn't have a rule defined for it, the default rule is used to either keep it unrestricted for `allow`, or blocked from getting used for `block`. Keep in mind that this applies when new properties and actions are available to be configured, but the scenario configuration is not yet updated to specify rules for these. ++For more information about using rules, see [Configuring task rules in Planner](/graph/planner-task-rules-overview). ++## Targeting tasks ++Created tasks are placed in plans based on the specified target when they are created. In the current version, a [group](group.md) can be targeted. The task will be placed in the [plan](plannerplan.md) associated with the scenario in that group. If the group doesn't have a plan for the scenario, a new plan is going to be created based on the plan configuration. ++## Task metadata and behavior ++As part of the tasks, [scenario properties](businessscenarioproperties.md) are required. These properties include the external ID of the task, which is required to be specified for each task. This value must be unique within the tenant. If you create a second task with the same external ID, it causes the first task to be returned without any modifications. You can also use the external ID as an alternate key when working with tasks. Additionally, a context ID can be specified for each task. This value can be used to query the tasks with the same context ID, allowing the applications to group tasks across plans. |
v1.0 | Businessscenario | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenario.md | + + Title: "businessScenario resource type" +description: "Represents a scenario that collects relevant data and configuration for a specific problem domain." ++ms.localizationpriority: medium +++# businessScenario resource type ++Namespace: microsoft.graph +++Represents a scenario that collects relevant data and configuration for a specific problem domain. For more details about business scenarios, see [Business scenarios API overview](/graph/businessscenarios-concept-overview). ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List businessScenarios](../api/solutionsroot-list-businessscenarios.md)|[businessScenario](../resources/businessscenario.md) collection|Get a list of all [businessScenario](../resources/businessscenario.md) objects in an organization.| +|[Create businessScenario](../api/solutionsroot-post-businessscenarios.md)|[businessScenario](../resources/businessscenario.md)|Create a new [businessScenario](../resources/businessscenario.md) object.| +|[Get businessScenario](../api/businessscenario-get.md)|[businessScenario](../resources/businessscenario.md)|Read the properties and relationships of a [businessScenario](../resources/businessscenario.md) object.| +|[Update businessScenario](../api/businessscenario-update.md)|[businessScenario](../resources/businessscenario.md)|Update the properties of a [businessScenario](../resources/businessscenario.md) object.| +|[Delete businessScenario](../api/solutionsroot-delete-businessscenarios.md)|None|Delete a [businessScenario](../resources/businessscenario.md) object. The deletion of a scenario causes all data associated with the scenario to be deleted.| +|[Get businessScenarioPlanner](../api/businessscenarioplanner-get.md)|[businessScenarioPlanner](../resources/businessscenarioplanner.md)|Read the properties and relationships of a [businessScenarioPlanner](../resources/businessscenarioplanner.md) object.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|createdBy|[identitySet](../resources/identityset.md)|The identity of the user who created the scenario.| +|createdDateTime|DateTimeOffset|The date and time when the scenario was created. 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`.| +|displayName|String|Display name of the scenario.| +|id|String|The unique identifier for the scenario. Inherited from [entity](../resources/entity.md).| +|lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of the user who last modified the scenario.| +|lastModifiedDateTime|DateTimeOffset|The date and time when the scenario was last modified. 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`.| +|ownerAppIds|String collection|Identifiers of applications that are authorized to work with this scenario.| +|uniqueName|String|Unique name of the scenario. To avoid conflicts, the recommended value for the unique name is a reverse domain name format, owned by the author of the scenario. For example, a scenario authored by *Contoso.com* would have a unique name that starts with `com.contoso`.| ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|planner|[businessScenarioPlanner](../resources/businessscenarioplanner.md)|Planner content related to the scenario.| ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.businessScenario", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.businessScenario", + "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)", + "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, + "lastModifiedDateTime": "String (timestamp)", + "ownerAppIds": ["String"], + "uniqueName": "String" +} +``` |
v1.0 | Businessscenariogrouptarget | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenariogrouptarget.md | + + Title: "businessScenarioGroupTarget resource type" +description: "Represents a [group](../resources/group.md) which will be used as the target when creating tasks in a [businessScenario](businessscenario.md)." ++ms.localizationpriority: medium +++# businessScenarioGroupTarget resource type ++Namespace: microsoft.graph +++Represents a [group](../resources/group.md) which will be used as the target when creating tasks in a [businessScenario](businessscenario.md). ++Inherits from [businessScenarioTaskTargetBase](../resources/businessscenariotasktargetbase.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|groupId|String|The unique identifier for the group. | +|taskTargetKind|plannerTaskTargetKind|Represents the kind of the target. The possible values are: `group`, `unknownFutureValue`. The value of this property will be `group`. Inherited from [businessScenarioTaskTargetBase](../resources/businessscenariotasktargetbase.md).| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.businessScenarioGroupTarget" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.businessScenarioGroupTarget", + "groupId": "String", + "taskTargetKind": "String" +} +``` |
v1.0 | Businessscenarioplanner | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenarioplanner.md | + + Title: "businessScenarioPlanner resource type" +description: "Contains Microsoft Planner-related content for the scenario, allowing both configuration of Planner behavior and accessing the scenario data in Planner." ++ms.localizationpriority: medium +++# businessScenarioPlanner resource type ++Namespace: microsoft.graph +++Contains Microsoft Planner-related content for the scenario, allowing both configuration of Planner behavior and accessing the scenario data in Planner. ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get businessScenarioPlanner](../api/businessscenarioplanner-get.md)|[businessScenarioPlanner](../resources/businessscenarioplanner.md)|Read the properties and relationships of a [businessScenarioPlanner](../resources/businessscenarioplanner.md) object.| +|[getPlan](../api/businessscenarioplanner-getplan.md)|[businessScenarioPlanReference](../resources/businessscenarioplanreference.md)|Get information about the [plannerPlan](../resources/plannerplan.md) mapped to a given target.| +|[Get plannerPlanConfiguration](../api/plannerplanconfiguration-get.md)|[plannerPlanConfiguration](../resources/plannerplanconfiguration.md)|Get the **plannerPlanConfiguration** from the **planConfiguration** navigation property.| +|[Get plannerTaskConfiguration](../api/plannertaskconfiguration-get.md)|[plannerTaskConfiguration](../resources/plannertaskconfiguration.md)|Get the **plannerTaskConfiguration** from the **taskConfiguration** navigation property.| +|[List tasks](../api/businessscenarioplanner-list-tasks.md)|[businessScenarioTask](../resources/businessscenariotask.md) collection|Get the **businessScenarioTasks** from the **tasks** navigation property.| +|[Create businessScenarioTask](../api/businessscenarioplanner-post-tasks.md)|[businessScenarioTask](../resources/businessscenariotask.md)|Create a new **businessScenarioTask** object.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier for the **businessScenarioPlanner** object. Inherited from [entity](../resources/entity.md). Read-only.| ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|planConfiguration|[plannerPlanConfiguration](../resources/plannerplanconfiguration.md)|The configuration of Planner plans that will be created for the scenario.| +|taskConfiguration|[plannerTaskConfiguration](../resources/plannertaskconfiguration.md)|The configuration of Planner tasks that will be created for the scenario.| +|tasks|[businessScenarioTask](../resources/businessscenariotask.md) collection|The Planner tasks for the scenario.| ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.businessScenarioPlanner", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.businessScenarioPlanner", + "id": "String (identifier)" +} +``` |
v1.0 | Businessscenarioplanreference | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenarioplanreference.md | + + Title: "businessScenarioPlanReference resource type" +description: "Represents a reference to a plannerPlan object." ++ms.localizationpriority: medium +++# businessScenarioPlanReference resource type ++Namespace: microsoft.graph +++Represents a reference to a [plannerPlan](../resources/plannerplan.md) object. ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[getPlan](../api/businessscenarioplanner-getplan.md)|[businessScenarioPlanReference](../resources/businessscenarioplanreference.md)|Get information about the [plannerPlan](../resources/plannerplan.md) mapped to a given target.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier for the **plannerPlan**. Inherited from [entity](../resources/entity.md). Read-only.| +|title|String|The title property of the **plannerPlan**.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.businessScenarioPlanReference", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.businessScenarioPlanReference", + "id": "String (identifier)", + "title": "String" +} +``` |
v1.0 | Businessscenarioproperties | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenarioproperties.md | + + Title: "businessScenarioProperties resource type" +description: "Represents scenario metadata for a businessScenarioTask object." ++ms.localizationpriority: medium +++# businessScenarioProperties resource type ++Namespace: microsoft.graph +++Represents scenario metadata for a [businessScenarioTask](../resources/businessscenariotask.md) object. ++## Properties ++|Property|Type|Description| +|:|:|:| +|externalBucketId|String|The identifier for the [bucketDefinition](../resources/plannerplanconfigurationbucketdefinition.md) configured in the [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) for the scenario. The task will be placed in the corresponding [plannerBucket](../resources/plannerbucket.md) in the target plan. Required.| +|externalContextId|String|The identifier for the context of the task. Context is an application controlled value, and tasks can be queried by their **externalContextId**. Optional.| +|externalObjectId|String|Application-specific identifier for the task. Every task for the same scenario must have a unique identifier specified for this property. Required.| +|externalObjectVersion|String|Application-specific version of the task. Optional.| +|webUrl|String|The URL to the application-specific experience for this task. Optional.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.businessScenarioProperties" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.businessScenarioProperties", + "externalBucketId": "String", + "externalContextId": "String", + "externalObjectId": "String", + "externalObjectVersion": "String", + "webUrl": "String" +} +``` |
v1.0 | Businessscenariotask | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenariotask.md | + + Title: "businessScenarioTask resource type" +description: "Represents a plannerTask that is associated with a businessScenario and contains additional scenario data." ++ms.localizationpriority: medium +++# businessScenarioTask resource type ++Namespace: microsoft.graph +++Represents a [plannerTask](../resources/plannertask.md) that is associated with a [businessScenario](../resources/businessscenario.md) and contains additional scenario data. ++Inherits from [plannerTask](../resources/plannertask.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List businessScenarioTasks](../api/businessscenarioplanner-list-tasks.md)|[businessScenarioTask](../resources/businessscenariotask.md) collection|Get a list of the [businessScenarioTask](../resources/businessscenariotask.md) objects and their properties.| +|[Create businessScenarioTask](../api/businessscenarioplanner-post-tasks.md)|[businessScenarioTask](../resources/businessscenariotask.md)|Create a new [businessScenarioTask](../resources/businessscenariotask.md) object.| +|[Get businessScenarioTask](../api/businessscenariotask-get.md)|[businessScenarioTask](../resources/businessscenariotask.md)|Read the properties and relationships of a [businessScenarioTask](../resources/businessscenariotask.md) object.| +|[Update businessScenarioTask](../api/businessscenariotask-update.md)|[businessScenarioTask](../resources/businessscenariotask.md)|Update the properties of a [businessScenarioTask](../resources/businessscenariotask.md) object.| +|[Delete businessScenarioTask](../api/businessscenarioplanner-delete-tasks.md)|None|Delete a [businessScenarioTask](../resources/businessscenariotask.md) object.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|activeChecklistItemCount|Int32|Number of checklist items with value set to `false`, representing incomplete items. Inherited from [plannerTask](../resources/plannertask.md).| +|appliedCategories|[plannerAppliedCategories](../resources/plannerappliedcategories.md)|The categories to which the task has been applied. For possible values, see [plannerAppliedCategories](plannerappliedcategories.md). Inherited from [plannerTask](../resources/plannertask.md).| +|assigneePriority|String|Hint used to order items of this type in a list view. For details about the supported format, see [Using order hints in Planner](planner-order-hint-format.md). Inherited from [plannerTask](../resources/plannertask.md).| +|assignments|[plannerAssignments](../resources/plannerassignments.md)|The set of assignees the task is assigned to. Inherited from [plannerTask](../resources/plannertask.md).| +|bucketId|String|Bucket ID to which the task belongs. Inherited from [plannerTask](../resources/plannertask.md).| +|businessScenarioProperties|[businessScenarioProperties](../resources/businessscenarioproperties.md)|Scenario-specific properties of the task. **externalObjectId** and **externalBucketId** properties must be specified when creating a task.| +|checklistItemCount|Int32|Number of checklist items that are present on the task. Inherited from [plannerTask](../resources/plannertask.md).| +|completedBy|[identitySet](../resources/identityset.md)|Identity of the user who completed the task. Inherited from [plannerTask](../resources/plannertask.md). Read-Only.| +|completedDateTime|DateTimeOffset|Date and time at which the **percentComplete** of the task is set to `100`. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [plannerTask](../resources/plannertask.md). Read-only.| +|conversationThreadId|String|Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the **group**. Inherited from [plannerTask](../resources/plannertask.md).| +|createdBy|[identitySet](../resources/identityset.md)|Identity of the user who created the task. Inherited from [plannerTask](../resources/plannertask.md). Read-Only.| +|createdDateTime|DateTimeOffset|Date and time at which the task is created. 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` Inherited from [plannerTask](../resources/plannertask.md). Read-only.| +|creationSource|[plannerTaskCreation](../resources/plannertaskcreation.md)|Contains information about the origin of the task. Inherited from [plannerTask](../resources/plannertask.md).| +|dueDateTime|DateTimeOffset|Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [plannerTask](../resources/plannertask.md).| +|hasDescription|Boolean|`True` indicates that the details object of the task has a non-empty description; otherwise, `false`. Inherited from [plannerTask](../resources/plannertask.md). Read-only.| +|id|String|The unique identifier for the task. Inherited from [entity](../resources/entity.md). Read-only.| +|orderHint|String|Hint used to order items of this type in a list view. For details about the supported format, see [Using order hints in Planner](planner-order-hint-format.md). Inherited from [plannerTask](../resources/plannertask.md).| +|percentComplete|Int32|Percentage of task completion. When set to `100`, the task is considered completed. Inherited from [plannerTask](../resources/plannertask.md).| +|planId|String|Identifier of the plan to which the task belongs. Inherited from [plannerTask](../resources/plannertask.md).| +|previewType|plannerPreviewType|This sets the type of preview that shows up on the task. Possible values are: `automatic`, `noPreview`, `checklist`, `description`, `reference`. Inherited from [plannerTask](../resources/plannertask.md).| +|priority|Int32|Priority of the task. Valid range of values is between `0` and `10` (inclusive), with increasing value being lower priority (`0` has the highest priority and `10` has the lowest priority). Currently, Planner interprets values `0` and `1` as "urgent", `2`, `3`, and `4` as "important", `5`, `6`, and `7` as "medium", and `8`, `9`, and `10` as "low". Currently, Planner sets the value `1` for "urgent", `3` for "important", `5` for "medium", and `9` for "low". Inherited from [plannerTask](../resources/plannertask.md).| +|referenceCount|Int32|Number of external references that exist on the task. Inherited from [plannerTask](../resources/plannertask.md).| +|startDateTime|DateTimeOffset|Date and time at which the task starts. 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`. Inherited from [plannerTask](../resources/plannertask.md).| +|target|[businessScenarioTaskTargetBase](../resources/businessscenariotasktargetbase.md)|Target of the task that specifies where the task should be placed. Must be specified when creating a task.| +|title|String|Title of the task. Inherited from [plannerTask](../resources/plannertask.md).| ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|assignedToTaskBoardFormat|[plannerAssignedToTaskBoardTaskFormat](../resources/plannerassignedtotaskboardtaskformat.md)|Used to render the task correctly in the task board view when grouped by **assignedTo**. Inherited from [plannerTask](../resources/plannertask.md).| +|bucketTaskBoardFormat|[plannerBucketTaskBoardTaskFormat](../resources/plannerbuckettaskboardtaskformat.md)|Used to render the task correctly in the task board view when grouped by **bucket**. Inherited from [plannerTask](../resources/plannertask.md).| +|details|[plannerTaskDetails](../resources/plannertaskdetails.md)|Additional details about the task. Inherited from [plannerTask](../resources/plannertask.md).| +|progressTaskBoardFormat|[plannerProgressTaskBoardTaskFormat](../resources/plannerprogresstaskboardtaskformat.md)|Used to render the task correctly in the task board view when grouped by **progress**. Inherited from [plannerTask](../resources/plannertask.md).| ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.businessScenarioTask", + "baseType": "microsoft.graph.plannerTask", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.businessScenarioTask", + "activeChecklistItemCount": "Int32", + "appliedCategories": {"@odata.type": "microsoft.graph.plannerAppliedCategories"}, + "assigneePriority": "String", + "assignments": {"@odata.type": "microsoft.graph.plannerAssignments"}, + "bucketId": "String", + "businessScenarioProperties": {"@odata.type": "microsoft.graph.businessScenarioProperties"}, + "checklistItemCount": "Int32", + "completedBy": {"@odata.type": "microsoft.graph.identitySet"}, + "completedDateTime": "String (timestamp)", + "conversationThreadId": "String", + "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, + "createdDateTime": "String (timestamp)", + "creationSource": {"@odata.type": "microsoft.graph.plannerTaskCreation"}, + "dueDateTime": "String (timestamp)", + "hasDescription": "Boolean", + "id": "String (identifier)", + "orderHint": "String", + "percentComplete": "Int32", + "planId": "String", + "previewType": "String", + "priority": "Int32", + "referenceCount": "Int32", + "startDateTime": "String (timestamp)", + "target": {"@odata.type": "microsoft.graph.businessScenarioTaskTargetBase"}, + "title": "String" +} +``` |
v1.0 | Businessscenariotasktargetbase | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/businessscenariotasktargetbase.md | + + Title: "businessScenarioTaskTargetBase resource type" +description: "An abstract type that represents a base object for all targets that can be specified for creating tasks for a scenario." ++ms.localizationpriority: medium +++# businessScenarioTaskTargetBase resource type ++Namespace: microsoft.graph +++An abstract type that represents a base object for all targets that can be specified for creating tasks for a scenario. ++Base type of [businessScenarioGroupTarget](businessscenariogrouptarget.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|taskTargetKind|plannerTaskTargetKind|Represents the kind of the target. The possible values are: `group`, `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.businessScenarioTaskTargetBase" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.businessScenarioTaskTargetBase", + "taskTargetKind": "String" +} +``` |
v1.0 | Cloudpc Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpc-api-overview.md | Microsoft Graph controls access to resources via permissions. As a developer, yo |List, get, create, update delete, update AD domain password, and run health checks for on-premises network connections|[cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md)|[On-premises network connection overview](/windows-365/enterprise/on-premises-network-connections)| |List audit events for Cloud PCs, get a specific audit event, and get audit activity types|[cloudPcAuditEvent](../resources/cloudpcauditevent.md)|[Get Cloud PC audit logs](/windows-365/enterprise/get-cloud-pc-audit-logs-using-powershell)| |List, get, create, update, delete or assign user settings|[cloudPcUserSetting](../resources/cloudpcusersetting.md)|[User settings overview](../resources/cloudpcusersetting.md)|+|Set up rules to alert issues on the Microsoft Endpoint Manager admin center with provisioning Cloud PCs, uploading Cloud PC images, and checking Azure network connections. |[alertRecord](devicemanagement-alertrecord.md), [alertRule](devicemanagement-alertrule.md) | [Alert monitoring API](devicemanagement-monitoring.md) | ## What's new |
v1.0 | Cloudpcexportjob | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcexportjob.md | Namespace: microsoft.graph Represents the export job created for downloading reports. ## Methods-|Method|Return type|Description| -|:|:|:| -|[Create cloudPcExportJob](../api/cloudpcreports-post-exportjobs.md)|[cloudPcExportJob](../resources/cloudpcexportjob.md)|Create a new [cloudPcExportJob](../resources/cloudpcexportjob.md) object.| -|[Get cloudPcExportJob](../api/cloudpcexportjob-get.md)|[cloudPcExportJob](../resources/cloudpcexportjob.md)|Read the properties and relationships of a [cloudPcExportJob](../resources/cloudpcexportjob.md) object.| +| Method | Return type | Description | +| : | : | : | +| [Create cloudPcExportJob](../api/cloudpcreports-post-exportjobs.md) | [cloudPcExportJob](../resources/cloudpcexportjob.md) | Create a new [cloudPcExportJob](../resources/cloudpcexportjob.md) object. | +| [Get cloudPcExportJob](../api/cloudpcexportjob-get.md) | [cloudPcExportJob](../resources/cloudpcexportjob.md) | Read the properties and relationships of a [cloudPcExportJob](../resources/cloudpcexportjob.md) object. | ## Properties-|Property|Type|Description| -|:|:|:| -|expirationDateTime|DateTimeOffset|The date time when the export job expires.| -|exportJobStatus|[cloudPcExportJobStatus](#cloudpcexportjobstatus-values)|The status of the export job.The possible values are: `notStarted`, `inProgress`, `completed`, `unknownFutureValue`. Read-only.| -|exportUrl|String|The storage account url of the exported report, it can be used to download the file.| -|filter|String|The filter applied on the report.| -|format|String|The format of the exported report.| -|id|String|The unique identifier for the report. Read-only.| -|reportName|[cloudPcReportName](#cloudpcreportname-values)|The report name.The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `unknownFutureValue`.| -|requestDateTime|DateTimeOffset|The date time when the export job was requested.| -|select|String collection|The selected columns of the report.| --## Relationships -None. +| Property | Type | Description | +| :-- | :- | :-- | +| expirationDateTime | DateTimeOffset | The date and time when the export job expires. | +| exportJobStatus | [cloudPcExportJobStatus](#cloudpcexportjobstatus-values) | The status of the export job. The possible values are: `notStarted`, `inProgress`, `completed`, `unknownFutureValue`. Read-only. | +| exportUrl | String | The storage account URL of the exported report. It can be used to download the file. | +| filter | String | The filter applied on the report. | +| format | String | The format of the exported report. | +| id | String | The unique identifier for the report. Read-only. | +| reportName | [cloudPcReportName](#cloudpcreportname-values) | The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `unknownFutureValue`. | +| requestDateTime | DateTimeOffset | The date and time when the export job was requested. | +| select | String collection | The selected columns of the report. | ### cloudPcExportJobStatus values -|Member|Description| -|:|:| -|notStarted|The export job doesn't start yet.| -|inProgress|The export job is in progress.| -|completed|The export job is completed with export url returned. | -|failed|The export job is failed. | -|unknownFutureValue|Evolvable enumeration sentinel value. Do not use. | +| Member | Description | +| :-- | :- | +| notStarted | The export job doesn't start yet. | +| inProgress | The export job is in progress. | +| completed | The export job is completed with export URL returned. | +| failed | The export job has failed. | +| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | ### cloudPcReportName values -|Member|Description| -|:|:| -|remoteConnectionHistoricalReports|The historical remote connections report.| -|dailyAggregatedRemoteConnectionReports|The daily aggregated remote connections report. | -|totalAggregatedRemoteConnectionReports|The total aggregated remote connections report.| -|unknownFutureValue|Evolvable enumeration sentinel value. Do not use. | +| Member | Description | +| :- | : | +| remoteConnectionHistoricalReports | The historical remote connections report. | +| dailyAggregatedRemoteConnectionReports | The daily aggregated remote connections report. | +| totalAggregatedRemoteConnectionReports | The total aggregated remote connections report. | +| sharedUseLicenseUsageReport | Indicates daily/hourly aggregated shared use license usage report. | +| sharedUseLicenseUsageRealTimeReport | Indicates real-time data for shared use license usage. | +| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | +++## Relationships +None. ## JSON representation The following is a JSON representation of the resource. The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.cloudPcExportJob",+ "expirationDateTime": "String (timestamp)", + "exportJobStatus": "String", + "exportUrl": "String", + "filter": "String", + "format": "String", "id": "String (identifier)", "reportName": "String",- "filter": "String", + "requestDateTime": "String (timestamp)", "select": [ "String"- ], - "format": "String", - "expirationDateTime": "String (timestamp)", - "requestDateTime": "String (timestamp)", - "exportJobStatus": "String", - "exportUrl": "String" + ] } ```- |
v1.0 | Cloudpconpremisesconnection | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpconpremisesconnection.md | Represents a defined collection of Azure resource information that can be used t |healthCheckStatusDetails|[cloudPcOnPremisesConnectionStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md)|The details of the connection's health checks and the corresponding results. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.| |id|String|Unique identifier for the Azure network connection. Read-only.| |inUse|Boolean|When `true`, the Azure network connection is in use. When `false`, the connection is not in use. You cannot delete a connection thatΓÇÖs in use. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.|-|managedBy|[cloudPcManagementService](#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox,` `unknownFutureValue`. Read-only.| +|managedBy|[cloudPcManagementService](#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox`, `rpaBox`, `unknownFutureValue`. Read-only.| |organizationalUnit|String|The organizational unit (OU) in which the computer account is created. If left null, the OU thatΓÇÖs configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.| |resourceGroupId|String|The ID of the target resource group. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}`.| |subnetId|String|The ID of the target subnet. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}`.| Represents a defined collection of Azure resource information that can be used t ### cloudPcManagementService values -|Member| Value |Description| -|:|:|:| -|windows365|1| Azure network connection was successfully created through Windows365.| -|devBox|2| Azure network connection was successfully created through Project Fidalgo.| -|unknownFutureValue|4| Evolvable enumeration sentinel value. Do not use.| +| Member | Description | +|:-|:| +| windows365 | Azure network connection was successfully created through Windows365. | +| devBox | Azure network connection was successfully created through Project Fidalgo. | +| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | +| rpaBox | The Azure network connection was successfully created through the Power Automate project. | ### cloudPcOnPremisesConnectionType values |
v1.0 | Cloudpcprovisioningpolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcprovisioningpolicy.md | Represents a Cloud PC provisioning policy. |imageId|String|The ID of the OS image you want to provision on Cloud PCs. The format for a gallery type image is: {publisher_offer_sku}. Supported values for each of the parameters are as follows:<ul><li>publisher: Microsoftwindowsdesktop.</li> <li>offer: windows-ent-cpc.</li> <li>sku: 21h1-ent-cpc-m365, 21h1-ent-cpc-os, 20h2-ent-cpc-m365, 20h2-ent-cpc-os, 20h1-ent-cpc-m365, 20h1-ent-cpc-os, 19h2-ent-cpc-m365 and 19h2-ent-cpc-os.</li></ul>| |imageType|cloudPcProvisioningPolicyImageType|The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: `gallery`, `custom`.| |localAdminEnabled|Boolean|Indicates whether the local admin option is enabled. If the local admin option is enabled, the end user can be an admin of the Cloud PC device. Read-only.|-|managedBy|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox`, `unknownFutureValue`. Read-only.| +|managedBy|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox`, `rpaBox`, `unknownFutureValue`. Read-only.| |microsoftManagedDesktop|[microsoftManagedDesktop](../resources/microsoftManagedDesktop.md)|The specific settings for the Microsoft Managed Desktop, which enables customers to get a managed device experience for the Cloud PC. Before you can enable Microsoft Managed Desktop, an admin must configure it.| |onPremisesConnectionId|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.| |windowsSettings|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure while creating Cloud PCs for this provisioning policy.| |
v1.0 | Cloudpcreports | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcreports.md | Represents the Windows 365 Cloud PC-related reports, including the Windows 365 C |[getRealTimeRemoteConnectionLatency](../api/cloudpcreports-getrealtimeremoteconnectionlatency.md)|Stream|Get the real-time remote connection latency reports like current round trip time and available bandwidth of a Cloud PC.| |[getRealTimeRemoteConnectionStatus](../api/cloudpcreports-getrealtimeremoteconnectionstatus.md)|Stream|Get the real-time remote connection status reports like sign in status, or days since last use of a Cloud PC.| |[getRemoteConnectionHistoricalReports](../api/cloudpcreports-getremoteconnectionhistoricalreports.md)|Stream|Get a Cloud PC's remote connection historical reports, such as **signInDateTime**, **signOutDateTime**, or **usageInHour**, in a given period.|+|[getSharedUseLicenseUsageReport](../api/cloudpcreports-getshareduselicenseusagereport.md)|Stream|Get the shared use license usage reports, such as **servicePlanId**, **licenseCount**, and **claimedLicenseCount**, for real-time, 7 days, or 28 days trend.| |[getTotalAggregatedRemoteConnectionReports](../api/cloudpcreports-gettotalaggregatedremoteconnectionreports.md)|Stream|Get the total aggregated remote connection reports, like usage and **daysSinceLastUse**, in a given period.| - ## Properties |Property|Type|Description| |:|:|:| The following is a JSON representation of the resource. "id": "String (identifier)" } ```- |
v1.0 | Cloudpcsupportedregion | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcsupportedregion.md | Represents a supported region to establish an Azure network connection for Cloud ## Properties -|Property|Type|Description| -|:|:|:| +| Property | Type | Description | +|: |: |: | |displayName|String|The name for the supported region. Read-only.| |id|String|The unique identifier for the supported region. Read-only.|+|regionGroup|[cloudPcRegionGroup](#cloudpcregiongroup-values)|The geographic group this region belongs to. Multiple regions can belong to one region group. For example, the `europeUnion` region group contains the Northern Europe and Western Europe regions. A customer can select a region group when provisioning a Cloud PC; however, the Cloud PC will be put under one of the regions under the group based on resource capacity. The region with more quota will be chosen. Possible values are: `default`, `australia`, `canada`, `usCentral`, `usEast`, `usWest`, `france`, `germany`, `europeUnion`, `unitedKingdom`, `japan`, `asia`, `india`, `southAmerica`, `euap`, `usGovernment`, `usGovernmentDOD`, `norway`, `switzerland`,`southKorea`, `unknownFutureValue`. Read-only.| |regionStatus|[cloudPcSupportedRegionStatus](#cloudpcsupportedregionstatus-values)|The status of the supported region. Possible values are: `available`, `restricted`, `unavailable`, `unknownFutureValue`. Read-only.|-|supportedSolution|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|The supported service or solution for the region. The possible values are: `windows365`, `devBox`, `unknownFutureValue`. Read-only.| +|supportedSolution|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|The supported service or solution for the region. The possible values are: `windows365`, `devBox`, `rpaBox`, `unknownFutureValue`. Read-only.| ### cloudPcSupportedRegionStatus values Represents a supported region to establish an Azure network connection for Cloud |unavailable|The region has no support for Cloud PC provisioning.| |unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| +### cloudPcRegionGroup values ++| Member | Description | +|:-|:--| +| default | The region belongs to the default region group. | +| australia | The region belongs to the region group: Australia. | +| canada | The region belongs to the region group: Canada. | +| usCentral | The region belongs to the region group: Central US. | +| usEast | The region belongs to the region group: East US. | +| usWest | The region belongs to the region group: West US. | +| france | The region belongs to the region group: France. | +| germany | The region belongs to the region group: Germany. | +| europeUnion | The region belongs to the region group: European Union. | +| unitedKingdom | The region belongs to the region group: United Kingdom. | +| japan | The region belongs to the region group: Japan. | +| asia | The region belongs to the region group: Asia. | +| india | The region belongs to the region group: India. | +| southAmerica | The region belongs to the region group: South America. | +| euap | The region belongs to the region group: Early Update Access Program. | +| usGovernment | The region belongs to the region group: US Government. | +| usGovernmentDOD | The region belongs to the region group: US Government Department of Defense (DOD). | +| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | +| norway | The region belongs to the region group: Norway. | +| switzerland | The region belongs to the region group: Switzerland. | +| southKorea | The region belongs to the region group: South Korea. | + ## Relationships None. The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.cloudPcSupportedRegion", "displayName": "String", "id": "String (identifier)",+ "regionGroup": "String", "regionStatus": "microsoft.graph.cloudPcSupportedRegionStatus", "supportedSolution": "String" } |
v1.0 | Consentrequests Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/consentrequests-overview.md | ms.localizationpriority: medium ms.prod: "governance" doc_type: conceptualPageType Last updated : 09/28/2022 # Azure Active Directory consent requests |
v1.0 | Crosstenantaccesspolicy Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/crosstenantaccesspolicy-overview.md | description: "Cross-tenant access settings let you manage both B2B collaboration ms.localizationpriority: medium ms.prod: "identity-and-sign-in"-doc_type: resourcePageType Last updated : 09/13/2022 # Cross-tenant access settings API overview |
v1.0 | Custom Security Attributes Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/custom-security-attributes-overview.md | |
v1.0 | Devicemanagement Alertimpact | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/devicemanagement-alertimpact.md | Represents the impact of an alert event. |Property|Type|Description| |:|:|:|-|aggregationType|[microsoft.graph.deviceManagement.aggregationType](../resources/devicemanagement-ruleThreshold.md#aggregationtype-values)|The aggregation type of the impact. The possible values are: `count`, `percentage`, `affectedCloudPcCount`, `affectedCloudPcPercentage`, `unknownFutureValue`.| -|value|Int32|The number value of the impact.| +|aggregationType|[microsoft.graph.deviceManagement.aggregationType](../resources/devicemanagement-ruleThreshold.md#aggregationtype-values)|The aggregation type of the impact. The possible values are: `count`, `percentage`, `affectedCloudPcCount`, `affectedCloudPcPercentage`, `unknownFutureValue`. | +|value|Int32|The number value of the impact. For the aggregation types of `count` and `affectedCloudPcCount`, the value indicates the number of affected instances. For example, `6 affectedCloudPcCount` means that 6 Cloud PCs are affected. For the aggregation types of `percentage` and `affectedCloudPcPercentage`, the value indicates the percent of affected instances. For example, `12 affectedCloudPcPercentage` means that 12% of Cloud PCs are affected. | ## Relationships |
v1.0 | Devicemanagement Alertrecord | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/devicemanagement-alertrecord.md | Namespace: microsoft.graph.deviceManagement [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -This entity represents the record of an alert event triggered by a rule. When the threshold of an alert rule is reached, a record of the alert event will be generated and stored, and administrators will receive notifications via defined notification channels. +Represents the record of an alert event in the Microsoft Endpoint Manager admin center triggered by an [alertRule](devicemanagement-alertrule.md). ++When the threshold of an **alertRule** is reached, an **alertRecord** is generated and stored, and administrators receive notifications via defined notification channels. ++For more information, see the [monitoring](devicemanagement-monitoring.md) resource. ## Methods This entity represents the record of an alert event triggered by a rule. When th |:|:|:| |[List alertRecords](../api/devicemanagement-alertrecord-list.md)|[microsoft.graph.deviceManagement.alertRecord](../resources/devicemanagement-alertrecord.md) collection|Get a list of the [alertRecord](../resources/devicemanagement-alertrecord.md) objects and their properties.| |[Get alertRecord](../api/devicemanagement-alertrecord-get.md)|[microsoft.graph.deviceManagement.alertRecord](../resources/devicemanagement-alertrecord.md)|Read the properties and relationships of an [alertRecord](../resources/devicemanagement-alertrecord.md) object.|-|[getPortalNotifications](../api/devicemanagement-alertrecord-getportalnotifications.md)|[microsoft.graph.deviceManagement.portalNotification](../resources/devicemanagement-portalnotification.md) collection|Get a list of all portal notifications that one or more users can access.| -|[setPortalNotificationAsSent](../api/devicemanagement-alertrecord-setportalnotificationassent.md)|None|Set a single portal notification status to published.| +|[getPortalNotifications](../api/devicemanagement-alertrecord-getportalnotifications.md)|[microsoft.graph.deviceManagement.portalNotification](../resources/devicemanagement-portalnotification.md) collection|Get a list of all portal notifications that one or more users can access, from the Microsoft Endpoint Manager admin center.| +|[setPortalNotificationAsSent](../api/devicemanagement-alertrecord-setportalnotificationassent.md)|None|Set the status of the specified notification on the Microsoft EndPoint Manager admin center as sent.| ## Properties |Property|Type|Description| |:|:|:|-|alertImpact|[microsoft.graph.deviceManagement.alertImpact](../resources/devicemanagement-alertimpact.md)|The impact of the alert event. Consists of a number followed by the aggregation type. For example, `6 Count` and `12 AffectedCloudPcPercentage`.| +|alertImpact|[microsoft.graph.deviceManagement.alertImpact](../resources/devicemanagement-alertimpact.md)|The impact of the alert event. Consists of a number followed by the aggregation type. For example, `6 affectedCloudPcCount` means that 6 Cloud PCs are affected. `12 affectedCloudPcPercentage` means 12% of Cloud PCs are affected.| |alertRuleId|String|The corresponding ID of the alert rule.| |alertRuleTemplate|[microsoft.graph.deviceManagement.alertRuleTemplate](../resources/devicemanagement-alertrule.md#alertruletemplate-values)|The rule template of the alert event. The possible values are: `cloudPcProvisionScenario`, `cloudPcImageUploadScenario`, `cloudPcOnPremiseNetworkConnectionCheckScenario`, `unknownFutureValue`.| |detectedDateTime|DateTimeOffset|The date and time when the alert event was detected. The Timestamp type represents date and time information using ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |
v1.0 | Devicemanagement Alertrule | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/devicemanagement-alertrule.md | Namespace: microsoft.graph.deviceManagement [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the rules that IT administrators can configure to trigger alerts. +Represents a rule that an IT administrator with the appropriate roles can configure to monitor issues and trigger alerts on the Microsoft Endpoint Manager admin center. ++When the threshold of an **alertRule** is reached, an [alertRecord](devicemanagement-alertrecord.md) is generated and stored, and administrators receive notifications via defined notification channels. ++For more information, see the [monitoring](devicemanagement-monitoring.md) resource. |Method|Return type|Description| |:|:|:| Represents the rules that IT administrators can configure to trigger alerts. |displayName|String|The display name of the rule.| |enabled|Boolean|The status of the rule that indicates whether the rule is enabled or disabled. If `true`, the rule is enabled; otherwise, the rule is disabled.| |id|String|The unique identifier for the alert rule. Inherited from [entity](../resources/entity.md).|-|isSystemRule|Boolean|Indicates whether the rule is a system rule. If `true`, the rule is a system rule; otherwise, the rule is a custom defined rule and can be edited. System rules are built-in and only -a few properties can be edited.| +|isSystemRule|Boolean|Indicates whether the rule is a system rule. If `true`, the rule is a system rule; otherwise, the rule is a custom defined rule and can be edited. System rules are built-in and only a few properties can be edited.| |notificationChannels|[microsoft.graph.deviceManagement.notificationChannel](../resources/devicemanagement-notificationchannel.md) collection|The notification channels of the rule selected by the user.| |severity|[microsoft.graph.deviceManagement.ruleSeverityType](#ruleseveritytype-values)|The severity of the rule. The possible values are: `unknown`, `informational`, `warning`, `critical`, `unknownFutureValue`.|-|threshold|[microsoft.graph.deviceManagement.ruleThreshold](../resources/devicemanagement-rulethreshold.md)|The threshold of the rule.| +|threshold|[microsoft.graph.deviceManagement.ruleThreshold](../resources/devicemanagement-rulethreshold.md)|The conditions to send alerts. For example, send alert when provisioning has failed for greater than or equal to 6 Cloud PCs.| ### alertRuleTemplate values |
v1.0 | Devicemanagement Monitoring | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/devicemanagement-monitoring.md | Title: "monitoring resource type" -description: "Represents the entry point entity type to access all alert-related resources." +description: "Represents the entry point entity type to access all resources related to alerts in the Microsoft Endpoint Manager admin center." ms.localizationpriority: medium ms.prod: "cloud-pc" Namespace: microsoft.graph.deviceManagement [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the entry point entity type to access all alert-related resources. +Represents the entry point to access all resources related to alerts in the [Microsoft Endpoint Manager admin center](https://endpoint.microsoft.com). ++The alert monitoring API provide a programmatic alert experience in the Microsoft Endpoint Manager admin center. A Microsoft Endpoint Manager admin can create an [alert rule](devicemanagement-alertrule.md) with preferred notification channels, and receive alerts when conditions set as thresholds in alert rules are met. Notification channels may include email and Microsoft Endpoint Manager admin center notifications. Each alert is recorded as an [alert record](devicemanagement-alertrecord.md). Admins can review alert records to learn about alert impact, severity, status, and more. ++Only the role of Windows 365 admin has access to the alert monitoring API. Admins also need a role of global admin, Intune admin, or Cloud PC admin to successfully make API calls. ++> [!Note] +> Currently this API set supports only [Windows 365](/windows-365/overview) and Cloud PC scenarios. It allows admins to set up rules to alert issues with provisioning Cloud PCs, uploading Cloud PC images, and checking Azure network connections. +> +> Have a different scenario that can use additional programmatic alert support on the Microsoft Endpoint Manager admin center? [Suggest the feature or vote for existing feature requests](https://developer.microsoft.com/en-us/graph/support). ## Properties |
v1.0 | Devicemanagement Portalnotification | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/devicemanagement-portalnotification.md | Namespace: microsoft.graph.deviceManagement [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the portal notification associated with the alert record of a user. +Represents the portal notification associated with the [alert record](devicemanagement-alertrecord.md) of a user. ## Properties Represents the portal notification associated with the alert record of a user. |alertRuleName|String|The associated alert rule name.| |alertRuleTemplate|[microsoft.graph.deviceManagement.alertRuleTemplate](../resources/devicemanagement-alertrule.md#alertruletemplate-values)|The associated alert rule template. The possible values are: `cloudPcProvisionScenario`, `cloudPcImageUploadScenario`, `cloudPcOnPremiseNetworkConnectionCheckScenario`, `unknownFutureValue`.| |id|String|The unique identifier for the portal notification.|-|isPortalNotificationSent|Boolean|If `true`, the portal notification has already been sent for the user; otherwise, the portal notification hasn't been sent yet.| +|isPortalNotificationSent|Boolean|`true` if the portal notification has already been sent to the user; `false` otherwise.| |severity|[microsoft.graph.deviceManagement.ruleSeverityType](../resources/devicemanagement-alertrule.md#ruleseveritytype-values)|The associated alert rule severity. The possible values are: `unknown`, `informational`, `warning`, `critical`, `unknownFutureValue`.| ## Relationships |
v1.0 | Devicemanagement Rulethreshold | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/devicemanagement-rulethreshold.md | Namespace: microsoft.graph.deviceManagement [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents details about the threshold settings of an alert rule. +Represents details about the threshold settings of an [alert rule](devicemanagement-alertrule.md). ## Properties |
v1.0 | Dynamics Account | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/dynamics-account.md | Title: accounts resource type -description: An account object in Dynamics 365 Business Central. -+ Title: "accounts resource type" +description: "Represents an account object in Dynamics 365 Business Central." + documentationcenter: ''-+ ms.localizationpriority: medium ms.prod: "dynamics-365-business-central" doc_type: resourcePageType Represents an account object in Dynamics 365 Business Central. ## Properties | Property | Type |Description| |:|:--|:-|-|id|GUID|The unique ID of the account.| -|number|string, maximum size 20|Specifies the number of the G/L account.| -|displayName|string, maximum size 50|Specifies the name of the G/L account.| -|category|string, maximum size 20|Specifies the category of the G/L account.| -|subCategory|string, maximum size 80|Specifies the subcategory of the account category of the G/L account.| -|blocked|boolean|Specifies that entries cannot be posted to the G/L account. **True** indicates account is blocked and posting is not allowed.| -|lastModifiedDateTime|datetime|The last datetime the account was modified.| -+|blocked|Boolean|Specifies that entries cannot be posted to the G/L account. `True` indicates that the account is blocked and posting is not allowed.| +|category|String|Specifies the category of the G/L account. Maximum size is 20.| +|displayName|String|Specifies the name of the G/L account. Maximum size is 50.| +|id|GUID|The unique identifier for the account.| +|lastModifiedDateTime|Datetime|The date and time when the account was last modified.| +|number|String |Specifies the number of the G/L account. Maximum size is 20.| +|subCategory|String|Specifies the subcategory of the account category of the G/L account. Maximum size is 80.| ## Relationships-None +None. ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. ```json {+ "blocked": "Boolean", + "category": "String", + "displayName": "String", "id": "GUID",- "number": "string", - "displayName": "string", - "category": "string", - "subCategory": "string", - "blocked": "boolean", - "lastModifiedDateTime": "datetime" + "lastModifiedDateTime": "Datetime" + "number": "String", + "subCategory": "String" } ``` |
v1.0 | Dynamics Paymentterms | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/dynamics-paymentterms.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a payment term in Dynamics 365 Business Central. +Represents a [payment term](../resources/dynamics-paymentterms.md) in Dynamics 365 Business Central. ## Methods | Method | Return Type|Description | |:|:--|:-|-|[Get paymentTerms](../api/dynamics-paymentterms-get.md) |paymentTerms|Get a payment terms object. | -|[Post paymentTerms](../api/dynamics-create-paymentterms.md) |paymentTerms|Create a payment terms object.| -|[Patch paymentTerms](../api/dynamics-paymentterms-update.md) |paymentTerms|Update a payment terms object.| -|[Delete paymentTerms](../api/dynamics-paymentterms-delete.md)|none |Delete a payment terms object.| +|[Get paymentTerms](../api/dynamics-paymentterms-get.md) |**paymentTerms**|Get a payment terms object. | +|[Post paymentTerms](../api/dynamics-create-paymentterms.md) |**paymentTerms**|Create a payment terms object.| +|[Patch paymentTerms](../api/dynamics-paymentterms-update.md) |**paymentTerms**|Update a payment terms object.| +|[Delete paymentTerms](../api/dynamics-paymentterms-delete.md)|none |Delete a payment terms object.| ## Properties | Property | Type |Description | |:--|:-|:-|-|id |GUID |The unique ID of the paymentTerms. Non-editable. | +|calculateDiscountOnCreditMemos|Boolean |Specifies whether the discount should be applied to credit memos. `True` indicates a discount will be given; `false`* indicates a discount will not be given.| |code |string |Specifies the payment term code. |-|displayName |string |Specifies the payment term display name. | -|dueDateCalculation |string |Specifies the formula that is used to calculate the date that a payment must be made.| |discountDateCalculation |string |Specifies the formula that is used to calculate the date that a payment must be made in order to obtain a discount.| |discountPercent |decimal |Specifies the discount percentage that is applied for early payment of an invoice amount.|-|calculateDiscountOnCreditMemos|boolean |Specifies if the discount should be applied to credit memos. **True** indicates a discount will be given, **false** indicates a discount will not be given.| -|lastModifiedDateTime |datetime|The last datetime the paymentTerms was modified. Read-Only.| +|displayName |string |Specifies the payment term display name. | +|dueDateCalculation |string |Specifies the formula that is used to calculate the date that a payment must be made.| +|id |GUID |The unique identifier for the **paymentTerms**. Non-editable. | +|lastModifiedDateTime |datetime|The date and time when the **paymentTerms** were last modified. Read-Only.| ## Relationships-None +None. ## JSON representation -Here is a JSON representation of the paymentTerms. +The following is a JSON representation of the resource. ```json {- "id": "GUID", + "calculateDiscountOnCreditMemos": "boolean", "code": "string",- "displayName": "string", - "dueDateCalculation": "string", "discountDateCalculation": "string", "discountPercent": "decimal",- "calculateDiscountOnCreditMemos": "boolean", + "displayName": "string", + "dueDateCalculation": "string", + "id": "GUID", "lastModifiedDateTime": "datetime" }- ``` |
v1.0 | Educationresource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/educationresource.md | Title: "educationResource resource type" -description: "A base class for all resource objects in the system." +description: "An abstract type that represents the base class for all education-related resource objects in a system." ms.localizationpriority: medium ms.prod: "education" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A base class for [educationExcelResource](../resources/educationexcelresource.md), [educationFileResource](../resources/educationfileresource.md), [educationLinkResource](../resources/educationlinkresource.md), [educationPowerPointResource](../resources/educationpowerpointresource.md), [educationWordResource](../resources/educationwordresource.md), [educationMediaResource](../resources/educationmediaresource.md), [educationExternalResource](../resources/educationexternalresource.md) and [educationTeamsAppResource](../resources/educationteamsappresource.md). +An abstract type that represents the base class for all education-related resource objects in a system. ++Base type of [educationExcelResource](../resources/educationexcelresource.md), [educationFileResource](../resources/educationfileresource.md), [educationLinkResource](../resources/educationlinkresource.md), [educationPowerPointResource](../resources/educationpowerpointresource.md), [educationWordResource](../resources/educationwordresource.md), [educationMediaResource](../resources/educationmediaresource.md), [educationExternalResource](../resources/educationexternalresource.md), and [educationTeamsAppResource](../resources/educationteamsappresource.md). An educationResource is associated with an [assignment](educationassignment.md) and/or [submission](educationsubmission.md), which represents the learning object that is being handed out or handed in. You cannot instantiate a resource directly; you must make a subclass that will represent the type of resource being used. |
v1.0 | Educationteamsappresource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/educationteamsappresource.md | Title: "educationTeamsAppResource resource type" -description: "Corresponds to an [installed Microsoft Teams app](teamsappinstallation.md). This allows education service users to create and share assignments with embedded Teams applications." +description: "Corresponds to an installed Microsoft Teams app." ms.localizationpriority: medium ms.prod: "education" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An education resource that corresponds to an [installed Microsoft Teams app](teamsappinstallation.md). This allows education service users to create and share assignments with embedded Teams applications, such as YouTube or FlipGrid. +Corresponds to an [installed Microsoft Teams app](teamsappinstallation.md). This allows education service users to create and share assignments with embedded Teams applications, such as YouTube or Flip. -For information about using FlipGrid for education on Microsoft Teams, see [introduction to FlipGrid](https://education.microsoft.com/en-us/resource/13cb22b1). +For information about using Flip for education on Microsoft Teams, see [introduction to Flip](/training/educator-center/product-guides/flip). -Inherites from [educationResource](educationresource.md). +Inherits from [educationResource](educationresource.md). ## Properties-| Property | Type |Description| -|:|:--|:-| -|displayName|string|The display name of the resource.| -|appId|string|Teams App ID of the application.| -|appIconWebUrl|string|URL that points to the app's icon.| -|teamsEmbeddedContentUrl|string|URL for the app resource that will be opened by Teams.| -|webUrl|string|URL for the app resource that can be opened in the browser.| -|createdBy|String|The display name of the user that created this resource. Inherited from **educationResource**.| -|createdDateTime|DateTimeOffset|Date time the resoruce was added. Inherited from **educationResource**.| -|lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource. Inherited from **educationResource**.| -|lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. 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`. Inherited from **educationResource**.| +| Property | Type | Description | +|:|:|:--| +| appIconWebUrl | String | URL that points to the icon of the app. | +| appId | String | Teams app ID of the application. | +| createdBy | [identitySet](identityset.md) | Identity of the user who created this resource. Inherited from **educationResource**. | +| createdDateTime | DateTimeOffset | The date and time when the resource was added. 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`. Inherited from **educationResource**. | +| displayName | String | The display name of the resource. Inherited from **educationResource**. | +| lastModifiedBy | [identitySet](identityset.md) | Identity of the user who last modified the resource. Inherited from **educationResource**. | +| lastModifiedDateTime | DateTimeOffset | The date and time when the resource was last modified. 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`. Inherited from **educationResource**. | +| teamsEmbeddedContentUrl | String | URL for the app resource that will be opened by Teams. | +| webUrl | String | URL for the app resource that can be opened in the browser. | ## JSON representation The following is a JSON representation of the resource. ```json {- "displayName": "String", - "appId": "Unique String", - "appIconWebUrl": "String URL", - "teamsEmbeddedContentUrl": "String URL", - "webUrl": "String URL", + "appIconWebUrl": "String", + "appId": "String", "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, "createdDateTime": "String (timestamp)",+ "displayName": "String", "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},- "lastModifiedDateTime": "String (timestamp)" + "lastModifiedDateTime": "String (timestamp)", + "teamsEmbeddedContentUrl": "String", + "webUrl": "String" }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 The following is a JSON representation of the resource. <!-- { "type": "#page.annotation",- "description": "educationExcelResource resource", + "description": "educationTeamsAppResource resource", "keywords": "", "section": "documentation", "tocPath": "", "suppressions": [] } -->-- |
v1.0 | Emailauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/emailauthenticationmethodconfiguration.md | Title: "emailAuthenticationMethodConfiguration resource type" description: "Represents an email OTP authentication methods policy"-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "resourcePageType" Represents this tenant's email OTP authentication methods policy. Authentication |Method|Return type|Description| |:|:|:| |[Get emailAuthenticationMethodConfiguration](../api/emailauthenticationmethodconfiguration-get.md)|[emailAuthenticationMethodConfiguration](../resources/emailauthenticationmethodconfiguration.md)|Read the properties and relationships of an emailAuthenticationMethodConfiguration object.|-|[Update emailAuthenticationMethodConfiguration](../api/emailauthenticationmethodconfiguration-update.md)|[emailAuthenticationMethodConfiguration](../resources/emailauthenticationmethodconfiguration.md)|Update the properties of an emailAuthenticationMethodConfiguration object.| -|[Delete emailAuthenticationMethodConfiguration](../api/emailauthenticationmethodconfiguration-delete.md)|None|Deletes an emailAuthenticationMethodConfiguration object.| +|[Update emailAuthenticationMethodConfiguration](../api/emailauthenticationmethodconfiguration-update.md)|None|Update the properties of an emailAuthenticationMethodConfiguration object.| +|[Delete emailAuthenticationMethodConfiguration](../api/emailauthenticationmethodconfiguration-delete.md)|None|Reverts the emailAuthenticationMethodConfiguration object to its default configuration.| ## Properties |Property|Type|Description| |:|:|:|+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| |id|String|The authentication method policy identifier. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| |state|authenticationMethodState|Indicates whether this authentication method is enabled or not. Possible values are: `enabled`, `disabled`.| |allowExternalIdToUseEmailOtp|externalEmailOtpState|Determines whether email OTP is usable by external users for authentication. Possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`. Tenants in the `default` state who did not use public preview will automatically have email OTP enabled beginning in October 2021.| Represents this tenant's email OTP authentication methods policy. Authentication |Relationship|Type|Description| |:|:|:|-|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of users or groups who are enabled to use the authentication method.| +|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration", "id": "String (identifier)", "state": "String",+ "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ], "allowExternalIdToUseEmailOtp": "String", "includeTargets": [ { "@odata.type": "microsoft.graph.authenticationMethodTarget" } ] } |
v1.0 | Entitlementmanagement Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/entitlementmanagement-overview.md | ms.localizationpriority: medium ms.prod: "governance" doc_type: "conceptualPageType" Last updated : 11/11/2022 # Working with the Azure AD entitlement management API |
v1.0 | Enums | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/enums.md | Possible values for user account types (group membership), per Windows definitio |actionUndefined| |unknownFutureValue| +### plannerRelationshipUserRoles values ++|Member| +|:| +|defaultRules| +|groupOwners| +|groupMembers| +|taskAssignees| +|applications| +|unknownFutureValue| ++### plannerRuleKind values ++|Member| +|:| +|taskRule| +|bucketRule| +|planRule| +|unknownFutureValue| ++### plannerUserRoleKind values ++|Member| +|:| +|relationship| +|unknownFutureValue| ++### plannerTaskTargetKind values ++|Member| +|:| +|group| +|unknownFutureValue| + ### onPremisesDirectorySynchronizationDeletionPreventionType values |Member| Possible values for user account types (group membership), per Windows definitio |disabled| |enabledForCount| |enabledForPercentage|+|enabledForPercentage| |unknownFutureValue|++### authenticationMethodTargetType values ++|Member| +|:--| +|group| +|unknownFutureValue| ++### authenticationMethodsPolicyMigrationState values ++|Member| +|:--| +|premigration| +|migrationInProgress| +|migrationComplete| |
v1.0 | Excludetarget | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/excludetarget.md | Represents the users or groups of users that are excluded from a policy. ## Properties |Property|Type|Description| |:|:|:|-|id|String|The object identifier of an Azure AD user or group.| -|targetType|authenticationMethodTargetType|The type of the authentication method target. Possible values are: `user`, `group`, `unknownFutureValue`.| +|id|String|The object identifier of an Azure AD group.| +|targetType|authenticationMethodTargetType|The type of the authentication method target. Possible values are: `group` and `unknownFutureValue`.| ## Relationships None. |
v1.0 | Federatedidentitycredentials Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/federatedidentitycredentials-overview.md | |
v1.0 | Fido2authenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/fido2authenticationmethodconfiguration.md | Represents a FIDO2 authentication methods policy. Authentication methods policie |Method|Return type|Description| |:|:|:| |[Get](../api/fido2authenticationmethodconfiguration-get.md)|[fido2AuthenticationMethodConfiguration](../resources/fido2authenticationmethodconfiguration.md)|Read the properties and relationships of a fido2AuthenticationMethodConfiguration object.|-|[Update](../api/fido2authenticationmethodconfiguration-update.md)|[fido2AuthenticationMethodConfiguration](../resources/fido2authenticationmethodconfiguration.md)|Update the properties of a fido2AuthenticationMethodConfiguration object.| +|[Update](../api/fido2authenticationmethodconfiguration-update.md)|None|Update the properties of a fido2AuthenticationMethodConfiguration object.| |[Delete](../api/fido2authenticationmethodconfiguration-delete.md)|None|Reverts the fido2AuthenticationMethodConfiguration object to its default configuration.| ## Properties |Property|Type|Description| |:|:|:|+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| |id|String|The authentication method policy identifier.| |isAttestationEnforced|Boolean|Determines whether attestation must be enforced for FIDO2 security key registration.| |isSelfServiceRegistrationAllowed|Boolean|Determines if users can register new FIDO2 security keys.| Represents a FIDO2 authentication methods policy. Authentication methods policie ## Relationships |Relationship|Type|Description| |:|:|:|-|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of users or groups who are enabled to use the authentication method.| +|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation The following is a JSON representation of the resource. The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.fido2AuthenticationMethodConfiguration", "id": "String (identifier)", "state": "String",+ "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ], "isSelfServiceRegistrationAllowed": "Boolean", "isAttestationEnforced": "Boolean", "keyRestrictions": { |
v1.0 | Group | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/group.md | This resource supports: | hideFromOutlookClients | Boolean | `true` if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. Default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | id | String | The unique identifier for the group. <br><br>Returned by default. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`). | | isArchived | Boolean | When a group is associated with a team, this property determines whether the team is in read-only mode. <br/>To read this property, use the `/group/{groupId}/team` endpoint or the [Get team](../api/team-get.md) API. To update this property, use the [archiveTeam](../api/team-archive.md) and [unarchiveTeam](../api/team-unarchive.md) APIs. |-| isAssignableToRole | Boolean | Indicates whether this group can be assigned to an Azure Active Directory role. Optional. <br><br>This property can only be set while creating the group and is immutable. If set to `true`, the **securityEnabled** property must also be set to `true` and the group cannot be a dynamic group (that is, **groupTypes** cannot contain `DynamicMembership`). <br/><br/>Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the _RoleManagement.ReadWrite.Directory_ permission to set this property or update the membership of such groups. For more, see [Using a group to manage Azure AD role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`). | +| isAssignableToRole | Boolean | Indicates whether this group can be assigned to an Azure Active Directory role. Optional. <br><br>This property can only be set while creating the group and is immutable. If set to `true`, the **securityEnabled** property must also be set to `true`, **visibility** must be `Hidden`, and the group cannot be a dynamic group (that is, **groupTypes** cannot contain `DynamicMembership`). <br/><br/>Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the _RoleManagement.ReadWrite.Directory_ permission to set this property or update the membership of such groups. For more, see [Using a group to manage Azure AD role assignments](https://go.microsoft.com/fwlink/?linkid=2103037)<br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`). | | infoCatalogs | String collection | Identifies the info segments assigned to the group. Returned by default. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`). | | isSubscribedByMail | Boolean | Indicates whether the signed-in user is subscribed to receive email conversations. Default value is `true`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | licenseProcessingState | String | Indicates status of the group license assignment to all members of the group. Possible values: `QueuedForProcessing`, `ProcessingInProgress`, and `ProcessingComplete`. <br><br>Returned only on `$select`. Read-only. | |
v1.0 | Groups Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/groups-overview.md | Content-type: application/json } ``` +## Group membership ++Not all object types can be members of both Microsoft 365 and security groups. ++ ## Dynamic membership All types of groups can have dynamic membership rules that automatically add or remove members from the group based on the principal's properties. For example, a "Marketing employees" group can define a dynamic membership rule that only users with their department property set to "Marketing" can be members of the group. In this case, any user's who leave the department are automatically removed from the group. To learn more about formulating membership rules, see [Dynamic membership rules ## Other types of groups -Microsoft 365 groups in Yammer are used to facilitate user collaboration through Yammer posts. This type of group can be returned through a read request, but their posts can't be accessed through the API. When Yammer posts and conversation feeds are enabled on a group, default Microsoft 365 group conversations are disabled. To learn more, see [Yammer developer API docs](https://developer.yammer.com/docs). +Microsoft 365 groups in Yammer are used to facilitate user collaboration through Yammer posts. This type of group can be returned through a read request, but their posts can't be accessed through the API. When Yammer posts and conversation feeds are enabled on a group, default Microsoft 365 group conversations are disabled. To learn more, see [Yammer developer API docs](/rest/api/yammer/). ## Group search limitations for guest users in organizations |
v1.0 | Identitygovernance Lifecycleworkflows Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-lifecycleworkflows-overview.md | ms.localizationpriority: medium ms.prod: "governance" doc_type: conceptualPageType Last updated : 11/29/2022 # Overview of Lifecycle Workflows APIs |
v1.0 | Identitygovernance Lifecycleworkflows Reporting Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-lifecycleworkflows-reporting-overview.md | ms.localizationpriority: medium ms.prod: "governance" doc_type: conceptualPageType Last updated : 11/17/2022 # Lifecycle Workflow reporting API Overview |
v1.0 | Identitygovernance Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-overview.md | ms.localizationpriority: medium ms.prod: "governance" doc_type: conceptualPageType Last updated : 11/29/2022 # Overview of Azure AD Identity Governance using Microsoft Graph |
v1.0 | Identityprotection Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identityprotection-overview.md | |
v1.0 | Indexing Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/indexing-api-overview.md | The use cases for the APIs in this section involve building [Microsoft Graph con The following are current known limitations: -- Organizations are limited to a maximum of 10 connections.-- You can create only four `externalItem` resources items per second.-- An application is limited to four concurrent operations on a connection.-- Connections have a capacity limit of 700,000 items or ~70 GB of data.+- Organizations are limited to a maximum of 10 connections (reach out if you need more). +- You can create up to 25 `externalItem` resources items per second. +- An application is limited to 25 concurrent operations on a connection. +- Connections have a capacity limit of 5,000,000 items or ~350 GB of data. - Maximum size of an `externalItem` entity is 4 MB. - Sorting results is not supported. |
v1.0 | Internaldomainfederation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/internaldomainfederation.md | Title: "internalDomainFederation resource type" description: "Represents configurations of the domains in a tenant that are federated with Azure AD."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Meetinginfo | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/meetinginfo.md | Title: "meetingInfo resource type" -description: "Meeting information specified to create or join a meeting." +description: "An abstract class that contains meeting-specific information." ms.localizationpriority: medium ms.prod: "cloud-communications" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -This is an abstract class that contains meeting specific information. - +An abstract class that contains meeting-specific information. + To join an existing meeting, you must either specify the [organizerMeetingInfo](organizermeetinginfo.md) in combination with the [chatInfo](./chatinfo.md), the [tokenMeetingInfo](tokenmeetinginfo.md), or the [joinMeetingIdMeetingInfo](joinmeetingidmeetinginfo.md). +Base type of [organizerMeetingInfo](organizermeetinginfo.md), [tokenMeetingInfo](tokenmeetinginfo.md), and [joinMeetingIdMeetingInfo](joinmeetingidmeetinginfo.md). -## Derived types +## Properties -| Type | Description | -|:--|:--| -| [joinMeetingIdMeetingInfo](joinmeetingidmeetinginfo.md) | Contains the **joinMeetingId** and **passcode** of the meeting. | -| [organizerMeetingInfo](./organizermeetinginfo.md) | Details about the organizer of the meeting. | -| [tokenMeetingInfo](tokenmeetinginfo.md) | An encrypted token that contains the information about the meeting. | +None. ## JSON representation The following is a JSON representation of the resource. "suppressions": [] } -->-- |
v1.0 | Microsoftauthenticatorauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/microsoftauthenticatorauthenticationmethodconfiguration.md | Title: "microsoftAuthenticatorAuthenticationMethodConfiguration resource type" description: "Represents a Microsoft Authenticator authentication methods policy."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType Represents a Microsoft Authenticator authentication methods policy. Authenticati |Method|Return type|Description| |:|:|:| |[Get](../api/microsoftauthenticatorauthenticationmethodconfiguration-get.md)|[microsoftAuthenticatorAuthenticationMethodConfiguration](../resources/microsoftauthenticatorauthenticationmethodconfiguration.md)|Read the properties and relationships of a microsoftAuthenticatorAuthenticationMethodConfiguration object.|-|[Update](../api/microsoftauthenticatorauthenticationmethodconfiguration-update.md)|[microsoftAuthenticatorAuthenticationMethodConfiguration](../resources/microsoftauthenticatorauthenticationmethodconfiguration.md)|Update the properties of a microsoftAuthenticatorAuthenticationMethodConfiguration object.| +|[Update](../api/microsoftauthenticatorauthenticationmethodconfiguration-update.md)|None|Update the properties of a microsoftAuthenticatorAuthenticationMethodConfiguration object.| |[Delete](../api/microsoftauthenticatorauthenticationmethodconfiguration-delete.md)|None|Reverts the microsoftAuthenticatorAuthenticationMethodConfiguration object to its default configuration.| ## Properties |Property|Type|Description| |:|:|:|+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| |id|String|The authentication method policy identifier.|+|isSoftwareOathEnabled|Boolean|`true` if users can use the OTP code generated by the Microsoft Authenticator app, `false` otherwise.| |state|authenticationMethodState|Possible values are: `enabled`, `disabled`.| |featureSettings|[microsoftAuthenticatorFeatureSettings](../resources/microsoftauthenticatorfeaturesettings.md)|A collection of Microsoft Authenticator settings such as number matching and location context, and whether they are enabled for all users or specific users only.| ## Relationships |Relationship|Type|Description| |:|:|:|-|includeTargets|[microsoftAuthenticatorAuthenticationMethodTarget](../resources/microsoftauthenticatorauthenticationmethodtarget.md) collection|A collection of users or groups who are enabled to use the authentication method. Expanded by default.| +|includeTargets|[microsoftAuthenticatorAuthenticationMethodTarget](../resources/microsoftauthenticatorauthenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method. Expanded by default.| ## JSON representation The following is a JSON representation of the resource. The following is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.microsoftAuthenticatorAuthenticationMethodConfiguration", "id": "String (identifier)",- "state": "String" + "state": "String", + "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ], + "isSoftwareOathEnabled": "Boolean", + "featureSettings": { + "@odata.type": "microsoft.graph.microsoftAuthenticatorFeatureSettings" + } } ``` |
v1.0 | Microsoftauthenticatorauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/microsoftauthenticatorauthenticationmethodtarget.md | Title: "microsoftAuthenticatorAuthenticationMethodTarget resource type" -description: "A collection of users or groups enabled to use Microsoft Authenticator authentication methods policy." +description: "A collection of groups enabled to use Microsoft Authenticator authentication methods policy." ms.localizationpriority: medium ms.prod: "identity-and-sign-in" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A collection of users or groups enabled to use [Microsoft Authenticator authentication methods policy](../resources/microsoftAuthenticatorAuthenticationMethodConfiguration.md) in Azure AD. Inherits from [authenticationMethodTarget](authenticationMethodTarget.md). +A collection of groups enabled to use [Microsoft Authenticator authentication methods policy](../resources/microsoftAuthenticatorAuthenticationMethodConfiguration.md) in Azure AD. Inherits from [authenticationMethodTarget](authenticationMethodTarget.md). ## Properties |Property|Type|Description| |:|:|:| |authenticationMode|microsoftAuthenticatorAuthenticationMode|Determines which types of notifications can be used for sign-in. The possible values are: `deviceBasedPush` (passwordless only), `push`, and `any`.| |id|String|Object identifier of an Azure AD user or group. Inherited from [authenticationMethodTarget](authenticationmethodtarget.md).|-|isRegistrationRequired|Boolean|Determines whether the user is enforced to register the authentication method. Inherited from [authenticationMethodTarget](authenticationmethodtarget.md). *Not supported*. | -|targetType|authenticationMethodTargetType| The possible values are: `user`, `group`, and `unknownFutureValue`. Inherited from [authenticationMethodTarget](authenticationMethodTarget.md).| +|isRegistrationRequired|Boolean|Determines whether the user is enforced to register the authentication method. Inherited from [authenticationMethodTarget](authenticationmethodtarget.md). **Not supported**. | +|targetType|authenticationMethodTargetType| Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets will remain but we recommend to move the individual users to a targeted group. Inherited from [authenticationMethodTarget](authenticationMethodTarget.md).| |numberMatchingRequiredState (deprecated)|advancedConfigState|Requires number matching for MFA notifications. Value is ignored for phone sign-in notifications. Possible values are: `enabled`, `disabled`, `default`.| |displayAppInformationRequiredState (deprecated)|advancedConfigState|Determines whether the user is shown additional context in their Authenticator app notification. In the body of the Authenticator notification, the user will be shown the app they are signing into along with the location that the authentication request originated from. Possible values are: `enabled`, `disabled`, `default`.| |
v1.0 | Onlinemeeting | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/onlinemeeting.md | This resource supports subscribing to [change notifications](/graph/webhooks). S | Property | Type | Description | | :-- | :-- | : |-| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a meeting. | | allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. | | allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. | | allowMeetingChat | [meetingChatMode](#meetingchatmode-values) | Specifies the mode of meeting chat. | | allowTeamworkReactions | Boolean | Indicates if Teams reactions are enabled for the meeting. |+| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a meeting. | | alternativeRecording | Stream | The content stream of the alternative recording of a [Microsoft Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events). Read-only. | | attendeeReport | Stream | The content stream of the attendee report of a [Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events). Read-only. | | audioConferencing | [audioConferencing](audioconferencing.md) | The phone access (dial-in) information for an online meeting. Read-only. | This resource supports subscribing to [change notifications](/graph/webhooks). S | id | String | The default ID associated with the online meeting. Read-only. | | isBroadcast | Boolean | Indicates whether this is a [Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events). | | isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. |-| joinWebUrl | String | The join URL of the online meeting. Read-only. | | joinInformation | [itemBody](itembody.md) | The join information in the language and locale variant specified in 'Accept-Language' request HTTP header. Read-only. |-| joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. | +| joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. Once an **onlineMeeting** is created, the **joinMeetingIdSettings** cannot be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. | +| joinWebUrl | String | The join URL of the online meeting. Read-only. | | lobbyBypassSettings | [lobbyBypassSettings](lobbyBypassSettings.md) | Specifies which participants can bypass the meeting lobby. | | participants | [meetingParticipants](meetingparticipants.md) | The participants associated with the online meeting. This includes the organizer and the attendees. | | recordAutomatically | Boolean | Indicates whether to record the meeting automatically. | This resource supports subscribing to [change notifications](/graph/webhooks). S { "allowAttendeeToEnableCamera": "Boolean", "allowAttendeeToEnableMic": "Boolean",- "allowedPresenters": "String", "allowMeetingChat": {"@odata.type": "microsoft.graph.meetingChatMode"}, "allowTeamworkReactions": "Boolean",+ "allowedPresenters": "String", + "alternativeRecording": "Stream", + "attendeeReport": "Stream", "audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"}, "broadcastSettings": {"@odata.type": "microsoft.graph.broadcastSettings"}, "chatInfo": {"@odata.type": "microsoft.graph.chatInfo"}, This resource supports subscribing to [change notifications](/graph/webhooks). S "id": "String (identifier)", "isBroadcast": "Boolean", "isEntryExitAnnounced": "Boolean",+ "joinInformation": {"@odata.type": "microsoft.graph.itemBody"}, "joinMeetingIdSettings": {"@odata.type": "microsoft.graph.joinMeetingIdSettings"}, "joinWebUrl": "String", "lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"}, "participants": {"@odata.type": "microsoft.graph.meetingParticipants"},+ "recordAutomatically": "Boolean", + "recording": "Stream", "startDateTime": "String (timestamp)", "subject": "String", "videoTeleconferenceId": "String" |
v1.0 | Onpremisespublishingprofile Root | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/onpremisespublishingprofile-root.md | ms.localizationpriority: medium ms.prod: "applications" doc_type: "resourcePageType" Last updated : 01/20/2022 # On-premises publishing profiles |
v1.0 | Passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration.md | Represents a Microsoft Authenticator Passwordless Phone Sign-in authentication m ## Relationships |Relationship|Type|Description| |:|:|:|-|includeTargets|[passwordlessMicrosoftAuthenticatorAuthenticationMethodTarget](../resources/passwordlessmicrosoftauthenticatorauthenticationmethodtarget.md) collection|A collection of users or groups who are enabled to use the authentication method.| +|includeTargets|[passwordlessMicrosoftAuthenticatorAuthenticationMethodTarget](../resources/passwordlessmicrosoftauthenticatorauthenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation The following is a JSON representation of the resource. |
v1.0 | Passwordlessmicrosoftauthenticatorauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/passwordlessmicrosoftauthenticatorauthenticationmethodtarget.md | Title: "passwordlessMicrosoftAuthenticatorAuthenticationMethodTarget resource type" -description: "A collection of users or groups enabled to use Microsoft Authenticator Passwordless Phone Sign-in authentication methods policy." +description: "A collection of groups enabled to use Microsoft Authenticator Passwordless Phone Sign-in authentication methods policy." ms.localizationpriority: medium ms.prod: "identity-and-sign-in" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A collection of users or groups enabled to use Microsoft Authenticator Passwordless Phone Sign-in authentication methods policy](../resources/passwordlessMicrosoftAuthenticatorAuthenticationMethodConfiguration.md) in Azure AD. +A collection of groups enabled to use Microsoft Authenticator Passwordless Phone Sign-in authentication methods policy](../resources/passwordlessMicrosoftAuthenticatorAuthenticationMethodConfiguration.md) in Azure AD. > [!CAUTION] > The Microsoft Authenticator Passwordless Phone Sign-in authentication method policy API is deprecated and stopped returning results on December 31, 2020. Please use the new [Microsoft Authenticator authentication method policy](../resources/microsoftAuthenticatorAuthenticationMethodConfiguration.md). |
v1.0 | Plannerexternalbucketsource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerexternalbucketsource.md | doc_type: resourcePageType Namespace: microsoft.graph -Contains information about the relationship of a [plannerBucket](plannerbucket.md) to a user experience outside of Planner. Buckets in Planner can be surfaced in or synced with other experiences to track work in the context of that experience. Data in the plannerExternalBucketSource can be displayed in a user interface, used for sync information utilized by external services, or used to simply point to where a bucket was created in an external service. The combination of contextScenarioId and externalObjectId is enforced to be unique within a tenant. If creation is called with an existing contextScenarioId and externalObjectId, the existing object is returned with no modifications. This type derives from [plannerBucketCreation](plannerBucketCreation.md). +Contains information about the relationship of a [plannerBucket](plannerbucket.md) to a user experience outside of Planner. This allows surfacing or syncing buckets in Planner with other experiences to track work in the context of that experience. ++You can display data in a **plannerExternalBucketSource** in a user interface to sync information for an external service, or to simply point to where a task was created in the external service. ++The combination of the **contextScenarioId** and **externalObjectId** properties is unique within a tenant. If creation is called with existing **contextScenarioId** and **externalObjectId** values, the existing object is returned with no modifications. ++This type is derived from [plannerBucketCreation](plannerBucketCreation.md). ## Properties |Property|Type|Description| |
v1.0 | Plannerexternalplansource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerexternalplansource.md | doc_type: resourcePageType Namespace: microsoft.graph -Contains information about the relationship of a [plannerPlan](plannerplan.md) to a user experience outside of Planner. Plans in Planner can be surfaced in or synced with other experiences to track work in the context of that experience. Data in the plannerExternalPlanSource can be displayed in a user interface, used for sync information utilized by external services, or used to simply point to where a plan was created in an external service. The combination of contextScenarioId and externalObjectId is enforced to be unique within a tenant. If creation is called with an existing contextScenarioId and externalObjectId, the existing object is returned with no modifications. This type derives from [plannerPlanCreation](plannerPlanCreation.md). +Contains information about the relationship of a [plannerPlan](plannerplan.md) to a user experience outside of Planner. This allows surfacing or syncing plans in Planner with other experiences to track work in the context of that experience. ++You can display data in a **plannerExternalPlanSource** in a user interface to sync information for an external service, or to simply point to where a plan was created in the external service. ++The combination of the **contextScenarioId** and **externalObjectId** properties is unique within a tenant. If creation is called with existing **contextScenarioId** and **externalObjectId** values, the existing object is returned with no modifications. ++This type is derived from [plannerPlanCreation](plannerPlanCreation.md). ## Properties |Property|Type|Description| |
v1.0 | Plannerexternaltasksource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerexternaltasksource.md | doc_type: resourcePageType Namespace: microsoft.graph -Contains information about the relationship of a [plannerTask](plannerTask.md) to a user experience outside of Planner. Tasks in Planner can be surfaced in or synced with other experiences to track work in the context of that experience. Data in the plannerExternalTaskSource can be displayed in a user interface, used for sync information utilized by external services, or used to simply point to where a task was created in an external service. The combination of contextScenarioId and externalObjectId is enforced to be unique within a tenant. If creation is called with an existing contextScenarioId and externalObjectId, the existing object is returned with no modifications. This type derives from [plannerTaskCreation](plannerTaskCreation.md). +Contains information about the relationship of a [plannerTask](plannerTask.md) to a user experience outside of Planner. This allows surfacing or syncing tasks in Planner with other experiences to track work in the context of that experience. ++You can display data in a **plannerExternalTaskSource** in a user interface to sync information for an external service, or to simply point to where a task was created in the external service. ++The combination of the **contextScenarioId** and **externalObjectId** properties is unique within a tenant. If creation is called with existing **contextScenarioId** and **externalObjectId** values, the existing object is returned with no modifications. ++This type is derived from [plannerTaskCreation](plannerTaskCreation.md). ## Properties |Property|Type|Description| |
v1.0 | Plannerfieldrules | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerfieldrules.md | + + Title: "plannerFieldRules resource type" +description: "Represents the rules and permissions that apply to a property as part of a plannerTaskPropertyRule." ++ms.localizationpriority: medium +++# plannerFieldRules resource type ++Namespace: microsoft.graph +++Represents the rules and permissions that apply to a property as part of a [plannerTaskPropertyRule](../resources/plannertaskpropertyrule.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|defaultRules|String collection|The default rules that apply if no override matches to the current data.| +|overrides|[plannerRuleOverride](../resources/plannerruleoverride.md) collection|Overrides that specify different rules for specific data associated with the field.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerFieldRules" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerFieldRules", + "defaultRules": ["String"], + "overrides": [{"@odata.type": "microsoft.graph.plannerRuleOverride"}] +} +``` |
v1.0 | Plannerplan | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerplan.md | Represents a plan in Microsoft 365. A plan can be owned by a [group](group.md) a ## Properties | Property | Type |Description| |:|:--|:-|-|container|[plannerPlanContainer](../resources/plannerplancontainer.md)|Identifies the container of the plan. After it is set, this property canΓÇÖt be updated. Required.| +|container|[plannerPlanContainer](../resources/plannerplancontainer.md)|Identifies the container of the plan. Specify only the **url**, the **containerId** and **type**, or all properties. After it is set, this property canΓÇÖt be updated. Required.| |contexts|[plannerPlanContextCollection](plannerplancontextcollection.md)| Read-only. Additional user experiences in which this plan is used, represented as [plannerPlanContext](plannerplancontext.md) entries.| |createdBy|[identitySet](identityset.md)|Read-only. The user who created the plan.| |createdDateTime|DateTimeOffset|Read-only. Date and time at which the plan is created. 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`| |
v1.0 | Plannerplanconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerplanconfiguration.md | + + Title: "plannerPlanConfiguration resource type" +description: "Represents the configuration of plannerPlan resources created for a businessScenario." ++ms.localizationpriority: medium +++# plannerPlanConfiguration resource type ++Namespace: microsoft.graph +++Represents the configuration of [plannerPlan](../resources/plannerplan.md) resources created for a [businessScenario](../resources/businessscenario.md). ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get plannerPlanConfiguration](../api/plannerplanconfiguration-get.md)|[plannerPlanConfiguration](../resources/plannerplanconfiguration.md)|Read the properties and relationships of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object.| +|[Update plannerPlanConfiguration](../api/plannerplanconfiguration-update.md)|[plannerPlanConfiguration](../resources/plannerplanconfiguration.md)|Update the properties of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object for a [businessScenario](../resources/businessscenario.md). | +|[List localizations](../api/plannerplanconfiguration-list-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) collection|Get the plannerPlanConfigurationLocalization resources from the localizations navigation property.| +|[Create plannerPlanConfigurationLocalization](../api/plannerplanconfiguration-post-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Create a new plannerPlanConfigurationLocalization object.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|buckets|[plannerPlanConfigurationBucketDefinition](../resources/plannerplanconfigurationbucketdefinition.md) collection|List the buckets that should be created in the plan.| +|createdBy|[identitySet](../resources/identityset.md)|The identity of the creator of the plan configuration.| +|createdDateTime|DateTimeOffset|The date and time when the plan configuration was created. 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`. | +|defaultLanguage|String|The language code for the default language to be used for the names of the objects created for the plan.| +|id|String|The unique identifier for the plan configuration. Inherited from [entity](../resources/entity.md). | +|lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of the user who last modified the plan configuration. | +|lastModifiedDateTime|DateTimeOffset|The date and time when the plan configuration was last modified. 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`. | ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|localizations|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) collection|Localized names for the plan configuration.| ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.plannerPlanConfiguration", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerPlanConfiguration", + "buckets": [{"@odata.type": "microsoft.graph.plannerPlanConfigurationBucketDefinition"}], + "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, + "createdDateTime": "String (timestamp)", + "defaultLanguage": "String", + "id": "String (identifier)", + "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, + "lastModifiedDateTime": "String (timestamp)" +} +``` |
v1.0 | Plannerplanconfigurationbucketdefinition | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerplanconfigurationbucketdefinition.md | + + Title: "plannerPlanConfigurationBucketDefinition resource type" +description: "Represents a bucket in a plannerPlanConfiguration." ++ms.localizationpriority: medium +++# plannerPlanConfigurationBucketDefinition resource type ++Namespace: microsoft.graph +++Represents a bucket in a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|externalBucketId|String|Application-specified identifier of the bucket. | ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketDefinition" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationBucketDefinition", + "externalBucketId": "String" +} +``` |
v1.0 | Plannerplanconfigurationbucketlocalization | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerplanconfigurationbucketlocalization.md | + + Title: "plannerPlanConfigurationBucketLocalization resource type" +description: "Represents the localized name of a bucket in a plannerPlanConfigurationLocalization." ++ms.localizationpriority: medium +++# plannerPlanConfigurationBucketLocalization resource type ++Namespace: microsoft.graph +++Represents the localized name of a bucket in a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|externalBucketId|String|Application-specified identifier of the bucket.| +|name|String|Name of the bucket.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationBucketLocalization", + "externalBucketId": "String", + "name": "String" +} +``` |
v1.0 | Plannerplanconfigurationlocalization | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerplanconfigurationlocalization.md | + + Title: "plannerPlanConfigurationLocalization resource type" +description: "Represents the localized names for a plannerPlanConfiguration for a specific language." ++ms.localizationpriority: medium +++# plannerPlanConfigurationLocalization resource type ++Namespace: microsoft.graph +++Represents the localized names for a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) for a specific language. ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List plannerPlanConfigurationLocalizations](../api/plannerplanconfiguration-list-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) collection|Get a list of the [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) objects and their properties.| +|[Create plannerPlanConfigurationLocalization](../api/plannerplanconfiguration-post-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Create a new [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| +|[Get plannerPlanConfigurationLocalization](../api/plannerplanconfigurationlocalization-get.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Read the properties and relationships of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| +|[Update plannerPlanConfigurationLocalization](../api/plannerplanconfigurationlocalization-update.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Update the properties of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| +|[Delete plannerPlanConfigurationLocalization](../api/plannerplanconfiguration-delete-localizations.md)|None|Delete a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|buckets|[plannerPlanConfigurationBucketLocalization](../resources/plannerplanconfigurationbucketlocalization.md) collection|Localized names for configured buckets in the plan configuration.| +|id|String|The unique identifier for the plan configuration location. Inherited from [entity](../resources/entity.md).| +|languageTag|String|The language code associated with the localized names in this object.| +|planTitle|String|Localized title of the plan.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.plannerPlanConfigurationLocalization", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", + "buckets": [{"@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization"}], + "id": "String (identifier)", + "languageTag": "String", + "planTitle": "String" + +} +``` |
v1.0 | Plannerplancontainer | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerplancontainer.md | Planner currently supports the container types listed in the following table. Wh ## Properties |Property|Type|Description| |:|:|:|-|containerId|String|The identifier of the resource that contains the plan.| -|type|plannerContainerType| The type of the resource that contains the plan. See the previous table for supported types. Possible values are: `group`, `unknownFutureValue`, `roster` and `project`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `roster`, `project`.| -|url|String|The full canonical URL of the container.| +|containerId|String|The identifier of the resource that contains the plan. Optional.| +|type|plannerContainerType|The type of the resource that contains the plan. For supported types, see the previous table. Possible values are: `group`, `unknownFutureValue`, `roster`, and `project`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `roster`, `project`. Optional.| +|url|String|The full canonical URL of the container. Optional.| ## Relationships None. |
v1.0 | Plannerpropertyrule | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerpropertyrule.md | + + Title: "plannerPropertyRule resource type" +description: "An abstract base type of all entity rule definitions for Microsoft Planner." ++ms.localizationpriority: medium +++# plannerPropertyRule resource type ++Namespace: microsoft.graph +++An abstract base type of all entity rule definitions for Microsoft Planner. ++Base type of [plannerTaskPropertyRule](plannertaskpropertyrule.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|ruleKind|plannerRuleKind|Identifies which type of property rules is represented by this instance. The possible values are: `taskRule`, `bucketRule`, `planRule`, `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerPropertyRule" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerPropertyRule", + "ruleKind": "String" +} +``` |
v1.0 | Plannerrelationshipbasedusertype | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerrelationshipbasedusertype.md | + + Title: "plannerRelationshipBasedUserType resource type" +description: "Represents a role based on the caller's relationship to the businessScenarioTask that a plannerTaskRoleBasedRule can be applied to." ++ms.localizationpriority: medium +++# plannerRelationshipBasedUserType resource type ++Namespace: microsoft.graph +++Represents a role based on the caller's relationship to the [businessScenarioTask](../resources/businessscenariotask.md) that a [plannerTaskRoleBasedRule](../resources/plannertaskrolebasedrule.md) can be applied to. ++Inherits from [plannerTaskConfigurationRoleBase](../resources/plannertaskconfigurationrolebase.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|role|plannerRelationshipUserRoles|Identifies the relationship of the caller to the task. The possible values are: `defaultRules`, `groupOwners`, `groupMembers`, `taskAssignees`, `applications`, `unknownFutureValue`.| +|roleKind|plannerUserRoleKind|The kind of the rule. The value must be `relationship`. The possible values are: `relationship`, `unknownFutureValue`. Inherited from [plannerTaskConfigurationRoleBase](../resources/plannertaskconfigurationrolebase.md).| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerRelationshipBasedUserType" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerRelationshipBasedUserType", + "role": "String", + "roleKind": "String" +} +``` |
v1.0 | Plannerruleoverride | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerruleoverride.md | + + Title: "plannerRuleOverride resource type" +description: "Represents an overridden rule as part of plannerFieldRules." ++ms.localizationpriority: medium +++# plannerRuleOverride resource type ++Namespace: microsoft.graph +++Represents an overridden rule as part of [plannerFieldRules](../resources/plannerfieldrules.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|name|String|Name of the override. Allowed override values will be dependent on the property affected by the rule.| +|rules|String collection|Overridden rules. These are used as rules for the override instead of the default rules.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerRuleOverride" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerRuleOverride", + "name": "String", + "rules": ["String"] +} +``` |
v1.0 | Plannertaskconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannertaskconfiguration.md | + + Title: "plannerTaskConfiguration resource type" +description: "Represents the configuration of plannerTasks created for a businessScenario." ++ms.localizationpriority: medium +++# plannerTaskConfiguration resource type ++Namespace: microsoft.graph +++Represents the configuration of [plannerTasks](../resources/plannertask.md) created for a [businessScenario](../resources/businessscenario.md). ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get plannerTaskConfiguration](../api/plannertaskconfiguration-get.md)|[plannerTaskConfiguration](../resources/plannertaskconfiguration.md)|Read the properties and relationships of a [plannerTaskConfiguration](../resources/plannertaskconfiguration.md) object.| +|[Update plannerTaskConfiguration](../api/plannertaskconfiguration-update.md)|[plannerTaskConfiguration](../resources/plannertaskconfiguration.md)|Update the properties of a [plannerTaskConfiguration](../resources/plannertaskconfiguration.md) object.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|editPolicy|[plannerTaskPolicy](../resources/plannertaskpolicy.md)|Policy configuration for tasks created for the businessScenario when they are being changed outside of the scenario.| +|id|String|The unique identifier for the task configuration. Inherited from [entity](../resources/entity.md).| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.plannerTaskConfiguration", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerTaskConfiguration", + "editPolicy": {"@odata.type": "microsoft.graph.plannerTaskPolicy"}, + "id": "String (identifier)" +} +``` |
v1.0 | Plannertaskconfigurationrolebase | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannertaskconfigurationrolebase.md | + + Title: "plannerTaskConfigurationRoleBase resource type" +description: "An abstract type that represents a role that a plannerTaskRoleBasedRule can be applied to." ++ms.localizationpriority: medium +++# plannerTaskConfigurationRoleBase resource type ++Namespace: microsoft.graph +++An abstract type that represents a role that a [plannerTaskRoleBasedRule](../resources/plannertaskrolebasedrule.md) can be applied to. ++## Properties ++|Property|Type|Description| +|:|:|:| +|roleKind|plannerUserRoleKind|Type of the role. The possible values are: `relationship`, `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerTaskConfigurationRoleBase" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerTaskConfigurationRoleBase", + "roleKind": "String" +} +``` |
v1.0 | Plannertaskpolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannertaskpolicy.md | + + Title: "plannerTaskPolicy resource type" +description: "Represents the policy configuration for tasks created for a businessScenario when they are being changed outside of the scenario." ++ms.localizationpriority: medium +++# plannerTaskPolicy resource type ++Namespace: microsoft.graph +++Represents the policy configuration for [tasks](../resources/businessscenariotask.md) created for a [businessScenario](../resources/businessscenario.md) when they are being changed outside of the scenario. ++## Properties ++|Property|Type|Description| +|:|:|:| +|rules|[plannerTaskRoleBasedRule](../resources/plannertaskrolebasedrule.md) collection|The rules that should be enforced on the tasks when they are being changed outside of the scenario, based on the role of the caller.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerTaskPolicy" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerTaskPolicy", + "rules": [{"@odata.type": "microsoft.graph.plannerTaskRoleBasedRule"}] +} +``` |
v1.0 | Plannertaskpropertyrule | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannertaskpropertyrule.md | + + Title: "plannerTaskPropertyRule resource type" +description: "Represents specific restrictions that apply to editing a plannerTask." ++ms.localizationpriority: medium +++# plannerTaskPropertyRule resource type ++Namespace: microsoft.graph +++Represents specific restrictions that apply to editing a [plannerTask](../resources/plannertask.md). For more details, see [Configuring task rules in Planner](/graph/planner-task-rules-overview). ++Inherits from [plannerPropertyRule](../resources/plannerpropertyrule.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|appliedCategories|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for applied categories. This value does not currently support overrides. Accepted values for the default rule and individual overrides are `allow`, `block`.| +|assignments|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for assignments. Allowed overrides are `userCreated` and `applicationCreated`. Accepted values for the default rule and individual overrides are `allow`, `add`, `addSelf`, `addOther`, `remove`, `removeSelf`, `removeOther`, `block`.| +|checkLists|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for checklist. Allowed overrides are `userCreated` and `applicationCreated`. Accepted values for the default rule and individual overrides are `allow`, `add`, `remove`, `update`, `check`, `reorder`, `block`.| +|delete|String collection|Rules and restrictions for deleting the task. Accepted values are `allow` and `block`.| +|dueDate|String collection|Rules and restrictions for changing the due date of the task. Accepted values are `allow` and `block`.| +|move|String collection|Rules and restrictions for moving the task between buckets or plans. Accepted values are `allow`, `moveBetweenPlans`, `moveBetweenBuckets`, and `block`.| +|notes|String collection|Rules and restrictions for changing the notes of the task. Accepted values are `allow` and `block`.| +|order|String collection|Rules and restrictions for changing the order of the task. Accepted values are `allow` and `block`.| +|percentComplete|String collection|Rules and restrictions for changing the completion percentage of the task. Accepted values are `allow`, `setToComplete`, `setToNotStarted`, `setToInProgress`, and `block`.| +|previewType|String collection|Rules and restrictions for changing the preview type of the task. Accepted values are `allow` and `block`.| +|priority|String collection|Rules and restrictions for changing the priority of the task. Accepted values are `allow` and `block`.| +|references|[plannerFieldRules](../resources/plannerfieldrules.md)|Rules and restrictions for references. Allowed overrides are `userCreated` and `applicationCreated`. Accepted values for the default rule and individual overrides are `allow`, `add`, `remove`, `block`.| +|ruleKind|plannerRuleKind|Identifies which type of property rules is represented by this instance. Must be set to `taskRule`. The possible values are: `taskRule`, `bucketRule`, `planRule`, `unknownFutureValue`. Inherited from [plannerPropertyRule](../resources/plannerpropertyrule.md).| +|startDate|String collection|Rules and restrictions for changing the start date of the task. Accepted values are `allow` and `block`.| +|title|String collection|Rules and restrictions for changing the title of the task. Accepted values are `allow` and `block`.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerTaskPropertyRule" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerTaskPropertyRule", + "appliedCategories": {"@odata.type": "microsoft.graph.plannerFieldRules"}, + "assignments": {"@odata.type": "microsoft.graph.plannerFieldRules"}, + "checkLists": {"@odata.type": "microsoft.graph.plannerFieldRules"}, + "delete": ["String"], + "dueDate": ["String"], + "move": ["String"], + "notes": ["String"], + "order": ["String"], + "percentComplete": ["String"], + "previewType": ["String"], + "priority": ["String"], + "references": {"@odata.type": "microsoft.graph.plannerFieldRules"}, + "ruleKind": "String", + "startDate": ["String"], + "title": ["String"] +} +``` |
v1.0 | Plannertaskrolebasedrule | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannertaskrolebasedrule.md | + + Title: "plannerTaskRoleBasedRule resource type" +description: "Represents the rules for editing tasks created for a scenario." ++ms.localizationpriority: medium +++# plannerTaskRoleBasedRule resource type ++Namespace: microsoft.graph +++Represents the rules for editing [tasks](../resources/businessscenariotask.md) created for a [scenario](../resources/businessscenario.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|defaultRule|String|Default rule that applies when a property or action-specific rule is not provided. Possible values are: `Allow`, `Block`| +|propertyRule|[plannerTaskPropertyRule](../resources/plannertaskpropertyrule.md)|Rules for specific properties and actions.| +|role|[plannerTaskConfigurationRoleBase](../resources/plannertaskconfigurationrolebase.md)|The role these rules apply to.| ++## Relationships ++None. ++## JSON representation ++The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.plannerTaskRoleBasedRule" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.plannerTaskRoleBasedRule", + "defaultRule": "String", + "propertyRule": {"@odata.type": "microsoft.graph.plannerTaskPropertyRule"}, + "role": {"@odata.type": "microsoft.graph.plannerTaskConfigurationRoleBase"} +} +``` |
v1.0 | Policy Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/policy-overview.md | ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "conceptualPageType" Last updated : 10/05/2022 # Azure AD policy overview |
v1.0 | Presence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/presence.md | This resource supports subscribing to [change notifications](/graph/webhooks). | [Clear presence](../api/presence-clearpresence.md) | | Clear a presence session of an application for a user. | | [Set user preferred presence](../api/presence-setuserpreferredpresence.md) | | Set the preferred availability and activity status for a user. | | [Clear user preferred presence](../api/presence-clearuserpreferredpresence.md) | | Clear the preferred availability and activity status for a user. |+| [Set user status message](../api/presence-setstatusmessage.md) | | Set a presence status message for a user. | ## Properties This resource supports subscribing to [change notifications](/graph/webhooks). | id | string | The user object id | | availability | string collection | The base presence information for a user. Possible values are `Available`, `AvailableIdle`, `Away`, `BeRightBack`, `Busy`, `BusyIdle`, `DoNotDisturb`, `Offline`, `PresenceUnknown` | | activity | string collection | The supplemental information to a user's availability. Possible values are `Available`, `Away`, `BeRightBack`, `Busy`, `DoNotDisturb`, `InACall`, `InAConferenceCall`, `Inactive`,`InAMeeting`, `Offline`, `OffWork`,`OutOfOffice`, `PresenceUnknown`,`Presenting`, `UrgentInterruptionsOnly`. |-| outOfOfficeSettings | [outOfOfficeSettings](outOfOfficeSettings.md) | The out of office settings for a user. | +| outOfOfficeSettings | [outOfOfficeSettings](outOfOfficeSettings.md) | The out of office settings for a user. | +| statusMessage | [microsoft.graph.presenceStatusMessage](presencestatusmessage.md) | The presence status message of a user. | >**Note:** To learn more about the different presence states, see [User presence in Teams](/microsoftteams/presence-admins). The following is a JSON representation of the resource. "id":"string", "availability":"string", "activity":"string",- "outOfOfficeSettings":{"@odata.type": "#microsoft.graph.outOfOfficeSettings"} + "outOfOfficeSettings":{"@odata.type": "#microsoft.graph.outOfOfficeSettings"}, + "statusMessage":{"@odata.type": "#microsoft.graph.presenceStatusMessage"} } ``` |
v1.0 | Presencestatusmessage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/presenceStatusMessage.md | + + Title: "presenceStatusMessage resource type" +description: "Represents a presence status message related to the presence of a user in Microsoft Teams." ++ms.localizationpriority: medium +++# presenceStatusMessage resource type ++Namespace: microsoft.graph +++Represents a presence status message related to the [presence](presence.md) of a user in Microsoft Teams. ++## Properties ++| Property | Type | Description | +| -- | -- | - | +| expiryDateTime | [microsoft.graph.dateTimeTimeZone](datetimetimezone.md) | Time in which the status message expires.<br/>If not provided, the status message does not expire.<br/><br/>**expiryDateTime.dateTime** should not include time zone.<br/><br/>**expiryDateTime** is not available when requesting presence of another user. | +| message | [microsoft.graph.itemBody](itembody.md) | Status message item.<br/><br/> The only supported format currently is `message.contentType = 'text'`. | +| publishedDateTime | DateTimeOffset |Time in which the status message was published.<br/>Read-only.<br/><br/>**publishedDateTime** is not available when requesting presence of another user. | ++## JSON representation ++The following is a JSON representation of the resource. ++<!-- { + "blockType": "resource", + "optionalProperties": [ + "publishedDateTime", + "expiryDateTime" + ], + "@odata.type": "microsoft.graph.presenceStatusMessage" +}--> +```json +{ + "expiryDateTime": {"@odata.type": "#microsoft.graph.dateTimeTimeZone"}, + "message": {"@odata.type": "#microsoft.graph.itemBody"}, + "publishedDateTime": "String" +} +``` |
v1.0 | Privilegedidentitymanagementv3 Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/privilegedidentitymanagementv3-overview.md | |
v1.0 | Report Identity Access | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/report-identity-access.md | ms.localizationpriority: high ms.prod: "identity-and-access-reports" doc_type: conceptualPageType Last updated : 07/07/2022 # Identity and access reports API overview |
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 an Azure Active Directory (Azure AD) user as determined by Azure AD Identity Protection."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Search Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/search-api-overview.md | The **collapseProperties** property contains a set of criteria, fields, and limi The [query](../api/search-query.md) method lets you customize the collapse property by specifying **collapseProperties** on the `requests` parameter, which is a collection of [collapseProperty](collapseproperty.md) objects. This allows you to specify a set of one or more collapse properties. -Note that collapsing results is currently only supported on the following SharePoint and OneDrive types: [driveItem](driveitem.md), [listItem](listitem.md), [drive](drive.md), [list](list.md), [site](site.md). +Note that collapsing results is currently supported on the following entity types: [driveItem](driveitem.md), [listItem](listitem.md), [drive](drive.md), [list](list.md), [site](site.md), [externalItem](externalconnectors-externalitem.md). -The properties on which the collapse clause are applied need to be queryable and either sortable or refinable in the SharePoint [search schema](/sharepoint/manage-search-schema). For multi-level collapse, each subsequent property limit size specified in a multi-level request should be less than or equal to the previous; otherwise, the response will return an `HTTP 400 Bad Request` error. +The properties on which the collapse clause are applied need to be queryable and either sortable or refinable. For multi-level collapse, each subsequent property limit size specified in a multi-level request should be less than or equal to the previous; otherwise, the response will return an `HTTP 400 Bad Request` error. For examples that show how to collapse results, see [collapse search results](/graph/search-concept-collapse). |
v1.0 | Search Qna | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/search-qna.md | Namespace: microsoft.graph.search Q&As are administrative answer results in the search results page which provide answers for specific search keywords. Q&As allow administrators to answer the user's questions directly in search instead of providing a link to a webpage. A Q&A has many properties which allow administrators to make common resources more accessible in their organization. -Inherits from [searchAnswer](../resources/search-searchAnswer.md). +Inherits from [searchAnswer](../resources/search-searchanswer.md). ## Methods+ |Method|Return type|Description| |:|:|:| |[List qnas](../api/search-searchentity-list-qnas.md)|[microsoft.graph.search.qna](../resources/search-qna.md) collection|Get a list of the [qna](../resources/search-qna.md) objects and their properties.| |[Create qna](../api/search-searchentity-post-qnas.md)|[microsoft.graph.search.qna](../resources/search-qna.md)|Create a new [qna](../resources/search-qna.md) object.| |[Get qna](../api/search-qna-get.md)|[microsoft.graph.search.qna](../resources/search-qna.md)|Read the properties and relationships of a [qna](../resources/search-qna.md) object.| |[Update qna](../api/search-qna-update.md)|[microsoft.graph.search.qna](../resources/search-qna.md)|Update the properties of a [qna](../resources/search-qna.md) object.|-|[Delete qna](../api/search-qna-delete.md)|None|Deletes a [qna](../resources/search-qna.md) object.| +|[Delete qna](../api/search-qna-delete.md)|None|Delete a [qna](../resources/search-qna.md) object.| ## Properties+ |Property|Type|Description| |:|:|:|-|id|String|The unique identifier (GUID) for the qna. Inherited from [entity](../resources/entity.md).| -|displayName|String|Question displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| -|description|String|Answer displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| -|webUrl|String|Qna URL link. When users click this qna in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| -|lastModifiedBy|[microsoft.graph.identitySet](../resources/identityset.md)|Details of the user that created or last modified the qna. Inherited from [searchAnswer](../resources/search-searchAnswer.md). Read-only. | -|lastModifiedDateTime|DateTimeOffset| Timestamp of when the qna is created or edited. Inherited from [searchAnswer](../resources/search-searchAnswer.md). Read-only.| -|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna will start to appear as a search result. Set as `null` for always available.| |availabilityEndDateTime|DateTimeOffset|Timestamp of when the qna will stop to appear as a search result. Set as `null` for always available.|-|languageTags|String collection|A list of language names that are geographically specific and that this QnA can be viewed in. Each language tag value follows the pattern {language}-{region}. As an example, `en-us` is English as used in the United States. See [supported language tags](search-api-answers-overview.md#supported-language-tags) for the list of possible values. | +|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna will start to appear as a search result. Set as `null` for always available.| +|description|String|Answer displayed in search results. Inherited from [searchAnswer](../resources/search-searchanswer.md).| +|displayName|String|Question displayed in search results. Inherited from [searchAnswer](../resources/search-searchanswer.md).| +|groupIds|String collection|List of security groups able to view this qna.| +|id|String|The unique identifier (GUID) for the qna. Inherited from [entity](../resources/entity.md).| +|isSuggested|Boolean| True if this qna was suggested to the admin by a user or was mined and suggested by Microsoft. Read-only.| +|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerkeyword.md)|Keywords that trigger this qna to appear in search results.| +|languageTags|String collection|A list of language names that are geographically specific and that this QnA can be viewed in. Each language tag value follows the pattern {language}-{region}. As an example, `en-us` is English as used in the United States. For the list of possible values, see [supported language tags](search-api-answers-overview.md#supported-language-tags). | +|lastModifiedBy|[microsoft.graph.identitySet](../resources/identityset.md)|Details of the user that created or last modified the qna. Inherited from [searchAnswer](../resources/search-searchanswer.md). Read-only. | +|lastModifiedDateTime|DateTimeOffset| Timestamp of when the qna is created or edited. Inherited from [searchAnswer](../resources/search-searchanswer.md). Read-only.| |platforms|microsoft.graph.devicePlatformType collection|List of devices and operating systems able to view this qna. Possible values are: `unknown`, `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `androidASOP`.|-|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.| -|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerKeyword.md)|Keywords that trigger this qna to appear in search results.| |state|microsoft.graph.search.answerState|State of the qna. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.|-|isSuggested|Boolean| True if this qna was suggested to the admin by a user or was mined and suggested by Microsoft. Read-only.| -|groupIds|String collection|List of security groups able to view this qna.| -+|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answervariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.| +|webUrl|String|Qna URL link. When users click this qna in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchanswer.md).| ## Relationships+ None. ## JSON representation+ The following is a JSON representation of the resource.+ <!-- { "blockType": "resource", "keyProperty": "id", The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.search.qna",- "id": "String (identifier)", - "displayName": "String", + "availabilityEndDateTime": "String (timestamp)", + "availabilityStartDateTime": "String (timestamp)", "description": "String",- "webUrl": "String", - "lastModifiedBy": { - "@odata.type": "microsoft.graph.identitySet" + "displayName": "String", + "groupIds": [ + "String" + ], + "id": "String (identifier)", + "isSuggested": "Boolean", + "keywords": { + "@odata.type": "microsoft.graph.search.answerKeyword" },- "lastModifiedDateTime": "String (timestamp)", - "availabilityStartDateTime": "String (timestamp)", - "availabilityEndDateTime": "String (timestamp)", "languageTags": [ "String" ],+ "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", "platforms": [ "String" ],+ "state": "String", "targetedVariations": [ { "@odata.type": "microsoft.graph.search.answerVariant" } ],- "keywords": { - "@odata.type": "microsoft.graph.search.answerKeyword" - }, - "state": "String", - "isSuggested": "Boolean", - "groupIds": [ - "String" - ] + "webUrl": "String" } ``` |
v1.0 | Security Alertevidence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-alertevidence.md | This alert evidence base type and its derived evidence types provide a means to |Property|Type|Description| |:|:|:| |createdDateTime|DateTimeOffset|The time the evidence was created and added to the alert.|-|remediationStatus|[microsoft.graph.security.evidenceRemediationStatus](#evidenceremediationstatus-values)|Status of the remediation action taken. The possible values are: `none`, `remediated`, `prevented`, `blocked`, `notFound`, `active`, `pendingApproval`, `declined`, `notRemediated`, `running`, `unknownFutureValue`.| +|remediationStatus|[microsoft.graph.security.evidenceRemediationStatus](#evidenceremediationstatus-values)|Status of the remediation action taken. The possible values are: `none`, `remediated`, `prevented`, `blocked`, `notFound`, `unknownFutureValue`.| |remediationStatusDetails|String|Details about the remediation status.| |roles|[microsoft.graph.security.evidenceRole](#evidencerole-values) collection|The role/s that an evidence entity represents in an alert, e.g., an IP address that is associated with an attacker will have the evidence role "Attacker".| |tags|String collection|Array of custom tags associated with an evidence instance, for example to denote a group of devices, high value assets, etc.| This alert evidence base type and its derived evidence types provide a means to | remediated | Remediation action has completed successfully. | | prevented | The threat was prevented from executing. | | blocked | The threat was blocked while executing. |-| active | Live response session is currently active. | -| pendingApproval | Remediation action is pending manual approval. | -| declined | Remediation action was not approved by analyst.| -| notRemediated | Remediation action failed to remediate threat. | -| running | Remediation action is currently running. | +| notFound | The evidence was not found. | | unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | |
v1.0 | Security Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-api-overview.md | Title: "Use the Microsoft Graph security API" -description: " > **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported." +description: "The Microsoft Graph security API provides a unified interface and schema to integrate with security solutions from Microsoft and ecosystem partners." ms.localizationpriority: high ms.prod: "security" Take immediate action to defend against threats using the [securityAction](secur > **Note:** Currently security actions only support application permissions. -## Advanced hunting (preview) +## Advanced hunting Advanced hunting is a query-based threat hunting tool that lets you explore up to 30 days of raw data. You can proactively inspect events in your network to locate threat indicators and entities. The flexible access to data enables unconstrained hunting for both known and potential threats. Use [runHuntingQuery](../api/security-security-runhuntingquery.md) to run a [Kusto Query Language](/azure/data-explorer/kusto/query/) (KQL) query on data stored in Microsoft 365 Defender. Leverage the returned result set to enrich an existing investigation or to uncover undetected threats in your network. Use [runHuntingQuery](../api/security-security-runhuntingquery.md) to run a [Kus 6. The maximum query result size of a single request cannot exceed 124 MB. Exceeding the size limit results in HTTP 400 Bad Request with the message "Query execution has exceeded the allowed result size. Optimize your query by limiting the number of results and try again." ## Alerts-Alerts are suspicious activities in a customer's tenant that Microsoft or partner security providers have identified and flagged for action. Attacks typically employ various techniques against different types of entities, such as devices, users, and mailboxes. The result is alerts from multiple security providers for multiple entities in the tenant. Piecing the individual alerts together to gain insight into an attack can be challenging and time-consuming. +Alerts are detailed warnings about suspicious activities in a customer's tenant that Microsoft or partner security providers have identified and flagged for action. Attacks typically employ various techniques against different types of entities, such as devices, users, and mailboxes. The result is alerts from multiple security providers for multiple entities in the tenant. Piecing the individual alerts together to gain insight into an attack can be challenging and time-consuming. The beta version of the security API offers two types of alerts that aggregate other alerts from security providers and make analyzing attacks and determining response easier: -- [Alerts and incidents](#alerts-and-incidents-preview) (preview) - these are the latest generation of alerts in the Microsoft Graph security API. They are represented by the [alert](security-alert.md) resource and its collection, [incident](security-incident.md) resource, defined in the `microsoft.graph.security` namespace.+- [Alerts and incidents](#alerts-and-incidents) - these are the latest generation of alerts in the Microsoft Graph security API. They are represented by the [alert](security-alert.md) resource and its collection, [incident](security-incident.md) resource, defined in the `microsoft.graph.security` namespace. - [Legacy alerts](#legacy-alerts) - these are the first generation of alerts in the Microsoft Graph security API. They are represented by the [alert](alert.md) resource defined in the `microsoft.graph` namespace. -### Alerts and incidents (preview) +### Alerts and incidents These [alert](security-alert.md) resources first pull alert data from security provider services, that are either part of or integrated with [Microsoft 365 Defender](/microsoft-365/security/defender/microsoft-365-defender?view=o365-worldwide&preserve-view=true). Then they consume the data to return rich, valuable clues about a completed or ongoing attack, the impacted assets, and associated [evidence](security-alertevidence.md). In addition, they automatically correlate other alerts with the same attack techniques or the same attacker into an [incident](security-incident.md) to provide a broader context of an attack. They recommend response and remediation actions, offering consistent actionability across all the different providers. The rich content makes it easier for analysts to collectively investigate and respond to threats. Alerts from the following security providers are available via this legacy **ale [Microsoft Purview eDiscovery (Premium)](/microsoft-365/compliance/overview-ediscovery-20) provides an end-to-end workflow to preserve, collect, analyze, review, and export content that's responsive to your organization's internal and external investigations. -## Incidents (preview) +## Incidents An [incident](security-incident.md) is a collection of correlated  [alerts](security-alert.md) and associated data that make up the story of an attack. Incident management is part of Microsoft 365 Defender, and is available in the Microsoft 365 Defender portal (https://security.microsoft.com/). The following are some of the most popular requests for working with the Microso |List security actions| [List security actions](../api/securityactions-list.md)|[https://graph.microsoft.com/beta/security/securityActions](https://developer.microsoft.com/graph/graph-explorer?request=security/securityActions&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |Create security actions|[Create security actions](../api/securityactions-post.md)|[https://graph.microsoft.com/beta/security/securityActions](https://developer.microsoft.com/graph/graph-explorer?request=security/securityActions&method=POST&version=beta&GraphUrl=https://graph.microsoft.com)| |Cancel security action|[Cancel security actions](../api/securityaction-cancelsecurityaction.md)| [https://graph.microsoft.com/beta/security/securityActions/{id}/cancelSecurityAction](https://developer.microsoft.com/graph/graph-explorer?request=security/securityActions/{id}/cancelSecurityAction&method=POST&version=beta&GraphUrl=https://graph.microsoft.com) |-| **Alerts and incidents (preview)**||| +| **Alerts and incidents**||| | List alerts | [List alerts](../api/security-list-alerts_v2.md) | [https://graph.microsoft.com/beta/security/alerts_v2](https://developer.microsoft.com/graph/graph-explorer?request=security/alerts_v2&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | | Update alert | [Update alert](../api/security-alert-update.md) | [https://graph.microsoft.com/beta/security/alerts/{id}](https://developer.microsoft.com/graph/graph-explorer?request=security/alerts/{id}&method=PATCH&version=beta&GraphUrl=https://graph.microsoft.com) | | List incidents | [List incidents](../api/security-list-incidents.md) | [https://graph.microsoft.com/beta/security/incidents](https://developer.microsoft.com/graph/graph-explorer?request=security/incidents&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | | List incidents with alerts| [List incidents](../api/security-list-incidents.md) | [https://graph.microsoft.com/beta/security/incidents?$expand=alerts](https://developer.microsoft.com/graph/graph-explorer?request=security/incidents?$expand=alerts&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | | Update incident | [Update incident](../api/security-incident-update.md) | [https://graph.microsoft.com/beta/security/incidents/{id}](https://developer.microsoft.com/graph/graph-explorer?request=security/incidents/{id}&method=PATCH&version=beta&GraphUrl=https://graph.microsoft.com) |-| **Attack simulation and training (preview)**||| +| **Attack simulation and training**||| |List simulations|[List simulations](../api/attacksimulationroot-list-simulations.md)|[https://graph.microsoft.com/beta/security/attackSimulation/simulations](https://developer.microsoft.com/graph/graph-explorer?request=security/attackSimulation/simulations&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |Get simulation overview report|[Get simulation overview report](../api/simulationreportoverview-get.md)|[https://graph.microsoft.com/beta/security/attackSimulation/simulations/{id}/report/overview](https://developer.microsoft.com/graph/graph-explorer?request=security/attackSimulation/simulations/{id}/report/overview&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |List simulation users report|[List simulation users report](../api/usersimulationdetails-list.md)|[https://graph.microsoft.com/beta/security/attackSimulation/simulations/{id}/report/simulationUsers](https://developer.microsoft.com/graph/graph-explorer?request=security/attackSimulation/simulations/{id}/report/simulationUsers&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |
v1.0 | Security Caseoperation | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-caseoperation.md | Title: "caseOperation resource type" -description: "An abstract entity that represents a long-running process." +description: "An abstract entity that represents a long-running eDiscovery process." ms.localizationpriority: medium ms.prod: "ediscovery" Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Inherits from [entity](../resources/entity.md). --An abstract entity that represents a long-running eDiscovery process. It contains a common set of properties that are shared among inheriting entities. Entities that derive from **caseOperation** include: +An abstract entity that represents a long-running eDiscovery process. It contains a common set of properties that are shared among inheriting entities. Entities that derive from **caseOperation** include: - [Index operation](../resources/security-ediscoveryindexoperation.md) - [Hold operation](../resources/security-ediscoveryholdoperation.md) An abstract entity that represents a long-running eDiscovery process. It contain - [Tag operation](../resources/security-ediscoverytagoperation.md) - [Export operation](../resources/security-ediscoveryexportoperation.md) +Inherits from [entity](../resources/entity.md). + ## Methods |Method|Return type|Description| |:|:|:| An abstract entity that represents a long-running eDiscovery process. It contain | applyTags | The operation represents bulk tagging documents in a review set for the specified review set query. | | contentExport | The operation represents a content export from a review set. | | convertToPdf | The operation represents converting documents to PDFs with redactions. |-| estimateStatistics | The operation represents searching against Microsoft 365 services such as Exchange, SharePoint, and OneDrive for business. | +| estimateStatistics | The operation represents searching against Microsoft 365 services such as Exchange, SharePoint, and OneDrive for Business. | | holdUpdate | The operation represent updating legal hold (apply/remove) for custodians and non-custodial data sources. | index | The operation represents indexing data sources of custodians and non-custodial data sources to make them searchable. | | purgeData | The operation represents purging content from the source workloads. | An abstract entity that represents a long-running eDiscovery process. It contain | submissionFailed | Submission of the operation failed. | | running | The operation is currently running. | | succeeded | The operation was successfully completed without any errors. |-| partiallySucceeded | The operation completed, but there were errors - See [resultInfo](../resources/resultinfo.md) for error details. | -| failed | The operation failed - See result info for error details. | +| partiallySucceeded | The operation completed, but there were errors. For error details, see [resultInfo](../resources/resultinfo.md). | +| failed | The operation failed. For error details, see [resultInfo](../resources/resultinfo.md). | ## Relationships None. The following is a JSON representation of the resource. ``` json { "@odata.type": "#microsoft.graph.security.caseOperation",- "id": "String (identifier)", - "createdDateTime": "String (timestamp)", - "completedDateTime": "String (timestamp)", "action": "String",+ "completedDateTime": "String (timestamp)", "createdBy": { "@odata.type": "microsoft.graph.identitySet" },- "percentProgress": "Integer", - "status": "String", + "createdDateTime": "String (timestamp)", + "id": "String (identifier)", + "percentProgress": "Int32", "resultInfo": { "@odata.type": "microsoft.graph.resultInfo"- } + }, + "status": "String" }-``` +``` |
v1.0 | Security Incident | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-incident.md | Because piecing the individual alerts together to gain insight into an attack ca |redirectIncidentId|String|Only populated in case an incident is grouped together with another incident, as part of the logic that processes incidents. In such a case, the **status** property is `redirected`. | |severity|alertSeverity|Indicates the possible impact on assets. The higher the severity, the bigger the impact. Typically higher severity items require the most immediate attention. Possible values are: `unknown`, `informational`, `low`, `medium`, `high`, `unknownFutureValue`.| |status|[microsoft.graph.security.incidentStatus](#incidentstatus-values)|The status of the incident. Possible values are: `active`, `resolved`, `redirected`, `unknownFutureValue`.|-|tags|String collection|Array of custom tags associated with an incident.| +|customTags|String collection|Array of custom tags associated with an incident.| ### incidentStatus values The following is a JSON representation of the resource. "determination": "String", "status": "String", "severity": "String",- "tags": [ + "customTags": [ "String" ], "comments": [ |
v1.0 | Security Ipevidence | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-ipevidence.md | Inherits from [alertEvidence](../resources/security-alertevidence.md). |Property|Type|Description| |:|:|:| |ipAddress|String|The value of the IP Address, can be either in V4 address or V6 address format.|+|countryLetterCode|String|The two-letter country code according to ISO 3166 format, for example: `US`, `UK`, `CA`, etc..).| ## Relationships None. The following is a JSON representation of the resource. "tags": [ "String" ],- "ipAddress": "String" + "ipAddress": "String", + "countryLetterCode": "String" } ``` |
v1.0 | Signingcertificateupdatestatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/signingcertificateupdatestatus.md | Title: "signingCertificateUpdateStatus resource type" description: "Provides status of the last update of the signing certificate."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType |
v1.0 | Smsauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/smsauthenticationmethodconfiguration.md | Represents a Text Message authentication methods policy. Authentication methods |Method|Return type|Description| |:|:|:| |[Get](../api/smsauthenticationmethodconfiguration-get.md)|[smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.md)|Read the properties and relationships of a smsAuthenticationMethodConfiguration object.|-|[Update](../api/smsauthenticationmethodconfiguration-update.md)|[smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.md)|Update the properties of a smsAuthenticationMethodConfiguration object.| +|[Update](../api/smsauthenticationmethodconfiguration-update.md)|None|Update the properties of a smsAuthenticationMethodConfiguration object.| |[Delete](../api/smsauthenticationmethodconfiguration-delete.md)|None|Reverts the smsAuthenticationMethodConfiguration object to its default configuration.| ## Properties |Property|Type|Description| |:|:|:|+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| |id|String|The authentication method policy identifier.| |state|authenticationMethodState|Possible values are: `enabled`, `disabled`.| ## Relationships |Relationship|Type|Description| |:|:|:|-|includeTargets|[smsAuthenticationMethodTarget](../resources/smsauthenticationmethodtarget.md) collection|A collection of users or groups who are enabled to use the authentication method.| +|includeTargets|[smsAuthenticationMethodTarget](../resources/smsauthenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation The following is a JSON representation of the resource. The following is a JSON representation of the resource. { "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration", "id": "String (identifier)",- "state": "String" + "state": "String", + "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ] } ``` |
v1.0 | Smsauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/smsauthenticationmethodtarget.md | Title: "smsAuthenticationMethodTarget resource type" -description: "A collection of users or groups enabled to use Text Message authentication methods policy." +description: "A collection of groups enabled to use Text Message authentication methods policy." ms.localizationpriority: medium ms.prod: "identity-and-sign-in" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A collection of users or groups enabled to use [Text Message authentication methods policy](../resources/smsAuthenticationMethodConfiguration.md) in Azure AD. +A collection of groups enabled to use [Text Message authentication methods policy](../resources/smsAuthenticationMethodConfiguration.md) in Azure AD. ## Properties |Property|Type|Description| |:|:|:| |id|String|Object ID of an Azure AD user or group.| |isRegistrationRequired|Boolean|Determines whether the user is enforced to register the authentication method. **Not supported**.|-|isUsableForSignIn|Boolean|Determines if the users or groups can use this authentication method to sign in to Azure AD. The value is always `true`.| -|targetType|authenticationMethodTargetType| Possible values are: `user`, `group`.| +|isUsableForSignIn|Boolean|Determines if users can use this authentication method to sign in to Azure AD. `true` if users can use this method for primary authentication, otherwise `false`.| +|targetType|authenticationMethodTargetType|Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets will remain but we recommend to move the individual users to a targeted group. Inherited from [authenticationMethodTarget](authenticationMethodTarget.md).| ## Relationships None. |
v1.0 | Softwareoathauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/softwareoathauthenticationmethodconfiguration.md | + + Title: "softwareOathAuthenticationMethodConfiguration resource type" +description: "Represents the authentication policy for a third-party software OATH authentication method." ++ms.localizationpriority: medium +++# softwareOathAuthenticationMethodConfiguration resource type ++Namespace: microsoft.graph +++Represents the authentication policy for a third-party software OATH authentication method. Authentication methods policies define configuration settings and users or groups that are enabled to use the authentication method. +++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get softwareOathAuthenticationMethodConfiguration](../api/softwareoathauthenticationmethodconfiguration-get.md)|[softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md)|Read the properties and relationships of a [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object.| +|[Update softwareOathAuthenticationMethodConfiguration](../api/softwareoathauthenticationmethodconfiguration-update.md)|None|Update the properties of a [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object.| +|[Delete softwareOathAuthenticationMethodConfiguration](../api/softwareoathauthenticationmethodconfiguration-delete.md)|None|Reverts the [softwareOathAuthenticationMethodConfiguration](../resources/softwareoathauthenticationmethodconfiguration.md) object to its default configuration.| ++## Properties +|Property|Type|Description| +|:|:|:| +|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| +|id|String|The authentication method policy identifier.| +|state|authenticationMethodState|Represents whether users can register this authentication method. The possible values are: `enabled`, `disabled`.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection| A collection of groups that are enabled to use the authentication method. Expanded by default.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.softwareOathAuthenticationMethodConfiguration", + "baseType": "microsoft.graph.authenticationMethodConfiguration", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.softwareOathAuthenticationMethodConfiguration", + "id": "String (identifier)", + "state": "String", + "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ] +} +``` + |
v1.0 | Subscription | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/subscription.md | Namespace: microsoft.graph A subscription allows a client app to receive change notifications about changes to data in Microsoft Graph. For the possible resource path values for each supported resource, see [Use the Microsoft Graph API to get change notifications](webhooks.md). To learn how to use lifecycle notifications, see [Reduce missing subscriptions and change notifications](/graph/webhooks-lifecycle). For the possible resource path values for each supported resource, see [Use the ## Properties -| Property | Type | Description | Supported Resources | -|:|:--|:|:--| -| applicationId | String | Optional. Identifier of the application used to create the subscription. Read-only. | All | -| changeType | String | Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: `created`, `updated`, `deleted`. Multiple values can be combined using a comma-separated list. <br><br>**Note:** <li> Drive root item and list change notifications support only the `updated` changeType. <li>[User](../resources/user.md) and [group](../resources/user.md) change notifications support `updated` and `deleted` changeType. Use `updated` to receive notifications when user or group is created, updated or soft deleted. Use `deleted` to receive notifications when user or group is permanently deleted. | All | -| clientState | String | Optional. Specifies the value of the **clientState** property sent by the service in each change notification. The maximum length is 255 characters. The client can check that the change notification came from the service by comparing the value of the **clientState** property sent with the subscription with the value of the **clientState** property received with each change notification. | All | -| creatorId | String | Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the ID of the service principal corresponding to the app. Read-only. | All | -| encryptionCertificate | String | Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when **includeResourceData** is `true`. | All | -| encryptionCertificateId | String | Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when **includeResourceData** is `true`. | All | -| expirationDateTime | DateTimeOffset | Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see [the table below](#maximum-length-of-subscription-per-resource-type). | All | -| id | String | Optional. Unique identifier for the subscription. Read-only. | All | -| includeResourceData | Boolean | Optional. When set to `true`, change notifications [include resource data](/graph/webhooks-with-resource-data) (such as content of a chat message). | All | -| latestSupportedTlsVersion | String | Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by **notificationUrl**, supports. The possible values are: `v1_0`, `v1_1`, `v1_2`, `v1_3`. </br></br>For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set [timeline](https://developer.microsoft.com/graph/blogs/microsoft-graph-subscriptions-deprecating-tls-1-0-and-1-1/) allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. </br></br>For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to `v1_2`. | All | -| lifecycleNotificationUrl | String | Optional. The URL of the endpoint that receives lifecycle notifications, including `subscriptionRemoved` and `missed` notifications. This URL must make use of the HTTPS protocol. | All | -| notificationContentType | String | Optional. Desired **content-type** for Microsoft Graph change notifications for supported resource types. The default content-type is `application/json`. | All | -| notificationQueryOptions | String |Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the **notificationQueryOptions** property. For example, when the print job is completed or when a print job resource `isFetchable` property value becomes `true` etc. | [Universal Print Service](/graph/universal-print-webhook-notifications) | -| notificationUrl | String | Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. | All | -| notificationUrlAppId| String | Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received. | All | -| resource | String | Required. Specifies the resource that will be monitored for changes. Do not include the base URL (`https://graph.microsoft.com/bet) for each supported resource. | All | +| Property | Type | Description | +|||| +| applicationId | String | Optional. Identifier of the application used to create the subscription. Read-only. | +| changeType | String | Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: `created`, `updated`, `deleted`. Multiple values can be combined using a comma-separated list. <br><br>**Note:** <li> Drive root item and list change notifications support only the `updated` changeType. <li>[User](../resources/user.md) and [group](../resources/user.md) change notifications support `updated` and `deleted` changeType. Use `updated` to receive notifications when user or group is created, updated or soft deleted. Use `deleted` to receive notifications when user or group is permanently deleted. | +| clientState | String | Optional. Specifies the value of the **clientState** property sent by the service in each change notification. The maximum length is 255 characters. The client can check that the change notification came from the service by comparing the value of the **clientState** property sent with the subscription with the value of the **clientState** property received with each change notification. | +| creatorId | String | Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the ID of the service principal corresponding to the app. Read-only. | +| encryptionCertificate | String | Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when **includeResourceData** is `true`. | +| encryptionCertificateId | String | Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when **includeResourceData** is `true`. | +| expirationDateTime | DateTimeOffset | Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see [the table below](#maximum-length-of-subscription-per-resource-type). | +| id | String | Optional. Unique identifier for the subscription. Read-only. | +| includeResourceData | Boolean | Optional. When set to `true`, change notifications [include resource data](/graph/webhooks-with-resource-data) (such as content of a chat message). | +| latestSupportedTlsVersion | String | Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by **notificationUrl**, supports. The possible values are: `v1_0`, `v1_1`, `v1_2`, `v1_3`. </br></br>For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set [timeline](https://developer.microsoft.com/graph/blogs/microsoft-graph-subscriptions-deprecating-tls-1-0-and-1-1/) allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. </br></br>For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to `v1_2`. | +| lifecycleNotificationUrl | String | Optional. The URL of the endpoint that receives lifecycle notifications, including `subscriptionRemoved`, `reauthorizationRequired`, and `missed` notifications. This URL must make use of the HTTPS protocol. | +| notificationContentType | String | Optional. Desired **content-type** for Microsoft Graph change notifications for supported resource types. The default content-type is `application/json`. | +| notificationQueryOptions | String | Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the **notificationQueryOptions** property. For example, when the print job is completed or when a print job resource `isFetchable` property value becomes `true` etc. <br/><br/> Supported only for Universal Print Service. For more information, see [Subscribe to change notifications from cloud printing APIs using Microsoft Graph](/graph/universal-print-webhook-notifications). | +| notificationUrl | String | Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. | +| notificationUrlAppId | String | Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received. | +| resource | String | Required. Specifies the resource that will be monitored for changes. Do not include the base URL (`https://graph.microsoft.com/bet) for each supported resource. | ### Maximum length of subscription per resource type |
v1.0 | Synchronization Configure With Custom Target Attributes | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/synchronization-configure-with-custom-target-attributes.md | ms.localizationpriority: medium doc_type: conceptualPageType ms.prod: "applications" Last updated : 07/20/2022 # Configure synchronization with custom target attributes |
v1.0 | Synchronization Configure With Directory Extension Attributes | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/synchronization-configure-with-directory-extension-attributes.md | ms.localizationpriority: medium doc_type: conceptualPageType ms.prod: "applications" Last updated : 07/20/2022 # Configure synchronization with directory extension attributes |
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 | Team | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/team.md | Every team is associated with a [Microsoft 365 group](../resources/group.md). Th | Property | Type | Description | |:|:--|:-|+| id | string | The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type. | |classSettings|[teamClassSettings](teamclasssettings.md) |Configure settings of a class. Available only when the team represents a class.| |classification|string| An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory. | |createdDateTime|dateTimeOffset|Timestamp at which the team was created.| |
v1.0 | Teamsapp | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/teamsapp.md | Users can see these apps in the Microsoft Teams Store, and these apps can be ins - [teamsAppInstallation](teamsappinstallation.md) - [teamsAppDefinition](teamsappdefinition.md) - [teamsTab](../resources/teamstab.md)+- [App catalog sample (C#)](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/graph-appcatalog-lifecycle/csharp) +- [App catalog sample (Node.JS)](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/graph-appcatalog-lifecycle/nodejs) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Teamvisibilitytype | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/teamvisibilitytype.md | Describes the visibility of a [team](../resources/team.md). |:|:--|:-| |private|0|Anyone can see the team but only the owner can add a user to the team.| |public|1|Anyone can join the team.|-+|hiddenMembership|2|Only the administrators (global, company, user, and helpdesk) can view the members of a team.<br>Owner permissions are required to join a team.| |
v1.0 | Temporaryaccesspassauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/temporaryaccesspassauthenticationmethodconfiguration.md | Represents a Temporary Access Pass authentication methods policy that defines th |:|:|:| |defaultLength|Int|Default length in characters of a Temporary Access Pass object. Must be between 8 and 48 characters.| |defaultLifetimeInMinutes|Int|Default lifetime in minutes for a Temporary Access Pass. Value can be any integer between the **minimumLifetimeInMinutes** and **maximumLifetimeInMinutes**.|+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| |id|String|The identifier of the authentication method policy. Inherited from [entity](entity.md).| |isUsableOnce|Boolean |If `true`, all the passes in the tenant will be restricted to one-time use. If `false`, passes in the tenant can be created to be either one-time use or reusable.| |minimumLifetimeInMinutes|Int|Minimum lifetime in minutes for any Temporary Access Pass created in the tenant. Value can be between 10 and 43200 minutes (equivalent to 30 days).| Represents a Temporary Access Pass authentication methods policy that defines th ## Relationships |Relationship|Type|Description| |:|:|:|-|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of users or groups who are enabled to use the authentication method.| +|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation The following is a JSON representation of the resource. The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration", "id": "String (identifier)", "state": "String",+ "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ], "defaultLifetimeInMinutes": "Integer", "defaultLength": "Integer", "minimumLifetimeInMinutes": "Integer", |
v1.0 | Users | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/users.md | ms.localizationpriority: high ms.prod: "users" doc_type: conceptualPageType Last updated : 11/16/2022 # Working with users in Microsoft Graph |
v1.0 | Voiceauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/voiceauthenticationmethodconfiguration.md | + + Title: "voiceAuthenticationMethodConfiguration resource type" +description: "Represents a voice call authenticaiton methods policy" ++ms.localizationpriority: medium +++# voiceAuthenticationMethodConfiguration resource type ++Namespace: microsoft.graph +++Represents a voice call authentication methods policy. Authentication methods policies define configuration settings and users or groups that are enabled to use the authentication method. +++Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get voiceAuthenticationMethodConfiguration](../api/voiceauthenticationmethodconfiguration-get.md)|[voiceAuthenticationMethodConfiguration](../resources/voiceauthenticationmethodconfiguration.md)|Read the properties and relationships of a [voiceAuthenticationMethodConfiguration](../resources/voiceauthenticationmethodconfiguration.md) object.| +|[Update voiceAuthenticationMethodConfiguration](../api/voiceauthenticationmethodconfiguration-update.md)|None|Update the properties of a [voiceAuthenticationMethodConfiguration](../resources/voiceauthenticationmethodconfiguration.md) object.| +|[Delete voiceAuthenticationMethodConfiguration](../api/voiceauthenticationmethodconfiguration-delete.md)|None|Revert the [voiceAuthenticationMethodConfiguration](../resources/voiceauthenticationmethodconfiguration.md) object to its default configuration.| ++## Properties +|Property|Type|Description| +|:|:|:| +|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| +|id|String|The authentication method policy identifier.| +|isOfficePhoneAllowed|Boolean|`true` if users can register office phones, otherwise, `false`. | +|state|authenticationMethodState|Represents whether users can register this authentication method. The possible values are: `enabled`, `disabled`.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|includeTargets|[voiceAuthenticationMethodTarget](../resources/voiceauthenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method. Expanded by default.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.voiceAuthenticationMethodConfiguration", + "baseType": "microsoft.graph.authenticationMethodConfiguration", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.voiceAuthenticationMethodConfiguration", + "id": "String (identifier)", + "state": "String", + "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ], + "isOfficePhoneAllowed": "Boolean" +} +``` + |
v1.0 | Voiceauthenticationmethodtarget | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/voiceauthenticationmethodtarget.md | + + Title: "voiceAuthenticationMethodTarget resource type" +description: "A collection of groups enabled to use voice call authentication method via policy." ++ms.localizationpriority: medium +++# voiceAuthenticationMethodTarget resource type ++Namespace: microsoft.graph +++A collection of groups enabled to use voice call authentication via the [voice call authentication methods policy](../resources/voiceAuthenticationMethodConfiguration.md) in Azure AD. ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Object ID of an Azure AD group.| +|isRegistrationRequired|Boolean|Determines whether the user is enforced to register the authentication method. **Not supported**.| +|targetType|authenticationMethodTargetType|Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets will remain but we recommend to move the individual users to a targeted group. Inherited from [authenticationMethodTarget](authenticationMethodTarget.md).| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.voiceAuthenticationMethodTarget", + "baseType": "microsoft.graph.authenticationMethodTarget", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.voiceAuthenticationMethodTarget", + "id": "String (identifier)", + "targetType": "String", + "isRegistrationRequired": "Boolean" +} +``` + |
v1.0 | Webhooks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/webhooks.md | ms.localizationpriority: medium doc_type: conceptualPageType ms.prod: "change-notifications" Last updated : 10/04/2022 # Use the Microsoft Graph API to get change notifications Namespace: microsoft.graph The Microsoft Graph REST API uses a webhook mechanism to deliver change notifications to clients. A client is a web service that configures its own URL to receive notifications. Client apps use notifications to update their state upon changes. For more details, including how to subscribe to and handle incoming notifications, see [Set up notifications for changes in user data](/graph/webhooks). -Using the Microsoft Graph API, an app can subscribe to changes in the resources in the table below. Apply the resource path corresponding to your scenario as specified when [creating a subscription](/graph/api/subscription-post-subscriptions). --| **Resource** | **Supported resource paths** | **Resource data can be included in notifications** | -|:-|:|:--| -| Cloud printing [printer][] | Changes when a print job is ready to be downloaded (JobFetchable event):<br>`/print/printers/{id}/jobs` | No | -| Cloud printing [printTaskDefinition][] | Changes when there is a valid job in the queue (JobStarted event) :<br>`/print/printtaskdefinition/{id}/tasks` | No | -| [driveItem][] on OneDrive for Business | Changes to content within the hierarchy of the _root folder_:<br>`/drives/{id}/root`<br> `/users/{id}/drive/root` | No | -| [driveItem][] on OneDrive (personal) | Changes to content within the hierarchy of _any folder_:<br>`/users/{id}/drive/root` | No | -| [group][] | Changes to all groups:<br>`/groups` <br>Changes to a specific group:<br>`/groups/{id}`<br>Changes to owners of a specific group:<br>`/groups/{id}/owners`<br>Changes to members of a specific group:<br>`/groups/{id}/members` | No | -| [list][] under a SharePoint [site][] | `/sites/{id}/lists/{id}` | No | -| Microsoft 365 group [conversation][] | Changes to a group's conversations:<br>`groups/{id}/conversations` | No | -| Outlook [event][] | Changes to all events in a user's mailbox:<br>`/users/{id}/events` | Yes | -| Outlook [message][] | Changes to all messages in a user's mailbox: <br>`/users/{id}/messages`<br>Changes to messages in a user's Inbox:<br>`/users/{id}/mailFolders('inbox')/messages` | Yes | -| Outlook personal [contact][] | Changes to all personal contacts in a user's mailbox:<br>`/users/{id}/contacts` | Yes | -| Security [alert][] | Changes to a specific alert:<br>`/security/alerts/{id}` <br>Changes to filtered alerts:<br> `/security/alerts/?$filter`| No | -| Teams [callRecord][] | Changes to _all_ call records: `/communications/callRecords` | No | -| Teams [channel][] | Changes to channels in all teams:<br>`/teams/getAllChannels` <br>Changes to channel in a specific team:<br>`/teams/{id}/channels` | Yes | -| Teams [chat][] | Changes to any chat in the tenant:<br>`/chats` <br>Changes to a specific chat:<br>`/chats/{id}`<br>Changes to any chat in the tenant a particular Teams app is installed to:<br>`/appCatalogs/teamsApps{id}/installedToChats` | Yes | -| Teams [chatmessage][] | Changes to chat messages in all channels in all teams:<br>`/teams/getAllMessages` <br>Changes to chat messages in a specific channel:<br>`/teams/{id}/channels/{id}/messages`<br>Changes to chat messages in all chats:<br>`/chats/getAllMessages` <br>Changes to chat messages in a specific chat:<br>`/chats/{id}/messages`<br>Changes to chat messages in all chats a particular user is part of:<br>`/users/{id}/chats/getAllMessages`<br>Changes to chat messages in all the chats in the tenant that a particular Teams app is installed to:<br>`/appCatalogs/teamsApps/{id}/installedToChats/getAllMessages` | Yes | -| Teams [conversationMember][] | Changes to membership in a specific team:<br>`/teams/{id}/members` <br> Changes to membership in a specific chat:<br>`/chats/{id}/members` <br> Changes to membership in all chats:<br>`/chats/getAllMembers` <br> Changes to membership in all channels under a specific team:<br>`/teams/{id}/channels/getAllMembers`<br>Changes to membership in all the chats in the tenant that a particular Teams app is installed to:<br>`/appCatalogs/teamsApps/{id}/installedToChats/getAllMembers` <br> Changes to membership in all channels across the tenant:<br> `teams/getAllChannels/getAllMembers`| Yes | -| Teams [onlineMeeting][] | Changes to an online meeting: <br>`/communications/onlineMeetings/?$filter=JoinWebUrl eq {joinWebUrl}` | Yes | -| Teams [presence][] | Changes to a single user's presence: `/communications/presences/{id}` <br> Changes to multiple user presences:<br> `/communications/presences?$filter=id in ({id},{id}...)` | Yes | -| Teams [team][] | Changes to any team in the tenant:<br>`/teams` <br>Changes to a specific team:<br>`/teams/{id}` | Yes | -| To Do [baseTask][] (deprecated) | Changes to all task in a specific task list:<br>`/me/tasks/lists/{baseTaskListId}/tasks`<br>Changes to all tasks:<br>`/me/tasks/lists/alltasks` | No | -| [To Do task][] | Changes to all task in a specific task list:<br>`/me/todo/lists/{todoTaskListId}/tasks` | No | -| [user][] | Changes to all users:<br>`/users` <br>Changes to a specific user:<br>`/users/{id}`| No | - > **Note**: Any resource path that begins with `/users/{id}` can also accept `/me` to reference the signed-in user. In general, subscription operations require read permission to the resource. For ## See also -- [Subscription resource type](subscription.md)-- [List subscriptions](../api/subscription-list.md)-- [Get subscription](../api/subscription-get.md)-- [Create subscription](../api/subscription-post-subscriptions.md)-- [Update subscription](../api/subscription-update.md)-- [Delete subscription](../api/subscription-delete.md)+- [subscription resource type](subscription.md) +- [Training module: Use change notifications and track changes with Microsoft Graph](/training/modules/msgraph-changenotifications-trackchanges) +- [Lifecycle notifications](/graph/webhooks-lifecycle) + +<!-- Links --> [chat]: ./chat.md [chatMessage]: ./chatmessage.md [contact]: ./contact.md |
v1.0 | X509certificateauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/x509certificateauthenticationmethodconfiguration.md | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet |Method|Return type|Description| |:|:|:| |[Get x509CertificateAuthenticationMethodConfiguration](../api/x509certificateauthenticationmethodconfiguration-get.md)|[x509CertificateAuthenticationMethodConfiguration](../resources/x509certificateauthenticationmethodconfiguration.md)|Read the properties and relationships of a x509CertificateAuthenticationMethodConfiguration object.|-|[Update x509CertificateAuthenticationMethodConfiguration](../api/x509certificateauthenticationmethodconfiguration-update.md)|[x509CertificateAuthenticationMethodConfiguration](../resources/x509certificateauthenticationmethodconfiguration.md)|Update the properties of a x509CertificateAuthenticationMethodConfiguration object.| +|[Update x509CertificateAuthenticationMethodConfiguration](../api/x509certificateauthenticationmethodconfiguration-update.md)|None|Update the properties of a x509CertificateAuthenticationMethodConfiguration object.| |[Delete x509CertificateAuthenticationMethodConfiguration](../api/x509certificateauthenticationmethodconfiguration-delete.md)|None| Delete the tenant-customized x509CertificateAuthenticationMethodConfiguration object and restore the default configuration.| ## Properties |Property|Type|Description| |:|:|:|+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| |id|String|The identifier for the authentication method policy. The value is always `X509Certificate`. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| |state|authenticationMethodState|The possible values are: `enabled`, `disabled`. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| |certificateUserBindings|[x509CertificateUserBinding](../resources/x509certificateuserbinding.md) collection|Defines fields in the X.509 certificate that map to attributes of the Azure AD user object in order to bind the certificate to the user. The **priority** of the object determines the order in which the binding is carried out. The first binding that matches will be used and the rest ignored. | Inherits from [authenticationMethodConfiguration](../resources/authenticationmet ## Relationships |Relationship|Type|Description| |:|:|:|-|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of users or groups who are enabled to use the authentication method.| +|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method.| ## JSON representation The following is a JSON representation of the resource. The following is a JSON representation of the resource. "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration", "id": "String (identifier)", "state": "String",+ "excludeTargets": [ + { + "@odata.type": "microsoft.graph.excludeTarget" + } + ], "certificateUserBindings": [ { "@odata.type": "microsoft.graph.x509CertificateUserBinding" |
v1.0 | Accesspackageassignmentpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accesspackageassignmentpolicy-update.md | Content-Type: application/json [!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 | Administrativeunit Post Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/administrativeunit-post-members.md | The following table shows the properties of the [group](../resources/group.md) r If successful, adding an existing object (using `$ref`) returns `204 No Content` response code. It does not return anything in the response body. -When creating a new group (without `$ref`), this method returns a `201 Created` response code and a [group](../resources/group.md) object in the response body. The response includes only the default properties of the group. +When creating a new group (without `$ref`), this method returns a `201 Created` response code and a [group](../resources/group.md) object in the response body. The response includes only the default properties of the group. You must supply the `"@odata.type" : "#microsoft.graph.group"` line in the request body to explicitly identify the new member as a group. A request body without the correct @odata.type returns a `400 Bad Request` error message. ## Examples ### Example 1: Add an existing user or group HTTP/1.1 204 No Content ``` ### Example 2: Create a new group-The following example creates a new group in the administrative unit. +The following example creates a new group in the administrative unit. You must supply the `"@odata.type" : "#microsoft.graph.group"` line in the request body to explicitly identify the new member as a group. A request body without the correct @odata.type returns a `400 Bad Request` error message. #### Request The following is an example of the request. POST https://graph.microsoft.com/v1.0/directory/administrativeUnits/{id}/members Content-type: application/json {- "@odata.type": "#Microsoft.Graph.Group", + "@odata.type": "#microsoft.graph.group", "description": "Self help community for golf", "displayName": "Golf Assist", "groupTypes": [ |
v1.0 | Appcatalogs List Teamsapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appcatalogs-list-teamsapps.md | List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog. This includes apps from the Microsoft Teams store, as well as apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. > [!NOTE]-> The `id` of a **teamsApp** resource is generated by the server and is not the same as the `id` specified in a Teams app manifest. The `id` provided by the developer as part of the Teams app manifest is stamped as the `externalId` in the **teamsApp** resource. +> In general, the `id` of a **teamsApp** resource is generated by the server. It is not the same as the `id` specified in a Teams app manifest, unless its `distributionMethod` is *store*. For other cases, the `id` provided by the developer as part of the Teams app manifest is stamped as the `externalId` in the teamsApp resource. ## Permissions |
v1.0 | Application Post Calls | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-post-calls.md | One of the following permissions is required to call this API. To learn more, in | Permission type | Permissions (from least to most privileged) | |:|:-|-| Delegated (work or school account) | Not Supported | -| Delegated (personal Microsoft account) | Not Supported | -| Application | Calls.JoinGroupCallsasGuest.All, Calls.JoinGroupCalls.All, Calls.Initiate.All, Calls.InitiateGroupCalls.All | +| Delegated (work or school account) | Not supported. | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Calls.JoinGroupCalls.Chat*, Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.Initiate.All, Calls.InitiateGroupCall.All | > **Note:** For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the table above.+> +> Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request <!-- { "blockType": "ignored" } --> If successful, this method returns a `201 Created` response code and a [call](.. > **Note:** This call needs the Calls.Initiate.All permission. #### 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. +The following example shows a request that 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. # [HTTP](#tab/http) Content-Type: application/json <!-- { "blockType": "response", "truncated": true,+ "name": "create-call-service-hosted-media-1", "@odata.type": "microsoft.graph.call"-} --> +}--> ```http HTTP/1.1 201 Created Location: https://graph.microsoft.com/v1.0/communications/calls/2e1a0b00-2db4-4022-9570-243709c565ab Content-Type: application/json > **Note**: This example needs Calls.Initiate.All and Calls.AccessMedia.All permissions. #### 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. +The following example shows a request that 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. # [HTTP](#tab/http) Content-Type: application/json <!-- { "blockType": "response", "truncated": true,+ "name": "create-call-app-hosted-media", "@odata.type": "microsoft.graph.call" } --> ```http This supports up to 5 VoIP users. The example shows how to create a group call w #### Request ++# [HTTP](#tab/http) <!-- {- "blockType": "example", + "blockType": "request", "name": "create-group-call-service-hosted-media", "@odata.type": "microsoft.graph.call" }--> Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++#### Response ++> **Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "name": "create-group-call-service-hosted-media", + "@odata.type": "microsoft.graph.call" +}--> ++```http +HTTP/1.1 201 Created +Location: https://graph.microsoft.com/v1.0/communications/calls/2f1a1100-b174-40a0-aba7-0b405e01ed92 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.call", + "state": "establishing", + "direction": "outgoing", + "subject": "Create a group call with service hosted media", + "callbackUri": "https://bot.contoso.com/callback", + "callChainId": "d17646-3110-40b1-bae6-e9ac6c3f74", + "callRoutes": [], + "source": { + "@odata.type": "#microsoft.graph.participantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "application": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "TestBot", + "id": "dd3885da-f9ab-486b-bfae-85de3d445555" + } + }, + "region": null, + "languageId": null + }, + "targets": [ + { + "@odata.type": "#microsoft.graph.invitationParticipantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "user": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "user1", + "id": "98da8a1a-1b87-452c-a713-65d3f10b5555" + } + } + }, + { + "@odata.type": "#microsoft.graph.invitationParticipantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "user": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "user2", + "id": "bf5aae9a-d11d-47a8-93b1-782504c95555" + } + } + } + ], + "requestedModalities": [ + "audio" + ], + "activeModalities": [], + "mediaConfig": { + "@odata.type": "#microsoft.graph.serviceHostedMediaConfig", + }, + "routingPolicies": [], + "tenantId": "aa67bd4c-8475-432d-bd41-39f255720e0a", + "id": "2f1a1100-b174-40a0-aba7-0b405e01ed92", + "myParticipantId": "c9a65b85-a223-44ae-8cdb-29395458323f", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#app/calls/$entity", +} +``` + ### Example 4: Create a group call with application hosted media This supports up to 5 VoIP users. The example shows how to create a group call with two VoIP users. This supports up to 5 VoIP users. The example shows how to create a group call w #### Request ++# [HTTP](#tab/http) <!-- {- "blockType": "example", + "blockType": "request", "name": "create-group-call-app-hosted-media", "@odata.type": "microsoft.graph.call" }--> Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++#### Response ++> **Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "name": "create-group-call-app-hosted-media", + "@odata.type": "microsoft.graph.call" +}--> ++```http +HTTP/1.1 201 Created +Location: https://graph.microsoft.com/v1.0/communications/calls/2f1a1100-b174-40a0-aba7-0b405e01ed92 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.call", + "state": "establishing", + "direction": "outgoing", + "subject": "Create a group call with app hosted media", + "callbackUri": "https://bot.contoso.com/callback", + "callChainId": "d8217646-3110-40b1-bae6-e9ac6c3a9f74", + "callRoutes": [], + "source": { + "@odata.type": "#microsoft.graph.participantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "application": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "TestBot", + "id": "dd3885da-f9ab-486b-bfae-85de3d445555" + } + }, + "region": null, + "languageId": null + }, + "targets": [ + { + "@odata.type": "#microsoft.graph.invitationParticipantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "user": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "user1", + "id": "98da8a1a-1b87-452c-a713-65d3f10b5555" + } + } + }, + { + "@odata.type": "#microsoft.graph.invitationParticipantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "user": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "user2", + "id": "bf5aae9a-d11d-47a8-93b1-782504c95555" + } + } + } + ], + "requestedModalities": [ + "audio" + ], + "activeModalities": [], + "mediaConfig": { + "@odata.type": "#microsoft.graph.appHostedMediaConfig", + "blob": "<Media Session Configuration>", + "removeFromDefaultAudioGroup": false + }, + "routingPolicies": [], + "tenantId": "aa67bd4c-8475-432d-bd41-39f255720e0a", + "id": "2f1a1100-b174-40a0-aba7-0b405e01ed92", + "myParticipantId": "c9a65b85-a223-44ae-8cdb-29395458323f", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#app/calls/$entity", +} +``` + ### Example 5: Join scheduled meeting with service hosted media-To join the scheduled meeting we will need to get the thread id, message id, organizer id and the tenant id in which the meeting is scheduled. -This information can be obtained from the [Get Online Meetings API](../api/onlinemeeting-get.md) (VTC-based meetings only). +To join the scheduled meeting, you need to get the thread ID, message ID, organizer ID, and the tenant ID in which the meeting is scheduled. +You can get this information by using the [Get onlineMeeting](../api/onlinemeeting-get.md) API. ++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 the [Get onlineMeeting](../api/onlinemeeting-get.md) API with actual values to make the example work. -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 ++# [HTTP](#tab/http) <!-- {- "blockType": "example", + "blockType": "request", "name": "join-scheduled-meeting-service-hosted-media", "@odata.type": "microsoft.graph.call" }--> Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ #### Response <!-- { Content-Type: application/json >**Note:** For join meeting scenarios apart from call state notifications, we receive roster notifications. ### Example 6: Join scheduled meeting with application hosted media-Update the media config with the [AppHostedMediaConfig](../resources/apphostedmediaconfig.md) as shown below. +Update the media config with the [appHostedMediaConfig](../resources/apphostedmediaconfig.md) as shown in the following example. +#### Request ++# [HTTP](#tab/http) <!-- {- "blockType": "example", + "blockType": "request", "name": "join-scheduled-meeting-app-hosted-media", "@odata.type": "microsoft.graph.call" }--> Content-Type: application/json } ``` -### Example 7: Create peer-to-peer PSTN call with service hosted media +# [C#](#tab/csharp) -> **Note:** This call requires the Calls.Initiate.All permission. +# [JavaScript](#tab/javascript) -This call requires an application instance with a PSTN number assigned. For details, see [Assign a phone number to your bot](/graph/cloud-communications-phone-number#assign-a-phone-number-to-your-bot). +# [Java](#tab/java) -#### Request -The following example shows the request to make a peer-to-peer call between the bot and a PSTN number. In this example, the media is hosted by the service. The values of authorization token, callback URL, application instance ID, application instance display name, phone ID and tenant ID must be replaced with actual values to make the example work. -> **Note:** Application instance ID is the object ID of application instance. The application ID that application instance links to should match the one in authorization token. Phone ID is the phone number in E.164 format. +# [Go](#tab/go) +# [PowerShell](#tab/powershell) -# [HTTP](#tab/http) -<!-- { +# [PHP](#tab/php) +++++#### Response ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.call", + "truncated": "true" +}--> ++```http +HTTP/1.1 201 Created +Location: https://graph.microsoft.com/v1.0/communications/calls/2f1a1100-b174-40a0-aba7-0b405e01ed92 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.call", + "state": "establishing", + "direction": "outgoing", + "callbackUri": "https://bot.contoso.com/callback", + "callChainId": "d8217646-3110-40b1-bae6-e9ac6c3a9f74", + "callRoutes": [], + "source": { + "@odata.type": "#microsoft.graph.participantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "application": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "Calling Bot", + "id": "2891555a-92ff-42e6-80fa-6e1300c6b5c6" + } + }, + "region": null, + "languageId": null + }, + "targets": [], + "requestedModalities": [ + "audio" + ], + "activeModalities": [], + "mediaConfig": { + "@odata.type": "#microsoft.graph.appHostedMediaConfig", + "blob": "<Media Session Configuration>", + }, + "chatInfo": { + "@odata.type": "#microsoft.graph.chatInfo", + "threadId": "19:meeting_Win6Ydo4wsMijFjZS00ZGVjLTk5MGUtOTRjNWY2NmNkYTFm@thread.v2", + "messageId": "0", + "replyChainMessageId": null + }, + "meetingInfo": { + "@odata.type": "#microsoft.graph.organizerMeetingInfo", + "organizer": { + "@odata.type": "#microsoft.graph.identitySet", + "user": { + "@odata.type": "#microsoft.graph.identity", + "id": "5810cede-f3cc-42eb-b2c1-e9bd5d53ec96", + "tenantId": "aa67bd4c-8475-432d-bd41-39f255720e0a", + "displayName": "Bob" + } + }, + "allowConversationWithoutHost": true + }, + "transcription": null, + "routingPolicies": [], + "tenantId": "aa67bd4c-8475-432d-bd41-39f255720e0a", + "myParticipantId": "05491616-385f-44a8-9974-18cc5f9933c1", + "id": "2f1a1100-b174-40a0-aba7-0b405e01ed92", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#app/calls/$entity", + "terminationReason": null, + "ringingTimeoutInSeconds": null, + "mediaState": null, + "subject": null, + "resultInfo": null, + "answeredBy": null, + "meetingCapability": null, + "toneInfo": null +} +``` +++### Example 7: Join a scheduled meeting with joinMeetingId and passcode ++The following shows an example that requires a **joinMeetingId** and a **passcode** to join an existing meeting. You can retrieve these properties from the [Get onlineMeeting](../api/onlinemeeting-get.md) API. ++#### Request ++The following is an example of a request. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "join-meeting-with-join-meeting-id-and-passcode", + "@odata.type": "microsoft.graph.call" +}--> ++```http +POST https://graph.microsoft.com/v1.0/communications/calls +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.call", + "callbackUri": "https://bot.contoso.com/callback", + "requestedModalities": [ + "audio" + ], + "mediaConfig": { + "@odata.type": "#microsoft.graph.serviceHostedMediaConfig", + "preFetchMedia": [ + { + "uri": "https://cdn.contoso.com/beep.wav", + "resourceId": "f8971b04-b53e-418c-9222-c82ce681a582" + }, + { + "uri": "https://cdn.contoso.com/cool.wav", + "resourceId": "86dc814b-c172-4428-9112-60f8ecae1edb" + } + ] + }, + "meetingInfo": { + "@odata.type": "#microsoft.graph.joinMeetingIdMeetingInfo", + "joinMeetingId": "1234567", + "passcode": "psw123" + }, + "tenantId": "86dc81db-c112-4228-9222-63f3esaa1edb" +} +``` ++# [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", + "name": "join-meeting-with-join-meeting-id-and-passcode", + "@odata.type": "microsoft.graph.call" +}--> ++```http +HTTP/1.1 201 Created +Location: https://graph.microsoft.com/v1.0/communications/calls/2f1a1100-b174-40a0-aba7-0b405e01ed92 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.call", + "state": "establishing", + "direction": "outgoing", + "callbackUri": "https://bot.contoso.com/callback", + "callChainId": "d8217646-3110-40b1-bae6-e9ac6c3a9f74", + "callRoutes": [], + "source": { + "@odata.type": "#microsoft.graph.participantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "application": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "Calling Bot", + "id": "2891555a-92ff-42e6-80fa-6e1300c6b5c6" + } + }, + "region": null, + "languageId": null + }, + "targets": [], + "requestedModalities": [ + "audio" + ], + "activeModalities": [], + "mediaConfig": { + "@odata.type": "#microsoft.graph.serviceHostedMediaConfig", + "preFetchMedia": [ + { + "uri": "https://cdn.contoso.com/beep.wav", + "resourceId": "f8971b04-b53e-418c-9222-c82ce681a582" + }, + { + "uri": "https://cdn.contoso.com/cool.wav", + "resourceId": "86dc814b-c172-4428-9112-60f8ecae1edb" + } + ], + }, + "chatInfo": { + "@odata.type": "#microsoft.graph.chatInfo", + "threadId": "19:meeting_Win6Ydo4wsMijFjZS00ZGVjLTk5MGUtOTRjNNkYTFm@thread.v2", + "messageId": "0", + "replyChainMessageId": null + }, + "meetingInfo": { + "@odata.type": "#microsoft.graph.joinMeetingIdMeetingInfo", + "joinMeetingId": "1234567", + "passcode": "psw123" + }, + "transcription": null, + "routingPolicies": [], + "tenantId": "86dc81db-c112-4228-9222-63f3esaa1edb", + "myParticipantId": "05491616-385f-44a8-9974-18cc5f9933c1", + "id": "2f1a1100-b174-40a0-aba7-0b405e01ed92", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#app/calls/$entity", + "terminationReason": null, + "ringingTimeoutInSeconds": null, + "mediaState": null, + "subject": null, + "resultInfo": null, + "answeredBy": null, + "meetingCapability": null, + "toneInfo": null +} +``` ++### Example 8: Join a scheduled meeting with joinMeetingId ++The following shows an example that requires a **joinMeetingId** but doesn't require a **passcode** to join an existing meeting. You can retrieve the **joinMeetingId** property from the [Get onlineMeeting](../api/onlinemeeting-get.md) API. ++#### Request ++The following is an example of a request. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "join-meeting-with-join-meeting-id-and-without-passcode", + "@odata.type": "microsoft.graph.call" +}--> ++```http +POST https://graph.microsoft.com/v1.0/communications/calls +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.call", + "callbackUri": "https://bot.contoso.com/callback", + "requestedModalities": [ + "audio" + ], + "mediaConfig": { + "@odata.type": "#microsoft.graph.serviceHostedMediaConfig", + "preFetchMedia": [ + { + "uri": "https://cdn.contoso.com/beep.wav", + "resourceId": "f8971b04-b53e-418c-9222-c82ce681a582" + }, + { + "uri": "https://cdn.contoso.com/cool.wav", + "resourceId": "86dc814b-c172-4428-9112-60f8ecae1edb" + } + ] + }, + "meetingInfo": { + "@odata.type": "#microsoft.graph.joinMeetingIdMeetingInfo", + "joinMeetingId": "1234567", + "passcode": null + }, + "tenantId": "86dc81db-c112-4228-9222-63f3esaa1edb" +} +``` ++# [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", + "name": "join-meeting-with-join-meeting-id-and-without-passcode", + "@odata.type": "microsoft.graph.call" +}--> ++```http +HTTP/1.1 201 Created +Location: https://graph.microsoft.com/v1.0/communications/calls/2f1a1100-b174-40a0-aba7-0b405e01ed92 +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.call", + "state": "establishing", + "direction": "outgoing", + "callbackUri": "https://bot.contoso.com/callback", + "callChainId": "d8217646-3110-40b1-bae6-e9ac6c3a9f74", + "callRoutes": [], + "source": { + "@odata.type": "#microsoft.graph.participantInfo", + "identity": { + "@odata.type": "#microsoft.graph.identitySet", + "application": { + "@odata.type": "#microsoft.graph.identity", + "displayName": "Calling Bot", + "id": "2891555a-92ff-42e6-80fa-6e1300c6b5c6" + } + }, + "region": null, + "languageId": null + }, + "targets": [], + "requestedModalities": [ + "audio" + ], + "activeModalities": [], + "mediaConfig": { + "@odata.type": "#microsoft.graph.serviceHostedMediaConfig", + "preFetchMedia": [ + { + "uri": "https://cdn.contoso.com/beep.wav", + "resourceId": "f8971b04-b53e-418c-9222-c82ce681a582" + }, + { + "uri": "https://cdn.contoso.com/cool.wav", + "resourceId": "86dc814b-c172-4428-9112-60f8ecae1edb" + } + ], + }, + "chatInfo": { + "@odata.type": "#microsoft.graph.chatInfo", + "threadId": "19:meeting_Win6Ydo4wsMijFjZS00ZGVjLTk5MGUtOTRjNNkYTFm@thread.v2", + "messageId": "0", + "replyChainMessageId": null + }, + "meetingInfo": { + "@odata.type": "#microsoft.graph.joinMeetingIdMeetingInfo", + "joinMeetingId": "1234567", + "passcode": null + }, + "transcription": null, + "routingPolicies": [], + "tenantId": "86dc81db-c112-4228-9222-63f3esaa1edb", + "myParticipantId": "05491616-385f-44a8-9974-18cc5f9933c1", + "id": "2f1a1100-b174-40a0-aba7-0b405e01ed92", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#app/calls/$entity", + "terminationReason": null, + "ringingTimeoutInSeconds": null, + "mediaState": null, + "subject": null, + "resultInfo": null, + "answeredBy": null, + "meetingCapability": null, + "toneInfo": null +} +``` ++### Example 9: Create peer-to-peer PSTN call with service hosted media ++> **Note:** This call requires the Calls.Initiate.All permission. ++This call requires an application instance with a PSTN number assigned. For details, see [Assign a phone number to your bot](/graph/cloud-communications-phone-number#assign-a-phone-number-to-your-bot). ++#### Request +The following example shows the request to make a peer-to-peer call between the bot and a PSTN number. In this example, the media is hosted by the service. The values of authorization token, callback URL, application instance ID, application instance display name, phone ID and tenant ID must be replaced with actual values to make the example work. +> **Note:** Application instance ID is the object ID of application instance. The application ID that application instance links to should match the one in authorization token. Phone ID is the phone number in E.164 format. +++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "create-call-service-hosted-media-2", "@odata.type": "microsoft.graph.call" Content-Type: application/json <!-- { "blockType": "response", "truncated": true,+ "name": "create-call-service-hosted-media-2", "@odata.type": "microsoft.graph.call"-} --> +}--> ```http HTTP/1.1 201 Created Location: https://graph.microsoft.com/v1.0/communications/calls/2e1a0b00-2db4-4022-9570-243709c565ab Content-Type: application/json } ``` -### Example 8: Create peer-to-peer PSTN call with application hosted media +### Example 10: Create peer-to-peer PSTN call with application hosted media > **Note**: This example requires Calls.Initiate.All and Calls.AccessMedia.All permissions. Content-Type: application/json #### Response -> **Note:** The response object shown here might be shortened for readability. +> **Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true,+ "name": "create-call-service-hosted-media-3", "@odata.type": "microsoft.graph.call"-} --> +}--> ```http HTTP/1.1 201 Created Location: https://graph.microsoft.com/v1.0/communications/calls/2e1a0b00-2db4-4022-9570-243709c565ab |
v1.0 | Application Post Onlinemeetings | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-post-onlinemeetings.md | POST /users/{userId}/onlineMeetings ``` > [!NOTE]-> `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). See more details in [application access policy](/graph/cloud-communication-online-meeting-application-access-policy). +>- `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy). ## Request headers | Name | Description | The following example creates an online meeting with a user token. #### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json #### Response +The following is an example of the response. + > **Note:** The response object shown here might be shortened for readability. <!-- { Content-Type: application/json { "@odata.type": "#microsoft.graph.onlineMeeting",- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('f4053f86-17cc-42e7-85f4-f0389ac980d6')/onlineMeetings/$entity", + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('f4053e7-85f4-f0389ac980d6')/onlineMeetings/$entity", "audioConferencing": {- "tollNumber": "+12525634478", - "tollFreeNumber": "+18666390588", - "ConferenceId": "2425999", - "dialinUrl": "https://dialin.teams.microsoft.com/22f12fa0-499f-435b-bc69-b8de580ba330?id=2425999" + "tollNumber": "+1252578", + "tollFreeNumber": "+18588", + "ConferenceId": "24999", + "dialinUrl": "https://dialin.teams.microsoft.com/22f12faf--bc69-b8de580ba330?id=24299" }, "chatInfo": {- "threadId": "19:meeting_M2IzYzczNTItYmY3OC00MDlmLWJjMzUtYmFiMjNlOTY4MGEz@thread.skype", + "threadId": "19:meeting_M2IzYzczNTItYzUtYmFiMjNlOTY4MGEz@thread.skype", "messageId": "0", "replyChainMessageId": "0" }, "creationDateTime": "2019-07-11T02:17:17.6491364Z", "startDateTime": "2019-07-11T02:17:17.6491364Z", "endDateTime": "2019-07-11T02:47:17.651138Z",- "id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy", - "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2IzYzczNTItYmY3OC00MDlmLWJjMzUtYmFiMjNlOTY4MGEz%40thread.skype/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%22550fae72-d251-43ec-868c-373732c2704f%22%7d", + "id": "MSpkYzE3NjctYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy", + "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2IzYzczNTItYmY3OC00MDlmLWJjMzUtYmFiMjNlOTY4MGEz%40thread.skype/0?context=%7b%22Tid%22%3a%2272f988bf-87cd011db47%22%2c%22Oid%22%3a%22550fae72-d251-43ec-868c-373732c2704f%22%7d", "participants": { "organizer": { "identity": { "user": {- "id": "550fae72-d251-43ec-868c-373732c2704f", + "id": "550fae72-d25-868c-373732c2704f", "displayName": "Heidi Steen" } }, "upn": "upn-value" } },- "subject": "User Token Meeting" + "subject": "User Token Meeting", + "joinMeetingIdSettings": { + "isPasscodeRequired": false, + "joinMeetingId": "1234567890", + "passcode": null + } } ``` > [!NOTE] Content-Type: application/json }--> #### Request +The following is an example of a request. + ```http POST https://graph.microsoft.com/v1.0/me/onlineMeetings Content-Type: application/json Content-Type: application/json #### Response +The following is an example of the response. + > **Note:** The response object shown here has been shortened for readability. <!-- { Content-Type: application/json "role": "producer", "identity": { "user": {- "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622", + "id": "dc17674c-81d9-4ada442e4622", "displayName": null,- "tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38", + "tenantId": "909c6581-5130cb3582cde38", "identityProvider": "AAD" } } Content-Type: application/json "role": "producer", "identity": { "user": {- "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622", + "id": "dc17674c-81d9--8f6a442e4622", "displayName": null,- "tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38", + "tenantId": "909c6581-51f3-fcb3582cde38", "identityProvider": "AAD" } } Content-Type: application/json "role": "producer", "identity": { "user": {- "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622", + "id": "dc17674c-81d9-4adf6a442e4622", "displayName": null,- "tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38", + "tenantId": "909c6581-5f3-fcb3582cde38", "identityProvider": "AAD" } } Content-Type: application/json "scope": "organization", "isDialInBypassEnabled": false },+ "joinMeetingIdSettings": { + "isPasscodeRequired": false, + "joinMeetingId": "1234567890", + "passcode": null + }, "isBroadcast": true, "broadcastSettings": { "allowedAudience": "organization", Content-Type: application/json } ``` +### 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 ++The following is an example of a request. ++>**Note:** The passcode is automatically generated and a custom passcode is not supported. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create-online-meeting-with-passcode" +}--> ++```http +POST https://graph.microsoft.com/v1.0/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", + "joinMeetingIdSettings": { + "isPasscodeRequired": true + } +} +``` ++# [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.onlineMeeting" +} --> ++```http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('f4086-17cc-42e7-85f4-f03880d6')/onlineMeetings/$entity", + "audioConferencing": { + "tollNumber": "+12525478", + "tollFreeNumber": "+18690588", + "ConferenceId": "2999", + "dialinUrl": "https://dialin.teams.microsoft.com/22fa0-499f-435b-bc69-b8dea330?id=2999" + }, + "chatInfo": { + "threadId": "19%3A3b523985568b776357c1dd79%40thread.skype", + "messageId": "15629053", + "replyChainMessageId": null + }, + "creationDateTime": "2019-07-11T02:17:17.6491364Z", + "startDateTime": "2019-07-11T02:17:17.6491364Z", + "endDateTime": "2019-07-11T02:47:17.651138Z", + "id": "MSpkYzE3Njc0Yy04MWQ5LTRhFpHRTNaR1F6WGhyZWFkLnYy", + "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2IzYzczNTItYmY3iMjNlOTY4MGEz%40thread.skype/0?context=%7b%22Tid%22%3a%22f8bf-86f1-41af-91ab-2011db47%22%2c%22Oid%22%3a%20fae72-d251-43ec-86c-377304f%22%7d", + "participants": { + "organizer": { + "identity": { + "user": { + "id": "5e72-d251-43ec-868c-3732704f", + "tenantId": "72fbf-86f1-41af-91ab-2d71db47", + "displayName": "Mario Rogers" + } + }, + "role": "presenter", + "upn": "upn-value" + } + }, + "subject": "User meeting", + "joinMeetingIdSettings": { + "isPasscodeRequired": true, + "joinMeetingId": "1234567890", + "passcode": "123abc" + } +} +``` ++### 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 ++The following is an example of a request. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create-online-meeting-without-passcode" +}--> ++```http +POST https://graph.microsoft.com/v1.0/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.", + "joinMeetingIdSettings": { + "isPasscodeRequired": false + } +} +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++OR ++```http +POST https://graph.microsoft.com/v1.0/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." +} +``` ++#### 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.onlineMeeting" +} --> ++```http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('f4053f86-17cc-85f4-f0389ac980d6')/onlineMeetings/$entity", + "audioConferencing": { + "tollNumber": "+12525478", + "tollFreeNumber": "+186390588", + "ConferenceId": "24999", + "dialinUrl": "https://dialin.teams.microsoft.com/22f12fa0-45b-bc69-b8de580ba330?id=2425999" + }, + "chatInfo": { + "threadId": "19%3A3b52398f3c524556894b776357c1dd79%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": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy", + "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2IzYzczNTItYmY3OC00MDlmLWJjMzUtYmFiMjNlOTY4MGEz%40thread.skype/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-1ab-2d7cd011db47%22%2c%22Oid%22%3a%22550fae72-d251-c-373732c2704f%22%7d", + "participants": { + "organizer": { + "identity": { + "user": { + "id": "550fae72-d251-43ecc-373732c2704f", + "tenantId": "72f98841af-91ab-2d7cd011db47", + "displayName": "Tyler Stein" + } + }, + "role": "presenter", + "upn": "upn-value" + } + }, + "subject": "User meeting in Microsoft Teams channel.", + "joinMeetingIdSettings": { + "isPasscodeRequired": false, + "joinMeetingId": "1234567890", + "passcode": null + } +} +``` + <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- |
v1.0 | Attachment Createuploadsession | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/attachment-createuploadsession.md | Content-type: application/json [!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 | Calendargroup Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/calendargroup-update.md | Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/go/update-calendargroup-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-calendargroup-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Certificatebasedauthconfiguration Post Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | Organization.ReadWrite.All | +For delegated scenarios, the calling user must have the *Global Administrator* [Azure AD role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Channel Get Filesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-get-filesfolder.md | Namespace: microsoft.graph Get the metadata for the location where the files of a [channel](../resources/channel.md) are stored. +> [!NOTE] +> Some special characters in the channel name will cause this API to return an error. For details, see [Known issues](/graph/known-issues#create-channel). + ## 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 | Channel Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-get.md | GET /teams/{team-id}/channels/{channel-id} ## Optional query parameters -This method supports the `$filter`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter`and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers |
v1.0 | Channel List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-list.md | Namespace: microsoft.graph Retrieve the list of [channels](../resources/channel.md) in this [team](../resources/team.md). -This method supports federation. Any shared channel that the request initiator belongs to will be included in the response. +>**Note:** Guest users can't see private or shared channels that they aren't members of in the response for this API. ## Permissions GET /teams/{team-id}/channels ## Optional query parameters -This method supports the $filter, $select, and $expand [OData query parameters](/graph/query-parameters) to help customize the response. +This method supports the $filter and $select [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers |
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 |:|:--| | Delegated (work or school account) | ChannelMessage.Send, Group.ReadWrite.All** | | Delegated (personal Microsoft account) | Not supported. |-| Application | Teamwork.Migrate.All, ChannelMessage.ReadWrite.All | +| Application | Teamwork.Migrate.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 | Channel Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-post.md | doc_type: apiPageType Namespace: microsoft.graph -Create a new [channel](../resources/channel.md) in a team, as specified in the request body. -> **Note:** You can add a maximum of 200 members when you create a private channel. +Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams. ++If you're creating a private channel, you can add a maximum of 200 members. ++> [!NOTE] +> Some special characters in the channel name will cause the [Get filesFolder](/graph/api/channel-get-filesfolder) API to return an error. For details, see [Known issues](/graph/known-issues#create-channel). ## Permissions |
v1.0 | Conditionalaccessroot List Namedlocations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/conditionalaccessroot-list-namedlocations.md | GET https://graph.microsoft.com/v1.0/identity/conditionalAccess/namedLocations?$ [!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 | Device Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/device-get.md | GET https://graph.microsoft.com/beta/devices/6a59ea83-02bd-468f-a40b-f2c3d182198 [!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 | Directoryroletemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/directoryroletemplate-get.md | GET https://graph.microsoft.com/v1.0/directoryRoleTemplates/62e90394-69f5-4237-9 [!INCLUDE [sample-code](../includes/snippets/go/get-directoryroletemplate-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-directoryroletemplate-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Domain Post Federationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/domain-post-federationconfiguration.md | Title: "Create federationConfiguration" description: "Create a new internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Domain Promote | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/domain-promote.md | If successful, this call returns a `200 OK` response and a Boolean value that sp ### Request ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "domain_promote" If successful, this call returns a `200 OK` response and a Boolean value that sp POST https://graph.microsoft.com/v1.0/domains/contoso.com/promote ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ ### Response <!-- { Content-type: application/json "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Edm.Boolean", "value": true }-``` +``` |
v1.0 | Educationassignment Delete Rubric | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-delete-rubric.md | doc_type: "apiPageType" Namespace: microsoft.graph Remove an [educationRubric](../resources/educationrubric.md) from an [educationAssignment](../resources/educationassignment.md).-This method does not delete the rubric itself. ++This method does not delete the rubric itself and can only be performed by teachers. ## Permissions |
v1.0 | Educationassignment Get Rubric | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-get-rubric.md | doc_type: "apiPageType" Namespace: microsoft.graph -Get the [educationRubric](../resources/educationrubric.md) object attached to an [educationAssignment](../resources/educationassignment.md), if one exists. +Get the [educationRubric](../resources/educationrubric.md) object attached to an [educationAssignment](../resources/educationassignment.md), if one exists. Only teachers, students, and applications with application permissions can perform this operation. ## Permissions |
v1.0 | Educationassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-get.md | doc_type: apiPageType Namespace: microsoft.graph -Get the properties and relationships of an [assignment](../resources/educationassignment.md). +Get the properties and relationships of an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. Students can only see assignments assigned to them; teachers and applications with application permissions can see all assignments in a class. |
v1.0 | Educationassignment List Categories | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-list-categories.md | doc_type: apiPageType Namespace: microsoft.graph -List all the categories associated with an [assignment](../resources/educationassignment.md). +List all the categories associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. ## 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 | Educationassignment List Resources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-list-resources.md | doc_type: apiPageType Namespace: microsoft.graph -Get all the [educationAssignmentResource](../resources/educationassignmentresource.md) objects associated with an [assignment](../resources/educationassignment.md). +Get all the [educationAssignmentResource](../resources/educationassignmentresource.md) objects associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. ## 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 | Educationassignment List Submissions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-list-submissions.md | doc_type: apiPageType Namespace: microsoft.graph -List all the submissions associated with an [assignment](../resources/educationassignment.md). +List all the submissions associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. A teacher or an application with application permissions can get all the submissions while a student can only get submissions that they are associated with. |
v1.0 | Educationassignment Post Categories | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-post-categories.md | doc_type: "apiPageType" Namespace: microsoft.graph -Add one or more existing [educationCategory](../resources/educationcategory.md) objects to the specified [educationAssignment](../resources/educationassignment.md). +Add one or more existing [educationCategory](../resources/educationcategory.md) objects to the specified [educationAssignment](../resources/educationassignment.md). Only teachers can perform this operation. ## 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 | Educationassignment Post Resource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-post-resource.md | doc_type: apiPageType Namespace: microsoft.graph -Create an [assignment resource](../resources/educationassignmentresource.md). You can create the following types of assignment resources: +Create an [assignment resource](../resources/educationassignmentresource.md). Only teachers can perform this operation. ++You can create the following types of assignment resources: - [educationFileResource](../resources/educationfileresource.md) - [educationExcelResource](../resources/educationexcelresource.md) Create an [assignment resource](../resources/educationassignmentresource.md). Yo - [educationLinkResource](../resources/educationlinkresource.md) - [educationPowerPointResource](../resources/educationpowerpointresource.md) - [educationMediaResource](../resources/educationmediaresource.md)+- [educationTeamsAppResource](../resources/educationteamsappresource.md) -Every resource has an @odata.type property to indicate which type of resource is being created. +Every resource has an **@odata.type** property to indicate which type of resource is being created. > [!IMPORTANT] > Before you can upload an assignment resource, you must [set up the resources folder](../api/educationassignment-setupresourcesfolder.md) for the [educationAssignment](../resources/educationassignment.md) to upload the files to. In the request body, supply a JSON representation of one of the following resour - [educationLinkResource](../resources/educationlinkresource.md) - [educationPowerPointResource](../resources/educationpowerpointresource.md) - [educationMediaResource](../resources/educationmediaresource.md)+- [educationTeamsAppResource](../resources/educationteamsappresource.md) >**Note:** You can't use this operation to create an [educationExternalResource](../resources/educationexternalresource.md). Content-type: application/json } ``` +### Example 7: Create an educationTeamsAppResource ++#### Request +The following is an example of the request. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["2003c52e-807a-4186-9b49-60c573095461", "820371a1-4589-4a4a-8b40-9d5db94b9186"], + "name": "create_educationTeamsAppResource_from_educationassignmentsApp" +}--> +```http +POST https://graph.microsoft.com/v1.0/education/classes/2003c52e-807a-4186-9b49-60c573095461/assignments/820371a1-4589-4a4a-8b40-9d5db94b9186/resources +Content-type: application/json ++{ + "distributeForStudentWork": false, + "resource": { + "displayName": "Template - My Story", + "appId": "6fbeb90c-3d55-4bd5-82c4-bfe824be4300", + "appIconWebUrl": "https://statics.teams.cdn.office.net/evergreen-assets/ThirdPartyApps/6fbeb90c-3d55-4bd5-82c4-bfe824be4300_largeImage.png?v=2.0.2", + "teamsEmbeddedContentUrl": "https://app.api.edu.buncee.com/player/C7B0866C9B7E485EAE21AE14DBC3FD08?embed=1&render_slide_panel=1", + "webUrl": "https://app.edu.buncee.com/buncee/C7B0866C9B7E485EAE21AE14DBC3FD08", + "@odata.type": "#microsoft.graph.educationTeamsAppResource" + } +} +``` ++# [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.educationTeamsAppResource" +} --> +```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#education/classes('2003c52e-807a-4186-9b49-60c573095461')/assignments('820371a1-4589-4a4a-8b40-9d5db94b9186')/resources/$entity", + "distributeForStudentWork": false, + "id": "6821bff5-91e4-4b63-8f98-8157305ff004", + "resource": { + "@odata.type": "#microsoft.graph.educationTeamsAppResource", + "displayName": "Template - My Story", + "createdDateTime": "2022-12-01T16:35:58.0718192Z", + "lastModifiedDateTime": "2022-12-01T16:35:58.0718396Z", + "appId": "6fbeb90c-3d55-4bd5-82c4-bfe824be4300", + "appIconWebUrl": "https://statics.teams.cdn.office.net/evergreen-assets/ThirdPartyApps/6fbeb90c-3d55-4bd5-82c4-bfe824be4300_largeImage.png?v=2.0.2", + "teamsEmbeddedContentUrl": "https://app.api.edu.buncee.com/player/C7B0866C9B7E485EAE21AE14DBC3FD08?embed=1&render_slide_panel=1", + "webUrl": "https://app.edu.buncee.com/buncee/C7B0866C9B7E485EAE21AE14DBC3FD08", + "createdBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + } + } +} +``` ## See also |
v1.0 | Educationassignment Put Rubric | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-put-rubric.md | doc_type: "apiPageType" Namespace: microsoft.graph -Attach an existing [educationRubric](../resources/educationrubric.md) object to an [educationAssignment](../resources/educationassignment.md). +Attach an existing [educationRubric](../resources/educationrubric.md) object to an [educationAssignment](../resources/educationassignment.md). Only teachers can perform this operation. ## Permissions |
v1.0 | Educationassignment Remove Category | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-remove-category.md | doc_type: apiPageType Namespace: microsoft.graph -Remove an [educationCategory](../resources/educationcategory.md) from an [educationAssignment](../resources/educationassignment.md). +Remove an [educationCategory](../resources/educationcategory.md) from an [educationAssignment](../resources/educationassignment.md). Only teachers can perform this operation. ## 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 | Educationassignment Setupfeedbackresourcesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-setupfeedbackresourcesfolder.md | doc_type: apiPageType Namespace: microsoft.graph -Create a SharePoint folder to upload feedback files for a given [educationSubmission](../resources/educationsubmission.md). +Create a SharePoint folder to upload feedback files for a given [educationSubmission](../resources/educationsubmission.md). Only teachers can perform this operation. The teacher determines the resources to upload in the feedback resources folder of a submission. |
v1.0 | Educationassignment Setupresourcesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignment-setupresourcesfolder.md | doc_type: apiPageType Namespace: microsoft.graph -Create a SharePoint folder to upload files for a given [educationAssignment](../resources/educationassignment.md). +Create a SharePoint folder to upload files for a given [educationAssignment](../resources/educationassignment.md). Only teachers can perform this operation. The teacher determines the resources to upload in the assignment's folder. |
v1.0 | Educationassignmentdefaults Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignmentdefaults-get.md | Namespace: microsoft.graph Read the properties and relationships of an [educationAssignmentDefaults](../resources/educationassignmentdefaults.md) object. -These are the class-level assignment defaults respected by new [assignments](../resources/educationassignment.md) created in the class. Callers can continue to specify custom values on each **assignment** creation if they don't want the default behaviors. +These are the class-level assignment defaults respected by new [assignments](../resources/educationassignment.md) created in the class. Callers can continue to specify custom values on each **assignment** creation if they don't want the default behaviors. Only teachers can perform this operation. ## 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 | Educationassignmentresource Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignmentresource-get.md | doc_type: apiPageType Namespace: microsoft.graph -Get the properties of an [education assignment resource](../resources/educationassignmentresource.md) associated with an [assignment](../resources/educationassignment.md). +Get the properties of an [education assignment resource](../resources/educationassignmentresource.md) associated with an [assignment](../resources/educationassignment.md). Only teachers, students, and applications with application permissions can perform this operation. ## 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 | Educationassignmentsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationassignmentsettings-get.md | doc_type: apiPageType # Get educationAssignmentSettings Namespace: microsoft.graph -Read the properties and relationships of an [educationAssignmentSettings](../resources/educationassignmentsettings.md) object. +Read the properties and relationships of an [educationAssignmentSettings](../resources/educationassignmentsettings.md) object. Only teachers can perform this operation. ## 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 | Educationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationcategory-delete.md | doc_type: apiPageType Namespace: microsoft.graph -Delete an existing [category](../resources/educationcategory.md). +Delete an existing [category](../resources/educationcategory.md). Only teachers can perform this operation. ## Permissions |
v1.0 | Educationcategory Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationcategory-get.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve an [educationCategory](../resources/educationcategory.md) object. +Retrieve an [educationCategory](../resources/educationcategory.md) object. Only teachers, students, and applications with application permissions can perform this operation. ## Permissions |
v1.0 | Educationclass List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationclass-list-assignments.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve a list of assignment objects. +Retrieve a list of assignment objects. Only teachers, students, and applications with application permissions can perform this operation. A teacher or an application executing with application permissions can see all assignment objects for the class. Students can only see assignments that are assigned to them. |
v1.0 | Educationclass List Categories | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationclass-list-categories.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve a list of [educationCategory](../resources/educationcategory.md) objects. +Retrieve a list of [educationCategory](../resources/educationcategory.md) objects. Only teachers can perform this operation. ## Permissions |
v1.0 | Educationclass Post Assignment | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationclass-post-assignment.md | doc_type: apiPageType Namespace: microsoft.graph -Create a new assignment. +Create a new assignment. Only teachers in a class can create an assignment. Assignments start in the Draft state, which means that students will not see the assignment until publication. |
v1.0 | Educationclass Post Category | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationclass-post-category.md | doc_type: apiPageType Namespace: microsoft.graph -Creates a new [educationCategory](../resources/educationcategory.md) on an [educationClass](../resources/educationclass.md). +Creates a new [educationCategory](../resources/educationcategory.md) on an [educationClass](../resources/educationclass.md). Only teachers can perform this operation. ## 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 | Educationoutcome Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationoutcome-update.md | doc_type: "apiPageType" Namespace: microsoft.graph -Update the properties of an [educationOutcome](../resources/educationoutcome.md) object. +Update the properties of an [educationOutcome](../resources/educationoutcome.md) object. Only teachers can perform this operation. ## Permissions |
v1.0 | Educationrubric Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationrubric-delete.md | doc_type: "apiPageType" Namespace: microsoft.graph -Delete an [educationRubric](../resources/educationrubric.md) object. +Delete an [educationRubric](../resources/educationrubric.md) object. Only teachers can perform this operation. ## Permissions |
v1.0 | Educationrubric Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationrubric-get.md | doc_type: "apiPageType" Namespace: microsoft.graph -Retrieve the properties and relationships of an [educationRubric](../resources/educationrubric.md) object. +Retrieve the properties and relationships of an [educationRubric](../resources/educationrubric.md) object. Only teachers and students can perform this operation. ## Permissions |
v1.0 | Educationrubric Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationrubric-update.md | doc_type: "apiPageType" Namespace: microsoft.graph -Update the properties of an [educationRubric](../resources/educationrubric.md) object. +Update the properties of an [educationRubric](../resources/educationrubric.md) object. Only teachers can perform this operation. Updating a rubric attached to an assignment (`PATCH /education/classes/acdefc6b-2dc6-4e71-b1e9-6d9810ab1793/assignments/cf6005fc-9e13-44a2-a6ac-a53322006454/rubric`) is only possible before the assignment is published, and what is updated is actually the original rubric that exists under `/education/users/{id}/rubrics`. After the assignment is published, an immutable copy of the rubric is made that is attached to that specific assignment. That rubric can be retrieved using [GET /education/classes/acdefc6b-2dc6-4e71-b1e9-6d9810ab1793/assignments/cf6005fc-9e13-44a2-a6ac-a53322006454/rubric](educationrubric-get.md), but it cannot be updated. |
v1.0 | Educationsubmission Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-get.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve a particular [submission](../resources/educationsubmission.md). +Retrieve a particular [submission](../resources/educationsubmission.md). Only teachers, students, and applications with application permissions can perform this operation. A **submission** object represents a student's work for an [assignment](../resources/educationassignment.md). Resources associated with the **submission** represent this work. |
v1.0 | Educationsubmission List Outcomes | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-list-outcomes.md | doc_type: "apiPageType" Namespace: microsoft.graph -Retrieve a list of [educationOutcome](../resources/educationoutcome.md) objects. There are four types of outcomes: **educationPointsOutcome**, **educationFeedbackOutcome**, **educationRubricOutcome**, and **educationFeedbackResourceOutcome**. +Retrieve a list of [educationOutcome](../resources/educationoutcome.md) objects. There are four types of outcomes: **educationPointsOutcome**, **educationFeedbackOutcome**, **educationRubricOutcome**, and **educationFeedbackResourceOutcome**. Only teachers, students, and applications with application permissions can perform this operation. A submission for a credit assignment (one that has no point value and no rubric) will have an [educationFeedbackOutcome](../resources/educationpointsoutcome.md). (It might also return an [educationPointsOutcome](../resources/educationpointsoutcome.md), but that outcome is ignored.) |
v1.0 | Educationsubmission List Resources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-list-resources.md | doc_type: apiPageType Namespace: microsoft.graph -List the resources associated with a [submission](../resources/educationsubmission.md). +List the resources associated with a [submission](../resources/educationsubmission.md). Only teachers, students, and applications with application permissions can perform this operation. The [educationSubmissionResource](../resources/educationsubmissionresource.md) object is a wrapper around the actual resource object the student is working on. The wrapper also includes a pointer to the resources on the assignment if this was copied from the assignment during the assign process. These resources are the working copy of the assignment. The **submittedResources** are the resources that have officially been submitted to be graded. |
v1.0 | Educationsubmission List Submittedresources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-list-submittedresources.md | doc_type: apiPageType Namespace: microsoft.graph -List the [educationSubmissionResource](../resources/educationsubmissionresource.md) objects that have officially been submitted for grading. +List the [educationSubmissionResource](../resources/educationsubmissionresource.md) objects that have officially been submitted for grading. Only teachers, students, and applications with application permissions can perform this operation. The student who owns the submission cannot change the submitted list without resubmitting the assignment. This is a wrapper around the real resource and can contain a pointer back to the actual assignment resource if this resource was copied from the assignment. |
v1.0 | Educationsubmission Post Resources | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-post-resources.md | doc_type: apiPageType Namespace: microsoft.graph -Add an [educationSubmissionResource](../resources/educationsubmissionresource.md) to a submission resource list. +Add an [educationSubmissionResource](../resources/educationsubmissionresource.md) to a submission resource list. Only teachers and students can perform this operation. -Only the student assigned to the submission can perform this operation. --The operation will not succeed if the **allowStudentsToAddResources** flag is not set to `true`. +The operation will not succeed if the **allowStudentsToAddResources** flag is not set to `true`. To create a new file-based resource, upload the file to the resources folder associated with the submission. If the file doesn't exist or is not in that folder, the POST request will fail. |
v1.0 | Educationsubmission Setupresourcesfolder | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-setupresourcesfolder.md | doc_type: apiPageType Namespace: microsoft.graph -Trigger the creation of the SharePoint resource folder where all file-based resources (Word, Excel, and so on) should be uploaded for a given submission. +Trigger the creation of the SharePoint resource folder where all file-based resources (Word, Excel, and so on) should be uploaded for a given submission. Only teachers and students can perform this operation. Note that files must be located in this folder in order to be added as resources. Only a student in the class can determine what files to upload in a given submission-level resource folder. |
v1.0 | Educationsubmission Submit | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-submit.md | doc_type: apiPageType Namespace: microsoft.graph -Indicate that a student is done with the work and is ready to hand in the assignment. +Indicate that a student is done with the work and is ready to hand in the assignment. Only teachers, students, and applications with application permissions can perform this operation. This method changes the status of the submission from `working` to `submitted`. During the submit process, all the resources are copied to the **submittedResources** bucket. The teacher will be looking at the submitted resources list for grading. |
v1.0 | Educationsubmission Unsubmit | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-unsubmit.md | doc_type: apiPageType Namespace: microsoft.graph -Indicate that a student wants to work on the submission of the assignment after it was turned in. +Indicate that a student wants to work on the submission of the assignment after it was turned in. Only teachers, students, and applications with application permissions can perform this operation. This method changes the status of the submission from `submitted` to `working`. During the submit process, all the resources are copied from **submittedResources** to **workingResources**. The teacher will be looking at the working resources list for grading. |
v1.0 | Educationsubmissionresource Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmissionresource-delete.md | doc_type: apiPageType Namespace: microsoft.graph -Deletes an [educationSubmissionResource](../resources/educationsubmissionresource.md) from the submission. This can only be done by the student. If the resource was copied from the assignment, a new copy of the resource will be created after the current copy is deleted. This allows you to "reset" the resource to its original state. If the resource was not copied from the assignment but was added from the student, the resource is simply deleted. +Delete an [educationSubmissionResource](../resources/educationsubmissionresource.md) from the submission. Only teachers and students can perform this operation. ++If the resource was copied from the assignment, a new copy of the resource will be created after the current copy is deleted. This allows you to "reset" the resource to its original state. If the resource was not copied from the assignment but was added from the student, the resource is simply deleted. ## 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 | Educationsubmissionresource Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmissionresource-get.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve the properties of a specific resource associated with a [submission](../resources/educationsubmissionresource.md). +Retrieve the properties of a specific resource associated with a [submission](../resources/educationsubmissionresource.md). Only teachers, students, and applications with application permissions can perform this operation. This resource is in the "working" resource list and should be considered work in process by a student. This resource is wrapped with a possible pointer back to the assignment resource if it was copied from the assignment. |
v1.0 | Educationsubmittedsubmissionresource Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmittedsubmissionresource-get.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve a [submitted resource](../resources/educationsubmissionresource.md). +Retrieve a [submitted resource](../resources/educationsubmissionresource.md). Only teachers, students, and applications with application permissions can perform this operation. This will be available to a teacher or an application with application permissions after a student has submitted, and will be available to the student after the teacher has released the submission. Note that teachers can leave notes in some resources. |
v1.0 | Educationuser List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationuser-list-assignments.md | doc_type: apiPageType Namespace: microsoft.graph -Returns a list of [educationAssignment](../resources/educationassignment.md) assigned to a [educationUser](../resources/educationuser.md) for all [classes](../resources/educationclass.md). +Returns a list of [educationAssignment](../resources/educationassignment.md) assigned to a [educationUser](../resources/educationuser.md) for all [classes](../resources/educationclass.md). Only teachers, students, and applications with application permissions can perform this operation. This method allows a caller to find all the **assignments** belonging to a student or a teacher in a single call rather than having to request **assignments** from each **class**. The **assignment** list contains what is needed to get the detailed information for the **assignment** from within the **class** namespace. Use the methods defined for the **assignment** for all other operations. |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-list-members.md | Get a list of the group's direct members. A group can have users, organizational When a group contains more than 100 members, Microsoft Graph returns a `@odata.nextLink` property in the response that contains a URL to the next page of results. If that property is present, continue making additional requests with the `@odata.nextLink` URL in each response, until all the results are returned, as described in [paging Microsoft Graph data in your app](/graph/paging). +An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. + ## 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). Do not supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [directoryObject](../resources/directoryobject.md) objects in the response body. +An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. For example, `/groups/{id}}/members/microsoft.graph.group` when the group is a Microsoft 365 group will return this error, because Microsoft 365 groups cannot have other groups as members. + ## Examples ### Example 1: Get the direct membership in a group |
v1.0 | Group List Transitivemembers | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-list-transitivemembers.md | doc_type: apiPageType Namespace: microsoft.graph -Get a list of the group's members. A group can have users, devices, organizational contacts, and other groups as members. This operation is transitive and returns a flat list of all nested members. +Get a list of the group's members. A group can different object types as members. For more information about supported member types for different groups, see [Group membership](../resources/groups-overview.md#group-membership). ++This operation is transitive and returns a flat list of all nested members. An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. ## Permissions Do not supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [directoryObject](../resources/directoryobject.md) objects in the response body. + An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. For example, `/groups/{id}}/transitiveMembers/microsoft.graph.group` when the group is a Microsoft 365 group will return this error, because Microsoft 365 groups cannot have other groups as members. + ## Examples ### Example 1: Get the transitive membership of a group Content-type: application/json The following is an example of the request. -# [HTTP](#tab/http) - <!-- { "blockType": "ignored", "name": "get_group_transitivemembers_count" GET https://graph.microsoft.com/v1.0/groups/{id}/transitiveMembers/$count ConsistencyLevel: eventual ``` -# [C#](#tab/csharp) ---# [JavaScript](#tab/javascript) ---# [Objective-C](#tab/objc) ---# [Java](#tab/java) ---- #### Response The following is an example of the response. The following is an example of the response. <!-- { "blockType": "response" } -->- ```http HTTP/1.1 200 OK Content-type: text/plain |
v1.0 | Group Post Groups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-post-groups.md | Content-type: application/json The following is an example of the request. The calling user must be assigned the _RoleManagement.ReadWrite.Directory_ permission to set the **isAssignableToRole** property or update the membership of such groups. +A group with **isAssignableToRole** property set to `true` cannot be of dynamic membership type, its **securityEnabled** must be set to `true`, and **visibility** can only be `Private`. + # [HTTP](#tab/http) <!-- { |
v1.0 | Group Post Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-post-members.md | Namespace: microsoft.graph Add a member to a security or Microsoft 365 group through the **members** navigation property. -The following table shows the types of members that can be added to either security groups or Microsoft 365 groups. --| Object type | Member of security group | Member of Microsoft 365 group | -|-|-|-| -| User | ![Can be group member][Yes] | ![Can be group member][Yes] | -| Security group | ![Can be group member][Yes] | ![Cannot be group member][No] | -| Microsoft 365 group | ![Cannot be group member][No] | ![Cannot be group member][No] | -| Device | ![Can be group member][Yes] | ![Cannot be group member][No] | -| Service principal | ![Can be group member][Yes] | ![Cannot be group member][No] | -| Organizational contact | ![Can be group member][Yes] | ![Cannot be group member][No] | ## Permissions HTTP/1.1 204 No Content - [Update member's role in team](team-update-members.md) - [Remove member from team](team-delete-members.md) ---[Yes]: /graph/images/yesandnosymbols/greencheck.svg -[No]: /graph/images/yesandnosymbols/no.svg - <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- { |
v1.0 | Identityprotectionroot List Riskyserviceprincipals | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/identityprotectionroot-list-riskyserviceprincipals.md | If successful, this method returns a `200 OK` response code and a collection of ### Request ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_riskyserviceprincipal" If successful, this method returns a `200 OK` response code and a collection of GET https://graph.microsoft.com/v1.0/identityProtection/riskyServicePrincipals ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ ### Response >**Note:** The response object shown here might be shortened for readability. <!-- { |
v1.0 | Identityprotectionroot List Serviceprincipalriskdetections | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/identityprotectionroot-list-serviceprincipalriskdetections.md | If successful, this method returns a `200 OK` response code and a collection of The following is an example of the request. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_serviceprincipalriskdetection" The following is an example of the request. GET https://graph.microsoft.com/v1.0/identityProtection/servicePrincipalRiskDetections ``` +# [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. Content-Type: application/json #### Request The following example shows how to use `$filter` to get the collection of service principal risk detections where the risk level is `medium` or the risk event type is `investigationsThreatIntelligence`. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_filter_serviceprincipalriskdetection" The following example shows how to use `$filter` to get the collection of servic GET https://graph.microsoft.com/v1.0/identityProtection/servicePrincipalRiskDetections?$filter=riskEventType eq 'investigationsThreatIntelligence' or riskLevel eq 'medium' ``` +# [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. |
v1.0 | Internaldomainfederation Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/internaldomainfederation-delete.md | Title: "Delete internalDomainFederation" description: "Delete an internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Internaldomainfederation Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/internaldomainfederation-get.md | Title: "Get internalDomainFederation" description: "Read the properties and relationships of an internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Internaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/internaldomainfederation-update.md | Title: "Update internalDomainFederation" description: "Update the properties of an internalDomainFederation object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
v1.0 | Meetingattendancereport Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/meetingattendancereport-get.md | GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId} >- `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. >- `reportId` is the **id** of an [meetingAttendanceReport](../resources/meetingAttendanceReport.md) object. +> [!CAUTION] +> +>- The **attendanceRecords** property does not return information about a breakout room. + ## Optional query parameters This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. |
v1.0 | Notebook Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/notebook-get.md | GET https://graph.microsoft.com/v1.0/me/onenote/notebooks/1-e13f257d-78c6-46cf-a [!INCLUDE [sample-code](../includes/snippets/go/get-notebook-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-notebook-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Onlinemeeting Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/onlinemeeting-get.md | Retrieve the properties and relationships of an [onlineMeeting](../resources/onl For example, you can: -- Get details of an online meeting using [videoTeleconferenceId](#example-1-retrieve-an-online-meeting-by-videoteleconferenceid), [meeting ID](#example-2-retrieve-an-online-meeting-by-meeting-id), or [joinWebURL](#example-3-retrieve-an-online-meeting-by-joinweburl).-- Use the `/attendeeReport` path to get the attendee report of a [Microsoft Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events) in the form of a download link, as shown in [example 4](#example-4-fetch-attendee-report-of-a-teams-live-event).+- Get details of an online meeting using [videoTeleconferenceId](#example-1-retrieve-an-online-meeting-by-videoteleconferenceid), [meeting ID](#example-2-retrieve-an-online-meeting-by-meeting-id), [joinWebURL](#example-3-retrieve-an-online-meeting-by-joinweburl), or [joinMeetingId](#example-4-retrieve-an-online-meeting-by-joinmeetingid). +- Use the `/attendeeReport` path to get the attendee report of a [Microsoft Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events) in the form of a download link, as shown in [example 5](#example-5-fetch-attendee-report-of-a-teams-live-event). Teams live event attendee report is an online meeting artifact. For details, see [Online meeting artifacts and permissions](/graph/cloud-communications-online-meeting-artifacts). GET /me/onlineMeetings?$filter=JoinWebUrl%20eq%20'{joinWebUrl}' GET /users/{userId}/onlineMeetings?$filter=JoinWebUrl%20eq%20'{joinWebUrl}' ``` +To get an **onlineMeeting** using **joinMeetingId** with delegated (`/me`) and app (`/users/{userId}`) permission: +<!-- { "blockType": "ignored" } --> +```http +GET /me/onlineMeetings?$filter=joinMeetingIdSettings/joinMeetingId%20eq%20'{joinMeetingId}' +GET /users/{userId}/onlineMeetings?$filter=joinMeetingIdSettings/joinMeetingId%20eq%20'{joinMeetingId}' +``` + To get the attendee report of a [Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events) with delegated (`/me`) and app (`/users/{userId}`) permission: <!-- { "blockType": "ignored" }--> GET /users/{userId}/onlineMeetings/{meetingId}/attendeeReport ``` > [!NOTE]-> - `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [application access policy](/graph/cloud-communication-online-meeting-application-access-policy). +> - `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy). > - `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. > - **videoTeleconferenceId** is generated for Cloud-Video-Interop licensed users and can be found in an [onlineMeeting](../resources/onlinemeeting.md) object. For details, see [VTC conference id](/microsoftteams/cloud-video-interop-for-teams-set-up). > - \* This scenario only supports application token and doesn't support application access policy. > - `joinWebUrl` must be URL encoded.+>- `joinMeetingId` is the meeting ID to be used to join a meeting. ## Optional query parameters This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. If successful, this method returns a `200 OK` response code. The response also i - If you fetch an online meeting by **videoTeleconferenceId** or **joinWebUrl**, this method returns a collection that contains only one [onlineMeeting](../resources/onlinemeeting.md) object in the response body. - If you fetch the attendee report of a [Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events), this method returns a `Location` header that indicates the URI to the attendee report. +> [!NOTE] +>- **joinMeetingIdSettings** might not be generated for some prescheduled meetings if the meeting was created before this feature was supported. + ## Examples > [!NOTE] If successful, this method returns a `200 OK` response code. The response also i ### Example 1: Retrieve an online meeting by videoTeleconferenceId #### Request-The following example shows the request. +The following is an example of a request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/v1.0/communications/onlineMeetings/?$filter=Vide #### Response +The following is an example of the response. ++> **Note:** The response object shown here might be shortened for readability. + <!-- { "blockType": "response", "truncated": true, Content-Length: 1574 "@odata.type": "#microsoft.graph.onlineMeeting", "autoAdmittedUsers": "everyone", "audioConferencing": {- "tollNumber": "55525634478", - "tollFreeNumber": "55566390588", + "tollNumber": "5552478", + "tollFreeNumber": "5550588", "ConferenceId": "9999999", "dialinUrl": "https://dialin.teams.microsoft.com/6787A136-B9B8-4D39-846C-C0F1FF937F10?id=xxxxxxx" }, "chatInfo": { "@odata.type": "#microsoft.graph.chatInfo",- "threadId": "19:cbee7c1c860e465f8258e3cebf7bee0d@thread.skype", - "messageId": "1533758867081" + "threadId": "19:cbee7c1c860e465cebf7bee0d@thread.skype", + "messageId": "153367081" }, "creationDateTime": "2018-05-30T00:12:19.0726086Z", "endDateTime": "2018-05-30T01:00:00Z", "id": "112f7296-5fa4-42ca-bae8-6a692b15d4b8_19:cbee7c1c860e465f8258e3cebf7bee0d@thread.skype",- "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3a:meeting_NTg0NmQ3NTctZDVkZC00YzRhLThmNmEtOGQ3M2E0ODdmZDZk@thread.v2/0?context=%7b%22Tid%22%3a%aa67bd4c-8475-432d-bd41-39f255720e0a%22%2c%22Oid%22%3a%22112f7296-5fa4-42ca-bae8-6a692b15d4b8%22%7d", + "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3a:meeting_NTg0NmQ3NTctZDVkZC00YzRhLThmNmEtOGQDdmZDZk@thread.v2/0?context=%7b%22Tid%22%3a%aa67bd4c-8475-432d-bd41-39f255720e0a%22%2c%22Oid%22%3a%22112f7296-5fa4-42ca-bb15d4b8%22%7d", "participants": { "@odata.type": "#microsoft.graph.meetingParticipants", "attendees": [ Content-Length: 1574 "identity": { "user": { "@odata.type": "#microsoft.graph.identity",- "id": "112f7296-5fa4-42ca-bae8-6a692b15d4b8", + "id": "112f7296-5ca-bae8-6a692b15d4b8", "displayName": "Tyler Stein" } }, Content-Length: 1574 "identity": { "user": { "@odata.type": "#microsoft.graph.identity",- "id": "5810cede-f3cc-42eb-b2c1-e9bd5d53ec96", + "id": "5810cedeb-b2c1-e9bd5d53ec96", "displayName": "Jasmine Miller" } }, Content-Length: 1574 "scope": "everyone", "isDialInBypassEnabled": true },+ "joinMeetingIdSettings": { + "isPasscodeRequired": false, + "joinMeetingId": "1234567890", + "passcode": null + }, "isEntryExitAnnounced": true, "allowedPresenters": "everyone" } You can retrieve meeting information via meeting ID with either a user or applic #### Request -> **Note:** The meeting ID has been truncated for readability. +The following is an example of a request that uses a user (delegated) token. -The following request uses a user token. +> **Note:** The meeting ID has been truncated for readability. # [HTTP](#tab/http) <!-- {"blockType": "request", "name": "get-onlinemeeting-user-token","sampleKeys": ["MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy"]} --> GET https://graph.microsoft.com/v1.0/users/dc17674c-81d9-4adb-bfb2-8f6a442e4622/ ``` #### Response++The following is an example of the response. + <!-- { "blockType": "response", "truncated": true, HTTP/1.1 200 OK Content-Type: application/json {- "id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy", + "id": "MSpkYzE3Njc0Yy04MWQiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy", "creationDateTime": "2020-09-29T22:35:33.1594516Z", "startDateTime": "2020-09-29T22:35:31.389759Z", "endDateTime": "2020-09-29T23:35:31.389759Z",- "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_MGQ4MDQyNTEtNTQ2NS00YjQxLTlkM2EtZWVkODYxODYzMmY2%40thread.v2/0?context=%7b%22Tid%22%3a%22909c6581-5130-43e9-88f3-fcb3582cde37%22%2c%22Oid%22%3a%22dc17674c-81d9-4adb-bfb2-8f6a442e4622%22%7d", + "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_MGQ4MDQyNTE2EtZWVkODYxODYzMmY2%40thread.v2/0?context=%7b%22Tid%22%3a%22909c6581-5130-43e9-88f3-fcb3582cde37%22%2c%22Oid%22%3a%22dc17674c-81d9-4adb-442e4622%22%7d", "subject": null, "autoAdmittedUsers": "EveryoneInCompany", "isEntryExitAnnounced": true, Content-Type: application/json "role": "presenter", "identity": { "user": {- "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622", + "id": "dc17674c-81d9-4adb-a442e4622", "displayName": null,- "tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38", + "tenantId": "909c6581-5188f3-fcb3582cde38", "identityProvider": "AAD" } } Content-Type: application/json "lobbyBypassSettings": { "scope": "organization", "isDialInBypassEnabled": false+ }, + "joinMeetingIdSettings": { + "isPasscodeRequired": false, + "joinMeetingId": "1234567890", + "passcode": null } } ``` You can retrieve meeting information via JoinWebUrl by using either a user or ap #### Request -The following request uses a user token. +The following is an example of a request that uses a user (delegated) token. # [HTTP](#tab/http) <!-- {"blockType": "request", "name": "get-onlinemeeting-joinurl-user-token", "sampleKeys": ["https%3A%2F%2Fteams.microsoft.com%2Fl%2Fmeetup-join%2F19%253ameeting_MGQ4MDQyNTEtNTQ2NS00YjQxLTlkM2EtZWVkODYxODYzMmY2%2540thread.v2%2F0%3Fcontext%3D%257b%2522Tid%2522%253a%2522909c6581-5130-43e9-88f3-fcb3582cde37%2522%252c%2522Oid%2522%253a%2522dc17674c-81d9-4adb-bfb2-8f6a442e4622%2522%257d"]} --> GET https://graph.microsoft.com/v1.0/users/dc17674c-81d9-4adb-bfb2-8f6a442e4622/ #### Response +The following is an example of the response. + <!-- { "blockType": "response", "truncated": true, Content-Type: application/json { "value": [ {- "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622_19:meeting_MGQ4MDQyNTEtNTQ2NS00YjQxLTlkM2EtZWVkODYxODYzMmY2@thread.v2", + "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622_19:meeting_MGQ4MDQyNTEtNTQVkODYxODYzMmY2@thread.v2", "creationDateTime": "2020-09-29T22:35:33.1594516Z", "startDateTime": "2020-09-29T22:35:31.389759Z", "endDateTime": "2020-09-29T23:35:31.389759Z",- "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_MGQ4MDQyNTEtNTQ2NS00YjQxLTlkM2EtZWVkODYxODYzMmY2%40thread.v2/0?context=%7b%22Tid%22%3a%22909c6581-5130-43e9-88f3-fcb3582cde37%22%2c%22Oid%22%3a%22dc17674c-81d9-4adb-bfb2-8f6a442e4622%22%7d", + "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_MGQ4MDQyNTEtNTQ2NS00YjQxLTlkMYzMmY2%40thread.v2/0?context=%7b%22Tid%22%3a%22909c6581-5130-43e9-882cde37%22%2c%22Oid%22%3a%22dc17674c-81d9-4adb-bfb2-8f6a442e4622%22%7d", "subject": null, "isEntryExitAnnounced": true, "allowedPresenters": "everyone", Content-Type: application/json "role": "presenter", "identity": { "user": {- "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622", + "id": "dc17674c-81d9-4adb-bf442e4622", "displayName": null,- "tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38", + "tenantId": "909c6581-5130-43e93582cde38", "identityProvider": "AAD" } } Content-Type: application/json "lobbyBypassSettings": { "scope": "organization", "isDialInBypassEnabled": false+ }, + "joinMeetingIdSettings": { + "isPasscodeRequired": false, + "joinMeetingId": "1234567890", + "passcode": null } } ] } ``` -### Example 4: Fetch attendee report of a Teams live event +### Example 4: Retrieve an online meeting by joinMeetingId -The following example shows a request to download an attendee report. +You can retrieve meeting information via the **joinMeetingId** by using either a user (delegated) or an application token. #### Request -The following request uses delegated permission. +The following is an example of a request that uses a user (delegated) token. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get-an-online-meeting-by-joinmeetingid" +} --> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/me/onlineMeetings?$filter=joinMeetingIdSettings/joinMeetingId%20eq%20'1234567890' +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) +++++The following request uses an app token. +<!-- { "blockType": "ignored" } --> +```http +GET https://graph.microsoft.com/v1.0/users/dc17674c-81d9-4adb-bfb2-8f6a442e4622/onlineMeetings?$filter=joinMeetingIdSettings/joinMeetingId%20eq%20'1234567890' +``` ++#### 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.onlineMeeting" +} --> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622_19:meeting_MGQ4MDQyNtZWVkODYxODYzMmY2@thread.v2", + "creationDateTime": "2020-09-29T22:35:33.1594516Z", + "startDateTime": "2020-09-29T22:35:31.389759Z", + "endDateTime": "2020-09-29T23:35:31.389759Z", + "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_MGQ4MDQyNTEtNZWVkODYxODYzMmY2%40thread.v2/0?context=%7b%22Tid%22%3a%22909c6581-5130-43e9-88cb3582cde37%22%2c%22Oid%22%3a%22dc17674c-81d9-4adb-bfb2-8f6a442e4622%22%7d", + "subject": null, + "autoAdmittedUsers": "EveryoneInCompany", + "isEntryExitAnnounced": true, + "allowedPresenters": "everyone", + "allowMeetingChat": "enabled", + "allowTeamworkReactions": true, + "videoTeleconferenceId": "(redacted)", + "participants": { + "organizer": { + "upn": "(redacted)", + "role": "presenter", + "identity": { + "user": { + "id": "dc174c-81db-bfb2-8f6622", + "displayName": null, + "tenantId": "9091-5130-48f3-fce38", + "identityProvider": "AAD" + } + } + }, + "attendees": [], + "producers": [], + "contributors": [] + }, + "lobbyBypassSettings": { + "scope": "organization", + "isDialInBypassEnabled": false + }, + "joinMeetingIdSettings": { + "isPasscodeRequired": false, + "joinMeetingId": "1234567890", + "passcode": null + } + } + ] +} +``` ++### Example 5: Fetch attendee report of a Teams live event ++The following example shows a request to download an attendee report. ++#### Request ++The following request uses a user (delegated) token. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/v1.0/users/dc74d9bb-6afe-433d-8eaa-e39d80d3a647/ #### Response +The following is an example of the response. + <!-- { "blockType": "response", "truncated": true, |
v1.0 | Planner Post Plans | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/planner-post-plans.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) | Tasks.ReadWrite, Group.ReadWrite.All | +| Delegated (work or school account) | Tasks.ReadWrite, Group.ReadWrite.All | | Delegated (personal Microsoft account) | Not supported. | | Application | Not supported. | POST /planner/plans ## Request body In the request body, supply a JSON representation of [plannerPlan](../resources/plannerplan.md) object.-The **plannerPlan** owner property must be set to an id of a [group](../resources/group.md) object. ->**Note:** The user who is creating the plan must be a member of the group that will own the plan. When you create a new group by using [Create group](../api/group-post-groups.md), you are not added to the group as a member. After the group is created, add yourself as a member by using [group post members](../api/group-post-members.md). +The following table shows the properties that are required when you create a [plannerPlan](../resources/plannerplan.md). ++|Property|Type|Description| +|:|:|:| +|container|[plannerPlanContainer](../resources/plannerplancontainer.md)|Identifies the container of the plan. Specify only the **url**, the **containerId** and **type**, or all properties. After it is set, this property canΓÇÖt be updated.| +|title|String|The title of the plan.| ++>**Note:** If the container is a Microsoft 365 group, the user who is creating the plan must be a member of the group that will contain the plan. When you create a new group by using [Create group](../api/group-post-groups.md), you are not added to the group as a member. After the group is created, add yourself as a member by using [group post members](../api/group-post-members.md). ## Response -If successful, this method returns `201 Created` response code and [plannerPlan](../resources/plannerplan.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [plannerPlan](../resources/plannerplan.md) object in the response body. -This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 400, 403 and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). +This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 400, 403, and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). ## Example ### Request -Here is an example of the request. +The following is an example of the request. # [HTTP](#tab/http) POST https://graph.microsoft.com/v1.0/planner/plans Content-type: application/json {- "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874", + "container": { + "url": "https://graph.microsoft.com/beta/groups/ebf3b108-5234-4e22-b93d-656d7dae5874" + }, "title": "title-value" } ``` Content-type: application/json --In the request body, supply a JSON representation of [plannerPlan](../resources/plannerplan.md) object. - ### Response -Here is an example of the response. Note: The response object shown here might be shortened for readability. +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 "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa" }, "user": {- "id": "ebf3b108-5234-4e22-b93d-656d7dae5874" + "id": "b108ebf3-4e22-b93d-5234-dae5874656d7" } }, "createdDateTime": "2015-03-30T18:36:49.2407981Z",- "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874", + "container": { + "@odata.type": "microsoft.graph.plannerPlanContainer", + "url": "https://graph.microsoft.com/beta/groups/ebf3b108-5234-4e22-b93d-656d7dae5874", + "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874", + "type": "group" + }, "title": "title-value", "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM" } Content-type: application/json "suppressions": [ ] }-->- |
v1.0 | Plannerassignedtotaskboardtaskformat Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/plannerassignedtotaskboardtaskformat-get.md | Title: "Get plannerAssignedToTaskBoardTaskFormat" -description: "Retrieve the properties and relationships of **plannerAssignedToTaskBoardTaskFormat** object." +description: "Retrieve the properties and relationships of a **plannerAssignedToTaskBoardTaskFormat** object." ms.localizationpriority: medium ms.prod: "planner" doc_type: apiPageType Namespace: microsoft.graph -Retrieve the properties and relationships of **plannerAssignedToTaskBoardTaskFormat** object. +Retrieve the properties and relationships of a **plannerAssignedToTaskBoardTaskFormat** 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). One of the following permissions is required to call this API. To learn more, in ```http GET /planner/tasks/{id}/assignedToTaskBoardFormat ```+ ## Request headers | Name |Description| |:-|:-| Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [plannerAssignedToTaskBoardTaskFormat](../resources/plannerassignedtotaskboardtaskformat.md) object in the response body. +If successful, this method returns a `200 OK` response code and a [plannerAssignedToTaskBoardTaskFormat](../resources/plannerassignedtotaskboardtaskformat.md) object in the response body. This method can return any of the [HTTP status codes](/graph/errors). The most common errors that apps should handle for this method are the 403 and 404 responses. For more information about these errors, see [Common Planner error conditions](../resources/planner-overview.md#common-planner-error-conditions). ## Example-##### Request -Here is an example of the request. +### Request +The following is an example of the request. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/v1.0/planner/tasks/{task-id}/assignedToTaskBoard -##### Response -Here is an example of the response. Note: The response object shown here might be shortened for readability. +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
v1.0 | Print List Connectors | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/print-list-connectors.md | Title: List printConnectors -description: Retrieve a list of connectors. -+ Title: "List printConnectors" +description: "Retrieve a list of connectors." + ms.localizationpriority: medium doc_type: apiPageType To use the Universal Print service, the user or app's tenant must have an active |Permission type | Permissions (from least to most privileged) | |:|:--| |Delegated (work or school account)| PrintConnector.Read.All, PrintConnector.ReadWrite.All |-|Delegated (personal Microsoft account)|Not Supported.| -|Application| Not Supported. | +|Delegated (personal Microsoft account)|Not supported.| +|Application| Not supported. | ## HTTP request GET /print/connectors This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ### Exceptions-Some operators are not supported: `$count`, `$search`, `$filter`. +The following operators are not supported: `$count`, `$search`, `$filter`. ## 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", GET https://graph.microsoft.com/v1.0/print/connectors ### Response-**Note:** The response object shown here might be shortened for readability. ++The following is an example of the response. ++>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
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 | Riskyserviceprincipal Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyserviceprincipal-confirmcompromised.md | If successful, this action returns a `204 No Content` response code. It does not ### Request ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "riskyserviceprincipal_confirmcompromised" Content-Type: application/json } ``` +# [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. <!-- { |
v1.0 | Riskyserviceprincipal Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyserviceprincipal-dismiss.md | If successful, this action returns a `204 No Content` response code. It does not ### Request ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "riskyserviceprincipal_dismiss" Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ ### Response <!-- { "blockType": "response", |
v1.0 | Riskyserviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyserviceprincipal-get.md | If successful, this method returns a `200 OK` response code and a [riskyServiceP ### Request ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_riskyserviceprincipal" If successful, this method returns a `200 OK` response code and a [riskyServiceP GET https://graph.microsoft.com/v1.0/identityProtection/riskyServicePrincipals/9089a539-a539-9089-39a5-899039a58990 ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ |
v1.0 | Riskyserviceprincipal List History | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/riskyserviceprincipal-list-history.md | If successful, this method returns a `200 OK` response code and a collection of ### Request ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_riskyserviceprincipalhistoryitem" If successful, this method returns a `200 OK` response code and a collection of GET https://graph.microsoft.com/v1.0/identityProtection/riskyServicePrincipals/{riskyServicePrincipalId}/history ``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PowerShell](#tab/powershell) ++# [PHP](#tab/php) ++++ ### Response >**Note:** The response object shown here might be shortened for readability. <!-- { |
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 | Security Alert Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/security-alert-get.md | + + Title: "Get alert" +description: "Retrieve the properties and relationships of an security alert object." Last updated : 11/11/2022++ms.localizationpriority: medium +++# Get alert +Namespace: microsoft.graph.security ++Get the properties and relationships of an [alert](../resources/security-alert.md) in an organization based on the specified alert **id** property. ++## 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)|SecurityAlert.Read.All, SecurityAlert.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|SecurityAlert.Read.All, SecurityAlert.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/alerts_v2/{alertId} +``` +++## 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 [alert](../resources/security-alert.md) object in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["da637578995287051192_756343937"], + "name": "get_security_alert" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/alerts_v2/da637578995287051192_756343937 +``` ++# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Java](#tab/java) ++# [Go](#tab/go) ++# [PHP](#tab/php) ++++++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", |