Updates from: 03/27/2023 01:10:50
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Accesspackageassignmentpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentpolicy-get.md
Content-type: application/json
} ```
+### Example 3: Retrieve the custom extension stage settings for a policy
+
+#### Request
+
+The following is an example of a request to retrieve the collection of custom extension stage settings that are defined for a policy and their associated access package custom workflow extension.
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_accesspackageassignmentpolicy_expand_customextensionstagesettings"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197?$expand=customExtensionStageSettings($expand=customExtension)
+```
+
+# [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.accessPackageAssignmentPolicy"
+} -->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "id": "4540a08f-8ab5-43f6-a923-015275799197",
+ "displayName": "policy with custom access package workflow extension",
+ "description": "Run specified custom access package workflow extension at different stages.",
+ "canExtend": true,
+ "durationInDays": 0,
+ "expirationDateTime": null,
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "accessReviewSettings": null,
+ "requestorSettings": {
+ "scopeType": "AllExistingDirectorySubjects",
+ "acceptRequests": true,
+ "allowedRequestors": []
+ },
+ "requestApprovalSettings": {
+ "isApprovalRequired": false,
+ "isApprovalRequiredForExtension": false,
+ "isRequestorJustificationRequired": false,
+ "approvalMode": "NoApproval",
+ "approvalStages": []
+ },
+ "customExtensionStageSettings": [
+ {
+ "id": "5a38d27a-b702-48d9-ac72-dcf158ba1b0d",
+ "stage": "assignmentRequestCreated",
+ "customExtension": {
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "id": "219f57b6-7983-45a1-be01-2c228b7a43f8",
+ "displayName": "test_action_1",
+ "description": "Test logic app",
+ "createdDateTime": "2022-01-11T05:19:16.97Z",
+ "lastModifiedDateTime": "2022-01-11T05:19:16.97Z",
+ "endpointConfiguration": {
+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName": "resourcegroup",
+ "logicAppWorkflowName": "customextension_test",
+ "url": "https://prod-31.eastus.logic.azure.com:443/workflows/8ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration": {
+ "@odata.type": "#microsoft.graph.azureAdPopTokenAuthentication"
+ }
+ }
+ }
+ ]
+}
+```
+ <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- {
v1.0 Accesspackageassignmentpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentpolicy-update.md
Content-Type: application/json
"accessReviewSettings": null } ```
+### Example 3: Remove the customExtensionStageSettings from a policy
+
+To remove the collection of **customExtensionStageSettings** and their associated custom workflow extension objects from a policy, assign an empty collection to the **customExtensionStageSettings** object.
+
+#### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_accesspackageassignmentpolicy_delete_customExtensionStageSettings"
+}
+-->
+
+```http
+PUT https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197
+Content-Type: application/json
+
+{
+ "id": "5540a08f-8ab5-43f6-a923-015275799197",
+ "displayName": "policy with access package custom workflow extension",
+ "description": "Run specified access package custom workflow extension at different stages.",
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "expiration": {
+ "type": "afterDuration",
+ "duration": "P365D"
+ },
+ "requestApprovalSettings": null,
+ "requestorSettings": {
+ "acceptRequests": true,
+ "scopeType": "AllExistingDirectorySubjects",
+ "allowedRequestors": []
+ },
+ "accessReviewSettings": null,
+ "customExtensionHandlers": []
+}
+```
+
+# [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,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentPolicy"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "id": "4540a08f-8ab5-43f6-a923-015275799197",
+ "displayName": "policy with access package custom workflow extension",
+ "description": "Run specified access package custom workflow extension at different stages.",
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "expiration": {
+ "type": "afterDuration",
+ "duration": "P365D"
+ },
+ "requestApprovalSettings": null,
+ "requestorSettings": {
+ "acceptRequests": true,
+ "scopeType": "AllExistingDirectorySubjects",
+ "allowedRequestors": []
+ },
+ "accessReviewSettings": null
+}
+```
<!-- {
v1.0 Accesspackageassignmentrequest Resume https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentrequest-resume.md
+
+ Title: "accessPackageAssignmentRequest: resume"
+description: "Resume accessPackageAssignmentRequest objects."
+ms.localizationpriority: medium
+++
+# accessPackageAssignmentRequest: resume
+Namespace: microsoft.graph
++
+In [Azure AD entitlement management](../resources/entitlementmanagement-overview.md), when an access package policy has been enabled to call out a custom extension and the request processing is waiting for the callback from the customer, the customer can initiate a resume action. It is performed on an [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object whose **requestStatus** is in a `WaitingForCallback` state.
+
+## 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) | EntitlementManagement.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /identityGovernance/entitlementManagement/accessPackageAssignmentRequests/{accessPackageAssignmentRequestId}/resume
+```
+
+## 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|
+|:|:|:|
+|source|String|Source from where customer is trying to resume the request, which can be stored in service and will be helpful for auditing.|
+|type|String|Indicate at which stage the custom callout extension was executed. The possible values are: `microsoft.graph.accessPackageCustomExtensionStage.assignmentRequestCreated`, `microsoft.graph.accessPackageCustomExtensionStage.assignmentRequestApproved`, `microsoft.graph.accessPackageCustomExtensionStage.assignmentRequestGranted`, `microsoft.graph.accessPackageCustomExtensionStage.assignmentRequestRemoved`|
+|data|[accessPackageAssignmentRequestCallbackData](../resources/accesspackageassignmentrequestcallbackdata.md)| Contains information about the instance of the callout that was made to the customer endpoint. |
+++
+## Response
+
+If successful, this action returns a `204 No Content` response code.
+
+## Examples
+
+### Example 1: Resume an access package assignment request
+
+#### Request
+The following is an example of a call to resume an access package assignment request that's waiting for a callback.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "accesspackageassignmentrequestthis.resume"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests/0e60f18c-b2a0-4887-9da8-da2e30a39d99/resume
+Content-Type: application/json
+
+{
+ "source": "Contoso.SodCheckProcess",
+ "type": "microsoft.graph.accessPackageCustomExtensionStage.assignmentRequestCreated",
+ "data": {
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequestCallbackData",
+ "stage": "assignmentRequestCreated",
+ "customExtensionStageInstanceId": "957d0c50-466b-4840-bb5b-c92cea7141ff",
+ "customExtensionStageInstanceDetail": "This user is all verified"
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
++++
+#### Response
+The following is an example of the response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
+### Example 2: Resume and deny an access package assignment request
+
+#### Request
+The following is an example to resume the processing of an access package assignment request by denying the request that's waiting for a callback. A request cannot be denied at the `assignmentRequestCreated` stage of the callout.
+<!-- {
+ "blockType": "request"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests/9e60f18c-b2a0-4887-9da8-da2e30a39d99/resume
+Content-Type: application/json
+
+{
+ "source": "Contoso.SodCheckProcess",
+ "type": "microsoft.graph.accessPackageCustomExtensionStage.assignmentRequestCreated",
+ "data": {
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequestCallbackData",
+ "stage": "AssignmentRequestCreated",
+ "customExtensionStageInstanceId": "857d0c50-466b-4840-bb5b-c92cea7141ff",
+ "state": "denied",
+ "customExtensionStageInstanceDetail": "Potential risk user based on the SOD check"
+ }
+}
+```
++
+### Response
+The following is an example of the response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Accesspackageassignmentrequestworkflowextension Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentrequestworkflowextension-delete.md
+
+ Title: "Delete accessPackageAssignmentRequestWorkflowExtension"
+description: "Delete an accessPackageAssignmentRequestWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Delete accessPackageAssignmentRequestWorkflowExtension
+Namespace: microsoft.graph
++
+Delete an [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) object. The custom workflow extension must first be removed from any associated [policies](../resources/accesspackageassignmentpolicy.md) before it can be deleted. Follow these steps to remove the custom workflow extension from any associated policies:
+1. First retrieve the accessPackageCatalogId by calling the [Get accessPackageAssignmentPolicies](accesspackageassignmentpolicy-get.md) operation and appending `?$expand=accessPackage($expand=accessPackageCatalog)` to the query. For example, `https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies?$expand=accessPackage($expand=accessPackageCatalog)`.
+2. Use the access package catalog ID and retrieve the ID of the **accessPackageCustomWorkflowExtension** object that you want to delete by running the [List accessPackageCustomWorkflowExtensions](accesspackagecatalog-list-accesspackagecustomworkflowextensions.md) operation.
+3. Call the [Update accessPackageAssignmentPolicy](accesspackageassignmentpolicy-update.md) operation to remove the custom workflow extension object from the policy. For an example, see [Example 3: Remove the customExtensionStageSettings from a policy](accesspackageassignmentpolicy-update.md#example-3-remove-the-customextensionstagesettings-from-a-policy).
+
+## 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)| EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application| EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions/{customAccessPackageWorkflowExtensionId}
+```
+
+## 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_accesspackageassignmentrequestworkflowextension"
+}
+-->
+``` http
+DELETE /identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions/E3D4CE35-B16A-4E19-ADF2-616B64D336DC
+```
++
+### Response
+The following is an example of the response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Accesspackageassignmentrequestworkflowextension Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentrequestworkflowextension-get.md
+
+ Title: "Get accessPackageAssignmentRequestWorkflowExtension"
+description: "Read the properties and relationships of an accessPackageAssignmentRequestWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Get accessPackageAssignmentRequestWorkflowExtension
+Namespace: microsoft.graph
++
+Read the properties and relationships of an [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.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)|EntitlementManagement.Read.All, EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.Read.All, EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/accessPackageCustomWorkflowExtensions/{accessPackageCustomWorkflowExtensionId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) object in the response body.
+
+## Examples
+
+### Request
+The following is an example of a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_accesspackageassignmentrequestworkflowextension"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackageCustomWorkflowExtensions/98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
++++
+### Response
+The following is an example of the response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequestWorkflowExtension"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "id":"98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0124_email",
+ "description":"this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/8ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ },
+ "callbackConfiguration":{
+ "@odata.type":"microsoft.graph.customExtensionCallbackConfiguration",
+ "durationBeforeTimeout":"PT1H"
+ }
+ }
+}
+```
+
v1.0 Accesspackageassignmentrequestworkflowextension Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentrequestworkflowextension-update.md
+
+ Title: "Update accessPackageAssignmentRequestWorkflowExtension"
+description: "Update the properties of an accessPackageAssignmentRequestWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Update accessPackageAssignmentRequestWorkflowExtension
+Namespace: microsoft.graph
++
+Update the properties of an [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.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)|EntitlementManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PUT /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions/{customAccessPackageWorkflowExtensionId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Authentication type. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|description|String|Description for the accessPackageCustomWorkflowExtension object. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|displayName|String|Display name for the accessPackageCustomWorkflowExtension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The type and details for configuring the endpoint to call the logic app's workflow. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|callbackConfiguration|[customExtensionCallbackConfiguration](../resources/customextensioncallbackconfiguration.md)|The timeout duration for callback. Optional.|
+++
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) object in the response body.
+
+## Examples
+
+### Request
+The following is an example of a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_accesspackageassignmentrequestworkflowextension"
+}
+-->
+``` http
+PUT https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackageCustomWorkflowExtensions/98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "displayName": "test_action_0124_email",
+ "description": "this is for graph testing only"
+}
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
++++
+### Response
+The following is an example of the response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequestWorkflowExtension"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "id":"98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0124_email",
+ "description": "this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/8ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ },
+ "callbackConfiguration":{
+ "@odata.type":"microsoft.graph.customExtensionCallbackConfiguration",
+ "durationBeforeTimeout":"PT1H"
+ }
+ }
+}
+```
+
v1.0 Accesspackageassignmentworkflowextension Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentworkflowextension-delete.md
+
+ Title: "Delete accessPackageAssignmentWorkflowExtension"
+description: "Delete an accessPackageAssignmentWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Delete accessPackageAssignmentWorkflowExtension
+Namespace: microsoft.graph
++
+Delete an [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) object. The custom workflow extension must first be removed from any associated [policies](../resources/accesspackageassignmentpolicy.md) before it can be deleted. Follow these steps to remove the custom workflow extension from any associated policies:
+1. First retrieve the accessPackageCatalogId by calling the [Get accessPackageAssignmentPolicies](accesspackageassignmentpolicy-get.md) operation and appending `?$expand=accessPackage($expand=accessPackageCatalog)` to the query. For example, `https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies?$expand=accessPackage($expand=accessPackageCatalog)`.
+2. Use the access package catalog ID and retrieve the ID of the **accessPackageCustomWorkflowExtension** object that you want to delete by running the [List accessPackageCustomWorkflowExtensions](accesspackagecatalog-list-accesspackagecustomworkflowextensions.md) operation.
+3. Call the [Update accessPackageAssignmentPolicy](accesspackageassignmentpolicy-update.md) operation to remove the custom workflow extension object from the policy. For an example, see [Example 3: Remove the customExtensionStageSettings from a policy](accesspackageassignmentpolicy-update.md#example-3-remove-the-customextensionstagesettings-from-a-policy).
+
+## 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)| EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application| EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions/{customAccessPackageWorkflowExtensionId}
+```
+
+## 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_accesspackageassignmentworkflowextension"
+}
+-->
+``` http
+DELETE /identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions/5FD6D8D5-E8F1-4B54-A1E6-1D0FE0B6E6EC
+```
++
+### Response
+The following is an example of the response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Accesspackageassignmentworkflowextension Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentworkflowextension-get.md
+
+ Title: "Get accessPackageAssignmentWorkflowExtension"
+description: "Read the properties and relationships of an accessPackageAssignmentWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Get accessPackageAssignmentWorkflowExtension
+Namespace: microsoft.graph
++
+Read the properties and relationships of an [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.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)|EntitlementManagement.Read.All, EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.Read.All, EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/accessPackageCustomWorkflowExtensions/{accessPackageCustomWorkflowExtensionId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) object in the response body.
+
+## Examples
+
+### Request
+The following is an example of a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_accesspackageassignmentworkflowextension"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackageCustomWorkflowExtensions/78ffaec5-ae8e-4902-a434-5ffc5d3d3cd0
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
++++
+### Response
+The following is an example of the response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentWorkflowExtension"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "id":"78ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0127_email",
+ "description":"this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/7ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ }
+ }
+}
+```
+
v1.0 Accesspackageassignmentworkflowextension Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentworkflowextension-update.md
+
+ Title: "Update accessPackageAssignmentWorkflowExtension"
+description: "Update the properties of an accessPackageAssignmentWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Update accessPackageAssignmentWorkflowExtension
+Namespace: microsoft.graph
++
+Update the properties of an [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.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)|EntitlementManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PUT /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions/{customAccessPackageWorkflowExtensionId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Authentication type. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|description|String|Description for the accessPackageCustomWorkflowExtension object. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|displayName|String|Display name for the accessPackageCustomWorkflowExtension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The type and details for configuring the endpoint to call the logic app's workflow. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
+|callbackConfiguration|[customExtensionCallbackConfiguration](../resources/customextensioncallbackconfiguration.md)|The timeout duration for callback. Optional.|
+++
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) object in the response body.
+
+## Examples
+
+### Request
+The following is an example of a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_accesspackageassignmentworkflowextension"
+}
+-->
+``` http
+PUT https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackageCustomWorkflowExtensions/78ffaec5-ae8e-4902-a434-5ffc5d3d3cd0
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "displayName": "test_action_0124_email",
+ "description": "this is for graph testing only"
+}
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
++++
+### Response
+The following is an example of the response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentWorkflowExtension"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "id":"78ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0127_email",
+ "description": "this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/7ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ }
+ }
+}
+```
+
v1.0 Accesspackagecatalog List Accesspackagecustomworkflowextensions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackagecatalog-list-accesspackagecustomworkflowextensions.md
+
+ Title: "List accessPackagecustomWorkflowExtensions"
+description: "Get a list of the accessPackageCustomWorkflowExtension objects and their properties."
+
+ms.localizationpriority: medium
++
+# List accessPackageCustomWorkflowExtensions
+Namespace: microsoft.graph
++
+Get a list of the [accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) and [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) objects and their properties. The resulting list includes all the **customAccessPackageWorkflowExtension** objects for the catalog that the caller has access to read. Each object includes an `@odata.type` property that indicates whether the object is an **accessPackageAssignmentRequestWorkflowExtension** or an **accessPackageAssignmentWorkflowExtension**.
+
+## 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)|EntitlementManagement.Read.All, EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.Read.All, EntitlementManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/accessPackageCustomWorkflowExtensions
+```
+
+## Optional query parameters
+This method supports the `$select` and `$filter` OData query parameters to help customize the response. For example, to search for access packages with a particular name, include a filter such as `$filter=contains(tolower(displayName),'team')` in the query. 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 [accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) or [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) objects in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "list_accesspackagecustomworkflowextension"
+}
+-->
+``` http
+GET /identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackageCustomWorkflowExtensions
+```
+
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.customCalloutExtension)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackageCustomWorkflowExtensions",
+ "value":[
+ {
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "id":"98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0124",
+ "description":"this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/8ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ },
+ "callbackConfiguration":{
+ "@odata.type":"microsoft.graph.customExtensionCallbackConfiguration",
+ "durationBeforeTimeout":"PT1H"
+ }
+ },
+ {
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "id":"98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0124",
+ "description":"this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/9ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ }
+ }
+ ]
+}
+```
v1.0 Accesspackagecatalog Post Accesspackagecustomworkflowextensions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackagecatalog-post-accesspackagecustomworkflowextensions.md
+
+ Title: "Create accessPackageCustomWorkflowExtension"
+description: "Create a new accessPackageCustomWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Create accessPackageCustomWorkflowExtension
+Namespace: microsoft.graph
++
+Create a new [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) or [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object and add it to an existing [accessPackageCatalog](../resources/accesspackagecatalog.md) object.
+
+You must explicitly provide an `@odata.type` property that indicates whether the object is an **accessPackageAssignmentRequestWorkflowExtension** or an **accessPackageAssignmentWorkflowExtension**.
+
+## 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)|EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.Read.All EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/accessPackageCustomWorkflowExtensions
+```
+
+## 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 [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) or [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object.
+
+You can specify the following properties when creating a **accessPackageCustomWorkflowExtension**.
+
+|Property|Type|Description|
+|:|:|:|
+|description|String|Description for the customAccessPackageWorkflowExtension object.|
+|displayName|String|Display name for the customAccessPackageWorkflowExtension.|
+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The type and details for configuring the endpoint to call the logic app's workflow.|
+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.|
+|callbackConfiguration|[customExtensionCallbackConfiguration](../resources/customextensioncallbackconfiguration.md)|The callback configuration for a custom extension. This is suppoted for `accessPackageAssignmentRequestWorkflowExtension`. |
+
+You must also supply an **@odata.type** property with a value of the specific access package workflow extension type. For example, `"@odata.type": "#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension"`.
+
+## Response
+
+If successful, this method returns a `201 Created` response code and a [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) or [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object in the response body.
+
+## Examples
+
+### Example 1: Create a custom extension for use with an access package assignment request
+The following is an example of a access package assignment request custom workflow extension.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_accessPackageAssignmentRequestWorkflowExtension"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackagecustomWorkflowExtensions
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "displayName":"test_action_0124_email",
+ "description":"this is for graph testing only",
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ },
+ "callbackConfiguration":{
+ "@odata.type":"microsoft.graph.customExtensionCallbackConfiguration",
+ "durationBeforeTimeout":"PT1H"
+ }
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
+++++
+#### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.customCalloutExtension"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "id":"98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0124_email",
+ "description":"this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/8ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ },
+ "callbackConfiguration":{
+ "@odata.type":"microsoft.graph.customExtensionCallbackConfiguration",
+ "durationBeforeTimeout":"PT1H"
+ }
+ }
+}
+```
+
+### Example 2: Create a custom extension for use with an access package assignment
+The following is an example of a access package assignment custom workflow extension.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_accessPackageAssignmentWorkflowExtension"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/accessPackagecustomWorkflowExtensions
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "displayName":"test_action_0127_email",
+ "description":"this is for graph testing only",
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ }
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
+++++
+#### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.customCalloutExtension"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "value":{
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "id":"78ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName":"test_action_0127_email",
+ "description":"this is for graph testing only",
+ "createdDateTime":"2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime":"2022-01-24T21:55:44.953Z",
+ "clientConfiguration":null,
+ "endpointConfiguration":{
+ "@odata.type":"#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId":"38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName":"test",
+ "logicAppWorkflowName":"elm-extension-email",
+ "url":"https://prod-31.eastus.logic.azure.com:443/workflows/7ccffea766ae48e680gd9a22d1549bbc/triggers/manual/paths/invoke?api-version=2016-10-01"
+ },
+ "authenticationConfiguration":{
+ "@odata.type":"#microsoft.graph.azureAdPopTokenAuthentication"
+ }
+ }
+}
+```
+
v1.0 Accesspackagecatalog Post Customaccesspackageworkflowextensions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackagecatalog-post-customaccesspackageworkflowextensions.md
If successful, this method returns a `201 Created` response code and a [customAc
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "create_customaccesspackageworkflowextension_from_"
+ "name": "create_customaccesspackageworkflowextension_"
} --> ``` http
Content-Type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Appmanagementpolicy Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appManagementPolicy-delete.md
Delete an [appManagementPolicy](../resources/appManagementPolicy.md) object.
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.ApplicationConfiguration |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Policy.ReadWrite.ApplicationConfiguration |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Policy.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.ReadWrite.ApplicationConfiguration |
## HTTP request
The following is an example of the request.
"name": "delete_appManagementPolicy" }-->
-```msgraph-interactive
+```http
DELETE https://graph.microsoft.com/beta/policies/appManagementPolicies/{id} ```
v1.0 Appmanagementpolicy List Appliesto https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appManagementPolicy-list-appliesTo.md
List application and service principal objects assigned an [appManagementPolicy]
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) |
-| :- | : |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
| Delegated (work or school account) | Application.Read.All and Policy.Read.All, Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
-| Delegated (personal Microsoft account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
| Application | Application.Read.All and Policy.Read.All, Application.Read.All and Policy.ReadWrite.ApplicationConfiguration | ## HTTP request
The following is an example of the request.
"name": "list_appManagementPolicyAppliesTo" }-->
-```msgraph-interactive
+```http
GET https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}/appliesTo ```
The following is an example of the request using $select query option.
"name": "list_appManagementPolicyAppliesTo_select" }-->
-```msgraph-interactive
+```http
GET https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}/appliesTo?$select=id,appId,displayName,createdDateTime ```
v1.0 Appmanagementpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appManagementPolicy-update.md
Update an [appManagementPolicy](../resources/appManagementPolicy.md) object.
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.ApplicationConfiguration |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Policy.ReadWrite.ApplicationConfiguration |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Policy.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.ReadWrite.ApplicationConfiguration |
## HTTP request
In the request body, supply the values for relevant fields from the [appManageme
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.
-| Property | Type | Description |
-|:|:-|:--|
-| displayName | String | The display name of the policy. Inherited from [policyBase](../resources/policybase.md). |
-| description | String | The description of the policy. Inherited from [policyBase](../resources/policybase.md). |
-| isEnabled | Boolean | Denotes whether the policy is enabled. |
-| restrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply to an application or service principal object. |
+| Property | Type | Description |
+| :-- | :-- | : |
+| displayName | String | The display name of the policy. Inherited from [policyBase](../resources/policybase.md). |
+| description | String | The description of the policy. Inherited from [policyBase](../resources/policybase.md). |
+| isEnabled | Boolean | Denotes whether the policy is enabled. |
+| restrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply to an application or service principal object. |
## Response
The following is an example of the request.
"name": "update_appManagementPolicy" }-->
-```msgraph-interactive
+```http
PATCH https://graph.microsoft.com/beta/policies/appManagementPolicies/{id} {
v1.0 Application Delete Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-delete-tokenlifetimepolicies.md
The following is an example of the request.
}--> ```http
-DELETE https://graph.microsoft.com/beta/applications/{id}/tokenLifetimePolicies/{id}/$ref
+DELETE https://graph.microsoft.com/beta/applications/3ccc9971-9ae7-45d6-8de8-263fd25fe116/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4/$ref
``` # [C#](#tab/csharp)
DELETE https://graph.microsoft.com/beta/applications/{id}/tokenLifetimePolicies/
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 Application List Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-list-tokenlifetimepolicies.md
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/applications/{id}/tokenLifetimePolicies
+GET https://graph.microsoft.com/beta/applications/3ccc9971-9ae7-45d6-8de8-263fd25fe116/tokenLifetimePolicies
``` # [C#](#tab/csharp)
HTTP/1.1 200 OK
Content-type: application/json {
- "value": [
- {
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true,
- "id": "id-value"
- }
- ]
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.tokenLifetimePolicy)",
+ "value": [
+ {
+ "id": "4d2f137b-e8a9-46da-a5c3-cc85b2b840a4",
+ "deletedDateTime": null,
+ "definition": [
+ "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"5:30:00\"}}"
+ ],
+ "displayName": "Contoso token lifetime policy",
+ "isOrganizationDefault": true
+ }
+ ]
} ```
v1.0 Application Post Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-tokenlifetimepolicies.md
The following is an example of the request.
}--> ```http
-POST https://graph.microsoft.com/beta/applications/{id}/tokenLifetimePolicies
+POST https://graph.microsoft.com/beta/applications/3ccc9971-9ae7-45d6-8de8-263fd25fe116/tokenLifetimePolicies/$ref
Content-Type: application/json {
- "@odata.id":"https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/cd3d9b57-0aee-4f25-8ee3-ac74ef5986a9"
+ "@odata.id":"https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4"
} ```
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/go/create-tokenlifetimepolicy-from-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/create-tokenlifetimepolicy-from-application-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Appmanagementpolicy Delete Appliesto https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appmanagementpolicy-delete-appliesto.md
+
+ Title: "Remove appliesTo"
+description: "Remove an appManagementPolicy from an application or service principal object."
+ms.localizationpriority: medium
+++
+# Remove appliesTo
+
+Namespace: microsoft.graph
++
+Remove an [appManagementPolicy](../resources/appManagementPolicy.md) policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide [tenantAppManagementPolicy](../resources/tenantappmanagementpolicy.md) setting.
+
+## 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) | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+DELETE /applications/{id}/appManagementPolicies/$ref
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, provide a reference to a single policy object from the [appManagementPolicies](../resources/appmanagementpolicy.md) collection.
+
+## Response
+
+If successful, this method returns `204 No Content` response code. It does not return anything in the response body.
+
+## Examples
+
+### Example 1: Remove an appManagementPolicy from an application object
+
+#### Request
+
+The following is an example of the request to remove an appManagementPolicy from an application.
++
+<!-- {
+ "blockType": "request",
+ "name": "remove_appliesTo"
+}-->
+
+```http
+DELETE https://graph.microsoft.com/beta/applications/{id}/appManagementPolicies/$ref
+Content-type: application/json
+
+{
+ "@odata.id":"https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}"
+}
+```
+
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+### Example 2: Remove an appManagementPolicy from a service principal object
+
+#### Request
+
+The following is an example of the request to remove an appManagementPolicy from a service principal.
+++
+<!-- {
+ "blockType": "request",
+ "name": "remove_appliesTo"
+}-->
+
+``` http
+DELETE https://graph.microsoft.com/beta/servicePrincipals/{id}/appManagementPolicies/$ref
+
+{
+ "@odata.id":"https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}"
+}
+```
++
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "list resources for appManagementPolicies",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Appmanagementpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appmanagementpolicy-get.md
Read the properties of an [appManagementPolicy](../resources/appManagementPolicy
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) |
+| Permission type | Permissions (from least to most privileged) |
| :- | : | | Delegated (work or school account) | Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration | | Delegated (personal Microsoft account) | Not supported. |
The following is an example of the request. From the response, the app manageme
"name": "get_appManagementPolicy" }-->
-```msgraph-interactive
+```http
GET https://graph.microsoft.com/beta/policies/appManagementPolicies/{id} ```
v1.0 Appmanagementpolicy List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appmanagementpolicy-list.md
Retrieve a list of [appManagementPolicy](../resources/appManagementPolicy.md) ob
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) |
+| Permission type | Permissions (from least to most privileged) |
| :- | : | | Delegated (work or school account) | Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration | | Delegated (personal Microsoft account) | Not supported. |
The following is an example of the request.
"name": "list_appManagementPolicies" }-->
-```msgraph-interactive
+```http
GET https://graph.microsoft.com/beta/policies/appManagementPolicies ```
v1.0 Appmanagementpolicy Post Appliesto https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appmanagementpolicy-post-appliesto.md
Assign an [appManagementPolicy](../resources/appManagementPolicy.md) policy obje
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) |
-| :- | : |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
| Delegated (work or school account) | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
-| Delegated (personal Microsoft account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
| Application | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration | ## HTTP request
POST /applications/{id}/appManagementPolicies/$ref
## Request headers | Name | Description |
-|:--|:-|
+| : | :-- |
| Authorization | Bearer {token}. Required. | | Content-Type | application/json. Required. |
The following is an example of the request to assign an appManagementPolicy to a
"name": "ApplicationsAppManagementPolicies" }-->
-```msgraph-interactive
+```http
POST https://graph.microsoft.com/beta/applications/{id}/appManagementPolicies/$ref Content-type: application/json
v1.0 Appmanagementpolicy Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/appmanagementpolicy-post.md
Create an [appManagementPolicy](../resources/appManagementPolicy.md) object.
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.ApplicationConfiguration |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Policy.ReadWrite.ApplicationConfiguration |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Policy.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.ReadWrite.ApplicationConfiguration |
## HTTP request
POST /policies/appManagementPolicies
| Authorization | Bearer {token}. Required. | | Content-Type | application/json. Required. |
+> [!IMPORTANT]
+> Service principals with a createdDateTime `null` are treated as having being created on 01/01/2019.
## Request body
-In the request body, provide a JSON representation of an [appManagementPolicy](../resources/appManagementPolicy.md).
+In the request body, supply a JSON representation of the [appManagementPolicy](../resources/appmanagementpolicy.md) object.
+
+You can specify the following properties when creating an **appManagementPolicy**.
+
+| Property | Type | Description |
+| :-- | :- | : |
+| displayName | String | The display name of the policy. Required. |
+| description | String | The description of the policy. Required. |
+| isEnabled | Boolean | Denotes whether the policy is enabled. Optional. |
+| restrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply to an application or service principal object. Optional. |
## Response
-If successful, this method returns a `201 Created` response code with the new [appManagementPolicy ](../resources/appmanagementpolicy.md) object in the response payload.
+If successful, this method returns a `201 Created` response code with the new [appManagementPolicy](../resources/appmanagementpolicy.md) object in the response payload.
## Examples
v1.0 Authentication List Emailmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-list-emailmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication List Methods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-list-methods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Authentication List Passwordmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-list-passwordmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Authentication List Softwareoathmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-list-softwareoathmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs [one of the following directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global Reader
-* Authentication administrator
-* Privileged authentication administrator
-* Global administrator
## HTTP request
v1.0 Authentication List Temporaryaccesspassmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-list-temporaryaccesspassmethods.md
One of the following permissions is required to call this API. To learn more, in
| Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication Post Emailmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-post-emailmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication Post Phonemethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-post-phonemethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication Post Temporaryaccesspassmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-post-temporaryaccesspassmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authenticationmethod Resetpassword https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authenticationmethod-resetpassword.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | Not supported. |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authenticationmethodspolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authenticationmethodspolicy-get.md
Title: "Get authenticationMethodsPolicy" description: "Read the properties and relationships of an authenticationMethodsPolicy object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|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):
-
-* Global Reader
-* Authentication Policy Administrator
-* Global Administrator
## HTTP request
v1.0 Authenticationmethodspolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authenticationmethodspolicy-update.md
Title: "Update authenticationMethodsPolicy" description: "Update the properties of an authenticationMethodsPolicy object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Authenticationoperation Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authenticationoperation-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | Not supported. | | Application | Not supported. | Not supported. |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authorizationpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authorizationpolicy-get.md
One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } --> ```http
-GET /policies/authorizationPolicy/authorizationPolicy
+GET /policies/authorizationPolicy
``` ## Request headers
If successful, this method returns a `200 OK` response code and the single [auth
The following is an example of the request. ```msgraph-interactive
-GET https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizationPolicy
+GET https://graph.microsoft.com/beta/policies/authorizationPolicy
```
v1.0 Calendar List Events https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/calendar-list-events.md
Retrieve a list of events in a calendar. The calendar can be one for a [user](.
To get expanded event instances, you can [get the calendar view](calendar-list-calendarview.md), or [get the instances of an event](event-list-instances.md).
+> [!NOTE]
+> If your target mailbox calendar contains any private items, the caller must either:
+> * Be granted `FullAccess` mailbox permissions over the target mailbox (via the [Add-MailboxPermission](/powershell/module/exchange/add-mailboxpermission) cmdlet).
+> * Be granted the `Delegate` + `CanViewPrivateItems` flags (similar to the previous option, but through the [Add-MailboxFolderPermission](/powershell/module/exchange/add-mailboxfolderpermission) cmdlet). This option routes all meeting requests to the delegate mailbox. For a workaround, see [SharingPermissionFlags](/powershell/module/exchange/add-mailboxfolderpermission?view=exchange-ps#-sharingpermissionflags).
+>
+> Failure to meet these conditions will result in a `The specified object was not found in the store` response.
+ ## Permissions Depending on the type of calendar that the events are in and the permission type (delegated or application) requested, 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 Callrecords Callrecord Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/callrecords-callrecord-get.md
There are two ways to get the **id** of a **callRecord**:
* Subscribe to [change notifications](/graph/api/resources/webhooks) to the `/communications/callRecords` endpoint. * Use the **callChainId** property of a [call](../resources/call.md). The call record is available only after the associated call is completed.
+> [!WARNING]
+>
+> A call record is created after a call or meeting ends and will remain available for **30 days**. Requests for call records older than 30 days will receive a `404 Not Found` response.
+ ## 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.
## Response
-If successful, this method returns a `200 OK` response code and the requested [microsoft.graph.callRecords.callRecord](../resources/callrecords-callrecord.md) object in the response body.
+If successful, this method returns a `200 OK` response code and the requested [microsoft.graph.callRecords.callRecord](../resources/callrecords-callrecord.md) object in the response body. A request for a call record older than 30 days will receive a `404 Not Found` response.
## Examples
GET https://graph.microsoft.com/beta/communications/callRecords/{id}?$expand=ses
#### Response
-The following is an example of the response. If the sessions list is truncated, a `sessions@odata.nextLink` value will be provided to retrieve the next page of sessions.
+The following is an example of the response. If the sessions list is truncated, a `sessions@odata.nextLink` value will be provided to retrieve the next page of sessions. The default page size for sessions is 60 entries.
> **Note:** The response object shown here might be shortened for readability.
v1.0 Cloudpc Getcloudpclaunchinfo https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpc-getcloudpclaunchinfo.md
If successful, this function returns a `200 OK` response code and a [cloudPcLaun
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "cloudpcthis.getcloudpclaunchinfo"
+ "name": "cloudpc.getcloudpclaunchinfo"
} --> ``` http
v1.0 Cloudpc Getshiftworkcloudpcaccessstate https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpc-getshiftworkcloudpcaccessstate.md
+
+ Title: "cloudPC: getShiftWorkCloudPcAccessState"
+description: "Get the access state of a shift work Cloud PC. Callers can get the latest shift work Cloud PC accessState and determine if the shift work Cloud PC is accessible to the user."
+
+ms.localizationpriority: medium
++
+# cloudPC: getShiftWorkCloudPcAccessState
+Namespace: microsoft.graph
++
+Get the [shiftWorkCloudPcAccessState](../resources/cloudpc.md#shiftworkcloudpcaccessstate-values) of a shift work Cloud PC.
+
+This API only supports shared-use licenses. For more information, see [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values). Shared-use licenses allow three users per license, with one user signed in at a time. Callers can get the latest shift work Cloud PC **accessState** and determine whether the shift work Cloud PC is accessible to the user.
+
+If a web client needs to connect to a shift work Cloud PC, the **sharedCloudPcAccessState** validates the bookmark scenario. If **sharedCloudPcAccessState** is not active/activating/hibernated, the web client shows a "bad bookmark".
+
+## 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|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /me/cloudPCs/{cloudPCId}/getShiftWorkCloudPcAccessState
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [shiftWorkCloudPcAccessState](../resources/cloudpc.md#shiftworkcloudpcaccessstate-values) object in the response body.
+
+If the Cloud PC has been provisioned as a dedicated device, this method returns `400 Bad request`.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "cloudpc.getShiftWorkCloudPcAccessState"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/me/cloudPCs/{cloudPCId}/getShiftWorkCloudPcAccessState
+```
+
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "string"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String",
+ "value": "noLicensesAvailable"
+}
+```
+
v1.0 Directory Deleteditems List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directory-deleteditems-list.md
The OData cast type is a required part of the URI and calling `GET /directory/de
## Optional query parameters
-This method supports the query parameters that are supported by the resource that is specified by the OData cast. That is, `$count`, `$expand`, `$filter`, `$orderBy`, `$search`, `$select`, and `$top` query parameters. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For example:
+This method supports the query parameters that are supported by the resource that is specified by the OData cast. That is, `$count`, `$expand`, `$filter`, `$orderBy`, `$search`, `$select`, and `$top` query parameters. This API returns 100 objects by default and supports returning up to 999 objects per page using `$top`.
+
+Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For example:
```msgraph-interactive https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?&$count=true&$orderBy=deletedDateTime desc&$select=id,displayName,deletedDateTime
v1.0 Directoryobject Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-delta.md
GET https://graph.microsoft.com/beta/directoryObjects/delta?filter=isof('microso
- #### Response The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization with `$filter=isof('{resource type}')`. Note the presence of the _members@delta_ property which includes the ids of member objects in the group.
GET https://graph.microsoft.com/beta/directoryObjects/delta?$filter=id eq '87d34
- #### Response The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization with `$filter=id eq '{id}'`.
GET https://graph.microsoft.com/beta/directoryObjects/delta?$filter=isof('micros
- #### Response The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization. Note that both properties are included in the response and it is not known which ones have changed since the `@odata.deltaLink` was obtained.
v1.0 Dynamics Companies Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/dynamics-companies-get.md
Title: Get companies
-description: Gets a company object in Dynamics 365 Business Central.
--
+ Title: "Get companies"
+description: "Get a companies object in Dynamics 365 Business Central."
+
+documentationcenter: ""
+ ms.localizationpriority: medium ms.prod: "dynamics-365-business-central" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve the properties and relationships of a companies object for Dynamics 365 Business Central.
+Get a [companies](../resources/dynamics-companies.md) object in Dynamics 365 Business Central.
## 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)|
One of the following permissions is required to call this API. To learn more, in
|Application|Financials.ReadWrite.All| ## HTTP request+
+<!-- { "blockType": "ignored" } -->
```http GET /financials/companies ``` ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
+
+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response.
## Request headers+ |Header|Value| ||--| |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 **companies** object in the response body.
+
+If successful, this method returns a `200 OK` response code and a [companies](../resources/dynamics-companies.md) object in the response body.
## Example
-**Request**
+### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "ignored",
+ "name": "get_companies"
+}-->
-Here is an example of the request.
```http GET https://graph.microsoft.com/beta/financials/companies ```
-**Response**
+### 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.
+<!-- {
+ "blockType": "ignored",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.companies"
+} -->
+ ```json
+HTTP/1.1 200 OK
+Content-Type: application/json
+ { "id": "id-value", "systemVersion": "17806",
Here is an example of the response.
"businessProfileId": "" } ```--
v1.0 Emailauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication admin
## HTTP request
v1.0 Emailauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Emailauthenticationmethod Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethod-update.md
Update a user's email address associated with an [email Authentication Method](.
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-### Permissions acting on self
-
-|Permission type | Permissions (from least to most privileged) |
-|:|:-|
-| Delegated (work or school account) | UserAuthenticationMethod.ReadWrite |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Not supported. |
-
-### Permissions acting on other users
- |Permission type | Permissions (from least to most privileged) | |:|:-| | Delegated (work or school account) | UserAuthenticationMethod.ReadWrite.All | | Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
+Users without one of the supported Azure AD roles cannot update their own email authentication method.
## HTTP request
v1.0 Emailauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Emailauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Emailauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
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
} ``` -- ### Example 4: Create a policy and specify the stages to trigger pre-defined custom workflow extensions #### Request
Content-type: application/json
} ```
+### Example 5: Create a policy and specify the stages to trigger pre-defined access package custom extensions
+
+#### Request
+
+In the following example, the pre-defined **accessPackageCustomWorkflowExtension** object is triggered when an access package assignment request is created and when it's granted. The identifier provided within the **customExtension** field is the **accessPackageCustomWorkflowExtension** object's ID.
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_accesspackageassignmentpolicy_accessPackageCustomWorkflowExtension"
+}-->
++
+```msgraph-interactive
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies
+Content-type: application/json
+
+{
+ "displayName": "extension-policy",
+ "description": "test",
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "expiration": {
+ "type": "afterDuration",
+ "duration": "P365D"
+ },
+ "canExtend": false,
+ "requestApprovalSettings": null,
+ "requestorSettings": {
+ "acceptRequests": true,
+ "scopeType": "AllExistingDirectorySubjects",
+ "allowedRequestors": [],
+ "isOnBehalfAllowed": false
+ },
+ "accessReviewSettings": null,
+ "questions": [],
+ "customExtensionStageSettings": [
+ {
+ "stage": "assignmentRequestCreated",
+ "customExtension": {
+ "id": "219f57b6-7983-45a1-be01-2c228b7a43f8"
+ }
+ },
+ {
+ "stage": "assignmentRequestGranted",
+ "customExtension": {
+ "id": "219f57b6-7983-45a1-be01-2c228b7a43f8"
+ }
+ }
+ ]
+}
+```
+
+# [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 **customExtensionStageSettings** object isn't returned by default. To retrieve this object, use the **GET** method with `$expand`. For more information, see [Retrieve the custom extension stage settings for a policy](accesspackageassignmentpolicy-get.md#example-3-retrieve-the-custom-extension-stage-settings-for-a-policy)
+
+> **Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentPolicy"
+} -->
+
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "id": "d0324cbb-24a2-4edb-acca-fee5384c6a5e",
+ "displayName": "extension-policy",
+ "description": "test",
+ "canExtend": false,
+ "durationInDays": 0,
+ "expirationDateTime": null,
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "accessReviewSettings": null,
+ "questions": [],
+ "requestorSettings": {
+ "scopeType": "AllExistingDirectorySubjects",
+ "acceptRequests": true,
+ "allowedRequestors": []
+ },
+ "requestApprovalSettings": {
+ "isApprovalRequired": false,
+ "isApprovalRequiredForExtension": false,
+ "isRequestorJustificationRequired": false,
+ "approvalMode": "NoApproval",
+ "approvalStages": []
+ }
+}
+```
+ <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- {
v1.0 Fido2authenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | Not supported. | | Application | Not applicable. | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Fido2authenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Fido2authenticationmethod List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethod-list.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Fido2authenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Fido2authenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Fido2authenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Group Post Groups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-groups.md
The following table shows the properties that are required when you create the [
| :-- | : | :-- | | displayName | string | The name to display in the address book for the group. Maximum length is 256 characters. Required. | | mailEnabled | boolean | Set to `true` for mail-enabled groups. Required. |
-| mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : . <> , SPACE`. Required. |
+| mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : <> , SPACE`. Required. |
| securityEnabled | boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Azure portal always have **securityEnabled** initially set to `true`. | > [!IMPORTANT]
v1.0 Identitygovernance Customtaskextension Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-customtaskextension-delete.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_delete_customtaskextension"
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/customTaskExtensions/2af4670b-47d3-460f-ad16-fc7d4c511d33 ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- ### Response <!-- {
v1.0 Identitygovernance Customtaskextension Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-customtaskextension-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_customtaskextension"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/customTaskExtensions/ffcc4c85-5a14-448e-a390-77abf2700369 ```
-# [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 Identitygovernance Customtaskextension Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-customtaskextension-update.md
One of the following permissions is required to call this API. To learn more, in
> [!IMPORTANT] > The calling user also requires one of the following Azure Resource Manager roles for the specified Azure Logic App: **Logic App contributor**, **Contributor**, or **Owner**.
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this action returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_update_customtaskextension"
Content-length: 588
} ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- ### Response <!-- {
v1.0 Identitygovernance Deleteditemcontainer Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-deletedItemcontainer-delete.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_delete_deleteditems"
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflowId} ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- ### Response <!-- {
v1.0 Identitygovernance Deleteditemcontainer Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-deleteditemcontainer-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_deleteditemcontainer"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/4557805a-1af5-4c29-b271-2cd7fb5de9bf ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_deleteditemcontainer_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/952b23c5-cc25-48c9-8848-95da4dd9dc6d?$select=id,category,displayName,description,version,executionConditions ```
-# [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 Identitygovernance Lifecyclemanagementsettings Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecyclemanagementsettings-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_lifecyclemanagementsettings"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/settings ```
-# [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/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",
- "workflowScheduleIntervalInHours": 1
+ "workflowScheduleIntervalInHours": 1,
+ "emailSettings": {
+ "senderDomain": "ContosoIndustries.net",
+ "useCompanyBranding": true
+ }
} ```
v1.0 Identitygovernance Lifecyclemanagementsettings Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecyclemanagementsettings-update.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
PATCH /identityGovernance/lifecycleWorkflows/settings
|Property|Type|Description| |:|:|:| |workflowScheduleIntervalInHours|Int32|The workflow schedule interval. Required.|
+|emailSettings|[microsoft.graph.emailSettings](../resources/emailsettings.md)|The settings for emails sent from email-specific tasks within a workflow. Required.|
## Response
If successful, this action returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_update_lifecyclemanagementsettings"
Content-Type: application/json
{ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",
- "workflowScheduleIntervalInHours": 3
+ "workflowScheduleIntervalInHours": 3,
+ "emailSettings": {
+ "senderDomain": "ContosoIndustries.net",
+ "useCompanyBranding": true
+ }
} ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- ### Response <!-- { "blockType": "response",
v1.0 Identitygovernance Lifecycleworkflowscontainer List Customtaskextensions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-customtaskextensions.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_customtaskextension"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/customTaskExtensions ```
-# [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 Identitygovernance Lifecycleworkflowscontainer List Deleteditems https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-deleteditems.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_deleteditemcontainer"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
-- #### Response
Content-Type: application/json
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_deleteditemcontainer_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows?$select=id,category,displayName,description,version&$filter=category eq 'leaver' ```
-# [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 Identitygovernance Lifecycleworkflowscontainer List Taskdefinitions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_taskdefinition"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions ```
-# [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
The following is an example of a request. Because the **category** is a flagged enumeration that can be one of `joiner`, `joiner,leaver`, or `leaver`, the `has` operator checks tasks where the category includes "joiner". -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_taskdefinition_filter_category"
The following is an example of a request. Because the **category** is a flagged
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions?$filter=category has 'joiner' ```
-# [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 Identitygovernance Lifecycleworkflowscontainer List Workflows https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-workflows.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflow"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
-- #### Response
Content-Type: application/json
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflow_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows?$filter=category eq 'leaver'&$select=id,category,displayName,isEnabled,isSchedulingEnabled ```
-# [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 Identitygovernance Lifecycleworkflowscontainer List Workflowtemplates https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-workflowtemplates.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflowtemplate"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflowTemplates ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflowtemplate_filter_category"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflowTemplates?$filter=category eq 'leaver' ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- #### Response <!-- {
v1.0 Identitygovernance Lifecycleworkflowscontainer Post Customtaskextensions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-post-customtaskextensions.md
One of the following permissions is required to call this API. To learn more, in
> [!IMPORTANT] > The calling user also requires one of the following Azure Resource Manager roles for the specified Azure Logic App: **Logic App contributor**, **Contributor**, or **Owner**.
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `201 Created` response code and a [microsof
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_create_customtaskextension_from_"
Content-length: 588
} ```
-# [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 Identitygovernance Lifecycleworkflowscontainer Post Workflows https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-post-workflows.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
The following is an example of a request that creates a workflow with the follow
+ It runs for new users that are based in Australia, on their employeeHireDate. + Two tasks are carried out when the workflow runs: the user's account is enabled and a "Welcome" email is sent to the user.
-# [HTTP](#tab/http)
+ <!-- { "blockType": "request", "name": "lifecycleworkflows_create_workflow_from_"
Content-Type: application/json
} ```
-# [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 Identitygovernance Run Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_workflow_run"
The following is an example of a request.
GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/dad77a47-6eda-4de7-bc37-fe8eb5aaf17d ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_workflow_run"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/runs/e65e08a0-d68d-41dc-915b-8c4019af5cc2?$select=id,failedTasksCount,failedUsersCount,processingStatus,totalTasksCount,totalUnprocessedTasksCount,totalUsersCount ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- #### Response
v1.0 Identitygovernance Run List Taskprocessingresults https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-list-taskprocessingresults.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_run_taskprocessingresult"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/a977dbe8-0f3f-4ae6-b3a7-29e1010ac4cc/runs/33bf1a9c-2b26-49b6-996f-ca416c518341/taskProcessingResults ```
-# [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
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_run_taskprocessingresult_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/a977dbe8-0f3f-4ae6-b3a7-29e1010ac4cc/runs/33bf1a9c-2b26-49b6-996f-ca416c518341/taskProcessingResults?$select=id,failureReason,processingStatus,subject ```
-# [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 Identitygovernance Run List Userprocessingresults https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-list-userprocessingresults.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_run_taskprocessingresult"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/dad77a47-6eda-4de7-bc37-fe8eb5aaf17d/userProcessingResults/ ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_run_taskprocessingresult_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/runs/e65e08a0-d68d-41dc-915b-8c4019af5cc2/userProcessingResults?$select=id,failedTasksCount,processingStatus,totalTasksCount,totalUnprocessedTasksCount,subject ```
-# [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 Identitygovernance Run Summary https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-run-summary.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this function returns a `200 OK` response code and a [microsoft.g
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_runthis.summary"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/summary(startDateTime=2022-08-01T00:00:00Z,endDateTime=2022-08-31T00:00:00Z) ```
-# [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 Identitygovernance Task Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-task-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
Content-Type: application/json
The following is an example of a request to get a task from a workflow version.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_workflowVersion_task",
The following is an example of a request to get a task from a workflow version.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/2/tasks/4d9d41d7-a8e1-4f2f-8c8c-a883bc02e6ee ```
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
--- #### Response The following is an example of the response of a request to get a task from a workflow version.
v1.0 Identitygovernance Task Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-task-update.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this action returns a `204 No Content` response code.
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_update_task"
Content-length: 454
} ```
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-- ### Response
v1.0 Identitygovernance Taskdefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-taskdefinition-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_taskdefinition"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions/1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950 ```
-# [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 Identitygovernance Taskprocessingresult Resume https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-taskprocessingresult-resume.md
If successful, this action returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_taskprocessingresultthis.resume"
Content-length: 155
} ```
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
--- ### Response The following is an example of the response.
v1.0 Identitygovernance Taskreport List Taskprocessingresults https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-taskreport-list-taskprocessingresults.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_taskreport_taskprocessingresult"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/taskReports/3a3bea11-99ca-462d-86fb-d283db8d734a/taskProcessingResults ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_taskreport_taskprocessingresult_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/taskReports/443c7611-45df-48c0-bf5e-dc6068c402f0/taskProcessingResults?$select=id,failureReason,processingStatus,subject,task ```
-# [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 Identitygovernance Taskreport Summary https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-taskreport-summary.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_taskreport.summary"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/taskReports/summary(startDateTime=2022-08-19T00:00:00.000Z,endDateTime=2022-08-25T00:33:31.533Z) ```
-# [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 Identitygovernance Userprocessingresult Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-userprocessingresult-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_run_userprocessingresult"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/dad77a47-6eda-4de7-bc37-fe8eb5aaf17d/userProcessingResults/78b83505-6967-4168-a7ea-4921c0543ce9 ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_run_userprocessingresult"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/runs/e65e08a0-d68d-41dc-915b-8c4019af5cc2/userProcessingResults/40efc576-840f-47d0-ab95-5abca800f8a2?$select=id,failedTasksCount,processingStatus,totalTasksCount,totalUnprocessedTasksCount,subject ```
-# [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 Identitygovernance Userprocessingresult List Taskprocessingresults https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-userprocessingresult-list-taskprocessingresults.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflow_userprocessingresult_taskprocessingresult"
The following is an example of a request.
GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/userProcessingResults/78b83505-6967-4168-a7ea-4921c0543ce9/taskProcessingResults ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflow_userprocessingresult_taskprocessingresult_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/userProcessingResults/40efc576-840f-47d0-ab95-5abca800f8a2/taskProcessingResults?$select=id,processingStatus,failureReason,subject,task ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- #### Response
Content-Type: application/json
### Example 3: Get the task processing results for a user processing result in a run report for a workflow -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflow_userprocessingresult_taskprocessingresults"
Content-Type: application/json
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/72885f91-2cf0-44b1-b3ed-bd145af0192c/userProcessingResults/78b83505-6967-4168-a7ea-4921c0543ce9/taskProcessingResults ```
-# [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
The following is an example of a request. --
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflow_userprocessingresult_taskprocessingresults_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/runs/e65e08a0-d68d-41dc-915b-8c4019af5cc2/userProcessingResults/40efc576-840f-47d0-ab95-5abca800f8a2/taskProcessingResults?$select=id,failureReason,processingStatus,subject,task ```
-# [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 Identitygovernance Userprocessingresult Summary https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-userprocessingresult-summary.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this function returns a `200 OK` response code and a [microsoft.g
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_userprocessingresultthis.summary"
The following is an example of a request.
GET https://graph.microsoft.com/beta/IdentityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/userProcessingResults/summary(startDateTime=2022-07-20T00:00:00Z,endDateTime=2022-07-23T00:00:00Z) ```
-# [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 Identitygovernance Workflow Activate https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-activate.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this action returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_workflowthis.activate"
Content-Type: application/json
} ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PHP](#tab/php)
--- ### Response <!-- {
v1.0 Identitygovernance Workflow Createnewversion https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-createnewversion.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this action returns a `200 OK` response code and a [microsoft.gra
## Examples
-### Request
+### Example 1: Create a new version of a workflow
+
+#### Request
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_workflowthis.createnewversion"
Content-length: 631
{ "workflow":{
+ "category": "joiner",
"description": "Configure new hire tasks for onboarding employees on their first day", "displayName": "Global onboard new hire employee", "isEnabled": true,
Content-length: 631
} ```
-# [JavaScript](#tab/javascript)
-# [Java](#tab/java)
+#### Response
-# [Go](#tab/go)
+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.identityGovernance.workflow"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
-# [PHP](#tab/php)
-
+{
+ "workflow":{
+ "category": "joiner",
+ "description": "Configure new hire tasks for onboarding employees on their first day",
+ "displayName": "Global onboard new hire employee",
+ "isEnabled": true,
+ "isSchedulingEnabled": false,
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
+ "rule": "(department eq 'Marketing')"
+ },
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
+ "timeBasedAttribute": "employeeHireDate",
+ "offsetInDays": 1
+ }
+ },
+ "tasks": [
+ {
+ "continueOnError": false,
+ "description": "Enable user account in the directory",
+ "displayName": "Enable User Account",
+ "isEnabled": true,
+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
+ "arguments": []
+ },
+ {
+ "continueOnError": false,
+ "description": "Send welcome email to new hire",
+ "displayName": "Send Welcome Email",
+ "isEnabled": true,
+ "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
+ "arguments": []
+ }
+ ]
+ }
+}
+```
+
+### Example 2: Create a new version of a task with customized email
+
+#### Request
+
+The following is an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "lifecycleworkflows_workflowthis.createnewversion_customemail"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion
+Content-Type: application/json
+Content-length: 631
+
+{
+ "workflow":{
+ "category": "joiner",
+ "description": "Configure new hire tasks for onboarding employees on their first day",
+ "displayName": "Global onboard new hire employee",
+ "isEnabled": true,
+ "isSchedulingEnabled": false,
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
+ "rule": "(department eq 'Marketing')"
+ },
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
+ "timeBasedAttribute": "employeeHireDate",
+ "offsetInDays": 1
+ }
+ },
+ "tasks": [
+ {
+ "continueOnError": false,
+ "description": "Enable user account in the directory",
+ "displayName": "Enable User Account",
+ "isEnabled": true,
+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
+ "arguments": []
+ },
+ {
+ "continueOnError": false,
+ "description": "Send welcome email to new hire",
+ "displayName": "Send Welcome Email",
+ "isEnabled": true,
+ "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
+ "arguments": [
+ {
+ "name": "cc",
+ "value": "1baa57fa-3c4e-4526-ba5a-db47a9df95f0"
+ },
+ {
+ "name": "customSubject",
+ "value": "Welcome to the organization {{userDisplayName}}!"
+ },
+ {
+ "name": "customBody",
+ "value": "Welcome to our organization {{userGivenName}}!"
+ },
+ {
+ "name": "locale",
+ "value": "en-us"
+ }
+ ]
+ }
+ ]
+ }
+}
+```
+
+#### Response
-### Response
The following is an example of the response >**Note:** The response object shown here might be shortened for readability.
Content-Type: application/json
{ "workflow":{
+ "category": "joiner",
"description": "Configure new hire tasks for onboarding employees on their first day", "displayName": "Global onboard new hire employee", "isEnabled": true,
Content-Type: application/json
"displayName": "Send Welcome Email", "isEnabled": true, "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
- "arguments": []
+ "arguments": [
+ {
+ "name": "cc",
+ "value": "b47471b9-af8f-4a5a-bfa2-b78e82398f6e, a7a23ce0-909b-40b9-82cf-95d31f0aaca2"
+ },
+ {
+ "name": "customSubject",
+ "value": "Welcome to the organization {{userDisplayName}}!"
+ },
+ {
+ "name": "customBody",
+ "value": "Welcome to our organization {{userGivenName}} {{userSurname}}. \nFor more information, reach out to your manager {{managerDisplayName}} at {{managerEmail}}."
+ },
+ {
+ "name": "locale",
+ "value": "en-us"
+ },
+ ]
} ] }
v1.0 Identitygovernance Workflow Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-delete.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_delete_workflow"
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/4c9c57b9-e1e9-4bed-a936-4fad9d8f5638 ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- ### Response <!-- {
v1.0 Identitygovernance Workflow Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_workflow"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390 ```
-# [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
} ``` - ### Example 2: Retrieve specific properties of a workflow #### Request
v1.0 Identitygovernance Workflow List Runs https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-runs.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_run"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/ ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_run_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/runs?$select=id,failedTasksCount,failedUsersCount,processingStatus,totalTasksCount,totalUnprocessedTasksCount,totalUsersCount,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 Identitygovernance Workflow List Task https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-task.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
v1.0 Identitygovernance Workflow List Taskreports https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-taskreports.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_taskreport"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/taskReports ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_taskreport_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/taskReports?$select=id,failedUsersCount,processingStatus,successfulUsersCount,totalUsersCount,unprocessedUsersCount,taskDefinition,taskProcessingResults ```
-# [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 Identitygovernance Workflow List Userprocessingresults https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-userprocessingresults.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_userprocessingresult"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/userProcessingResults ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_userprocessingresult_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/userProcessingResults?$select=id,failedTasksCount,processingStatus,totalTasksCount,totalUnprocessedTasksCount,workflowExecutionType,subject ```
-# [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 Identitygovernance Workflow List Versions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-list-versions.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflowversion"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflowversion_select"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/versions?$select=category,displayName,versionNumber ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- #### Response <!-- {
v1.0 Identitygovernance Workflow Restore https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-restore.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this action returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_workflowthis.restore"
The following is an example of a request.
POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/4c9c57b9-e1e9-4bed-a936-4fad9d8f5638/restore ```
-# [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 Identitygovernance Workflow Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflow-update.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Lifecycle workflows administrator ## HTTP request
If successful, this action returns a `204 No Content` response code.
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_update_workflow"
Content-length: 454
} ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
-- ### Response
v1.0 Identitygovernance Workflowtemplate Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflowtemplate-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_workflowtemplate"
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflowTemplates/77179007-8114-41b5-922e-2e22109df41f ```
-# [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 Identitygovernance Workflowversion Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflowversion-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_workflowversion",
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/3 ```
-# [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
The following is an example of a request. -
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_get_workflowversion_select",
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/versions/2?$select=category,displayName,versionNumber,executionConditions&$expand=tasks ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-
-# [PHP](#tab/php)
--- #### Response <!-- { "blockType": "response",
v1.0 Identitygovernance Workflowversion List Tasks https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identitygovernance-workflowversion-list-tasks.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "lifecycleworkflows_list_workflowversion_task",
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/2/tasks ```
-# [JavaScript](#tab/javascript)
-
-# [Java](#tab/java)
--- ### Response The following is an example of the response
v1.0 Industrydata Azuredatalakeconnector Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-azuredatalakeconnector-delete.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_azuredatalakeconnector",
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/external/industryData/dataConnectors/8c010e87-c28b-4350-bdc1-65ec29258b93 ```
+# [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 Industrydata Azuredatalakeconnector Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-azuredatalakeconnector-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_azuredatalakeconnector",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/dataConnectors/51dca0a0-85f6-4478-f526-08daddab2271 ```
+# [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 Industrydata Azuredatalakeconnector Getuploadsession https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-azuredatalakeconnector-getuploadsession.md
If successful, this function returns a `200 OK` response code and a [microsoft.g
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "azuredatalakeconnectorthis.getuploadsession",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/dataConnectors/51dca0a0-85f6-4478-f526-08daddab2271/microsoft.graph.industryData.azureDataLakeConnector/getUploadSession ```
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+++ ### Response The following is an example of the response.
v1.0 Industrydata Azuredatalakeconnector List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-azuredatalakeconnector-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_azuredatalakeconnector" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/dataConnectors ```
+# [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 Industrydata Azuredatalakeconnector Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-azuredatalakeconnector-post.md
If successful, this method returns a `201 Created` response code and a [microsof
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_azureDataLakeConnector_from_dataConnectors"
Content-length: 104
} ```
+# [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 Industrydata Azuredatalakeconnector Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-azuredatalakeconnector-update.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_azuredatalakeconnector",
Content-type: application/json
} ```
+# [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 Industrydata Filevalidateoperation Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-filevalidateoperation-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_fileValidateOperation",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/operations/581b2ef8-dda2-4a3e-bb62-df13fd4a5808 ```
+# [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 Industrydata Filevalidateoperation List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-filevalidateoperation-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_fileValidateOperation" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/operations ```
+# [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 Industrydata Inboundfileflow Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundfileflow-delete.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_inboundflow"
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/external/industryData/inboundFlows/7bd62d17-8c37-4494-f68d-08daddab2911 ```
+# [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 Industrydata Inboundfileflow Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundfileflow-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_inboundflow",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/inboundFlows/7bd62d17-8c37-4494-f68d-08daddab2911 ```
+# [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 Industrydata Inboundfileflow List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundfileflow-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_inboundflow" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/inboundFlows ```
+# [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 Industrydata Inboundfileflow Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundfileflow-post.md
If successful, this method returns a `201 Created` response code and a [microsof
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_inboundfileflow_from_inboundflows"
Content-length: 246
} ```
+# [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 Industrydata Inboundfileflow Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundfileflow-update.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_inboundfileflow"
Content-length: 246
} ```
+# [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 Industrydata Inboundflow Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundflow-delete.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_inboundflow",
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/external/industryData/inboundFlows/0c629a1a-a85c-4365-bdf0-623a32ca69cb ```
+# [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 Industrydata Inboundflow Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundflow-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_inboundflow",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/inboundFlows/7bd62d17-8c37-4494-f68d-08daddab2911 ```
+# [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 Industrydata Inboundflow List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundflow-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_inboundflow" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/inboundFlows ```
+# [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 Industrydata Inboundflow Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundflow-post.md
If successful, this method returns a `201 Created` response code and a [microsof
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_inboundflow_from_inboundFlows"
Content-length: 246
} ```
+# [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 Industrydata Inboundflow Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-inboundflow-update.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_inboundfileflow"
Content-length: 246
} ```
+# [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 Industrydata Industrydataconnector Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydataconnector-delete.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_azuredatalakeconnector",
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/external/industryData/dataConnectors/8c010e87-c28b-4350-bdc1-65ec29258b93 ```
+# [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 Industrydata Industrydataconnector Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydataconnector-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_azuredatalakeconnector",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/dataConnectors/51dca0a0-85f6-4478-f526-08daddab2271 ```
+# [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 Industrydata Industrydataconnector List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydataconnector-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_azuredatalakeconnector" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/dataConnectors ```
+# [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 Industrydata Industrydataconnector Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydataconnector-post.md
If successful, this method returns a `201 Created` response code and a [microsof
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_industrydataconnector_from_dataConnectors"
Content-length: 104
} ```
+# [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 Industrydata Industrydataconnector Validate https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydataconnector-validate.md
If successful, this action returns a `202 Accepted` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "industrydataconnectorthis.validate",
The following is an example of a request.
POST https://graph.microsoft.com/beta/external/industryData/dataConnectors/8c010e87-c28b-4350-bdc1-65ec29258b93/validate ```
+# [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 Industrydata Industrydatarun Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydatarun-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_industrydatarun",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/runs/918d4a8f-599b-4f6a-b409-e892855db534 ```
+# [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 Industrydata Industrydatarun Getstatistics https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydatarun-getstatistics.md
If successful, this function returns a `200 OK` response code and a [microsoft.g
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "industrydatarunthis.getstatistics",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/runs/918d4a8f-599b-4f6a-b409-e892855db534/getStatistics ```
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+++ ### Response The following is an example of the response.
v1.0 Industrydata Industrydatarun List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-industrydatarun-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_industrydatarun" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/runs ```
+# [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 Industrydata Referencedefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-referencedefinition-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_referencedefinition",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/referenceDefinitions/RefAcademicSubject-01 ```
+# [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 Industrydata Referencedefinition List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-referencedefinition-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_referencedefinition" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/referenceDefinitions ```
+# [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 Industrydata Rolegroup Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-rolegroup-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_rolegroup",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/roleGroups/students ```
+# [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 Industrydata Rolegroup List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-rolegroup-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_rolegroup" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/roleGroups ```
+# [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 Industrydata Sourcesystemdefinition Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-sourcesystemdefinition-delete.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_sourcesystemdefinition_from_",
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/external/industryData/sourceSystems/0c629a1a-a85c-4365-bdf0-623a32ca69cb ```
+# [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 Industrydata Sourcesystemdefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-sourcesystemdefinition-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_sourcesystemdefinition",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/sourceSystems/0190210e-8827-4747-6f2b-08dacc885e72 ```
+# [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 Industrydata Sourcesystemdefinition List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-sourcesystemdefinition-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_sourcesystemdefinition" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/sourceSystems ```
+# [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 Industrydata Sourcesystemdefinition Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-sourcesystemdefinition-post.md
If successful, this method returns a `201 Created` response code and a [microsof
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_sourcesystemdefinition_from_sourceSystems"
Content-length: 250
} ```
+# [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 Industrydata Sourcesystemdefinition Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-sourcesystemdefinition-update.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_sourcesystemdefinition",
Content-length: 250
} ```
+# [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 Industrydata Yeartimeperioddefinition Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-yeartimeperioddefinition-delete.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_yearTimePeriodDefinition_from_",
The following is an example of a request.
DELETE https://graph.microsoft.com/beta/external/industryData/years/0c629a1a-a85c-4365-bdf0-623a32ca69cb ```
+# [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 Industrydata Yeartimeperioddefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-yeartimeperioddefinition-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_yeartimeperioddefinition",
The following is an example of a request.
} -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/years/ebf18762-ab92-487e-21d1-08daddab28bb ```
+# [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 Industrydata Yeartimeperioddefinition List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-yeartimeperioddefinition-list.md
If successful, this method returns a `200 OK` response code and a collection of
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_yearTimePeriodDefinition" } -->
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/external/industryData/years ```
+# [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 Industrydata Yeartimeperioddefinition Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-yeartimeperioddefinition-post.md
If successful, this method returns a `201 Created` response code and a [microsof
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_yeartimeperioddefinition_from_years"
Content-length: 242
} ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response The following is an example of the response.
v1.0 Industrydata Yeartimeperioddefinition Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/industrydata-yeartimeperioddefinition-update.md
If successful, this method returns a `204 No Content` response code.
The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_yeartimeperioddefinition",
Content-length: 242
} ```
+# [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 Microsoftauthenticatorauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Microsoftauthenticatorauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Microsoftauthenticatorauthenticationmethod List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethod-list.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Microsoftauthenticatorauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Microsoftauthenticatorauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Microsoftauthenticatorauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Oauth2permissiongrant List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/oauth2permissiongrant-list.md
GET https://graph.microsoft.com/beta/oauth2PermissionGrants
[!INCLUDE [sample-code](../includes/snippets/go/list-oauth2permissiongrants-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
-# [PowerShell](#tab/powershell)
- # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-oauth2permissiongrants-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Organization Activateservice https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organization-activateservice.md
- Title: "organization: activateService"
-description: "Activates a service for an organization."
-
-doc_type: apiPageType
--
-# organization: activateService (deprecated)
-
-Namespace: microsoft.graph
--
-> [!CAUTION]
-> The **activateService** API is deprecated and will stop returning data on June 30, 2022.
-
-Activate a service for 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).
-
-In order to activate a service for an organization the requestor needs to have the _Company Administrator_ role with the following permissions.
-
-|Permission type|Permissions (from least to most privileged)|
-| : | : |
-| Delegated (work or school account) | Directory.ReadWrite.All|
-| Delegated (personal Microsoft account) | Not Supported. |
-| Application | Directory.ReadWrite.All|
--
-## HTTP request
-
-<!-- {
- "blockType": "ignored"
-}
>
-``` http
-POST /organization/{organizationId}/activateService
-```
-
-## 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 [activateService](../resources/activateService.md) object.
-You must define **service** or (**servicePlanId** _and_ **skuId**) for this action to be valid.
-
-| Property | Type | Description |
-| -- | | - |
-| service| String | The name of the service to activate. |
-| servicePlanId | Guid | The plan identifier of the service plan to activate. |
-| skuId | Guid | The SKU identifier of the service plan. |
-
-## Response
-
-If successful, this action returns a `204 No Content` response code.
-
-## Examples
-
-### Request
-
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "organization_activateservice"
-}
>
-``` http
-POST https://graph.microsoft.com/beta/organization/{:organizationId}/activateService
-Content-Type: application/json
-
-{
- "skuId": "6fd2c87f-b296-42f0-b197-1e91e994b900",
- "servicePlanId": "a23b959c-7ce8-4e57-9140-b90eb88a9e97"
-}
-```
-
-# [JavaScript](#tab/javascript)
---
-### Response
-<!-- {
- "blockType": "response",
- "truncated": true
-}
>
-``` http
-HTTP/1.1 204 No Content
-```
v1.0 Organizationalbranding Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbranding-get.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) | User.Read, Organization.Read.All, User.ReadBasic.All, User.Read.All |
+| Delegated (work or school account) | User.Read, Organization.Read.All, User.Read.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Organization.Read.All |
v1.0 Organizationalbranding List Localizations https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbranding-list-localizations.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) | User.Read, Organization.Read.All, User.ReadBasic.All, User.Read.All |
+| Delegated (work or school account) | User.Read, Organization.Read.All, User.Read.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Organization.Read.All |
v1.0 Organizationalbrandinglocalization Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbrandinglocalization-get.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) | User.Read, Organization.Read.All, User.ReadBasic.All, User.Read.All |
+| Delegated (work or school account) | User.Read, Organization.Read.All, User.Read.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Organization.Read.All |
v1.0 Passwordauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Passwordlessmicrosoftauthenticatorauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Passwordlessmicrosoftauthenticatorauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Passwordlessmicrosoftauthenticatorauthenticationmethod List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethod-list.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|Not supported.|
-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
v1.0 Passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|Not supported.|
-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
v1.0 Passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|Not supported.|
-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
v1.0 Phoneauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/phoneauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Phoneauthenticationmethod Disablesmssignin https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/phoneauthenticationmethod-disablesmssignin.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Phoneauthenticationmethod Enablesmssignin https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/phoneauthenticationmethod-enablesmssignin.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Phoneauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/phoneauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Phoneauthenticationmethod Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/phoneauthenticationmethod-update.md
If a user is enabled by policy to use SMS to sign in and the `mobile` number is
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-### Permissions acting on self
-
-|Permission type | Permissions (from least to most privileged) |
-|:|:-|
-| Delegated (work or school account) | UserAuthenticationMethod.ReadWrite |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Not supported. |
-
-### Permissions acting on other users
- |Permission type | Permissions (from least to most privileged) | |:|:-| | Delegated (work or school account) | UserAuthenticationMethod.ReadWrite.All | | Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
+
+Users without one of the supported Azure AD roles cannot update their own phone authentication method.
## HTTP request <!-- { "blockType": "ignored" } --> ```http
-PATCH /me/authentication/phoneMethods/{id}
PATCH /users/{id | userPrincipalName}/authentication/phoneMethods/{id} ``` The value of `id` corresponding to the phoneType to update is one of the following:
v1.0 Plannerbucket Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerbucket-delta.md
+
+ Title: "plannerBucket: delta"
+description: "Get newly created, updated, or deleted buckets in a Planner plan without having to perform a full read of the entire resource collection."
+
+ms.localizationpriority: medium
++
+# plannerBucket: delta
+
+Namespace: microsoft.graph
++
+Get newly created, updated, or deleted [buckets](../resources/plannerbucket.md) in a Planner [plan](../resources/plannerplan.md) without having to perform a full read of the entire resource collection. For details, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview).
+
+## 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) | Tasks.Read |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Tasks.Read.All |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /planner/plans/{plan-id}/buckets/delta
+```
+
+## Query parameters
+
+Tracking changes incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltaToken` and `$skipToken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. You only need to specify any query parameters once upfront. In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response. That URL already includes the encoded parameters.
+
+| Query parameter | Type | Description |
+| :-- | :-- | :-- |
+| $deltaToken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call for the same resource collection, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL, including this token in the first request of the next round of change tracking for that collection. |
+| $skipToken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating there are further changes to be tracked in the same resource collection. |
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [plannerBucket](../resources/plannerbucket.md) collection in the response body. The response also includes a `@odata.nextLink` or a `@odata.deltaLink` URL.
+
+- A `@odata.nextLink` URL in the response object indicates additional pages of data to be retrieved in the session. The application continues making requests using the `@odata.nextLink` URL until a `@odata.deltaLink` URL is included in the response.
+
+- A `@odata.deltaLink` URL in the response object indicates that no more data about the existing state of the resource is returned. Persist and use the `@odata.deltaLink` URL to learn about changes to the resource in the future.
+
+For more details, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview). For an example that shows how to track changes to users, see [Get incremental changes for users](/graph/delta-query-users).
+
+## Examples
+
+The following example shows a request for delta on **plannerBucket** objects contained by a **plannerPlan**.
+
+### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "plannerbucketthis.delta",
+ "sampleKeys": ["-W4K7hIak0WlAwgJCn1sEWQABgjH"]
+}
+-->
+
+```http
+GET https://graph.microsoft.com/beta/planner/plans/-W4K7hIak0WlAwgJCn1sEWQABgjH/buckets/delta
+```
+
+### 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.plannerBucket)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerBucket",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/buckets?deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
+ "value": [
+ {
+ "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
+ "id": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
+ "name": "This is a bucket",
+ "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
+ "orderHint": "8585371316800245114P\\"
+ }
+ ]
+}
+```
v1.0 Plannerbucket Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerbucket-get.md
Title: "Get plannerBucket"
-description: "Retrieve the properties and relationships of **plannerBucket** object."
+description: "Retrieve the properties and relationships of a plannerBucket object."
ms.localizationpriority: medium ms.prod: "planner"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve the properties and relationships of **plannerBucket** object.
+Retrieve the properties and relationships of a [plannerBucket](../resources/plannerbucket.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).
Do not supply a request body for this method.
## Response
-If successful, this method returns a `200 OK` response code and [plannerBucket](../resources/plannerbucket.md) object in the response body.
+If successful, this method returns a `200 OK` response code and a [plannerBucket](../resources/plannerbucket.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/buckets/hsOf2dhOJkqyYYZEtdzDe2QAIUC
-##### 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 Plannerplan Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannerplan-delta.md
+
+ Title: "plannerPlan: delta"
+description: "Get newly created, updated, or deleted Planner plans in either a group or a Planner roster without having to perform a full read of the entire resource collection."
+
+ms.localizationpriority: medium
++
+# plannerPlan: delta
+
+Namespace: microsoft.graph
++
+Get newly created, updated, or deleted Planner [plans](../resources/plannerplan.md) in either a [group](../resources/group.md) or a Planner [roster](../resources/plannerroster.md) without having to perform a full read of the entire resource collection. For details, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview).
+
+## 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) | Tasks.Read |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Tasks.Read.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /planner/rosters/{plannerRosterId}/plans/delta
+GET /groups/{group-id}/planner/plans/delta
+```
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [plannerPlan](../resources/plannerplan.md) collection in the response body.
+
+## Examples
+
+### Example 1: Get delta on plans in a plannerRoster
+
+The following example shows a request for delta on **plannerPlan** objects contained by a **plannerRoster**.
+
+#### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "plannerplanthis.delta",
+ "sampleKeys": ["-W4K7hIak0WlAwgJCn1sEWQABgjH"]
+}
+-->
+
+```http
+GET https://graph.microsoft.com/beta/planner/rosters/-W4K7hIak0WlAwgJCn1sEWQABgjH/plans/delta
+```
+
+#### 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.plannerPlan)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerBucket",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/rosters/('-W4K7hIak0WlAwgJCn1sEWQABgjH')/plans?deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
+ "value": [
+ {
+ "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+ "title": "Test plan",
+ "container": {
+ "@odata.type": "microsoft.graph.plannerPlanContainer",
+ "url": "https://graph.microsoft.com/beta/planner/rosters/-W4K7hIak0WlAwgJCn1sEWQABgjH",
+ "containerId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
+ "type": "roster"
+ }
+ }
+ ]
+}
+```
+
+### Example 2: Get delta on plans in a group
+
+The following example shows a request for delta on **plannerPlan** objects contained by a group.
+
+#### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "plannerplanthis.delta",
+ "sampleKeys": ["ebf3b108-5234-4e22-b93d-656d7dae5874"]
+}
+-->
+
+```http
+GET https://graph.microsoft.com/beta/groups/ebf3b108-5234-4e22-b93d-656d7dae5874/planner/plans/delta
+```
+
+#### 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.plannerPlan)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerBucket",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/groups/('ebf3b108-5234-4e22-b93d-656d7dae5874')/planner/plans?deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
+ "value": [
+ {
+ "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
+ "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+ "title": "Test plan",
+ "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"
+ }
+ }
+ ]
+}
+```
v1.0 Plannertask Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/plannertask-delta.md
+
+ Title: "plannerTask: delta"
+description: "Get newly created, updated, or deleted tasks in either a Planner plan or assigned to the signed-in user without having to perform a full read of the entire resource collection."
+
+ms.localizationpriority: medium
++
+# plannerTask: delta
+
+Namespace: microsoft.graph
++
+Get newly created, updated, or deleted [tasks](../resources/plannertask.md) in either a Planner [plan](../resources/plannerplan.md) or assigned to the signed-in user without having to perform a full read of the entire resource collection. For details, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview).
+
+## 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) | Tasks.Read |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Tasks.Read.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /planner/tasks/delta
+GET /me/planner/tasks/delta
+```
+
+## Query parameters
+
+Tracking changes incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltaToken` and `$skipToken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. You only need to specify any query parameters once upfront. In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response. That URL already includes the encoded parameters.
+
+| Query parameter | Type | Description |
+| :-- | :-- | :-- |
+| $deltaToken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call for the same resource collection, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL, including this token in the first request of the next round of change tracking for that collection. |
+| $skipToken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating there are further changes to be tracked in the same resource collection. |
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [plannerTask](../resources/plannertask.md) collection in the response body.
+
+## Examples
+
+### Example 1: Get delta on tasks in a plannerPlan
+
+The following example shows a request for the delta on **plannerTask** objects in a **plannerPlan**.
+
+#### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "plannertaskthis.delta"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/beta/planner/tasks/delta
+```
+
+#### 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.plannerTask)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
+ "value": [
+ {
+ "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
+ "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
+ "createdByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ },
+ "application": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
+ }
+ },
+ "userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "userContentLastModifiedByApp": null,
+ "userContentLastModifiedByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ }
+ },
+ "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
+ "bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
+ "title": "Testing",
+ "orderHint": "8585371316800245114P\\",
+ "assigneePriority": "8585371316123370883",
+ "focusDateTime": null,
+ "percentComplete": 0,
+ "startDateTime": null,
+ "createdDateTime": "2022-09-29T18:14:25.6091874Z",
+ "userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
+ "dueDateTime": null,
+ "recurrence": null,
+ "hasDescription": false,
+ "previewType": "automatic",
+ "completedDateTime": null,
+ "completedBy": null,
+ "completedByApp": null,
+ "completedByAsIdentitySet": null,
+ "referenceCount": 0,
+ "checklistItemCount": 0,
+ "activeChecklistItemCount": 0,
+ "appliedCategories": {},
+ "assignments": {
+ "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
+ "@odata.type": "#microsoft.taskServices.assignment",
+ "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "assignedByAppId": null,
+ "assignedByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ }
+ },
+ "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
+ "orderHint": "8585371316723527019PX",
+ "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "createdByAppId": null,
+ "createdByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ }
+ }
+ }
+ },
+ "conversationThreadId": null,
+ "priority": 5,
+ "creationSource": {
+ "publication": null,
+ "externalSource": null
+ },
+ "creationSourceInfo": null,
+ "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
+ "version": "1-Task @@@@@@@@@@@@@@@H",
+ "details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
+ "details": {
+ "@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
+ "description": "",
+ "notes": null,
+ "previewType": "automatic",
+ "references": {},
+ "checklist": {},
+ "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
+ "version": "1-TaskDetails @@@@@@@@@@@@@@@D"
+ }
+ }
+ ]
+}
+```
+
+### Example 2: Get delta on tasks assigned to a user
+
+The following example shows a request for the delta on **plannerTask** objects assigned to a user.
+
+#### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "plannertaskthis.delta"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/beta/me/planner/tasks/delta
+```
+
+#### 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.plannerTask)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/me/planner/tasks/delta?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
+ "value": [
+ {
+ "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
+ "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
+ "createdByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ },
+ "application": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
+ }
+ },
+ "userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "userContentLastModifiedByApp": null,
+ "userContentLastModifiedByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ }
+ },
+ "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
+ "bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
+ "title": "Testing",
+ "orderHint": "8585371316800245114P\\",
+ "assigneePriority": "8585371316123370883",
+ "focusDateTime": null,
+ "percentComplete": 0,
+ "startDateTime": null,
+ "createdDateTime": "2022-09-29T18:14:25.6091874Z",
+ "userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
+ "dueDateTime": null,
+ "recurrence": null,
+ "hasDescription": false,
+ "previewType": "automatic",
+ "completedDateTime": null,
+ "completedBy": null,
+ "completedByApp": null,
+ "completedByAsIdentitySet": null,
+ "referenceCount": 0,
+ "checklistItemCount": 0,
+ "activeChecklistItemCount": 0,
+ "appliedCategories": {},
+ "assignments": {
+ "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
+ "@odata.type": "#microsoft.taskServices.assignment",
+ "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "assignedByAppId": null,
+ "assignedByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ }
+ },
+ "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
+ "orderHint": "8585371316723527019PX",
+ "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
+ "createdByAppId": null,
+ "createdByAsIdentitySet": {
+ "user": {
+ "@odata.type": "#microsoft.taskServices.identity",
+ "displayName": null,
+ "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
+ }
+ }
+ }
+ },
+ "conversationThreadId": null,
+ "priority": 5,
+ "creationSource": {
+ "publication": null,
+ "externalSource": null
+ },
+ "creationSourceInfo": null,
+ "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
+ "version": "1-Task @@@@@@@@@@@@@@@H",
+ "details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
+ "details": {
+ "@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
+ "description": "",
+ "notes": null,
+ "previewType": "automatic",
+ "references": {},
+ "checklist": {},
+ "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
+ "version": "1-TaskDetails @@@@@@@@@@@@@@@D"
+ }
+ },
+ ]
+}
+```
v1.0 Reportroot Getteamsteamcounts https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-getteamsteamcounts.md
+
+ Title: "reportRoot: getTeamsTeamCounts"
+description: "Get the number of teams of a particular type in an instance of Microsoft Teams."
+ms.localizationpriority: medium
+++
+# reportRoot: getTeamsTeamCounts
+
+Namespace: microsoft.graph
++
+Get the number of teams of a particular type in an instance of Microsoft Teams.
+
+## 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) | Reports.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Reports.Read.All |
+
+> **Note:** For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure Active Directory limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /reports/getTeamsTeamCounts(period='{period_value}')
+```
+
+## Function parameters
+
+In the request URL, provide the following parameters with a valid value.
+
+| Parameter | Type | Description |
+| :-- | :-- | : |
+| period | string | Specifies the length of time over which the report is aggregated. The supported values for {period_value} are: `D7`, `D30`, `D90`, and `D180`. These values follow the format D*n*, where *n* represents the number of days over which the report is aggregated. Required. |
+
+> **Note:** You need to set either **period** or **date** in the request URL.
+## Optional query parameters
+
+This method supports the `$format` [OData query parameter](/graph/query-parameters) to customize the response. The default output type is `text/csv`. However, if you want to specify the output type, you can use the OData `$format` query parameter to set the default output to `text/csv` or `application/json`.
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+### CSV
+
+If successful, this method returns a `302 Found` response that redirects to a pre-authenticated download URL for the report. That URL can be found in the `Location` header in the response.
+
+Pre-authenticated download URLs are only valid for a short period (a few minutes) and do not require an `Authorization` header.
+
+The CSV file has the following headers for columns:
+
+- Report Refresh Date
+- Report Date
+- Public Teams
+- Active Public Teams
+- Private Teams
+- Active Private Teams
+
+### JSON
+
+If successful, this method returns a `200 OK` response code and a JSON object in the response body.
+
+## Examples
+
+### Example 1: CSV output
+
+The following is an example that outputs CSV.
+
+#### Request
+
+The following is an example of a request.
+
+<!-- {
+ "blockType": "ignored",
+ "name": "reportroot_getteamsteamcounts_csv"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=text/csv
+```
++
+#### Response
+
+The following is an example of the response.
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+HTTP/1.1 302 Found
+Content-Type: text/plain
+Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe
+```
+
+Follow the 302 redirection and the CSV file that downloads will have the following schema.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "stream"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/octet-stream
+Report Refresh Date,Report Date,Public Teams,Active Public Teams,Private Teams,Active Private Teams,
+```
+
+### Example 2: JSON output
+
+The following is an example that returns JSON.
+
+#### Request
+
+The following is an example of a request.
+
+<!-- {
+ "blockType": "ignored",
+ "name": "reportroot_getteamsteamcounts_json"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=application/json
+```
++
+#### 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": "stream"
+} -->
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 641
+{
+ "@odata.context": "https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$format=application/json&$skiptoken=D07uj",
+ "value": [
+ {
+ "reportRefreshDate": "2021-09-01",
+ "reportPeriod":7,
+ "teamsTeamUsageByDate": [
+ {
+ "reportDate": "2022-08-01",
+ "publicTeams": 26,
+ "privateTeams": 17,
+ "activePublicTeams": 20,
+ "activePrivateTeams": 12
+ }
+ ]
+ }
+ ]
+}
+```
+<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
+2015-10-25 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Example",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ ]
+}-->
v1.0 Riskyserviceprincipal List History https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyserviceprincipal-list-history.md
GET https://graph.microsoft.com/beta/identityProtection/riskyServicePrincipals/{
[!INCLUDE [sample-code](../includes/snippets/go/list-riskyserviceprincipalhistoryitem-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
-# [PowerShell](#tab/powershell)
- # [PHP](#tab/php) [!INCLUDE [sample-code](../includes/snippets/php/list-riskyserviceprincipalhistoryitem-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Search Query https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-query.md
If successful, this method returns an `HTTP 200 OK` response code and a collecti
## Examples
-### Request
+### Example 1: Basic call to perform a search request
+
+The following example shows how to perform a search to get expected connector items.
+
+#### Request
-The following is an example of the request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "search_query"
+ "name": "query"
}--> ```HTTP
Content-type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] ### Response
-The following is an example of the response.
+The following example shows the response.
> **Note:** The response object shown here might be shortened for readability.
Content-type: application/json
} ```
+### Example 2: Basic call to use queryTemplate
+
+The following example shows how to use the queryable property **createdBy** to retrieve all files created by a user.
+
+#### Request
+
+```HTTP
+POST https://graph.microsoft.com/beta/search/query
+Content-type: application/json
+
+{
+ "requests": [
+ {
+ "entityTypes": [
+ "listItem"
+ ],
+ "query": {
+ "queryString": "contoso",
+ "queryTemplate":"{searchTerms} CreatedBy:Bob"
+ },
+ "from": 0,
+ "size": 25
+ }
+ ]
+}
+```
+
+### Response
+
+The following example shows the response.
+
+```HTTP
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "value": [
+ {
+ "searchTerms": [
+ "contoso"
+ ],
+ "hitsContainers": [
+ {
+ "hits": [
+ {
+ "hitId": "1",
+ "rank": 1,
+ "summary": "_summary-value",
+ "resource": {
+ "@odata.type": "#microsoft.graph.listItem",
+ "id": "c23c7035-73d6-4bad-8901-9e2930d4be8e",
+ "createdBy": {
+ "user": {
+ "displayName": "Bob",
+ "email": "Bob@contoso.com"
+ }
+ },
+ "createdDateTime": "2021-11-19T17:04:18Z",
+ "lastModifiedDateTime": "2023-03-09T18:52:26Z"
+ }
+ }
+ ],
+ "total": 1,
+ "moreResultsAvailable": false
+ }
+ ]
+ }
+ ]
+}
+```
+ ## See also - Search [mail messages](/graph/search-concept-messages)
Content-type: application/json
- Search [person](/graph/search-concept-person) - Search content in SharePoint and OneDrive ([files, lists and sites](/graph/search-concept-files)) - Search [custom types (Graph Connectors)](/graph/search-concept-custom-types) data
+- Search with [queryTemplate](/graph/search-concept-query-template)
- [Sort](/graph/search-concept-sort) search results - Use [aggregations](/graph/search-concept-aggregation) to refine search results - Enable [spell corrections](/graph/search-concept-speller) in search results
v1.0 Security Ediscoveryexportoperation Getdownloadurl https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-ediscoveryexportoperation-getdownloadurl.md
Title: "ediscoveryExportOperation: getDownloadUrl"
-description: "return a downloadUrl from where the export content is delivered as a stream"
+ Title: "ediscoveryExportOperation: getDownloadUrl (deprecated)"
+description: "Return a download URL from where the export content is delivered as a stream."
ms.localizationpriority: medium ms.prod: "ediscovery" doc_type: "apiPageType"
-# ediscoveryExportOperation: getDownloadUrl
+# ediscoveryExportOperation: getDownloadUrl (deprecated)
+ Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-If a Azure blob url is not provided in export action, the export operation exports the files to an internal store. Contents of this store can be fetched by calling into this function. This will return a downloadUrl where the zipped content is delivered as a stream.
+> [!CAUTION]
+> The **getDownloadUrl** function is deprecated and will stop returning data on April 30th, 2023. Please use the new **exportFileMetadata** property returned by the [Get caseOperation](../api/security-ediscoverycase-get.md) API instead.
+
+If an Azure blob URL is not provided in export action, the export operation exports the files to an internal store. Contents of this store can be fetched by calling into this function. This returns a download URL where the zipped content is delivered as a stream.
## Permissions
v1.0 Security Ediscoveryreviewset Export https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-ediscoveryreviewset-export.md
The following table shows the parameters that can be used with this action.
|Parameter|Type|Description| |:|:|:|
-|outputName|String| Name of the export. Required. |
-|description|String| Description of the export |
-|azureBlobContainer|String| when you export to your own Azure storage account, this is the container URL. |
-|azureBlobToken|String| when you export to your own Azure storage account, SAS token for the container URL. |
-|exportOptions|String|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`.|
+|description|String| Description of the export. |
+|exportOptions|String|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`. The `fileInfo` member is deprecated and will stop returning data on April 30th, 2023. Going forward, the summary and load file are always included.|
|exportStructure|String| Options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`.|
+|outputName|String| Name of the export. Required. |
+|azureBlobContainer (deprecated)|String| When you export to your own Azure storage account, this is the container URL. The **azureBlobContainer** property is deprecated and will stop returning data on April 30th, 2023. |
+|azureBlobToken (deprecated)|String| When you export to your own Azure storage account, SAS token for the container URL. The **azureBlobToken** property is deprecated and will stop returning data on April 30th, 2023. |
+ ## Response If the export has started successfully, this action returns a `202 Accepted` response code. The response will also contain a `Location` header, which contains the location of the [Export operation](../resources/security-ediscoveryexportoperation.md) that was created to handle the export.
v1.0 Security Ediscoveryreviewsetquery Export https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-ediscoveryreviewsetquery-export.md
The following table shows the parameters that can be used with this action.
|Parameter|Type|Description| |:|:|:|
-|outputName|String| Name of the export. Required. |
-|description|String| Description of the export |
-|azureBlobContainer|String| when you export to your own Azure storage account, this is the container URL. |
-|azureBlobToken|String| when you export to your own Azure storage account, SAS token for the container URL. |
-|exportOptions|String|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`.|
+|description|String| Description of the export. |
+|exportOptions|String|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo` (deprecated), `tags`. The `fileInfo` member is deprecated and will stop returning data on April 30th, 2023. Going forward, the summary and load file are always included.|
|exportStructure|String| Options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`.|-
+|outputName|String| Name of the export. Required. |
+|azureBlobContainer (deprecated) |String| When you export to your own Azure storage account, this is the container URL. The **azureBlobContainer** property is deprecated and will stop returning data on April 30th, 2023. |
+|azureBlobToken (deprecated) |String| When you export to your own Azure storage account, SAS token for the container URL. The **azureBlobToken** property is deprecated and will stop returning data on April 30th, 2023. |
## Response
v1.0 Servicestoragequotabreakdown Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/servicestoragequotabreakdown-get.md
+
+ Title: "Get serviceStorageQuotaBreakdown"
+description: "Read the properties and relationships of a serviceStorageQuotaBreakdown object."
+
+ms.localizationpriority: medium
++
+# Get serviceStorageQuotaBreakdown
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.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)| Not supported. |
+|Delegated (personal Microsoft account)| Files.Read, Files.Read.All, Files.ReadWrite, Files.ReadWrite.All |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /me/settings/storage/quota/services/{serviceStorageQuotaBreakdownId}
+GET /users/{usersId}/settings/storage/quota/services/{serviceStorageQuotaBreakdownId}
+```
+
+## 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 [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.md) object in the response body.
+
+## Examples
+
+### Request
+The following is an example of a request.
+<!-- {
+ "blockType": "request",
+ "name": "get_servicestoragequotabreakdown"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/me/settings/storage/quota/services/OneDrive
+```
++
+### 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.serviceStorageQuotaBreakdown"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "displayName": "OneDrive",
+ "id": "OneDrive",
+ "used": 102633320226,
+ "manageWebUrl": "String"
+}
+```
+
v1.0 Sitepage Getwebpartsbyposition https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/sitepage-getwebpartsbyposition.md
The following is an example of a request.
<!-- { "blockType": "request",
- "name": "list_webpart"
+ "name": "get_webparts_by_position"
} -->
The following is an example of a request.
GET https://graph.microsoft.com/beta/sites/{siteId}/pages/{sitePageId}/getWebPartsByPosition(horizontalSectionId={horizontalSectionId},columnId={columnId},webPartIndex={webPartIndex},isInVerticalSection={isInVerticalSection}) ``` - ### Response The following is an example of the response
v1.0 Smsauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Smsauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Smsauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/s
|Content-Type|application/json. Required.| ## Request body
-In the request body, supply a JSON representation of the [smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.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.
-
-The following table shows the properties that are required when you update the [smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.md) object.
|Property|Type|Description| |:|:|:|
-|id|String|The authentication method policy identifier.|
+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.|
|state|authenticationMethodState|Possible values are: `enabled`, `disabled`.| >**Note:** The `@odata.type` property with a value of `#microsoft.graph.smsAuthenticationMethodConfiguration` must be included in the body.
v1.0 Softwareoathauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs [one of the following directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Authentication administrator
-* Privileged authentication administrator
-* Global administrator
## HTTP request
v1.0 Softwareoathauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs [one of the following directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global Reader
-* Authentication administrator
-* Privileged authentication administrator
-* Global administrator
## HTTP request
v1.0 Softwareoathauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Softwareoathauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Softwareoathauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/softwareoathauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
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)
Location: /teams('dbd8de4f-5d47-48da-87f1-594bed003375')/operations('3a6fdce1-c2
Content-Location: /teams('dbd8de4f-5d47-48da-87f1-594bed003375') Content-Length: 0 ```
+### Example 7: Create a team with a localized non-standard base template type
+Base template types can be localized to your preferred language choice, which enables you to create templates in your preferred language.
-### Example 7: Create a team with a non-standard base template type with extended properties
+Choose your team template from the defintion list returned by the [List definitions](/graph/api/teamtemplate-list-definitions) operation.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "convert_team_from_non_standard_localized"
+}-->
+
+```http
+POST https://graph.microsoft.com/beta/teams
+Content-Type: application/json
+
+{
+
+    "templateDefinition@odata.bind": "https://graph.microsoft.com/betC50ZWFtcy50ZW1wbGF0ZS5NYW5hZ2VBUHJvamVjdCMjUHVibGljIyNhci1TQQ==",
+
+    "displayName": "My Sample Team",
+
+    "description": "My Sample Team’s Description"
+
+}
+```
+
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+
+# [PHP](#tab/php)
+++
+#### Response
+<!-- {
+ "blockType": "response",
+ "name": "convert_team_from_non_standard_localized"
+}-->
+```http
+HTTP/1.1 202 Accepted
+Content-Type: application/json
+Location: /teams('dbd8de4f-5d47-48da-87f1-594bed003375')/operations('3a6fdce1-c261-48bc-89de-1cfef658c0d5')
+Content-Location: /teams('dbd8de4f-5d47-48da-87f1-594bed003375')
+Content-Length: 0
+```
+
+### Example 8: Create a team with a non-standard base template type with extended properties
Base template types can be extended with additional properties, enabling you to build on an existing base template with additional team settings, channels, apps, or tabs.
Content-Location: /teams('dbd8de4f-5d47-48da-87f1-594bed003375')
Content-Length: 0 ```
-### Example 8: Create a team in migration mode
+### Example 9: Create a team in migration mode
#### Request
v1.0 Teamtemplatedefinition Get Teamdefinition https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/teamtemplatedefinition-get-teamdefinition.md
Namespace: microsoft.graph
Get the properties of the [team](../resources/team.md) associated with a [teamTemplateDefinition](../resources/teamstemplate.md) object.
+> **Note**: This API is currently in private preview only. When it reaches public preview, we will publish a blog post announcement on the [Microsoft 365 Developer blog](https://devblogs.microsoft.com/microsoft365dev/).
++ ## 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 Teamtemplatedefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/teamtemplatedefinition-get.md
Namespace: microsoft.graph
Read the properties and relationships of a [teamTemplateDefinition](../resources/teamtemplatedefinition.md) object.
+> **Note**: This API is currently in private preview only. When it reaches public preview, we will publish a blog post announcement on the [Microsoft 365 Developer blog](https://devblogs.microsoft.com/microsoft365dev/).
++ ## 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 Temporaryaccesspassauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/temporaryaccesspassauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Temporaryaccesspassauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/temporaryaccesspassauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Temporaryaccesspassauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/temporaryaccesspassauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Temporaryaccesspassauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/temporaryaccesspassauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Tenantappmanagementpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tenantappmanagementpolicy-update.md
PATCH /policies/defaultAppManagementPolicy
| Authorization | Bearer {token}. Required. | | Content-Type | application/json. Required. |
+> [!IMPORTANT]
+> Service principals with a createdDateTime `null` are treated as having being created on 01/01/2019.
+ ## Request body In the request body, supply the values for relevant fields from the [tenantAppManagementPolicy](../resources/tenantAppManagementPolicy.md) that should be updated. Existing properties that are not included in the request body will maintain their previous values. For best performance, do not include unchanged values in the request payload.
In the request body, supply the values for relevant fields from the [tenantAppMa
| isEnabled | Boolean | Denotes if the policy is enabled. Default value is false. | | servicePrincipalRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all service principal objects in the tenant. |
+> [!IMPORTANT]
+> Service principals with a createdDateTime `null` are treated as having being created on 01/01/2019.
+ ## Response If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.
v1.0 Tokenlifetimepolicy Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tokenlifetimepolicy-delete.md
The following is an example of the request.
}--> ```http
-DELETE https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/{id}
+DELETE https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4
``` # [C#](#tab/csharp)
v1.0 Tokenlifetimepolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tokenlifetimepolicy-get.md
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/{id}
+GET https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4
``` # [C#](#tab/csharp)
HTTP/1.1 200 OK
Content-type: application/json {
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true,
- "id": "id-value"
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/tokenLifetimePolicies/$entity",
+ "id": "4d2f137b-e8a9-46da-a5c3-cc85b2b840a4",
+ "deletedDateTime": null,
+ "definition": [
+ "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"8:00:00\"}}"
+ ],
+ "displayName": "Contoso token lifetime policy",
+ "isOrganizationDefault": true
} ```
v1.0 Tokenlifetimepolicy List Appliesto https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tokenlifetimepolicy-list-appliesto.md
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/{id}/appliesTo
+GET https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4/appliesTo
``` # [JavaScript](#tab/javascript)
HTTP/1.1 200 OK
Content-type: application/json {
- "value": [
- {
- "id": "id-value",
- "deletedDateTime": "datetime-value"
- }
- ]
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.application",
+ "id": "3ccc9971-9ae7-45d6-8de8-263fd25fe116",
+ "appId": "6e4a2285-a438-4bcc-9d76-6c45fb91d4b0",
+ "applicationTemplateId": "8adf8e6e-67b2-4cf2-a259-e3dc5476c621",
+ "displayName": "Contoso IWA App",
+ "publisherDomain": "Contoso.com",
+ "signInAudience": "AzureADMyOrg"
+ }
+ ]
} ```
v1.0 Tokenlifetimepolicy List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tokenlifetimepolicy-list.md
HTTP/1.1 200 OK
Content-type: application/json {
- "value": [
- {
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true,
- "id": "id-value"
- }
- ]
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/tokenLifetimePolicies",
+ "value": [
+ {
+ "id": "4d2f137b-e8a9-46da-a5c3-cc85b2b840a4",
+ "deletedDateTime": null,
+ "definition": [
+ "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"8:00:00\"}}"
+ ],
+ "displayName": "Contoso token lifetime policy",
+ "isOrganizationDefault": true
+ }
+ ]
} ```
v1.0 Tokenlifetimepolicy Post Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tokenlifetimepolicy-post-tokenlifetimepolicies.md
If successful, this method returns a `201 Created` response code and a new [toke
### Request
-The following is an example of the request.
+The following is an example of a request that creates a token lifetime policy that sets the access and ID token lifetime to eight hours.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/policies/tokenLifetimePolicies
Content-type: application/json {
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true
+ "definition": [
+ "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"8:00:00\"}}"
+ ],
+ "displayName": "Contoso token lifetime policy",
+ "isOrganizationDefault": true
} ```
HTTP/1.1 201 Created
Content-type: application/json {
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true,
- "id": "id-value"
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/tokenLifetimePolicies/$entity",
+ "id": "4d2f137b-e8a9-46da-a5c3-cc85b2b840a4",
+ "deletedDateTime": null,
+ "definition": [
+ "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"8:00:00\"}}"
+ ],
+ "displayName": "Contoso token lifetime policy",
+ "isOrganizationDefault": true
} ```
v1.0 Tokenlifetimepolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tokenlifetimepolicy-update.md
In the request body, supply the values for relevant fields that should be update
| Property | Type | Description | |:-|:|:|
-|definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy. Required.|
+|definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy. For more information about the JSON schema for this property, see [Properties of a token lifetime policy definition](../resources/tokenlifetimepolicy.md#properties-of-a-token-lifetime-policy-definition). Required.|
|description|String| Description for this policy.| |displayName|String| Display name for this policy. Required.|
-|isOrganizationDefault|Boolean|If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.|
+|isOrganizationDefault|Boolean|If set to `true`, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is `false`.|
## Response
The following is an example of the request.
}--> ```http
-PATCH https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/{id}
+PATCH https://graph.microsoft.com/beta/policies/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4
Content-type: application/json {
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true
+ "definition": [
+ "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"5:30:00\"}}"
+ ],
+ "displayName": "Contoso token lifetime policy",
+ "isOrganizationDefault": true
} ```
Content-type: application/json
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.tokenLifetimePolicy"
+ "blockType": "response"
} --> ```http HTTP/1.1 204 No Content
-Content-type: application/json
-
-{
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true,
- "id": "id-value"
-}
``` <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
v1.0 Unifiedstoragequota Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedstoragequota-get.md
+
+ Title: "Get unifiedStorageQuota"
+description: "Read the properties and relationships of a unifiedStorageQuota object."
+
+ms.localizationpriority: medium
++
+# Get unifiedStorageQuota
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [unifiedStorageQuota](../resources/unifiedstoragequota.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)| Not supported. |
+|Delegated (personal Microsoft account)| Files.Read, Files.Read.All, Files.ReadWrite, Files.ReadWrite.All |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /me/settings/storage/quota
+GET /users/{user-id}/settings/storage/quota
+```
+
+## 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 [unifiedStorageQuota](../resources/unifiedstoragequota.md) object in the response body.
+
+## Examples
+
+### Example 1: Get the unified quota information for the current user
+#### Request
+The following is an example of a request.
+<!-- {
+ "blockType": "request",
+ "name": "get_unifiedstoragequota"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/me/settings/storage/quota
+```
++
+#### 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.unifiedStorageQuota"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.unifiedStorageQuota",
+ "manageWebUrl": "String",
+ "remaining": 1066671526110,
+ "state": "normal",
+ "total": 1169304846336,
+ "used": 102633320226
+ }
+}
+```
+
+### Example 2: Get the unified quota information for the current user
+#### Request
+The following is an example of a request.
+<!-- {
+ "blockType": "request",
+ "name": "get_unifiedstoragequotabyuserid"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/users/1234BBS1121YY95/settings/storage/quota
+```
++
+#### 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.unifiedStorageQuota"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.unifiedStorageQuota",
+ "manageWebUrl": "String",
+ "remaining": 1066671526110,
+ "state": "normal",
+ "total": 1169304846336,
+ "used": 102633320226
+ }
+}
+```
+
+### Example 3: Get the unified quota information, along with the service breakdowns, for the current user
+#### Request
+The following is an example of a request.
+<!-- {
+ "blockType": "request",
+ "name": "get_unifiedstoragequotaandservices"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/me/settings/storage/quota?$expand=services
+```
++
+#### 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.unifiedStorageQuota"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.unifiedStorageQuota",
+ "manageWebUrl": "String",
+ "remaining": 1066671526110,
+ "state": "normal",
+ "total": 1169304846336,
+ "used": 102633320226,
+ "services": [
+ {
+ "displayName": "OneDrive",
+ "id": "OneDrive",
+ "used": 102633320226
+ },
+ {
+ "displayName": "Outlook (Attachments)",
+ "id": "Outlook",
+ "used": 123
+ }
+ ]
+ }
+}
+```
v1.0 Unifiedstoragequota List Services https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedstoragequota-list-services.md
+
+ Title: "List serviceStorageQuotaBreakdown"
+description: "Get a list of serviceStorageQuotaBreakdown objects and their properties."
+
+ms.localizationpriority: medium
++
+# List serviceStorageQuotaBreakdown
+Namespace: microsoft.graph
++
+Get a list of [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.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)| Not supported. |
+|Delegated (personal Microsoft account)| Files.Read, Files.Read.All, Files.ReadWrite, Files.ReadWrite.All |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /me/settings/storage/quota/services
+GET /users/{usersId}/settings/storage/quota/services
+```
+
+## 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 [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.md) objects in the response body.
+
+## Examples
+
+### Request
+The following is an example of a request.
+<!-- {
+ "blockType": "request",
+ "name": "list_servicestoragequotabreakdown"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/me/settings/storage/quota/services
+```
++
+### 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.serviceStorageQuotaBreakdown)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "displayName": "OneDrive",
+ "id": "OneDrive",
+ "used": 102633320226
+ },
+ {
+ "displayName": "Outlook (Attachments)",
+ "id": "Outlook",
+ "used": 123456
+ }
+ ]
+}
+```
+
v1.0 User Activateserviceplan https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-activateserviceplan.md
- Title: "user: activateServicePlan"
-description: "Activate a service plan with a given `servicePlanId` and `skuId` for a given user."
-
-doc_type: apiPageType
--
-# user: activateServicePlan (deprecated)
-
-Namespace: microsoft.graph
--
-> [!CAUTION]
-> The **activateServicePlan** API is deprecated and will stop returning data on June 30, 2022.
-
-Activate a service plan with a given `servicePlanId` and `skuId` for a given user.
-
-## 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 most to least privileged)|
-| : | : |
-| Delegated (work or school account) | Directory.ReadWrite.All |
-| Delegated (personal Microsoft account) | Not Supported. |
-| Application | Directory.ReadWrite.All |
-
-## HTTP request
-
-<!-- {
- "blockType": "ignored"
-}
>-
-``` http
-POST /users/{id | userPrincipalName}/activateServicePlan
-```
-
-## Request headers
-
-| Name | Description |
-| : | : |
-| Authorization | Bearer {token}. Required. |
-| Content-Type | application/json. Required. |
-
-## Request body
-
-In the request body, provide a JSON object with the following parameter:
-
-| Parameter | Type | Description |
-| : | : | : |
-| servicePlanId | Guid | PlanId of the ServicePlan to activate. |
-| skuId | Guid | SkuId of SKU the service plan is on. |
-
-## Response
-
-If successful, this action returns a `204 No Content` response code.
-
-## Examples
-
-### Request
--
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "user_activateserviceplan"
-}
>-
-``` http
-POST https://graph.microsoft.com/beta/me/activateServicePlan
-Content-type: application/json
-
-{
- "servicePlanId": "28f42d6f-8034-4a0f-9d8a-a218a63b3299",
- "skuId": "465a2a90-5e59-456d-a7b8-127b9fb2e484"
-}
-```
-
-# [JavaScript](#tab/javascript)
---
-### Response
-
-<!-- {
- "blockType": "response",
- "truncated": true
-}
>-
-``` http
-HTTP/1.1 204 No Content
-```
v1.0 User List Transitivememberof https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-transitivememberof.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) | User.Read, GroupMember.Read.All, Directory.Read.All, Directory.ReadWrite.All |
+| Delegated (work or school account) | User.Read, User.Read.All, GroupMember.Read.All, Group.Read.All, Directory.Read.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. |
-| Application | Directory.Read.All, Directory.ReadWrite.All |
+| Application | User.Read.All, GroupMember.Read.All, Group.Read.All, Directory.Read.All, Directory.ReadWrite.All |
## HTTP request <!-- { "blockType": "ignored" } --> ```http
+GET /me/transitiveMemberOf
GET /users/{id | userPrincipalName}/transitiveMemberOf ```
v1.0 User Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-update.md
In the request body, supply the values for relevant fields that should be update
|identities|[objectIdentity](../resources/objectidentity.md) collection| Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft, by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. Any update to **identities** will replace the entire collection and you must supply the userPrincipalName **signInType** identity in the collection.| |interests|String collection|A list for the user to describe their interests.| |jobTitle|String|The userΓÇÖs job title.|
-|mail|String|The SMTP address for the user, for example, `jeff@contoso.onmicrosoft.com`. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. Changes to this property will also update the user's **proxyAddresses** collection to include the value as a SMTP address.|
+|mail|String|The SMTP address for the user, for example, `jeff@contoso.onmicrosoft.com`. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. Changes to this property will also update the user's **proxyAddresses** collection to include the value as a SMTP address. Cannot be updated to `null`.|
|mailNickname|String|The mail alias for the user. This property must be specified when a user is created.| |mobilePhone|String|The primary cellular telephone number for the user.| |mySite|String|The URL for the user's personal site.|
v1.0 Virtualendpoint Post Onpremisesconnections https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/virtualendpoint-post-onpremisesconnections.md
Title: "Create cloudPcOnPremisesConnection" description: "Create an Azure network connection for provisioning Cloud PCs."-+ ms.localizationpriority: medium ms.prod: "cloud-pc" doc_type: apiPageType
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremise
Content-Type: application/json {
- "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
"displayName": "test-canary-02", "type": "hybridAzureADJoin", "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
- "subscriptionName": "CPC customer 001 test subscription",
"adDomainName": "contoso001.com", "adDomainUsername": "dcadmin", "organizationalUnit": "OU=Domain Controllers, DC=contoso001, DC=com",
v1.0 Voiceauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/voiceauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Voiceauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/voiceauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Voiceauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/voiceauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/v
|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).
+|Property|Type|Description|
+|:|:|:|
+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.|
+|isOfficePhoneAllowed|Boolean|`true` if users can register office phones, otherwise, `false`.|
+|state|authenticationMethodState|Possible values are: `enabled`, `disabled`.|
>**Note:** The `@odata.type` property with a value of `#microsoft.graph.voiceAuthenticationMethodConfiguration` must be included in the body.
v1.0 Webpart List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/webpart-list.md
Content-Type: application/json
"innerHtml": "<h2>How do you get started?</h2>" }, {
- "@odata.type": "#microsoft.graph.textWebPart",
+ "@odata.type": "#microsoft.graph.standardWebPart",
"id": "6346d908-f20d-4528-902f-3c2a9c8c2442", "webPartType": "d1d91016-032f-456d-98a4-721247c305e8", "data": {
+ "audiences": [],
"dataVersion": "1.9", "description": "Show an image on your page", "title": "Image",
Content-Type: application/json
"alignment": "Center" }, "serverProcessedContent": {
+ "componentDependencies": [],
+ "htmlStrings": [],
+ "links": [],
+ "searchablePlainTexts": [],
"imageSources": [ {
+ "@odata.type": "#microsoft.graph.metaDataKeyStringPair",
"key": "imageSource", "value": "/_LAYOUTS/IMAGES/VISUALTEMPLATEIMAGE1.JPG" } ], "customMetadata": [ {
+ "@odata.type": "#microsoft.graph.metaDataKeyValuePair",
"key": "imageSource", "value": { "siteid": "0264cabe-6b92-450a-b162-b0c3d54fe5e8",
v1.0 Windowshelloforbusinessauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/windowshelloforbusinessauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Windowshelloforbusinessauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/windowshelloforbusinessauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Windowshelloforbusinessauthenticationmethod List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/windowshelloforbusinessauthenticationmethod-list.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Windowsupdates Catalog List Entries https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/windowsupdates-catalog-list-entries.md
GET /admin/windows/updates/catalog/entries
## Optional query parameters This method supports some of the [OData query parameters](/graph/query-parameters) to help customize the response, including `$count`, `$filter`, `$orderBy`, `$select`, `$skip`, and `$top`.
-To use a query parameter on a property that is not inherited from **catalogEntry**, include the full resource type for the property. For example, to filter on the **version** property of [featureUpdateCatalogEntry](../resources/windowsupdates-featureupdatecatalogentry.md) that equals 'Windows 11, version 22H2' , use `?$filter=microsoft.graph.windowsUpdates.featureUpdateCatalogEntry/version eq 'Windows 11, version 22H2''.
+To use a query parameter on a property that is not inherited from **catalogEntry**, include the full resource type for the property. For example, to filter on the **version** property of [featureUpdateCatalogEntry](../resources/windowsupdates-featureupdatecatalogentry.md) that equals 'Windows 11, version 22H2' , use `?$filter=microsoft.graph.windowsUpdates.featureUpdateCatalogEntry/version eq 'Windows 11, version 22H2'`.
## 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 a collection of catalogEntry objects in the response body.
+If successful, this method returns a `200 OK` response code and a collection of [catalogEntry](../resources/windowsupdates-catalogentry.md) objects in the response body.
## Examples ### Request
+The following is an example of a request.
+ # [HTTP](#tab/http) <!-- { "blockType": "request",
GET https://graph.microsoft.com/beta/admin/windows/updates/catalog/entries
### Response
+The following is an example of the response.
+ <!-- { "blockType": "response", "truncated": true,
Content-Type: application/json
] } ```-
v1.0 Workflow List Executionscope https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/workflow-list-executionscope.md
Namespace: microsoft.graph.identityGovernance
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Lists the users who are in the scope of the execution conditions of a [workflow](../resources/identitygovernance-workflow.md). Users who initially fall in the scope of the execution conditions, but are updated to no longer meet the conditions after it's scheduled to run, will remain on the list for a short period of time before being removed. If the execution scope is changed, users who initially met it's conditions, but no longer do so will be cleared from the list after a short period of time. New users who meet the conditions for the workflow will then be listed.
+List the users that meet the [execution conditions](../resources/identitygovernance-workflowexecutionconditions.md) regardless of whether they have already been processed by the [workflow](../resources/identitygovernance-workflow.md).
-This API call requires workflow scheduling to be enabled.
+The workflow engine periodically evaluates the users that meet the execution conditions. The results will not be up to date if the execution conditions have been changed recently, relevant attributes on the user have been changed recently or the [time based trigger](../resources/identitygovernance-timebasedattributetrigger.md) has been reached recently.
+
+The API is only supported for workflows with [trigger and scope based](../resources/identitygovernance-triggerandscopebasedconditions.md) [execution conditions](../resources/identitygovernance-workflowexecutionconditions.md). Furthermore, results are only returned if the workflows schedule (isSchedulingEnabled) is enabled.
## Permissions
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|
-For delegated scenarios, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
--- Global administrator-- Global reader-- Lifecycle workflows administrator ## HTTP request
v1.0 X509certificateauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 X509certificateauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 X509certificateauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/x
## Request body [!INCLUDE [table-intro](../../includes/update-property-table-intro.md)]
-The following properties can be updated.
-
-|Property|Type|Description|
-|:|:|:|
-|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. |
-|authenticationModeConfiguration|[x509CertificateAuthenticationModeConfiguration](../resources/x509certificateauthenticationmodeconfiguration.md)|Defines strong authentication configurations. This configuration includes the default authentication mode and the different rules for strong authentication bindings. |
>**Note:** The `@odata.type` property with a value of `#microsoft.graph.x509CertificateAuthenticationMethodConfiguration` must be included in the body.
v1.0 Accesspackageassignment https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignment.md
In [Azure AD Entitlement Management](entitlementmanagement-overview.md), an acce
|assignmentState|String|The state of the access package assignment. Possible values are `Delivering`, `Delivered`, or `Expired`. Read-only. Supports `$filter` (`eq`).| |assignmentStatus|String|More information about the assignment lifecycle. Possible values include `Delivering`, `Delivered`, `NearExpiry1DayNotificationTriggered`, or `ExpiredNotificationTriggered`. Read-only.| |catalogId|String|The identifier of the catalog containing the access package. Read-only.|
+|customExtensionCalloutInstances|[customExtensionCalloutInstance](customextensioncalloutinstance.md) collection|Information about all the custom extension calls that were made during the access package assignment workflow.|
|expiredDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |id|String| Read-only.| |isExtended|Boolean|Indicates whether the access package assignment is extended. Read-only.|
The following is a JSON representation of the resource.
<!-- { "blockType": "resource",
- "optionalProperties": [
-
- ],
+ "keyProperty": "id",
"@odata.type": "microsoft.graph.accessPackageAssignment",
- "keyProperty": "id"
-}-->
-
-```json
+ "openType": false
+}
+-->
+``` json
{
- "id":"9bdae7b4-6ece-487b-9eb8-9679dbd67aa2",
- "catalogId":"cc30dc98-6d3c-4fa0-bed8-fd76d0efd993",
- "accessPackageId":"e3f47362-993f-4fcb-8a38-532ffca16150",
- "assignmentPolicyId":"63ebd106-8116-40e7-a0ab-01ae475d11bb",
- "targetId":"ab4291f6-66b7-42bf-b597-a05b29414f5c",
- "assignmentStatus":"ExpiredNotificationTriggered",
- "assignmentState":"Expired",
- "isExtended":false,
- "expiredDateTime":"2019-04-25T23:45:40.42Z"
+ "@odata.type": "#microsoft.graph.accessPackageAssignment",
+ "id": "String (identifier)",
+ "catalogId": "String",
+ "accessPackageId": "String",
+ "assignmentPolicyId": "String",
+ "targetId": "String",
+ "assignmentStatus": "String",
+ "assignmentState": "String",
+ "isExtended": "Boolean",
+ "expiredDateTime": "String (timestamp)",
+ "schedule": {
+ "@odata.type": "microsoft.graph.requestSchedule"
+ },
+ "customExtensionCalloutInstances": [
+ {
+ "@odata.type": "microsoft.graph.customExtensionCalloutInstance"
+ }
+ ]
} ```
v1.0 Accesspackageassignmentpolicy https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentpolicy.md
To assign a user to an access package, [create an accessPackageAssignmentRequest
|:-|:|:| |accessPackage|[accessPackage](accesspackage.md)| The access package with this policy. Read-only. Nullable. Supports `$expand`.| |customExtensionHandlers|[customExtensionHandler](../resources/customextensionhandler.md) collection| The collection of stages when to execute one or more custom access package workflow extensions. Supports `$expand`.|
+|customExtensionStageSettings|[customExtensionStageSetting](../resources/customextensionstagesetting.md) collection|The collection of stages when to execute one or more custom access package workflow extensions. Supports `$expand`.|
The following is a JSON representation of the resource.
```json {
- "@odata.type": "#microsoft.graph.accessPackageAssignmentPolicy",
- "id": "String (identifier)",
- "accessPackageId": "String",
- "displayName": "String",
- "description": "String",
- "canExtend": "Boolean",
- "durationInDays": "Integer",
- "expirationDateTime": "String (timestamp)",
- "createdBy": "String",
- "createdDateTime": "String (timestamp)",
- "modifiedBy": "String",
- "modifiedDateTime": "String (timestamp)",
- "questions": [
- {
- "@odata.type": "microsoft.graph.accessPackageQuestion"
- }
- ],
- "requestorSettings": {
- "@odata.type": "microsoft.graph.requestorSettings"
- },
- "requestApprovalSettings": {
- "@odata.type": "microsoft.graph.approvalSettings"
- },
- "accessReviewSettings": {
- "@odata.type": "microsoft.graph.assignmentReviewSettings"
- }
+ "@odata.type":"#microsoft.graph.accessPackageAssignmentPolicy",
+ "id":"String (identifier)",
+ "accessPackageId":"String",
+ "displayName":"String",
+ "description":"String",
+ "canExtend":"Boolean",
+ "durationInDays":"Integer",
+ "expirationDateTime":"String (timestamp)",
+ "createdBy":"String",
+ "createdDateTime":"String (timestamp)",
+ "modifiedBy":"String",
+ "modifiedDateTime":"String (timestamp)",
+ "questions":[
+ {
+ "@odata.type":"microsoft.graph.accessPackageQuestion"
+ }
+ ],
+ "requestorSettings":{
+ "@odata.type":"microsoft.graph.requestorSettings"
+ },
+ "requestApprovalSettings":{
+ "@odata.type":"microsoft.graph.approvalSettings"
+ },
+ "accessReviewSettings":{
+ "@odata.type":"microsoft.graph.assignmentReviewSettings"
+ }
} ```
v1.0 Accesspackageassignmentrequest https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentrequest.md
In [Azure AD Entitlement Management](entitlementmanagement-overview.md), an acce
|:-|:|:| |completedDate|DateTimeOffset|The date of the end of processing, either successful or failure, of a request. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| |createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.|
-|customExtensionHandlerInstances|[customExtensionHandlerInstance](../resources/customextensionhandlerinstance.md) collection| A collection of [custom workflow extension](customaccesspackageworkflowextension.md) instances being run on an assignment request. Read-only. |
+|customExtensionCalloutInstances|[customExtensionCalloutInstance](../resources/customextensioncalloutinstance.md) collection|Information about all the custom extension calls that were made during the access package assignment request workflow.|
+|customExtensionHandlerInstances|[customExtensionHandlerInstance](../resources/customextensionhandlerinstance.md) collection| A collection of [custom workflow extension](customaccesspackageworkflowextension.md) instances being run on an assignment request. Read-only.|
|id|String| Read-only.| |isValidationOnly|Boolean|True if the request is not to be processed for assignment.| |justification|String|The requestor's supplied justification.|
The following is a JSON representation of the resource.
{ "@odata.type": "microsoft.graph.customExtensionHandlerInstance" }
+ ],
+ "customExtensionCalloutInstances": [
+ {
+ "@odata.type": "microsoft.graph.customExtensionCalloutInstance"
+ }
] } ```
v1.0 Accesspackageassignmentrequestcallbackdata https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentrequestcallbackdata.md
+
+ Title: "accessPackageAssignmentRequestCallbackData resource type"
+description: "Access package assignment request workflow calllback back that custom extension endpoint callback."
+
+ms.localizationpriority: medium
++
+# accessPackageAssignmentRequestCallbackData resource type
+
+Namespace: microsoft.graph
++
+Access package assignment request workflow calllback back that custom extension endpoint callback, derived from [customextensiondata](../resources/customextensiondata.md)
++
+Inherits from [customExtensionData](../resources/customextensiondata.md).
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|customExtensionStageInstanceId|String|Unique identifier of the callout to the custom extension.|
+|customExtensionStageInstanceDetail|String|Details for the callback.|
+|stage|accessPackageCustomExtensionStage|Indicates the stage at which the custom callout extension will be executed. The possible values are: `assignmentRequestCreated`, `assignmentRequestApproved`, `assignmentRequestGranted`, `assignmentRequestRemoved`, `assignmentFourteenDaysBeforeExpiration`, `assignmentOneDayBeforeExpiration`, `unknownFutureValue`.|
+|state|String|Allow the extension to be able to deny or cancel the request submitted by the requestor. The supported values are `Denied` and `Canceled`. This property can only be set for an `assignmentRequestCreated` stage.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequestCallbackData"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequestCallbackData",
+ "stage": "String",
+ "customExtensionStageInstanceId": "String",
+ "customExtensionStageInstanceDetail": "String",
+ "state": "String"
+}
+```
+
v1.0 Accesspackageassignmentrequestworkflowextension https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentrequestworkflowextension.md
+
+ Title: "accessPackageAssignmentRequestWorkflowExtension resource type"
+description: "Defines the attributes of a logic app that can be called at various stages of an access package request cycle."
+
+ms.localizationpriority: medium
++
+# accessPackageAssignmentRequestWorkflowExtension resource type
+
+Namespace: microsoft.graph
++
+Defines the attributes of a logic app that can be called at various stages of an access package request cycle. You can integrate logic apps with entitlement management to broaden your governance workflows beyond the core entitlement management use cases.
+
+The following use cases can be integrated with logic apps using [access package assignment request](accesspackageassignmentrequest.md) workflow:
+- When an [access package is requested](accesspackageassignmentrequest.md)
+- When an [access package request is approved](accesspackageassignmentrequest.md)
+- When an [access package request is granted](accesspackageassignmentrequest.md)
+- When an [access package assignment expires](accesspackageassignmentrequest.md)
++
+Inherits from [customCalloutExtension](../resources/customcalloutextension.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List accessPackageAssignmentRequestWorkflowExtension](../api/accesspackagecatalog-list-accesspackagecustomworkflowextensions.md)|[customCalloutExtension](../resources/accesspackageassignmentrequestworkflowextension.md) collection|Get a list of the [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) objects and their properties.|
+|[Create accessPackageAssignmentRequestWorkflowExtension](../api/accesspackagecatalog-post-accesspackagecustomworkflowextensions.md)|[accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md)| Create a new [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) object.|
+|[Get accessPackageAssignmentRequestWorkflowExtension](../api/accesspackageassignmentrequestworkflowextension-get.md)|[accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md)|Read the properties and relationships of an [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) object.|
+|[Update accessPackageAssignmentRequestWorkflowExtension](../api/accesspackageassignmentrequestworkflowextension-update.md)|[accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md)|Update the properties of an [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) object.|
+|[Delete accessPackageAssignmentRequestWorkflowExtension](../api/accesspackageassignmentrequestworkflowextension-delete.md)|None|Delete an [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|callbackConfiguration|[customExtensionCallbackConfiguration](../resources/customextensioncallbackconfiguration.md)|The callback configuration for a custom extension.|
+|createdBy|String|The userPrincipalName of the user or identity of the subject that created this resource. Read-only.|
+|createdDateTime|DateTimeOffset|When the object was created.|
+|description|String|Description for the customAccessPackageWorkflowExtension object. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|displayName|String|Display name for the customAccessPackageWorkflowExtension object. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The type and details for configuring the endpoint to call the logic app's workflow. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|id|String|Read-only.|
+|lastModifiedBy|String|The userPrincipalName of the identity that last modified the object. |
+|lastModifiedDateTime|DateTimeOffset|When the object was last modified.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "baseType": "microsoft.graph.customCalloutExtension",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",
+ "id": "String (identifier)",
+ "authenticationConfiguration": {
+ "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
+ },
+ "description": "String",
+ "displayName": "String",
+ "endpointConfiguration": {
+ "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
+ },
+ "createdBy": "String",
+ "lastModifiedBy": "String",
+ "createdDateTime": "String (timestamp)",
+ "lastModifiedDateTime": "String (timestamp)",
+ "callbackConfiguration": {
+ "@odata.type": "microsoft.graph.customExtensionCallbackConfiguration"
+ }
+}
+```
+
v1.0 Accesspackageassignmentworkflowextension https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentworkflowextension.md
+
+ Title: "accessPackageAssignmentWorkflowExtension resource type"
+description: "Defines the attributes of a logic app that can be called at various stages of an access package assignment cycle."
+
+ms.localizationpriority: medium
++
+# accessPackageAssignmentWorkflowExtension resource type
+
+Namespace: microsoft.graph
++
+Defines the attributes of a logic app that can be called at various stages of an access package request cycle. You can integrate logic apps with entitlement management to broaden your governance workflows beyond the core entitlement management use cases.
+
+The following use cases can be integrated with logic apps in the [access package assignment](accesspackageassignment.md) workflow:
+- When an [access package assignment will expire in fourteen days](accesspackageassignment.md)
+- When an [access package assignment will expire in one day](accesspackageassignment.md)
+
+Inherits from [customCalloutExtension](../resources/customcalloutextension.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List accessPackageAssignmentWorkflowExtensions](../api/accesspackagecatalog-list-accesspackagecustomworkflowextensions.md)|[customCalloutExtension](../resources/accesspackageassignmentworkflowextension.md) collection|Get a list of the [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) objects and their properties.|
+|[Create accessPackageAssignmentWorkflowExtension](../api/accesspackagecatalog-post-accesspackagecustomworkflowextensions.md)|[accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md)|Create a new [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) object.|
+|[Get accessPackageAssignmentWorkflowExtension](../api/accesspackageassignmentworkflowextension-get.md)|[accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md)|Read the properties and relationships of an [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) object.|
+|[Update accessPackageAssignmentWorkflowExtension](../api/accesspackageassignmentworkflowextension-update.md)|[accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md)|Update the properties of an [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) object.|
+|[Delete accessPackageAssignmentWorkflowExtension](../api/accesspackageassignmentworkflowextension-delete.md)|None|Delete an [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|callbackConfiguration|[customExtensionCallbackConfiguration](../resources/customextensioncallbackconfiguration.md)|The callback configuration for a custom extension.|
+|createdBy|String|The userPrincipalName of the user or identity of the subject that created this resource. Read-only.|
+|createdDateTime|DateTimeOffset|When the entity was created.|
+|description|String|Description for the customAccessPackageWorkflowExtension object. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|displayName|String|Display name for the customAccessPackageWorkflowExtension object. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The type and details for configuring the endpoint to call the logic app's workflow. Inherited from [customCalloutExtension](../resources/customcalloutextension.md).|
+|id|String|Read-only.|
+|lastModifiedBy|String|The userPrincipalName of the identity that last modified the entity. |
+|lastModifiedDateTime|DateTimeOffset|When the entity was last modified.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "baseType": "microsoft.graph.customCalloutExtension",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentWorkflowExtension",
+ "id": "String (identifier)",
+ "authenticationConfiguration": {
+ "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
+ },
+ "clientConfiguration": {
+ "@odata.type": "microsoft.graph.customExtensionClientConfiguration"
+ },
+ "description": "String",
+ "displayName": "String",
+ "endpointConfiguration": {
+ "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
+ },
+ "createdBy": "String",
+ "lastModifiedBy": "String",
+ "createdDateTime": "String (timestamp)",
+ "lastModifiedDateTime": "String (timestamp)",
+ "callbackConfiguration": {
+ "@odata.type": "microsoft.graph.customExtensionCallbackConfiguration"
+ }
+}
+```
+
v1.0 Accesspackagecatalog https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackagecatalog.md
An access package catalog might also have linked resources that are used in thos
| [List accessPackageCatalog resources](../api/accesspackagecatalog-list-accesspackageresources.md) | [accessPackageResource](accesspackageresource.md) collection | Retrieve a list of accessPackageResource objects in a catalog. | | **Access package resource roles**| | | | [List accessPackageCatalog resource roles](../api/accesspackagecatalog-list-accesspackageresourceroles.md) | [accessPackageResourceRole](accesspackageresourcerole.md) collection | Retrieve a list of accessPackageResourceRole objects for resources in a catalog. |
+| **Access package custom package workflow extensions**| | |
+|[List accessPackageCustomWorkflowExtensions](../api/accesspackagecatalog-list-accessPackageCustomWorkflowExtensions.md)|[accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) and [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) collection|Get a list of the [accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) and [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) objects and their properties.|
+|[Create accessPackageCustomWorkflowExtensions](../api/accesspackagecatalog-post-accessPackageCustomWorkflowExtensions.md)|[accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) or [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md)|Create a new [accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) or [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object.|
+|[Get accessPackageAssignmentRequestWorkflowExtension](../api/accesspackageassignmentrequestworkflowextension-get.md)|[accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md)|Read the properties and relationships of a [accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) object.|
+|[Update accessPackageAssignmentRequestWorkflowExtension](../api/accesspackageassignmentrequestworkflowextension-update.md)|[accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md)|Update the properties of a [accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) object.|
+|[Delete accessPackageAssignmentRequestWorkflowExtension](../api/accesspackageassignmentrequestworkflowextension-delete.md)|None|Deletes a [accessPackageAssignmentRequestWorkflowExtension](../resources/accessPackageAssignmentRequestWorkflowExtension.md) object.|
+|[Get accessPackageAssignmentWorkflowExtension](../api/accesspackageassignmentworkflowextension-get.md)|[accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md)|Read the properties and relationships of a [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object.|
+|[Update accessPackageAssignmentWorkflowExtension](../api/accesspackageassignmentworkflowextension-update.md)|[accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md)|Update the properties of a [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object.|
+|[Delete accessPackageAssignmentWorkflowExtension](../api/accesspackageassignmentworkflowextension-delete.md)|None|Deletes a [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object.|
| **Custom access package package workflow extensions**| | | |[List customAccessPackageWorkflowExtensions](../api/accesspackagecatalog-list-customaccesspackageworkflowextensions.md)|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) collection|Get a list of the [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) objects and their properties.| |[Create customAccessPackageWorkflowExtensions](../api/accesspackagecatalog-post-customaccesspackageworkflowextensions.md)|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md)|Create a new [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object.|
An access package catalog might also have linked resources that are used in thos
| Relationship | Type | Description | |:-|:|:| |accessPackages|[accessPackage](accesspackage.md) collection| The access packages in this catalog. Read-only. Nullable. Supports `$expand`.|
+|accessPackageCustomWorkflowExtensions|[customCalloutExtension](../resources/customcalloutextension.md) collection|The attributes of a logic app, which can be called at various stages of an access package request and assignment cycle. |
|accessPackageResources|[accessPackageResource](accesspackageresource.md) collection| Read-only. Nullable.| |accessPackageResourceRoles|[accessPackageResourceRole](accesspackageresourcerole.md) collection|The roles in each resource in a catalog. Read-only.| |accessPackageResourceScopes|[accessPackageResourceScope](accesspackageresourcescope.md) collection|Read-only.|
-|customAccessPackageWorkflowExtension|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) collection|The attributes of a logic app, which can be called at various stages of an access package request and assignment cycle. |
+|customAccessPackageWorkflowExtension |[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) collection|The attributes of a logic app, which can be called at various stages of an access package request and assignment cycle. |
## JSON representation
v1.0 Activateservice https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/activateservice.md
- Title: "activateService resource type"
-description: "Represents a service to be activated."
-
-doc_type: apiPageType
--
-# activateService resource type (deprecated)
-
-Namespace: microsoft.graph
--
-Represents a service to be activated.
-
-## Properties
-
-| Property | Type | Description |
-| -- | | - |
-| service| String | The name of the service to activate. |
-| servicePlanId | Guid | The plan identifier of the service plan to activate. |
-| skuId | Guid | The SKU identifier of the service plan. |
-
-## JSON representation
-
-Here is a JSON representation of the resource.
-
-<!-- {
- "blockType": "resource",
- "optionalProperties": [
-
- ],
- "@odata.type": "microsoft.graph.activateService"
-}-->
-
-```json
-{
- "service": "String",
- "skuId": "Guid",
- "servicePlanId": "Guid"
-}
-
-```
-
-<!-- uuid: 20fd7863-9545-40d4-ae8f-fee2d115a690
-2015-10-25 14:57:30 UTC -->
-<!--
-{
- "type": "#page.annotation",
- "description": "activateService",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": []
-}
>
v1.0 Applicationauthenticationmethodpolicy https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/applicationauthenticationmethodpolicy.md
ms.prod: "identity-and-sign-in"
doc_type: "conceptualPageType"
-# Azure AD application authentication methods API overview (preview)
+# Azure AD application authentication methods API overview
Namespace: microsoft.graph
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
+ [emailAuthenticationMethodConfiguration](emailauthenticationmethodconfiguration.md) + [fido2AuthenticationMethodConfiguration](fido2authenticationmethodconfiguration.md) + [microsoftAuthenticatorAuthenticationMethodConfiguration](microsoftauthenticatorauthenticationmethodconfiguration.md)++ [voiceAuthenticationMethodConfiguration](voiceauthenticationmethodconfiguration.md) + [smsAuthenticationMethodConfiguration](smsauthenticationmethodconfiguration.md)++ [softwareOathAuthenticationMethodConfiguration](softwareoathauthenticationmethodconfiguration.md) + [temporaryAccessPassAuthenticationMethodConfiguration](smsauthenticationmethodconfiguration.md) + [x509CertificateAuthenticationMethodConfiguration](x509certificateauthenticationmethodconfiguration.md)
The following is a JSON representation of the resource.
{ "@odata.type": "#microsoft.graph.authenticationMethodConfiguration", "id": "String (identifier)",
- "state": "String"
+ "state": "String",
+ "excludeTargets": [
+ {
+ "@odata.type": "microsoft.graph.excludeTarget"
+ }
+ ]
} ```
v1.0 Authenticationmethodspolicies Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/authenticationmethodspolicies-overview.md
The authentication method policies APIs are used to manage policy settings. For
|Authentication method policy | Description | |:|:|
-|[smsAuthenticationMethodConfiguration](smsAuthenticationMethodConfiguration.md)| Define users who can use Text Message on the Azure AD tenant.|
+|[emailauthenticationmethodconfiguration](emailauthenticationmethodconfiguration.md)|Define users who can use email OTP on the Azure AD tenant.|
|[fido2authenticationmethodconfiguration](fido2authenticationmethodconfiguration.md)| Define FIDO2 security key restrictions and users who can use them to sign in to Azure AD.| |[microsoftauthenticatorauthenticationmethodconfiguration](microsoftauthenticatorauthenticationmethodconfiguration.md)|Define users who can use Microsoft Authenticator on the Azure AD tenant.|
-|[emailauthenticationmethodconfiguration](emailauthenticationmethodconfiguration.md)|Define users who can use email OTP on the Azure AD tenant.|
|[passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration](passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration.md) (deprecated)|Define users who can use Passwordless Phone Sign-in to sign in to Azure AD.|
+|[smsAuthenticationMethodConfiguration](smsAuthenticationMethodConfiguration.md)| Define users who can use Text Message on the Azure AD tenant.|
+|[softwareOathAuthenticationMethodConfiguration](softwareOathAuthenticationMethodConfiguration.md)|Define users who can use a third-party software OATH authentication method.|
|[temporaryaccesspassauthenticationmethodconfiguration](temporaryaccesspassauthenticationmethodconfiguration.md)|Define users who can use Temporary Access Pass to sign in to Azure AD.|
+|[voiceAuthenticationMethodConfiguration](voiceAuthenticationMethodConfiguration.md)|Define users or groups that are enabled to use the voice call authentication method.|
|[x509CertificateAuthenticationMethodConfiguration](x509CertificateAuthenticationMethodConfiguration.md)|Define users who can use X.509 certificate to sign in to Azure AD.| ## Policies available to push users to set up authentication methods:
v1.0 Azureadpoptokenauthentication https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/azureadpoptokenauthentication.md
+
+ Title: "azureAdPopTokenAuthentication resource type"
+description: "Defines the Azure AD Proof Of Possession (PoP) used to authenticate with a workflow extension."
+
+ms.localizationpriority: medium
++
+# azureAdPopTokenAuthentication resource type
+
+Namespace: microsoft.graph
++
+Defines the Proof Of Possession (PoP) token authentication model to authenticate a logic app with a [accessPackageAssignmentRequestWorkflowExtensions](../resources/accessPackageAssignmentRequestWorkflowExtension.md) or a [accessPackageAssignmentWorkflowExtensions](../resources/accessPackageAssignmentWorkflowExtension.md) object.
+
+Inherits from [customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md).
+
+## Properties
+None.
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "baseType": "microsoft.graph.customExtensionAuthenticationConfiguration",
+ "@odata.type": "microsoft.graph.azureAdPopTokenAuthentication"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.azureAdPopTokenAuthentication"
+}
+```
v1.0 Callrecords Api Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/callrecords-api-overview.md
Title: "Working with the call records API in Microsoft Graph" description: "The Microsoft Graph call records API allows you to retrieve usage and diagnostics data for calls and online meetings within your organization."-+ doc_type: conceptualPageType ms.prod: cloud-communications ms.localizationpriority: high
ms.localizationpriority: high
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Call records provide usage and diagnostic information about the calls and online meetings that occur within your organization when using Microsoft Teams or Skype for Business. You can use the call records APIs to subscribe to call records and look up call records by IDs.
+Call records provide usage and diagnostic information about the calls and online meetings that occur within your organization when using Microsoft Teams or Skype for Business. You can use the call records APIs to subscribe to call records and look up call records by IDs. A call record is created after a call or meeting ends and the record is retained for 30 days.
The call records API is defined in the OData sub-namespace, `microsoft.graph.callRecords`.
v1.0 Callrecords Callrecord https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/callrecords-callrecord.md
Title: "callRecord resource type" description: "Represents a single peer-to-peer call or a group call between multiple participants, sometimes referred to as an online meeting." ms.localizationpriority: medium-+ ms.prod: "cloud-communications" doc_type: "resourcePageType"
Namespace: microsoft.graph.callRecords
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a single peer-to-peer call or a group call between multiple participants, sometimes referred to as an online meeting.
+Represents a single peer-to-peer call or a group call between multiple participants, sometimes referred to as an online meeting. A call record is created after a call or meeting ends.
## Methods
v1.0 Cloudpc https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpc.md
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|[List for user](../api/user-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List the [cloudPC](../resources/cloudpc.md) devices that are attributed to the signed-in user.| |[Get launch info for user](../api/cloudpc-getcloudpclaunchinfo.md)|[cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md)|Get the [cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md) for the signed-in user.| |[Get connectivity history](../api/cloudpc-getcloudpcconnectivityhistory.md)|[cloudPcConnectivityEvent](../resources/cloudpcconnectivityevent.md) collection|Get the Cloud PC connectivity history.|
+|[Get shift work access state](../api/cloudpc-getshiftworkcloudpcaccessstate.md)|[shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values)|Get the access state of the shift work Cloud PC. The possible values are: {unassigned, noLicensesAvailable, activationFailed, active, activating, waitlisted, unknownFutureValue, hibernated}. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values): {hibernated}.|
|[Get supported remote actions](../api/cloudpc-getsupportedcloudpcremoteactions.md)|[cloudPcRemoteActionCapability](../resources/cloudpcremoteactioncapability.md) collection|Get a list of supported Cloud PC remote actions for a specific Cloud PC device, including the action names and capabilities.| |[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents which failed to install on the [cloudPC](../resources/cloudpc.md).|
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|Property|Type|Description| |:|:|:| |aadDeviceId|String|The Azure Active Directory (Azure AD) device ID of the Cloud PC.|
-|connectivityResult|[cloudPcConnectivityResult](../resources/cloudpcconnectivityresult.md)|The connectivity health check result of a Cloud PC, including the updated timestamp and whether the Cloud PC is able to be connected or not.|
+|connectivityResult|[cloudPcConnectivityResult](../resources/cloudpcconnectivityresult.md)|The connectivity health check result of a Cloud PC, including the updated timestamp and whether the Cloud PC can be connected.|
|diskEncryptionState|[cloudPcDiskEncryptionState](#cloudpcdiskencryptionstate-values)|The disk encryption applied to the Cloud PC. Possible values: `notAvailable`, `notEncrypted`, `encryptedUsingPlatformManagedKey`, `encryptedUsingCustomerManagedKey`, and `unknownFutureValue`.| |displayName|String|The display name of the Cloud PC.| |gracePeriodEndDateTime|DateTimeOffset|The date and time when the grace period ends and reprovisioning/deprovisioning happens. Required only if the status is `inGracePeriod`. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|restoring|The Cloud PC is restoring.| |unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+### shiftWorkCloudPcAccessState values
+The following table lists the members of an [evolvable enumeration](#shiftworkcloudpcaccessstate-values). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `hibernated`.
+
+|Member|Description|
+|:|:|
+|unassigned|Set to unassigned if the Cloud PC is not consuming any shared-use licenses. The default value is unassigned.|
+|noLicensesAvailable|Indicates that all shared-use licenses are in use.|
+|activationFailed|Indicates that the shift work Cloud PC activation failed after the user requested a shift work Cloud PC.|
+|active|Indicates that the shift work Cloud PC is in an active state with a shared-use license assigned, and the user can connect to the Cloud PC.|
+|activating|Indicates that a user requested to connect the Cloud PC and the service is starting.|
+|waitlisted (deprecated)|Indicates that the shift work Cloud PC is in waitlisted state after the user requests to connect this Cloud PC and all shared use licenses are being actively used. This value is deprecated and will stop returning on May 17, 2023. |
+|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|hibernated|Indicates that the shift work Cloud PC is in the hibernated state before it's shut down and deallocated. A shift work Cloud PC in hibernated state is still accessible by the user.|
+ ## Relationships None.
v1.0 Cloudpcdeviceimage https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcdeviceimage.md
Represents the image resource on a Cloud PC.
|Property|Type|Description| |:|:|:|
-|displayName|String|The image's display name.|
+|displayName|String|The display name of the image.|
|expirationDate|Date|The date the image became unavailable.| |id|String|Unique identifier for the image resource on the Cloud PC. Read-only.|
-|lastModifiedDateTime|DateTimeOffset|The data and time that the image was last modified. The time is shown in ISO 8601 format and Coordinated Universal Time (UTC) time. For example, midnight UTC on Jan 1, 2014 appears as '2014-01-01T00:00:00Z'.|
-|operatingSystem|String|The image's operating system. For example: Windows 10 Enterprise.|
-|osBuildNumber|String|The image's OS build version. For example: 1909.|
+|lastModifiedDateTime|DateTimeOffset|The data and time that the image was last modified. The time is shown in ISO 8601 format and Coordinated Universal Time (UTC) time. For example, midnight UTC on Jan 1, 2014 appears as `2014-01-01T00:00:00Z`.|
+|operatingSystem|String|The operating system of the image. For example, `Windows 10 Enterprise`.|
+|osBuildNumber|String|The OS build version of the image. For example, `1909`.|
|osStatus|[cloudPcDeviceImageOsStatus](#cloudpcdeviceimageosstatus-values)|The OS status of this image. Possible values are: `supported`, `supportedWithWarning`, `unknownFutureValue`.|
-|sourceImageResourceId|String|The ID of the source image resource on Azure. Required format: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}".|
+|sourceImageResourceId|String|The ID of the source image resource on Azure. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}`.|
|status|[cloudPcDeviceImageStatus](#cloudpcdeviceimagestatus-values)|The status of the image on Cloud PC. Possible values are: `pending`, `ready`, `failed`.|
-|statusDetails|cloudPcDeviceImageStatusDetails|The details of the image's status, which indicates why the upload failed, if applicable. Possible values are: `internalServerError`, `sourceImageNotFound`, `osVersionNotSupported`, `sourceImageInvalid`, and `sourceImageNotGeneralized`.|
-|version|String|The image version. For example: 0.0.1, 1.5.13.|
+|statusDetails|cloudPcDeviceImageStatusDetails|The details of the status of the image that indicates why the upload failed, if applicable. Possible values are: `internalServerError`, `sourceImageNotFound`, `osVersionNotSupported`, `sourceImageInvalid`, and `sourceImageNotGeneralized`.|
+|version|String|The image version. For example, `0.0.1` and `1.5.13`.|
### cloudPcDeviceImageStatus values
The following is a JSON representation of the resource.
``` json { "@odata.type": "#microsoft.graph.cloudPcDeviceImage",
- "id": "String (identifier)",
"displayName": "String",
+ "expirationDate": "String (timestamp)",
+ "id": "String (identifier)",
+ "lastModifiedDateTime": "String (timestamp)",
"operatingSystem": "String", "osBuildNumber": "String",
- "version": "String",
- "lastModifiedDateTime": "String (timestamp)",
+ "osStatus": "String",
+ "sourceImageResourceId": "String",
"status": "String", "statusDetails": "String",
- "sourceImageResourceId": "String",
- "expirationDate":"String (timestamp)",
- "osStatus":"String"
+ "version": "String"
} ```
v1.0 Cloudpcgalleryimage https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcgalleryimage.md
Title: "cloudPcGalleryImage resource type"
-description: "Represents the gallery image resource of the current organization."
+description: "Represents the gallery image resource of the current organization that can be used to provision a Cloud PC."
ms.localizationpriority: medium ms.prod: "cloud-pc"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the gallery image resource of the current organization which can be used to provision a Cloud PC.
+Represents the gallery image resource of the current organization that can be used to provision a Cloud PC.
## Methods
Represents the gallery image resource of the current organization which can be u
|Property|Type|Description| |:|:|:| |displayName|String|The official display name of the gallery image. Read-only.|
-|endDate|Date|The date in which this image is no longer within long-term support. The Cloud PC will continue to provide short-term support. Read-only.|
+|endDate|Date|The date in which this image is no longer within long-term support. The Cloud PC continues to provide short-term support. Read-only.|
|expirationDate|Date|The date when the image is no longer available. Read-only.| |id|String|Unique identifier for the gallery image resource on the Cloud PC. Read-only.|
-|offer|String|The offer name of the gallery image. This value will be passed to Azure to get the image resource. Read-only.|
-|offerDisplayName|String|The official display offer name of the gallery image. For example, Windows 10 Enterprise + OS Optimizations. Read-only.|
-|publisher|String|The publisher name of the gallery image. This value will be passed to Azure to get the image resource. Read-only.|
+|offer|String|The offer name of the gallery image. This value is passed to Azure to get the image resource. Read-only.|
+|offerDisplayName|String|The official display offer name of the gallery image. For example, `Windows 10 Enterprise + OS Optimizations`. Read-only.|
+|publisher|String|The publisher name of the gallery image. This value is passed to Azure to get the image resource. Read-only.|
|recommendedSku|String|Recommended Cloud PC SKU for this gallery image. Read-only.| |sizeInGB|Int32|The size of this image in gigabytes. Read-only.|
-|sku|String|The SKU name of the gallery image. This value will be passed to Azure to get the image resource. Read-only.|
-|skuDisplayName|String|The official display stock keeping unit (SKU) name of this gallery image. For example, 2004. Read-only.|
+|sku|String|The SKU name of the gallery image. This value is passed to Azure to get the image resource. Read-only.|
+|skuDisplayName|String|The official display stock keeping unit (SKU) name of this gallery image. For example, `2004`. Read-only.|
|startDate|Date|The date when the image becomes available. Read-only.| |status|cloudPcGalleryImageStatus|The status of the gallery image on the Cloud PC. Possible values are: `supported`, `supportedWithWarning`, `notSupported`, `unknownFutureValue`. Read-only.|
The following is a JSON representation of the resource.
``` json { "@odata.type": "#microsoft.graph.cloudPcDeviceImage",
+ "displayName": "String",
+ "endDate": "String (Date)",
+ "expiredDate": "String (Date)",
"id": "String (identifier)",
- "displayName":"String",
- "offerDisplayName":"String",
- "skuDisplayName":"String",
- "publisher":"String",
- "offer":"String",
- "sku":"String",
- "recommendedSku":"String",
- "status":"String",
- "sizeInGB":"Int32",
- "startDate":"String (Date)",
- "endDate":"String (Date)",
- "expiredDate":"String (Date)"
+ "offer": "String",
+ "offerDisplayName": "String",
+ "publisher": "String",
+ "recommendedSku": "String",
+ "sizeInGB": "Int32",
+ "sku": "String",
+ "skuDisplayName": "String",
+ "startDate": "String (Date)",
+ "status": "String"
} ```
v1.0 Cloudpcserviceplan https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcserviceplan.md
Title: "cloudPcServicePlan resource type"
-description: "Represents a Windows 365 service plan configured for a Cloud PC."
+description: "Represents a Windows 365 service plan that can be purchased and configured for a Cloud PC."
ms.localizationpriority: medium ms.prod: "cloud-pc"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a Windows 365 service plan configured for a Cloud PC.
+Represents a Windows 365 service plan that can be purchased and configured for a Cloud PC.
-For examples of currently available service plans, see [Windows 365 compare plans and pricing](https://www.microsoft.com/windows-365/business/compare-plans-pricing). Currently, Microsoft Graph API is available for Windows 365 Enterprise.
+For examples of currently available service plans, see [Windows 365 compare plans and pricing](https://www.microsoft.com/windows-365/business/compare-plans-pricing). Currently, the Microsoft Graph API is available for Windows 365 Enterprise.
## Methods
For examples of currently available service plans, see [Windows 365 compare plan
|type|[cloudPcServicePlanType](#cloudpcserviceplantype-values)|The type of the service plan. Possible values are: `enterprise`, `business`, `unknownFutureValue`. Read-only.| |userProfileInGB|Int32|The size of the user profile disk in GB. Read-only.| |vCpuCount|Int32|The number of vCPUs. 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.|
+|provisioningType|[cloudPcProvisioningType](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values)|Specifies the type of license used when provisioning Cloud PCs. By default, the license type is `dedicated`. Possible values are: `dedicated`, `shared`, `unknownFutureValue`.|
### cloudPcServicePlanType values
The following is a JSON representation of the resource.
``` json { "@odata.type": "#microsoft.graph.cloudPcServicePlan",
- "id": "String (identifier)",
"displayName": "String",
- "type": "String",
- "vCpuCount": "Int32",
+ "id": "String (identifier)",
+ "provisioningType": "String",
"ramInGB": "Int32", "storageInGB": "Int32",
- "userProfileInGB": "Int32"
+ "supportedSolution": "String",
+ "type": "String",
+ "userProfileInGB": "Int32",
+ "vCpuCount": "Int32"
} ```
v1.0 Cloudpcsnapshot https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/cloudpcsnapshot.md
Inherits from [entity](../resources/entity.md).
|createdDateTime|DateTimeOffset|The date and time at which the snapshot was taken. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |id|String|The unique identifier for the snapshot of the Cloud PC device at a specific point in time. Inherited from [entity](../resources/entity.md).| |lastRestoredDateTime|DateTimeOffset|The date and time at which the snapshot was last used to restore the Cloud PC device. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
-|snapshotType| [cloudPcSnapshotType](#cloudpcsnapshottype-values) | The type of snapshot. indicates how the snapshot is to be created. Possible values are `automatic`, `manual`. Default value is `automatic`.|
+|snapshotType| [cloudPcSnapshotType](#cloudpcsnapshottype-values) | The type of snapshot that indicates how to create the snapshot. Possible values are `automatic`, `manual`. Default value is `automatic`.|
|status|[cloudPcSnapshotStatus](#cloudpcsnapshotstatus-values)|The status of the Cloud PC snapshot. The possible values are: `ready`, `unknownFutureValue`.|
-|expirationDateTime|DateTimeOffset| The date and time when the snapshot expires. The time is shown in ISO 8601 format and Coordinated Universal Time (UTC) time. For example, midnight UTC on Jan 1, 2014 appears as'2014-01-01T00:00:00Z'.|
+|expirationDateTime|DateTimeOffset| The date and time when the snapshot expires. The time is shown in ISO 8601 format and Coordinated Universal Time (UTC) time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
### cloudPcSnapshotStatus values
The following is a JSON representation of the resource.
"@odata.type": "#microsoft.graph.cloudPcSnapshot", "cloudPcId": "String", "createdDateTime": "String (timestamp)",
+ "expirationDateTime": "String (timestamp)",
"id": "String (identifier)", "lastRestoredDateTime": "String (timestamp)",
- "status": "String",
"snapshotType": "String",
- "expirationDateTime": "String (timestamp)",
+ "status": "String"
} ```
v1.0 Customcalloutextension https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/customcalloutextension.md
Title: "customCalloutExtension resource type" description: "An abstract type that defines the configuration for logic apps that can be integrated with the customer's entitlement management use cases to implement broader governance workflows. This abstract type is inherited by the customAccessPackageWorkflowExtension resource type"-+ ms.localizationpriority: medium ms.prod: "governance" doc_type: resourcePageType
This abstract type is inherited by:
- [customAccessPackageWorkflowExtension](customaccesspackageworkflowextension.md) - [customTaskExtension](../resources/identitygovernance-customtaskextension.md)
+- [accessPackageAssignmentRequestWorkflowExtension](accesspackageassignmentrequestworkflowextension.md)
+- [accessPackageAssignmentWorkflowExtension](../resources/accesspackageassignmentworkflowextension.md)
Inherits from [entity](entity.md).
v1.0 Customextensionauthenticationconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/customextensionauthenticationconfiguration.md
Title: "customExtensionAuthenticationConfiguration resource type" description: "Abstract base type that exposes the configuration for the **authenticationConfiguration** property of the derived types that inherit from the customCalloutExtension abstract type"-+ ms.localizationpriority: medium ms.prod: "governance" doc_type: resourcePageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Abstract base type that exposes the configuration for the **authenticationConfiguration** property of the derived types that inherit from the [customCalloutExtension](customcalloutextension.md) abstract type. This abstract type is inherited by the [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md) resource type.
+Abstract base type that exposes the configuration for the **authenticationConfiguration** property of the derived types that inherit from the [customCalloutExtension](customcalloutextension.md) abstract type.
+
+This abstract type is inherited by the following resource types:
+- [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md)
+- [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md)
+
+The type of token authentication used depends on the token security. If the token security value is normal, you will use the [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md) resource type. If the value is Proof of Possession, you will use the [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md) resource type.
## Properties
The following is a JSON representation of the resource.
``` json {
- "@odata.type": "#microsoft.graph.customExtensionAuthenticationConfiguration "
+ "@odata.type": "#microsoft.graph.customExtensionAuthenticationConfiguration"
}
-```
+```
v1.0 Customextensioncallbackconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/customextensioncallbackconfiguration.md
Title: "customExtensionCallbackConfiguration resource type"
-description: "The callback configuration for a custom task extension that's linked to an Azure Logic App."
-
+description: "Callback settings that define how long Azure AD can wait for a resume signal for the callout that it made to the logic app."
+ ms.localizationpriority: medium ms.prod: "governance" doc_type: resourcePageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-This is an abstract type describing the callback configuration of a [custom callout extension](../resources/customcalloutextension.md).
-This abstract type is inherited by:
-+ [customTaskExtensionCallbackConfiguration](../resources/identitygovernance-customtaskextensioncallbackconfiguration.md)
+Callback settings that define how long Azure AD can wait for a resume signal for the callout that it made to the logic app. This is an abstract type that's inherited by [customTaskExtensionCallbackConfiguration](../resources/identitygovernance-customtaskextensioncallbackconfiguration.md).
## Properties |Property|Type|Description| |:|:|:|
-|timeoutDuration|Duration|Callback time out in ISO 8601 time duration. Accepted time durations are between five minutes to three hours. For example, PT5M for five minutes and PT3H for three hours.|
+|timeoutDuration|Duration|The maximum duration in ISO 8601 format that Azure AD will wait for a resume action for the callout it sent to the logic app. The valid range for custom extensions in lifecycle workflows is five minutes to three hours. The valid range for custom extensions in entitlement management is between 5 minutes and 14 days. For example, `PT3H` refers to three hours, `P3D` refers to three days, `PT10M` refers to ten minutes.|
-## Relationships
+## Relationships
None. ## JSON representation- The following is a JSON representation of the resource. <!-- { "blockType": "resource",
The following is a JSON representation of the resource.
"timeoutDuration": "String (duration)" } ```+
v1.0 Customextensioncalloutinstance https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/customextensioncalloutinstance.md
+
+ Title: "customExtensionCalloutInstance resource type"
+description: "Defines the calls that were made by an instance of a custom extension callout."
+
+ms.localizationpriority: medium
++
+# customExtensionCalloutInstance resource type
+
+Namespace: microsoft.graph
++
+Defines the calls that were made by an instance of a custom extension callout.
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|customExtensionId|String|Identification of the custom extension that was triggered at this instance.|
+|detail|String|Details provided by the logic app during the callback of the request instance.|
+|externalCorrelationId|String|The unique run identifier for the logic app.|
+|id|String|Unique identifier for the callout instance. Read-only.|
+|status|customExtensionCalloutInstanceStatus| The status of the request to the custom extension. The possible values are: `calloutSent`, `callbackReceived`, `calloutFailed`, `callbackTimedOut`, `waitingForCallback`, `unknownFutureValue`.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.customExtensionCalloutInstance"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.customExtensionCalloutInstance",
+ "id": "String (identifier)",
+ "customExtensionId": "String",
+ "externalCorrelationId": "String",
+ "detail": "String",
+ "status": "String"
+}
+```
+
v1.0 Customextensiondata https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/customextensiondata.md
Title: "customExtensionData resource type" description: "An abstract type noting the data being sent and received as part of extensibility scenarios based on custom callout extensions"-+ ms.localizationpriority: medium ms.prod: "governance" doc_type: resourcePageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] This is an abstract type noting the data being sent and received as part of extensibility scenarios based on [custom callout extensions](../resources/customcalloutextension.md). The following types are derived from this abstract type:
-+ [customTaskExtensionCalloutData](../resources/identitygovernance-customtaskextensioncalloutdata.md)
-+ [customTaskExtensionCallbackData](../resources/identitygovernance-customtaskextensioncallbackdata.md)
+- [accessPackageAssignmentRequestCallbackData](../resources/accesspackageassignmentrequestcallbackdata.md)
+- [customTaskExtensionCalloutData](../resources/identitygovernance-customtaskextensioncalloutdata.md)
+- [customTaskExtensionCallbackData](../resources/identitygovernance-customtaskextensioncallbackdata.md)
## Properties- None. ## Relationships- None. ## JSON representation- The following is a JSON representation of the resource. <!-- { "blockType": "resource",
v1.0 Customextensionstagesetting https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/customextensionstagesetting.md
+
+ Title: "customExtensionStageSetting resource type"
+description: "Defines when to execute an access package custom workflow extension."
+
+ms.localizationpriority: medium
++
+# customExtensionStageSetting resource type
+
+Namespace: microsoft.graph
++
+Defines when to execute a [accessPackageAssignmentRequestWorkflowExtension](../resources/accesspackageassignmentrequestworkflowextension.md) or [accessPackageAssignmentWorkflowExtension](../resources/accessPackageAssignmentWorkflowExtension.md) object.
++
+Inherits from [entity](../resources/entity.md).
+
+To read the **customExtensionStageSettings** objects on a policy, append `?$expand=customExtensionStageSettings` to a [GET accessPackageAssignmentPolicy](../api/accesspackageassignmentpolicy-get.md) request. For example, `GET https://graph.microsoft.com/bet#example-2-retrieve-the-custom-extension-handlers-for-a-policy).
+
+To delete the **customExtensionStageSettings** objects from a policy, call the [Update accessPackageAssignmentPolicy](../api/accesspackageassignmentpolicy-update.md) and specify the customExtensionHandlers property as an empty collection. For more details, see [Example 2: Remove the customExtensionStageSettings from a policy](../api/accesspackageassignmentpolicy-update.md#example-3-remove-the-customextensionstagesettings-from-a-policy).
+
+## Methods
+None
++
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|id|String| Identifier of the stage. Inherited from [entity](../resources/entity.md).|
+|stage|accessPackageCustomExtensionStage|Indicates the stage of the access package assignment request workflow when the access package custom extension runs. The possible values are: `assignmentRequestCreated`, `assignmentRequestApproved`, `assignmentRequestGranted`, `assignmentRequestRemoved`, `assignmentFourteenDaysBeforeExpiration`, `assignmentOneDayBeforeExpiration`, `unknownFutureValue`.|
+
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|customExtension|[customCalloutExtension](../resources/customcalloutextension.md)|Indicates the custom workflow extension that will be executed at this stage. Nullable. Supports `$expand`.|
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.customExtensionStageSetting",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.customExtensionStageSetting",
+ "id": "String (identifier)",
+ "stage": "String"
+}
+```
+
v1.0 Dynamics Graph Reference https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/dynamics-graph-reference.md
Use the Azure AD v2.0 endpoint to authenticate Dynamics 365 Business Central API
## Common Dynamics 365 Business Central scenarios The Dynamics 365 Business Central API allows you to read and modify business data through apps that are connected and integrated through a single endpoint. Use the API to, for example, get access to [customer](../resources/dynamics-customer.md) and [vendor](../resources/dynamics-vendor.md) information, or [view overdue payments](../resources/dynamics-agedaccountspayable.md).
+## Environment
+To enable the Dynamics 365 Business Central API, you must ensure that the **Environment Name** in the Business Central Admin Center is **Production**.
+++ ## What's new Find out about the [latest new features and updates](/graph/whats-new-overview) for this API set.
v1.0 Emailauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/emailauthenticationmethodconfiguration.md
Namespace: microsoft.graph
Represents this tenant's email OTP authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. Email OTP may be used by the tenant's cloud-native users for self-service password reset, or by external users for authentication during invitation redemption and self-service sign-up for specific apps in user flows.
+Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).
+ ## Methods |Method|Return type|Description|
Represents this tenant's email OTP authentication methods policy. Authentication
|Property|Type|Description| |:|:|:|
+|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.|
|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.|
## Relationships
The following is a JSON representation of the resource.
```json { "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
- "id": "String (identifier)",
- "state": "String",
- "excludeTargets": [
+ "allowExternalIdToUseEmailOtp": "String",
+ "excludeTargets": [
{ "@odata.type": "microsoft.graph.excludeTarget" } ],
- "allowExternalIdToUseEmailOtp": "String",
- "includeTargets": [ { "@odata.type": "microsoft.graph.authenticationMethodTarget" } ]
+ "id": "String (identifier)",
+ "includeTargets": [ { "@odata.type": "microsoft.graph.authenticationMethodTarget" } ],
+ "state": "String"
}
-```
+```
v1.0 Emailsettings https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/emailsettings.md
+
+ Title: "emailSettings resource type"
+description: "Defines the settings for emails sent using Lifecycle Workflows."
+
+ms.localizationpriority: medium
++
+# emailSettings resource type
+
+Namespace: microsoft.graph
++
+Defines the settings for emails sent from Lifecycle workflow [tasks](identitygovernance-task.md). Allows you to use a verified custom [domain](domain.md) and [organizationalBranding](organizationalbranding.md) with emails sent out via workflow tasks.
+
+## Properties
+
+|Property|Type|Description|
+|:|:|:|
+|senderDomain|String|Specifies the [domain](domain.md) that should be used when sending email notifications. This domain must be [verified](../api/domain-verify.md) in order to be used.|
+|useCompanyBranding|Boolean|Specifies if the organizationΓÇÖs banner logo should be included in email notifications. The banner logo will replace the Microsoft logo at the top of the email notification. If `true` the banner logo will be taken from the tenantΓÇÖs [branding settings](organizationalbranding.md). This value can only be set to `true` if the [organizationalBranding](organizationalbranding.md) **bannerLogo** property is set. |
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.emailSettings"
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.emailSettings",
+ "senderDomain": "String",
+ "useCompanyBranding": "Boolean"
+}
+```
v1.0 Enums https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/enums.md
Namespace: microsoft.graph
+### usqState values
+
+| Member |
+|:-|
+| norma. |
+| nearing |
+| critical |
+| full |
+| overLimit |
+ ### userPurpose values | Member |
Namespace: microsoft.graph
|requestReceived| |unknownFutureValue|
+### customExtensionCalloutInstanceStatus values
+
+|Member|
+|:|
+|calloutSent|
+|callbackReceived|
+|calloutFailed|
+|callbackTimedOut|
+|waitingForCallback|
+|unknownFutureValue|
+ ### accessPackageCustomExtensionStage values |Member|
Possible values for user account types (group membership), per Windows definitio
|premigration| |migrationInProgress| |migrationComplete|
+|unknownFutureValue|
### authenticationEventType values
v1.0 Externalconnectors Urltoitemresolverbase https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/externalconnectors-urltoitemresolverbase.md
Namespace: microsoft.graph.externalConnectors
Defines the rules for resolving a URL to the ID of an [externalItem](externalconnectors-externalitem.md).
-This is an abstract type.
+This is an abstract base type of [itemIdResolver](externalconnectors-itemidresolver.md)..
## Properties |Property|Type|Description|
v1.0 Fido2authenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/fido2authenticationmethodconfiguration.md
Namespace: microsoft.graph
Represents a FIDO2 authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method.
+Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).
+ ## Methods |Method|Return type|Description|
The following is a JSON representation of the resource.
"@odata.type": "#microsoft.graph.fido2AuthenticationMethodConfiguration", "id": "String (identifier)", "state": "String",
- "excludeTargets": [
+ "excludeTargets": [
{ "@odata.type": "microsoft.graph.excludeTarget" }
v1.0 Identitygovernance Customtaskextensioncallbackconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-customtaskextensioncallbackconfiguration.md
Namespace: microsoft.graph.identityGovernance
Defines if, and in, which time span a callback is expected from the Azure Logic App.
-Inherits from [customTaskExtensionCallbackConfiguration](../resources/identitygovernance-customtaskextensioncallbackconfiguration.md).
+Inherits from [customExtensionCallbackConfiguration](../resources/customextensioncallbackconfiguration.md).
## Properties |Property|Type|Description| |:|:|:|
-|timeoutDuration|Duration| Callback time out in ISO 8601 time duration. Accepted time durations are between five minutes to three hours. For example, PT5M for five minutes and PT3H for three hours. Inherited from [customTaskExtensionCallbackConfiguration](../resources/identitygovernance-customtaskextensioncallbackconfiguration.md).|
+|timeoutDuration|Duration| Callback time out in ISO 8601 time duration. Accepted time durations are between five minutes to three hours. For example, PT5M for five minutes and PT3H for three hours. Inherited from [customExtensionCallbackConfiguration](../resources/customextensioncallbackconfiguration.md).|
+|authorizedApps|microsoft.graph.application collection| Unique identifier for the application object. |
+ ## Relationships
None.
The following is a JSON representation of the resource. <!-- { "blockType": "resource",
- "@odata.type": "microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration"
+ "@odata.type": "microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",
+ "baseType": "microsoft.graph.customExtensionCallbackConfiguration"
} --> ``` json { "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",
- "timeoutDuration": "String (duration)"
+ "timeoutDuration": "String (duration)",
+ "authorizedApps":[
+ {
+ "@odata.type": "microsoft.graph.application"
+ }
+]
} ```
v1.0 Identitygovernance Customtaskextensioncallbackdata https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-customtaskextensioncallbackdata.md
None.
The following is a JSON representation of the resource. <!-- { "blockType": "resource",
- "@odata.type": "microsoft.graph.identityGovernance.customTaskExtensionCallbackData"
+ "@odata.type": "microsoft.graph.identityGovernance.customTaskExtensionCallbackData",
+ "baseType": "microsoft.graph.customExtensionData"
} --> ``` json
v1.0 Identitygovernance Customtaskextensioncalloutdata https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-customtaskextensioncalloutdata.md
None.
The following is a JSON representation of the resource. <!-- { "blockType": "resource",
- "@odata.type": "microsoft.graph.identityGovernance.customTaskExtensionCalloutData"
+ "@odata.type": "microsoft.graph.identityGovernance.customTaskExtensionCalloutData",
+ "baseType": "microsoft.graph.customExtensionData"
} --> ``` json
v1.0 Identitygovernance Lifecyclemanagementsettings https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-lifecyclemanagementsettings.md
The settings of Azure AD Lifecycle Workflows in the tenant.
|:|:|:| |id|String|Identifier used for individually addressing Lifecycle Workflow settings.| |workflowScheduleIntervalInHours|Int32|The interval in hours at which all [workflows](../resources/identitygovernance-workflow.md) running in the tenant should be scheduled for execution. This interval has a minimum value of 1 and a maximum value of 24. The default value is 3 hours. |
+|emailSettings|[microsoft.graph.emailSettings](../resources/emailsettings.md)|Defines the settings for emails sent out from email-specific [tasks](../resources/identitygovernance-task.md) within workflows. Accepts 2 parameters<br><br>senderDomain- Defines the domain of who is sending the email. <br>useCompanyBranding- A boolean value that defines if company branding is to be used with the email.|
## Relationships
The following is a JSON representation of the resource.
--> ``` json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",
- "workflowScheduleIntervalInHours": 1
+ "@odata.type": "#microsoft.graph.identityGovernance.lifecycleManagementSettings",
+ "workflowScheduleIntervalInHours": "Integer",
+ "emailSettings": {
+ "@odata.type": "microsoft.graph.emailSettings"
+ }
} ```
v1.0 Identitygovernance Lifecycleworkflows Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-lifecycleworkflows-overview.md
Each workflow contains general descriptive information such as it's identifier,
Workflow tasks are specific actions that run automatically when a workflow is triggered. Lifecycle Workflows defines the following preconfigured and read-only tasks that are allowed for the specified workflow categories. These task definitions show the settings for the task type, guiding you as you create tasks for your workflow.
-<!-- Comment out CRR until we can resolve the links problem
->- [!INCLUDE [lifecycle-workflows-tasks-table](../includes/identitygovernance-lifecycleworkflows-tasks-table.md)] Use the [taskDefinition resource type](identitygovernance-taskdefinition.md) and its associated methods to discover all the predefined tasks that you can configure for your workflow and the settings for the properties The [task](identitygovernance-task.md) resource type and its associated GET methods allow you to view the tasks that are configured for your workflow.
The following [Azure AD roles](/azure/active-directory/roles/permissions-referen
| Operation | Application permissions | Required directory role of the calling user | |:|:|:--|
-| Read | LifecycleWorkflows.Read.All or LifecycleWorkflows.ReadWrite.All | Global Admin, Global Reader or Lifecycle Workflows Administrator |
-| Create, Update or Delete | LifecycleWorkflows.ReadWrite.All | Global Administrator or Lifecycle Workflows Administrator |
+| Read | LifecycleWorkflows.Read.All or LifecycleWorkflows.ReadWrite.All |Global Reader or Lifecycle Workflows Administrator |
+| Create, Update or Delete | LifecycleWorkflows.ReadWrite.All | Lifecycle Workflows Administrator |
## See also
v1.0 Identitygovernance Lifecycleworkflows Reporting Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-lifecycleworkflows-reporting-overview.md
The following [Azure AD roles](/azure/active-directory/roles/permissions-referen
| Operation | Application permissions | Required directory role of the calling user | |:|:|:--|
-| Read | LifecycleWorkflows.Read.All or LifecycleWorkflows.ReadWrite.All | Global Admin, Global Reader or Lifecycle Workflows Administrator |
-| Create, Update or Delete | LifecycleWorkflows.ReadWrite.All | Global Administrator or Lifecycle Workflows Administrator |
+| Read | LifecycleWorkflows.Read.All or LifecycleWorkflows.ReadWrite.All |Global Reader or Lifecycle Workflows Administrator |
+| Create, Update or Delete | LifecycleWorkflows.ReadWrite.All | Lifecycle Workflows Administrator |
## See also
v1.0 Identitygovernance Lifecycleworkflowscontainer https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-lifecycleworkflowscontainer.md
The following is a JSON representation of the resource.
"id": "String (identifier)" } ```+
v1.0 Identitygovernance Ondemandexecutiononly https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-ondemandexecutiononly.md
None.
The following is a JSON representation of the resource. <!-- { "blockType": "resource",
- "@odata.type": "microsoft.graph.identityGovernance.onDemandExecutionOnly"
+ "@odata.type": "microsoft.graph.identityGovernance.onDemandExecutionOnly",
+ "baseType": "microsoft.graph.identityGovernance.workflowExecutionConditions"
} --> ``` json
v1.0 Identitygovernance Rulebasedsubjectset https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-rulebasedsubjectset.md
Inherits from [subjectSet](../resources/subjectset.md).
### Supported user properties and query parameters
-Lifecycle Workflows supports the following [user properties](user.md#properties) for configuring the rules that are in the scope of an execution condition. You can use the `$filter` OData query parameter with either the `eq`, `ne`, `in`, or `startsWith` operators. You can also combine the filter expressions using one of the following conjunction and disjunction operators:
+Lifecycle Workflows supports the following user properties for configuring the rules that are in the scope of an execution condition. You can use the `$filter` OData query parameter with either the `eq`, `ne`, `in`, or `startsWith` operators. You can also combine the filter expressions using one of the following conjunction and disjunction operators:
+ `and` + `or` + `and` and `not`
You can also configure rules using [Directory (Azure AD) extensions](/graph/exte
| Example rule | Description | ||--| | `"rule": "(department eq 'Marketing')"` | Run the workflow for users in the "Marketing" department. |
-| `"rule": "(department ne 'Marketing')"` | Run the workflow for users not the "Marketing" department. |
-| `"rule": "(department in ('Marketing'))"` | Run the workflow for users not the "Marketing" department. |
+| `"rule": "(department ne 'Marketing')"` | Run the workflow for users not in the "Marketing" department. |
+| `"rule": "(department in ('Marketing'))"` | Run the workflow for users in the "Marketing" department. |
| `"rule": "(accountEnabled eq true)"` | Run the workflow for users whose account is enabled. | | `"rule": "(employeeOrgData/costCenter eq '100')"` | Run the workflow for users whose costCenter is `100`. | | `"rule": "(otherMails/any(p:startsWith(p, 'Av')))"` | Run the workflow for users whose **otherMails** starts with `Av`. |
v1.0 Identitygovernance Run https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-run.md
Inherits from [entity](../resources/entity.md).
|[List runs](../api/identitygovernance-workflow-list-runs.md)|[microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) collection|Get a list of the [run](../resources/identitygovernance-run.md) objects and their properties.| |[Get run](../api/identitygovernance-run-get.md)|[microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md)|Read the properties and relationships of a [run](../resources/identitygovernance-run.md) object.| |[summary](../api/identitygovernance-run-summary.md)|[microsoft.graph.identityGovernance.runSummary](../resources/identitygovernance-runsummary.md)|Get a summary of workflows runs.|
-|[List user processing results](../api/identitygovernance-run-summary.md)|[microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md) collection|Get a list of user processing results of a run.|
-|[Get user processing result](../api/identitygovernance-run-summary.md)|[microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md)|Get a user processing result of a run|
|[List task processing results of a run](../api/identitygovernance-run-list-taskprocessingresults.md)|[microsoft.graph.identityGovernance.taskReportSummary](../resources/identitygovernance-taskprocessingresult.md)|List task processing results from a run.| ## Properties
Inherits from [entity](../resources/entity.md).
|completedDateTime|DateTimeOffset|The date time that the run completed. Value is `null` if the workflow hasn't completed.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.| |failedTasksCount|Int32|The number of tasks that failed in the run execution.| |failedUsersCount|Int32|The number of users that failed in the run execution.|
+|id|String|A unique identifier for the workflow run.|
|lastUpdatedDateTime|DateTimeOffset|The datetime that the run was last updated.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
-|processingStatus|String|The run execution status. The possible values are: `queued`, `inProgress`, `completed`, `completedWithErrors`, `canceled`, `failed`, `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
+|processingStatus|microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus|The run execution status. The possible values are: `queued`, `inProgress`, `completed`, `completedWithErrors`, `canceled`, `failed`, `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
|startedDateTime|DateTimeOffset|The date time that the run execution started.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.| |scheduledDateTime|DateTimeOffset|The date time that the run is scheduled to be executed for a workflow.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.| |successfulUsersCount|Int32|The number of successfully completed users in the run.| |totalUsersCount|Int32|The total number of users in the workflow execution.|
+|totalTasksCounts|Int32|The total number of tasks in the run execution.|
|totalUnprocessedTasksCount|Int32|The total number of unprocessed tasks in the run execution.|
-|workflowExecutionType|String|The execution type of the workflows associated with the run. The possible values are: `scheduled`, `onDemand`, `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
+|workflowExecutionType|microsoft.graph.identityGovernance.workflowExecutionType|The execution type of the workflows associated with the run. The possible values are: `scheduled`, `onDemand`, `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
## Relationships
The following is a JSON representation of the resource.
"blockType": "resource", "keyProperty": "id", "@odata.type": "microsoft.graph.identityGovernance.run",
- "baseType": "microsoft.graph.entity",
"openType": false } -->
The following is a JSON representation of the resource.
"startedDateTime": "String (timestamp)", "scheduledDateTime": "String (timestamp)", "successfulUsersCount": "Integer",
+ "totalTasksCounts": "Integer",
"totalUsersCount": "Integer", "totalUnprocessedTasksCount": "Integer", "workflowExecutionType": "String"
v1.0 Identitygovernance Runsummary https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-runsummary.md
A summary of runs for a specified time period. This summary allows the administr
|failedTasks|Int32|The number of failed tasks of a workflow.| |successfulRuns|Int32|The number of successful workflow runs.| |totalRuns|Int32|The total number of runs for a workflow.|
+|totalTasks|Int32|The total number of tasks processed by a workflow.|
+|totalUsers|Int32|The total number of users processed by a workflow.|
## Relationships
The following is a JSON representation of the resource.
"failedRuns": "Integer", "failedTasks": "Integer", "successfulRuns": "Integer",
- "totalRuns": "Integer"
+ "totalRuns": "Integer",
+ "totalTasks": "Integer",
+ "totalUsers": "Integer"
} ```
v1.0 Identitygovernance Task https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-task.md
Inherits from [entity](../resources/entity.md).
|taskDefinitionId|String|A unique template identifier for the task. For more information about the tasks that Lifecycle Workflows currently supports and their unique identifiers, see [supported tasks](../resources/identitygovernance-task.md#supported-tasks). Required.<br><br>Supports `$filter`(`eq`, `ne`).| ### Supported tasks
-<!-- Comment out CRR until we can resolve the links problem
-> [!INCLUDE [lifecycle-workflows-tasks-table](../includes/identitygovernance-lifecycleworkflows-tasks-table.md)]
v1.0 Identitygovernance Taskdefinition https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-taskdefinition.md
Inherits from [entity](../resources/entity.md).
|Property|Type|Description| |:|:|:|
-|category|microsoft.graph.identityGovernance.lifecycleTaskCategory|The category of the HR function that the tasks created using this definition can be used with. The possible values are: `joiner`, `leaver`. This is a multi-valued enumeration whose allowed combinations are `joiner`, `joiner,leaver`, or `leaver`.<br><br>Supports `$filter`(`eq`, `ne`, `has`) and `$orderby`. |
+|category|microsoft.graph.identityGovernance.lifecycleTaskCategory|The category of the HR function that the tasks created using this definition can be used with. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. This is a multi-valued enumeration whose allowed combinations are `joiner`, `joiner,leaver`, or `leaver`.<br><br>Supports `$filter`(`eq`, `ne`, `has`) and `$orderby`. |
+|ContinueOnError|Boolean|Defines if the workflow will continue if the task has an error.|
|description|String|The description of the taskDefinition.| |displayName|String|The display name of the taskDefinition.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.| |id|String|The unique identifier for the taskDefinition. Inherited from [entity](../resources/entity.md).|
v1.0 Identitygovernance Timebasedattributetrigger https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-timebasedattributetrigger.md
None.
The following is a JSON representation of the resource. <!-- { "blockType": "resource",
- "@odata.type": "microsoft.graph.identityGovernance.timeBasedAttributeTrigger"
+ "@odata.type": "microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
+ "baseType": "microsoft.graph.identityGovernance.workflowExecutionTrigger"
} --> ``` json
v1.0 Identitygovernance Userprocessingresult https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-userprocessingresult.md
Inherits from [entity](../resources/entity.md).
|Method|Return type|Description| |:|:|:| |[List userProcessingResults](../api/identitygovernance-workflow-list-userprocessingresults.md)|[microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md) collection|Get a list of the [userProcessingResult](../resources/identitygovernance-userprocessingresult.md) objects and their properties.|
+|[Get userProcessingResult](../api/identitygovernance-userprocessingresult-get.md)|[microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md)|Get a user processing result.|
|[summary](../api/identitygovernance-userprocessingresult-summary.md)|[microsoft.graph.identityGovernance.userSummary](../resources/identitygovernance-usersummary.md)|Provides a summary of user processing results for a specified time period.|
-|[List taskProcessingResults](../api/identitygovernance-userprocessingresult-list-taskprocessingresults.md)|[microsoft.graph.identityGovernance.taskReport](../resources/identitygovernance-taskprocessingresult.md) collection|Get a list of the [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects and their properties.|
+|[List taskProcessingResults for a userProcessingResult](../api/identitygovernance-userprocessingresult-list-taskprocessingresults.md)|[microsoft.graph.identityGovernance.taskReport](../resources/identitygovernance-taskprocessingresult.md) collection|Get a list of the [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects and their properties.|
## Properties
Inherits from [entity](../resources/entity.md).
|:|:|:| |completedDateTime|DateTimeOffset|The date time that the workflow execution for a user completed. Value is null if the workflow hasn't completed.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.| |failedTasksCount|Int32|The number of tasks that failed in the workflow execution.|
-|id|String|Identifier used for individually addressing a specific user processing result. Inherited from [entity](../resources/entity.md).<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
-|processingStatus|String|The workflow execution status. The possible values are: `queued`, `inProgress`, `completed`, `completedWithErrors`, `canceled`, `failed`, `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
+|id|String|Identifier used for individually addressing a specific user processing result.Inherited from [entity](../resources/entity.md).<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
+|processingStatus|microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus|The workflow execution status. The possible values are: `queued`, `inProgress`, `completed`, `completedWithErrors`, `canceled`, `failed`, `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
|scheduledDateTime|DateTimeOffset|The date time that the workflow is scheduled to be executed for a user.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.| |startedDateTime|DateTimeOffset|The date time that the workflow execution started. Value is `null` if the workflow execution has not started.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.| |totalTasksCount|Int32|The total number of tasks that in the workflow execution.| |totalUnprocessedTasksCount|Int32|The total number of unprocessed tasks for the workflow.|
-|workflowExecutionType|String|Describes the execution type of the workflow. The possible values are: `scheduled`, `onDemand`, `unknownFutureValue`.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
+|workflowExecutionType|microsoft.graph.identityGovernance.workflowExecutionType|Describes the execution type of the workflow. The possible values are: `scheduled`, `onDemand`, `unknownFutureValue`.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
|workflowVersion|Int32|The version of the workflow that was executed.| ## Relationships
v1.0 Identitygovernance Workflowbase https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-workflowbase.md
None.
|:|:|:| |createdBy|[user](../resources/user.md)|The user who created the workflow.| |lastModifiedBy|[user](../resources/user.md)|The user who last modified the workflow.|
-|runs|[microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) collection|A history of every time a workflow ran.|
|tasks|[microsoft.graph.identityGovernance.task](../resources/identitygovernance-task.md) collection|The tasks in the workflow.|
-|userProcessingResults|[microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md) collection|The results of a user processed by the workflow.|
## JSON representation
v1.0 Identitygovernance Workflowtemplate https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-workflowtemplate.md
Inherits from [entity](../resources/entity.md).
|description|String|The description of the `workflowTemplate`.| |displayName|String|The display name of the `workflowTemplate`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.| |executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Conditions describing when to execute the workflow and the criteria to identify in-scope subject set.|
-|id|String|The unique identifier for the `workflowTemplate`. Inherited from [entity](../resources/entity.md).<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
+|id|String|The unique identifier for the `workflowTemplate`.Inherited from [entity](../resources/entity.md).<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
### Supported workflow templates
v1.0 Identitygovernance Workflowversion https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/identitygovernance-workflowversion.md
Inherits from [workflowBase](../resources/identitygovernance-workflowbase.md).
|:|:|:| |createdBy|[user](../resources/user.md)|The user who created the workflow. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md).<br><br>Supports `$filter`(`eq`, `ne`) and `$expand`.| |lastModifiedBy|[user](../resources/user.md)|The user who last modified the workflow.<br><br>Supports `$filter`(`eq`, `ne`) and `$expand`.|
-|runs|[microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) collection|A history of every time a workflow ran. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md).|
|tasks|[microsoft.graph.identityGovernance.task](../resources/identitygovernance-task.md) collection|The tasks in the workflow. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md).|
-|userProcessingResults|[microsoft.graph.identityGovernance.userProcessingResult](../resources/identitygovernance-userprocessingresult.md) collection|The results of a user processed by the workflow. Inherited from [workflowBase](../resources/identitygovernance-workflowbase.md).|
## JSON representation
v1.0 Industrydata Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/industrydata-overview.md
The industry data API is defined in the OData subnamespace `microsoft.graph.indu
## Industry data API and education
-The industry data API powers the [Microsoft School Data Sync](https://sds.microsoft.com) (SDS) platform to help automate the process of importing data and synchronizing organizations, users and users associations, and groups <!-- with Azure Active Directory (Azure AD) and Office 365 --> from student information systems (SIS) and student management systems (SMS) into an organization's Azure Data Lake. After normalizing the data in Azure Data Lake, the API utilizes the data in multiple outbound flows, synchronizing data with [Insights for Education Leaders](https://support.microsoft.com/topic/leader-s-guide-to-education-insights-premium-8738d1b1-4e1c-49bd-9e8d-b5292474c347) and [Education Data Lake Export](/schooldatasync/enable-education-data-lake-export) for custom analytics scenarios.
+The industry data API powers the [Microsoft School Data Sync](https://sds.microsoft.com) (SDS) platform to help automate the process of importing data and synchronizing organizations, users and users associations, and groups <!-- with Azure Active Directory (Azure AD) and Office 365 --> from student information systems (SIS) and student management systems (SMS) into an organization's Azure Data Lake. After normalizing the data in Azure Data Lake <!-- the API utilizes the data in multiple outbound flows, --> SDS can synchronize the data with [Insights for Education Leaders](/schooldatasync/enable-sync-with-insights), for use with the Insights app in Teams for Education, and [Education Data Lake Export](/schooldatasync/enable-education-data-lake-export), for custom analytics scenarios.
![Illustration of the industry data ETL process](/graph/images/industrydata-overview.png)
You can integrate industry data APIs with third-party apps. For details about ho
| Use case | REST resource | See also | | :- | :- | :-- | | Create an activity to import a delimited data set | [inboundFileFlow](../resources/industrydata-inboundfileflow.md) | [inboundFileFlow methods](../resources/industrydata-inboundfileflow.md#methods) |
-| Create a connector to retrieve data from an Azure Data Lake | [azureDataLakeConnector](../resources/industrydata-azuredatalakeconnector.md) | [azureDataLakeConnector methods](../resources/industrydata-azuredatalakeconnector.md#methods) |
| Define a source of inbound data | [sourceSystemDefinition](../resources/industrydata-sourcesystemdefinition.md) | [sourceSystemDefinition methods](../resources/industrydata-sourcesystemdefinition.md#methods) |
+| Create a connector to post data to an Azure Data Lake (if CSV)| [azureDataLakeConnector](../resources/industrydata-azuredatalakeconnector.md) | [azureDataLakeConnector methods](../resources/industrydata-azuredatalakeconnector.md#methods) |
<!-- ## Concepts
v1.0 Logicapptriggerendpointconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/logicapptriggerendpointconfiguration.md
Title: "logicAppTriggerEndpointConfiguration resource type" description: "The configuration details for the logic app's endpoint that is associated with a custom access package workflow extension."-+ ms.localizationpriority: medium ms.prod: "governance" doc_type: resourcePageType
The configuration details for the logic app's endpoint that is associated with a
|logicAppWorkflowName|String|The name of the logic app.| |resourceGroupName|String|The Azure resource group name for the logic app.| |subscriptionId|String|Identifier of the Azure subscription for the logic app.|
+|url|String| The URL to the logic app endpoint that will be triggered. Only required for app-only token scenarios where app is creating a [customCalloutExtension](../resources/customcalloutextension.md) without a signed-in user.|
## JSON representation
The following is a JSON representation of the resource.
"@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration", "subscriptionId": "String", "resourceGroupName": "String",
- "logicAppWorkflowName": "String"
+ "logicAppWorkflowName": "String",
+ "url": "String"
} ```
v1.0 Microsoft Teams Team Usage Reports https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/microsoft-teams-team-usage-reports.md
Use the Microsoft Teams team activity reports to get insights into the usage of
| Function | CSV return type | JSON return type | Description | | : | | - | - | | [Get team detail](../api/reportroot-getteamsteamactivitydetail.md) | Stream | Stream | Get details about Teams activity by team. The numbers include activities for both licensed and non-licensed users. |
-| [Get team counts](../api/reportroot-getteamsteamactivitycounts.md) | Stream | Stream | Get the number of team activities across Microsoft Teams. The activity types are related to meetings and messages. |
+| [Get team activity counts](../api/reportroot-getteamsteamactivitycounts.md) | Stream | Stream | Get the number of team activities across Microsoft Teams. The activity types are related to meetings and messages. |
+| [Get team counts](../api/reportroot-getteamsteamcounts.md) | Stream | Stream | Get the number of teams by type across Microsoft Teams. |
| [Get distribution team counts](../api/reportroot-getteamsteamactivitydistributioncounts.md) | Stream | Stream | Get the number of team activities across Microsoft Teams over a selected period. |
v1.0 Microsoftauthenticatorauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/microsoftauthenticatorauthenticationmethodconfiguration.md
Namespace: microsoft.graph
Represents a Microsoft Authenticator 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| |:|:|:|
v1.0 Organization https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/organization.md
This resource lets you add your own data to custom properties using [extensions]
|[Get open extension](../api/opentypeextension-get.md) |[openTypeExtension](opentypeextension.md) collection| Get an open extension identified by the extension name.| |**Schema extensions**| | | |[Add schema extension values](../api/schemaextension-post-schemaextensions.md) | [schemaExtension](schemaextension.md) | Create a schema extension definition and then use it to add custom typed data to a resource.|
-|**Organization licenses**| | |
-|[activateService](../api/organization-activateservice.md) (deprecated) | None | Activate a service for an organization. |
|**Organizational branding**| | | |[Get organizationalBranding](../api/organizationalbranding-get.md) | [organizationalBranding](organizationalbranding.md) | Get the default organizational branding object. | |[Update organizationalBranding](../api/organizationalbranding-update.md) | [organizationalBranding](organizationalbranding.md) | Update the default organizational branding object. |
v1.0 Plannerbucket https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannerbucket.md
Represents a bucket (or "custom column") for tasks in a plan in Microsoft 365. I
|[Create](../api/planner-post-buckets.md) | [plannerBucket](plannerbucket.md) | Create a new **plannerBucket** object. | |[Update](../api/plannerbucket-update.md) | [plannerBucket](plannerbucket.md) |Update **plannerBucket** object. | |[Delete](../api/plannerbucket-delete.md) | None |Delete **plannerBucket** object. |
+|[Get delta](../api/plannerbucket-delta.md)|[plannerBucket](../resources/plannerbucket.md) collection| Get newly created, updated, or deleted **plannerBucket** objects in a Planner plan without having to perform a full read of the entire resource collection.|
## Properties | Property | Type |Description|
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
|[List tasks](../api/plannerplan-list-tasks.md) |[plannerTask](plannertask.md) collection| Get a **plannerTask** object collection.| |[Update](../api/plannerplan-update.md) | [plannerPlan](plannerplan.md) |Update **plannerPlan** object. | |[Delete](../api/plannerplan-delete.md) | None | Delete **plannerPlan** object. |
+|[Get delta](../api/plannerplan-delta.md) | [plannerPlan](../resources/plannerplan.md) collection | Get newly created, updated, or deleted **plannerPlan** objects in either a **group** or a [plannerRoster](plannerroster.md) type container without having to perform a full read of the entire resource collection. |
## Properties | Property | Type |Description|
The following is a JSON representation of the resource.
"suppressions": [] } -->--
v1.0 Plannertask https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/plannertask.md
Represents a Planner task in Microsoft 365. A Planner task is contained in a [pl
|[Get plannerTask](../api/plannertask-get.md) | [plannerTask](plannertask.md) |Read properties and relationships of **plannerTask** object.| |[Update](../api/plannertask-update.md) | [plannerTask](plannertask.md) |Update **plannerTask** object. | |[Delete](../api/plannertask-delete.md) | None |Delete **plannerTask** object. |
+|[Get delta](../api/plannertask-delta.md)|[plannerTask](../resources/plannertask.md) collection| Get newly created, updated, or deleted **plannerTask** objects in either a **plannerPlan** or assigned to the signed-in user without having to perform a full read of the entire resource collection. |
## Properties | Property | Type |Description|
v1.0 Quota https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/quota.md
-description: The quota resource provides details about space constrains on a drive resource.
+description: The quota resource provides details about space constraints on a drive resource.
Last updated 09/10/2017 Title: Quota ms.localizationpriority: medium
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-The **quota** resource provides details about space constrains on a [drive](drive.md) resource.
+The **quota** resource provides details about space constraints on a [drive](drive.md) resource. In OneDrive Personal, the values reflect the total/used unified storage quota across multiple Microsoft services.
## JSON representation
v1.0 Report https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/report.md
The following table shows the availability for each API across all cloud deploym
| [Admin Report Settings](/graph/api/resources/adminreportsettings?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | Γ£ö | | [Microsoft 365 activations](/graph/api/resources/office-365-activations-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | Γ₧û | | [Microsoft 365 active users](/graph/api/resources/office-365-active-users-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | Γ₧û |
-| [Microsoft 365 Apps usage](/graph/api/resources/microsoft-365-apps-usage-report?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | Γ₧û |
+| [Microsoft 365 Apps usage](/graph/api/resources/microsoft-365-apps-usage-report?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | Γ₧û |
| [Microsoft 365 browser usage](/graph/api/resources/microsoft-365-browser-usage-report?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | Γ₧û | | [Microsoft 365 groups activity](/graph/api/resources/office-365-groups-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | Γ₧û | | [Microsoft Teams device usage](/graph/api/resources/microsoft-teams-device-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ₧û | Γ₧û | Γ£ö |
v1.0 Security Api Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-api-overview.md
Alerts from the following security providers are available via this legacy **ale
| Security provider | <p align="center">GET alert</p>| <p align="center">PATCH alert</p>| <p align="center">Subscribe to alert</p>| |:|:|:--|:|
-|[Azure Active Directory Identity Protection](/azure/active-directory/identity-protection/playbook) **** | <p align="center">&#x2713;</p> | <p align="center">[File issue](https://github.com/microsoftgraph/security-api-solutions/issues/new) *</p> | <p align="center">&#x2713;</p> |
+|[Azure Active Directory Identity Protection](/azure/active-directory/identity-protection/playbook) | <p align="center">&#x2713;</p> | <p align="center">[File issue](https://github.com/microsoftgraph/security-api-solutions/issues/new) *</p> | <p align="center">&#x2713;</p> |
|[Azure Security Center](/azure/security-center/security-center-alerts-type)| <p align="center">&#x2713;</p> | <p align="center">&#x2713;</p> | <p align="center">&#x2713;</p> | |Microsoft 365 <ul><li> [Default](/office365/securitycompliance/alert-policies#default-alert-policies)</li> <li>[Cloud App Security](/office365/securitycompliance/anomaly-detection-policies-in-ocas)</li><li>Custom Alert</li></ul> | <p align="center">&#x2713;</p> | <p align="center"> [File issue](https://github.com/microsoftgraph/security-api-solutions/issues/new) </p> | <p align="center"> [File issue](https://github.com/microsoftgraph/security-api-solutions/issues/new) </p> | | [Microsoft Defender for Cloud Apps](/cloud-app-security/monitor-alerts) (formerly Microsoft Cloud App Security) | <p align="center">&#x2713;</p> | <p align="center">[File issue](https://github.com/microsoftgraph/security-api-solutions/issues/new) *</p> | <p align="center">&#x2713;</p> |
Alerts from the following security providers are available via this legacy **ale
\*\*\* Microsoft Defender for Identity alerts are available via the Microsoft Defender for Cloud Apps integration. This means you will get Microsoft Defender for Identity alerts only if you have joined Unified SecOps and connected Microsoft Defender for Identity into Microsoft Defender for Cloud Apps. Learn more about [how to integrate Microsoft Defender for Identity and Microsoft Defender for Cloud Apps](/azure-advanced-threat-protection/atp-mcas-integration).
-\*\*\*\* Azure AD Identity Protection alerts only include user object IDs. The **userPrincipalName** (UPN) property is not included in GET request responses. This issue does not impact any of the other providers. For details and a workaround, see [Known issues](/graph/known-issues#upn-missing-in-identity-protection-security-alerts).
- ## Attack simulation and training [Attack simulation and training](/microsoft-365/security/office-365-security/attack-simulation-training) is part of [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/defender-for-office-365?view=o365-worldwide&preserve-view=true). This service lets users in a tenant experience a realistic benign phishing attack and learn from it. Social engineering simulation and training experiences for end users help reduce the risk of users being breached via those attack techniques. The attack simulation and training API enables tenant administrators to view launched [simulation](simulation.md) exercises and trainings, and get [reports](report-m365defender-reports-overview.md) on derived insights into online behaviors of users in the phishing simulations.
v1.0 Security Ediscoveryexportfilemetadata https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-ediscoveryexportfilemetadata.md
+
+ Title: "ediscoveryExportFileMetadata resource type"
+description: "Represents the file metadata for an export in eDiscovery."
+
+ms.localizationpriority: medium
++
+# ediscoveryExportFileMetadata resource type
+
+Namespace: microsoft.graph.security
++
+Represents the file metadata for an export in eDiscovery.
+
+## Properties
+
+|Property|Type|Description|
+|:|:|:|
+|downloadUrl| String |The URL to download the export. |
+|fileName | String | The name of the file. |
+|size| Int64 | The size of the file. |
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.security.ediscoveryExportFileMetadata",
+ "openType": false
+}
+-->
+
+``` json
+{
+ "@odata.type": "#microsoft.graph.security.ediscoveryExportFileMetadata",
+ "downloadUrl": "String",
+ "fileName": "String",
+ "size": "Int64"
+}
+```
v1.0 Security Ediscoveryexportoperation https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-ediscoveryexportoperation.md
Inherits from [caseOperation](../resources/security-caseoperation.md).
## Methods |Method|Return type|Description| |:|:|:|
-|[getDownloadUrl](../api/security-ediscoveryexportoperation-getdownloadurl.md)|String| Returns the URL for the export.|
+|[getDownloadUrl](../api/security-ediscoveryexportoperation-getdownloadurl.md) (deprecated) |String| Return the URL for the export. The **getDownloadUrl** function is deprecated and will stop returning data on April 30th, 2023. Please use the new **exportFileMetadata** property returned by the [Get caseOperation](../api/security-ediscoverycase-get.md) API instead.|
## Properties |Property|Type|Description| |:|:|:| |action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`|
-|azureBlobContainer|String| The name of the Azure storage location where the export will be stored. This only applies to exports stored in your own Azure storage location. |
-|azureBlobToken|String| The SAS token for the Azure storage location. This only applies to exports stored in your own Azure storage location. |
|completedDateTime|DateTimeOffset| The date and time the export was completed.| |createdBy|[identitySet](../resources/identityset.md)| The user who initiated the export operation.| |createdDateTime|DateTimeOffset| The date and time the export was created.| |description|String| The description provided for the export.|
-|exportOptions|microsoft.graph.security.exportOptions| The options provided for the export. For more details, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`.|
+|exportFileMetaData | [microsoft.graph.security.ediscoveryExportFileMetadata](../resources/security-ediscoveryexportfilemetadata.md)| Contains the properties for an export file metadata, including **downloadUrl**, **fileName**, and **size**. If you export to an Azure storage location, this property returns empty. |
+|exportOptions|microsoft.graph.security.exportOptions| The options provided for the export. For more details, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`. The `fileInfo` member is deprecated and will stop returning data on April 30th, 2023. Going forward, the summary and load file are always included. |
|exportStructure|microsoft.graph.security.exportFileStructure|The options provided that specify the structure of the export. For more details, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `none`, `directory`, `pst`.| |id|String| The ID for the operation. Read-only. | |outputName|String| The name provided for the export.| |percentProgress|Int32| The progress of the operation.| |resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/ediscovery-caseoperation.md).| |status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.|
+|azureBlobContainer (deprecated)|String| The name of the Azure storage location where the export is stored. This only applies to exports stored in your own Azure storage location. The **azureBlobContainer** property is deprecated and will stop returning data on April 30th, 2023. |
+|azureBlobToken (deprecated)|String| The SAS token for the Azure storage location. This only applies to exports stored in your own Azure storage location. The **azureBlobToken** property is deprecated and will stop returning data on April 30th, 2023. |
+|outputFolderId (deprecated) | String | The output folder ID. The **outputFolderId** property is deprecated and will stop returning data on April 30th, 2023.
### exportOptions values
Inherits from [caseOperation](../resources/security-caseoperation.md).
|originalFiles|Include original files in native format. For example: docx, xlsx, pptx, doc, xlst, pptm, etc.| |text|Include extracted text from the original files.| |pdfReplacement|Replace original file with PDF version when available.|
-|fileInfo|Include metadata of original files in a load file.|
|tags|Include tag information in fileInfo.|
+|fileInfo (deprecated) |Include metadata of original files in a load file. The `fileInfo` member is deprecated and will stop returning data on April 30th, 2023. Going forward, the summary and load file are always included. |
### exportFileStructure values
Inherits from [caseOperation](../resources/security-caseoperation.md).
|reviewSet|[microsoft.graph.security.ediscoveryReviewSet](../resources/security-ediscoveryreviewset.md)| Review set from where documents are exported.| |reviewSetQuery|[microsoft.graph.security.ediscoveryReviewSetQuery](../resources/security-ediscoveryreviewsetquery.md)|The review set query which is used to filter the documents for export.| + ## JSON representation The following is a JSON representation of the resource. <!-- {
The following is a JSON representation of the resource.
"openType": false } -->+ ``` json { "@odata.type": "#microsoft.graph.security.ediscoveryExportOperation",
- "id": "String (identifier)",
- "createdDateTime": "String (timestamp)",
- "completedDateTime": "String (timestamp)",
"action": "String",
+ "azureBlobContainer": "String",
+ "azureBlobToken": "String",
+ "completedDateTime": "String (timestamp)",
"createdBy": { "@odata.type": "microsoft.graph.identitySet" },
- "percentProgress": "Integer",
- "status": "String",
+ "createdDateTime": "String (timestamp)",
+ "description": "String",
+ "exportFileMetadata": {
+ "@odata.type": "microsoft.graph.security.ediscoveryExportFileMetadata"
+ },
+ "exportOptions": "String",
+ "exportStructure": "String",
+ "id": "String (identifier)",
+ "outputFolderId": "String",
+ "outputName": "String",
+ "percentProgress": "Int32",
"resultInfo": { "@odata.type": "microsoft.graph.resultInfo" },
- "outputName": "String",
- "description": "String",
- "outputFolderId": "String",
- "azureBlobContainer": "String",
- "azureBlobToken": "String",
- "exportOptions": "String",
- "exportStructure": "String"
+ "status": "String"
} ```-
v1.0 Service Communications Api Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/service-communications-api-overview.md
For more information on access tokens, app registration, and delegated and appli
Delegated permissions are needed to access the service communications API on behalf of a signed-in user. Customer-facing canvas applications, such as the [Microsoft 365 admin center](https://admin.microsoft.com/Adminportal/Home?source=applauncher#/homepage) (accessible only to admin roles), can call the service communications API to get the service health and service announcements data for the signed-in user's tenant, _on behalf of the signed-in user_. Users can find out whether their subscribed services are healthy or have issues. They can also learn about any current service issues affecting their tenants.
+#### Role-based access control for delegation access
+
+The service communications API applies role-based access control (RBAC) to identify whether the signed-in user who is on-behalf of has a required Azure Active Directory (Azure AD) role. The signed-in user who is on-behalf of must have at least one of the admin roles.
+
+For more information about the AZure AD administrator roles, see:
+* [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles)
+* [Azure AD built-in roles](/azure/active-directory/roles/permissions-reference)
+* [Roles in Microsoft 365, including Azure AD, service-specific and cross-service roles](/azure/active-directory/roles/concept-understand-roles#how-azure-ad-roles-are-different-from-other-microsoft-365-roles)
+ ### Access service communications API without user Application permissions are needed to access the service communications API without a signed-in user. Applications that run as backend services, such as monitoring or alert services, can call the service communications API with their own identity and not on behalf of a user. These backend services can build custom monitoring/alert pipelines and call the service communications API to get service health and service announcements data.
That service communications API is available in all Microsoft national cloud dep
|Microsoft Graph global service| https://graph.microsoft.com/beta/admin/serviceAnnouncement/| |Microsoft Graph for US Government L4 (GccHigh)|https://graph.microsoft.us/beta/admin/serviceAnnouncement/| |Microsoft Graph for US Government L5 (DoD)|https://dod-graph.microsoft.us/beta/admin/serviceAnnouncement/|
-|Microsoft Graph Germany|https://graph.microsoft.de/beta/admin/serviceAnnouncement/|
|Microsoft Graph China operated by 21Vianet|https://microsoftgraph.chinacloudapi.cn/beta/admin/serviceAnnouncement/| ## Service communications limits
v1.0 Servicestoragequotabreakdown https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/servicestoragequotabreakdown.md
+
+ Title: "serviceStorageQuotaBreakdown resource type"
+description: "Represents a proportion of the unified storage quota associated with a specific service."
+
+ms.localizationpriority: medium
++
+# serviceStorageQuotaBreakdown resource type
+
+Namespace: microsoft.graph
++
+Represents a proportion of the unified storage quota associated with a specific service.
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List serviceStorageQuotaBreakdown](../api/unifiedstoragequota-list-services.md)| [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.md) collection|Get a list of services in the serviceStorageQuotaBreakdown.|
+|[Get serviceStorageQuotaBreakdown](../api/servicestoragequotabreakdown-get.md)|[serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.md)|Read the properties and relationships of a [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.md) object.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|The service breakdown name displayed to users. Localized. Read-only.|
+|id|String|The service breakdown id. Read-only.|
+|manageWebUrl|String|A URL that can be used in a browser to manage the service breakdown. Read-only.|
+|used|Int64|The number of bytes this service breakdown is consuming. Read-only.|
+
+## Relationships
+None.
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.serviceStorageQuotaBreakdown",
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.serviceStorageQuotaBreakdown",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "manageWebUrl": "String",
+ "used": "Integer"
+}
+```
+
v1.0 Signinactivity https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/signinactivity.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Provides the last interactive or non-interactive sign-in time for a specific [user](user.md). Since signInActivity describes a property of the user object, Azure AD stores signinactivity for your users for as long as the user objects exist.
+Provides the last interactive or non-interactive sign-in time for a specific [user](user.md). Since signInActivity describes a property of the user object, Azure AD stores signinactivity for your users for as long as the user object exists.
## Properties
The following is a JSON representation of the resource.
```json {
+ "@odata.type": "#microsoft.graph.signInActivity",
"lastSignInDateTime": "String (timestamp)", "lastSignInRequestId": "String", "lastNonInteractiveSignInDateTime": "String (timestamp)",
v1.0 Smsauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/smsauthenticationmethodconfiguration.md
Title: "smsAuthenticationMethodConfiguration resource type" description: "Represents a Text Message authentication methods policy."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType
Namespace: microsoft.graph
Represents a Text Message 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| |:|:|:|
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 groups enabled to use Text Message authentication methods policy."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: resourcePageType
v1.0 Softwareoathauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/softwareoathauthenticationmethodconfiguration.md
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.
+Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).
## Methods |Method|Return type|Description|
v1.0 Subscription https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/subscription.md
For the possible resource path values for each supported resource, see [Use the
### Maximum length of subscription per resource type
-| Resource | Maximum expiration time |
-|:--|:-|
-| Security **alert** | 43200 minutes (under 30 days) |
-| Teams **callRecord** | 4230 minutes (under 3 days) |
-| Teams **channel** | 60 minutes (1 hour) |
-| Teams **chat** | 60 minutes (1 hour) |
-| Teams **chatMessage** | 60 minutes (1 hour) |
-| Teams **conversationMember** | 60 minutes (1 hour) |
-| Teams **onlineMeeting** | 4320 minutes (3 days) |
-| Teams **team** | 60 minutes (1 hour) |
-| Group **conversation** | 4230 minutes (under 3 days) |
-| OneDrive **driveItem** | 42300 minutes (under 30 days) |
-| SharePoint **list** | 42300 minutes (under 30 days) |
-| Outlook **message**, **event**, **contact** | 4230 minutes (under 3 days) |
-| **user**, **group**, other directory resources | 41760 minutes (under 29 days) |
-| **onlineMeeting** | 4230 minutes (under 3 days) |
-| **presence** | 60 minutes (1 hour) |
-| Print **printer** | 4230 minutes (under 3 days) |
-| Print **printTaskDefinition** | 4230 minutes (under 3 days) |
-| **todoTask** | 4230 minutes (under 3 days) |
-| **baseTask** (deprecated) | 4230 minutes (under 3 days) |
--
-> **Note:** Existing applications and new applications should not exceed the supported value. In the future, any requests to create or renew a subscription beyond the maximum value will fail.
## Relationships
Here is a JSON representation of the resource.
"notificationContentType": "String", "notificationUrlAppId": "String" }
-```
+```
v1.0 Teamtemplate https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/teamtemplate.md
Namespace: microsoft.graph
Represents a logical container for all the definitions and versions of the same team template.
-> **Note**: This API is currently in private preview only. When it reaches public preview, we will publish a blog post announcement on the [Microsoft 365 Developer blog](https://devblogs.microsoft.com/microsoft365dev/).
## Methods
v1.0 Teamtemplatedefinition https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/teamtemplatedefinition.md
Generic representation of a team template definition for a team with a specific
Inherits from [entity](../resources/entity.md).
-> **Note**: This API is currently in private preview only. When it reaches public preview, we will publish a blog post announcement on the [Microsoft 365 Developer blog](https://devblogs.microsoft.com/microsoft365dev/).
- ## Methods |Method|Return type|Description|
v1.0 Teamworktag https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/teamworktag.md
When a tag is added, users can @mention it in a channel. Everyone who has been a
## Properties |Property|Type|Description| |:|:|:|
-|description|String|Tag description as it will appear to the user in Microsoft Teams.|
+|description|String|Tag description as it will appear to the user in Microsoft Teams. A **teamworkTag** can't have more than 200 **teamworkTagMembers**.|
|displayName|String|Tag name as it will appear to the user in Microsoft Teams.| |id|String|ID of the tag.| |memberCount|Int32|The number of users assigned to the tag.|
The following is a JSON representation of the resource.
``` ## See also-- [teamworkTagMember](../resources/teamworktagmember.md)
+- [teamworkTagMember](../resources/teamworktagmember.md)
v1.0 Temporaryaccesspassauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/temporaryaccesspassauthenticationmethodconfiguration.md
Namespace: microsoft.graph
Represents a Temporary Access Pass authentication methods policy that defines the configuration settings and users or groups who are enabled to use the [Temporary Access Pass authentication method](temporaryaccesspassauthenticationmethod.md).
+Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).
+ ## Methods |Method|Return type|Description| |:|:|:|
v1.0 Tokenlifetimepolicy https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/tokenlifetimepolicy.md
Inherits from [stsPolicy](stsPolicy.md).
| Method | Return Type | Description | |:-|:|:|
+| [List tokenLifetimePolicies](../api/tokenlifetimepolicy-list.md) | [tokenLifetimePolicy](tokenlifetimepolicy.md) | Read properties and relationships of tokenLifetimePolicies objects. |
| [Create tokenLifetimePolicy](../api/tokenlifetimepolicy-post-tokenlifetimepolicies.md) | [tokenLifetimePolicy](tokenlifetimepolicy.md) | Create a tokenLifetimePolicy object. | | [Get tokenLifetimePolicy](../api/tokenlifetimepolicy-get.md) | [tokenLifetimePolicy](tokenlifetimepolicy.md) | Read properties and relationships of a tokenLifetimePolicy object. |
-| [List tokenLifetimePolicies](../api/tokenlifetimepolicy-list.md) | [tokenLifetimePolicy](tokenlifetimepolicy.md) | Read properties and relationships of tokenLifetimePolicies objects. |
| [Update tokenLifetimePolicy](../api/tokenlifetimepolicy-update.md) | None | Update a tokenLifetimePolicy object. | | [Delete tokenLifetimePolicy](../api/tokenlifetimepolicy-delete.md) | None | Delete a tokenLifetimePolicy object. | | [List appliesTo](../api/tokenlifetimepolicy-list-appliesto.md) | [directoryObject](directoryobject.md) collection | Get the list of directoryObjects that this policy has been applied to. |
Inherits from [stsPolicy](stsPolicy.md).
| Property | Type | Description | |:-|:|:| |id|String| Unique identifier for this policy. Read-only.|
-|definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required.|
+|definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy. For more information about the JSON schema for this property, see [Properties of a token lifetime policy definition](#properties-of-a-token-lifetime-policy-definition). Required.|
|description|String| Description for this policy.| |displayName|String| Display name for this policy. Required.| |isOrganizationDefault|Boolean|If set to `true`, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is `false`.| ### Properties of a token lifetime policy definition+ The properties below form the JSON object that represents a token lifetime policy. This JSON object must be **converted to a string with quotations escaped** to be inserted into the **definition** property. An example is shown below in JSON format: <!-- {
v1.0 Unifiedstoragequota https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/unifiedstoragequota.md
+
+ Title: "unifiedStorageQuota resource type"
+description: Provides an aggregate view of a user's quota information across multiple services.
+
+ms.localizationpriority: medium
++
+# unifiedStorageQuota resource type
+
+Namespace: microsoft.graph
++
+Provides an aggregate view of a user's quota information across multiple services.
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[Get unifiedStorageQuota](../api/unifiedstoragequota-get.md)|[unifiedStorageQuota](../resources/unifiedstoragequota.md)|Read the properties and relationships of a [unifiedStorageQuota](../resources/unifiedstoragequota.md) object.|
+|[List serviceStorageQuotaBreakdown](../api/unifiedstoragequota-list-services.md)| [serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.md) collection|Get the list of services in a **serviceStorageQuotaBreakdown**.|
+
+## Properties
+
+|Property|Type|Description|
+|:|:|:|
+|id|String|The user IF.|
+|manageWebUrl|String| A URL that can be used in a browser to manage the breakdown. Read-only. |
+|remaining|Int64| Total space remaining before reaching the quota limit in bytes. |
+|state|usqState| Indicates the state of the storage space. The possible values are: `normal`, `nearing`, `critical`, `full`, and `overLimit`.|
+|total|Int64| Total allowed storage space in bytes. |
+|used|Int64| Total space used in bytes. |
+
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|services|[serviceStorageQuotaBreakdown](../resources/servicestoragequotabreakdown.md) collection| The breakdown of services contributing to the user's quota usage. |
++
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.unifiedStorageQuota",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.unifiedStorageQuota",
+ "id": "String",
+ "manageWebUrl": "String",
+ "remaining": "Integer",
+ "state": "normal | nearing | critical | full | overLimit",
+ "total": "Integer",
+ "used": "Integer"
+}
+```
+
v1.0 User https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/user.md
This resource supports:
| [Get deleted user](../api/directory-deleteditems-get.md) | [directoryObject](directoryobject.md) collection | Retrieve a deleted user by ID. | | [Restore deleted user](../api/directory-deleteditems-delete.md) | [directoryObject](directoryobject.md) collection | Restore a user deleted in the tenant in the last 30 days. | | [Permanently delete user](../api/directory-deleteditems-restore.md) | [directoryObject](directoryobject.md) collection | Permanently delete a deleted user from the tenant. |
-| [activateServicePlan](../api/user-activateserviceplan.md) (deprecated) | None | Activate a service with a given `servicePlanId` and `skuId` for a given [user](user.md). |
| **Drive** ||| | [Get drive](../api/drive-get.md) | [drive](drive.md) | Retrieve the properties and relationships of a Drive resource. | | [List children](../api/driveitem-list-children.md) | [DriveItems](driveitem.md) | Return a collection of DriveItems in the children relationship of a DriveItem. |
This resource supports:
| showInAddressList | Boolean | **Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead.** Represents whether the user should be included in the Outlook global address list. See [Known issue](/graph/known-issues#showinaddresslist-property-is-out-of-sync-with-microsoft-exchange).| | signInSessionsValidFromDateTime | DateTimeOffset | Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use [revokeSignInSessions](../api/user-revokesigninsessions.md) to reset.| | skills | String collection | A list for the user to enumerate their skills. <br><br>Returned only on `$select`. |
-| signInActivity | [signInActivity](signinactivity.md) | Get the last signed-in date and request ID of the sign-in for a given user. Read-only.<br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`) *but*, not with any other filterable properties. **Note:** Details for this property require an Azure AD Premium P1/P2 license and the **AuditLog.Read.All** permission.<br><br>**Note:** <br/><li>There's a [known issue](/graph/known-issues#license-check-errors-for-azure-ad-activity-reports) with retrieving this property.<li>This property is not returned for a user who has never signed in or last signed in before April 2020.|
+| signInActivity | [signInActivity](signinactivity.md) | Get the last signed-in date and request ID of the sign-in for a given user. Read-only.<br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`) *but* not with any other filterable properties. <br><br>**Note:** <br/><li> Details for this property require an Azure AD Premium P1/P2 license and the **AuditLog.Read.All** permission.<li>There's a [known issue](/graph/known-issues#license-check-errors-for-azure-ad-activity-reports) with retrieving this property.<li>This property is not returned for a user who has never signed in or last signed in before April 2020.|
| state | String | The state or province in the user's address. Maximum length is 128 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | | streetAddress | String | The street address of the user's place of business. Maximum length is 1024 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| | surname | String | The user's surname (family name or last name). Maximum length is 64 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). |
v1.0 Voiceauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/voiceauthenticationmethodconfiguration.md
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
v1.0 Windowsupdates Featureupdatecatalogentry https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/windowsupdates-featureupdatecatalogentry.md
Title: "featureUpdateCatalogEntry resource type"
-description: "Metadata for a Windows 10 feature update that you can approve for deployment."
+description: "Represents metadata for a Windows 10 feature update that you can approve for deployment."
ms.localizationpriority: medium ms.prod: "w10"
Namespace: microsoft.graph.windowsUpdates
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Metadata for a Windows 10 feature update that you can approve for deployment.
+Represents metadata for a Windows 10 feature update that you can approve for deployment.
-Windows 10 feature updates are released bi-annually and contain new features for Windows 10. Installing these updates increases the Windows 10 build number and typically results in a new servicing lifecycle and end of service date. Microsoft recommends organizations regularly deploy new feature updates as part of adopting Windows as a service.
+Windows 10 feature updates are released bi-annually and contain new features for Windows 10. Installing these updates increases the Windows 10 build number and typically results in a new servicing lifecycle and end of service date. We recommend organizations regularly deploy new feature updates as part of adopting Windows as a service.
Inherits from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).
The following is a JSON representation of the resource.
``` json { "@odata.type": "#microsoft.graph.windowsUpdates.featureUpdateCatalogEntry",
- "id": "String (identifier)",
+ "deployableUntilDateTime": "String (timestamp)",
"displayName": "String",
+ "id": "String (identifier)",
"releaseDateTime": "String (timestamp)",
- "deployableUntilDateTime": "String (timestamp)",
"version": "String" } ```
v1.0 Windowsupdates Qualityupdatecatalogentry https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/windowsupdates-qualityupdatecatalogentry.md
Title: "qualityUpdateCatalogEntry resource type"
-description: "Metadata for a Windows 10 quality update that you can be approve for deployment."
+description: "Represents metadata for a Windows 10 quality update that you can approve for deployment."
ms.localizationpriority: medium ms.prod: "w10"
Namespace: microsoft.graph.windowsUpdates
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Metadata for a Windows 10 quality update that you can be approve for deployment.
+Represents metadata for a Windows 10 quality update that you can approve for deployment.
-Windows 10 quality updates are released one or more times per month. These updates contain both security and quality fixes and are typically released on the second Tuesday of every month, though they may be released at any time. These updates are cumulative, so later versions always contain all previous fixes. Microsoft strongly recommends keeping devices current by installing the most recent quality updates as soon as they are available.
+Windows 10 quality updates are released one or more times per month. These updates contain both security and quality fixes and are typically released on the second Tuesday of every month, though they might be released at any time. These updates are cumulative, so later versions always contain all previous fixes. We strongly recommend keeping devices current by installing the most recent quality updates as soon as they are available.
Inherits from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).
The following is a JSON representation of the resource.
``` json { "@odata.type": "#microsoft.graph.windowsUpdates.qualityUpdateCatalogEntry",
- "id": "String (identifier)",
- "displayName": "String",
- "releaseDateTime": "String (timestamp)",
"deployableUntilDateTime": "String (timestamp)",
+ "displayName": "String",
+ "id": "String (identifier)",
"isExpeditable": "Boolean",
- "qualityUpdateClassification": "String"
+ "qualityUpdateClassification": "String",
+ "releaseDateTime": "String (timestamp)"
} ```
v1.0 X509certificateauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/x509certificateauthenticationmethodconfiguration.md
Inherits from [authenticationMethodConfiguration](../resources/authenticationmet
## Properties |Property|Type|Description| |:|:|:|
-|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.|
+|authenticationModeConfiguration|[x509CertificateAuthenticationModeConfiguration](../resources/x509certificateauthenticationmodeconfiguration.md)|Defines strong authentication configurations. This configuration includes the default authentication mode and the different rules for strong authentication bindings. |
+|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. |
|id|String|The identifier for the authentication method policy. The value is always `X509Certificate`. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).|
+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.|
|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. |
-|authenticationModeConfiguration|[x509CertificateAuthenticationModeConfiguration](../resources/x509certificateauthenticationmodeconfiguration.md)|Defines strong authentication configurations. This configuration includes the default authentication mode and the different rules for strong authentication bindings. |
## Relationships
v1.0 Appmanagementpolicy Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appManagementPolicy-delete.md
+
+ Title: "Delete appManagementPolicy"
+description: "Delete an application management policy."
+ms.localizationpriority: medium
+++
+# Delete appManagementPolicy
+
+Namespace: microsoft.graph
++
+Delete an [appManagementPolicy](../resources/appManagementPolicy.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.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+DELETE /policies/appManagementPolicies/{id}
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+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.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_appManagementPolicy"
+}-->
+
+```http
+DELETE https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}
+```
++
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": false
+} -->
+
+```http
+HTTP/1.1 204 No Content
+
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "delete appManagementPolicy",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Appmanagementpolicy List Appliesto https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appManagementPolicy-list-appliesTo.md
+
+ Title: "List appliesTo"
+description: "List application or service principal resources assigned to an application management policy."
+ms.localizationpriority: medium
+++
+# List appliesTo
+
+Namespace: microsoft.graph
+
+List application and service principal objects that are assigned an [appManagementPolicy](../resources/appManagementPolicy.md) policy 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) | Application.Read.All and Policy.Read.All, Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Application.Read.All and Policy.Read.All, Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /policies/appManagementPolicies/{id}/appliesTo
+```
+
+## Optional query parameters
+
+This method supports the `$select`, `$filter`, and `$top` OData query parameters to help customize the response. You can apply `$filter` on properties of [application](../resources/application.md) or [servicePrincipal](../resources/serviceprincipal.md) objects that support `$filter`. For example, the following query retrieves the **appId** and **displayName** of applications or service principals that are assigned the policy.
+
+``` http
+https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}/appliesTo?$select=appId,displayName
+```
+
+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 [appManagementPolicy](../resources/appManagementPolicy.md) objects in the response body.
+
+## Examples
+
+### Example 1: Get applications and service principal objects applied to an app management policy
+
+#### Request
+
+The following is an example of the request.
+++
+<!-- {
+ "blockType": "request",
+ "name": "list_appManagementPolicyAppliesTo"
+}-->
+
+```http
+GET https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}/appliesTo
+```
++
+#### 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.appManagementPolicy"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.application",
+ "id": "0d77e011-2fc6-438f-8b93-decb4f926929",
+ "appId": "8f527de6-05c9-4032-bca9-b2b56ab2358a",
+ "displayName": "TestApp1",
+ "createdDateTime": "2018-01-24T05:55:37Z"
+ }
+ ]
+}
+```
+
+### Example 2: Get specific properties of applications and service principal objects applied to an app management policy using $select query option
+
+#### Request
+
+The following is an example of the request using $select query option.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_appManagementPolicyAppliesTo_select"
+}-->
+
+```http
+GET https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}/appliesTo?$select=id,appId,displayName,createdDateTime
+```
+
+#### Response
+
+The following is an example of the response that returns `id`, `appId`, `displayName` and `createdDateTime` of applications and service principals where the policy is applied.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.appManagementPolicy"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects(id,appId,displayName,createdDateTime)",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.application",
+ "id": "0d77e011-2fc6-438f-8b93-decb4f926929",
+ "appId": "8f527de6-05c9-4032-bca9-b2b56ab2358a",
+ "displayName": "TestApp1",
+ "createdDateTime": "2018-01-24T05:55:37Z"
+ },
+ {
+ "@odata.type": "#microsoft.graph.servicePrincipal",
+ "id": "0e1fa067-dcc1-4d85-9b4c-e69145dd3efb",
+ "appId": "255912cb-e31d-4dee-bee4-3fa5d774d6b9",
+ "displayName": "TestApp2",
+ "createdDateTime": "2018-01-24T05:55:37Z"
+ }
+ ]
+}
+```
++
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "list resources for appManagementPolicies",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Appmanagementpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appManagementPolicy-update.md
+
+ Title: "Update appManagementPolicy"
+description: "Update an application management policy."
+ms.localizationpriority: medium
+++
+# Update appManagementPolicy
+
+Namespace: microsoft.graph
+
+Update an [appManagementPolicy](../resources/appManagementPolicy.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.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+PATCH /policies/appManagementPolicies/{id}
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
++
+| Property | Type | Description |
+| :-- | :-- | : |
+| displayName | String | The display name of the policy. Inherited from [policyBase](../resources/policybase.md). |
+| description | String | The description of the policy. Inherited from [policyBase](../resources/policybase.md). |
+| isEnabled | Boolean | Denotes whether the policy is enabled. |
+| restrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply to an application or service principal object. |
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "update_appManagementPolicy"
+}-->
+
+```http
+PATCH https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}
+
+{
+ "isEnabled": false
+}
+
+```
+
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "update appManagementPolicies",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Application Delete Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-delete-tokenlifetimepolicies.md
The following is an example of the request.
}--> ```http
-DELETE https://graph.microsoft.com/v1.0/applications/{id}/tokenLifetimePolicies/{id}/$ref
+DELETE https://graph.microsoft.com/v1.0/applications/3ccc9971-9ae7-45d6-8de8-263fd25fe116/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4/$ref
``` # [C#](#tab/csharp)
v1.0 Application List Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-list-tokenlifetimepolicies.md
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/applications/acc848e9-e8ec-4feb-a521-8d58b5482e09/tokenLifetimePolicies
+GET https://graph.microsoft.com/v1.0/applications/3ccc9971-9ae7-45d6-8de8-263fd25fe116/tokenLifetimePolicies
``` # [C#](#tab/csharp)
HTTP/1.1 200 OK
Content-type: application/json {
- "value": [
- {
- "definition": [
- "definition-value"
- ],
- "displayName": "displayName-value",
- "isOrganizationDefault": true,
- "id": "id-value"
- }
- ]
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.tokenLifetimePolicy)",
+ "value": [
+ {
+ "id": "4d2f137b-e8a9-46da-a5c3-cc85b2b840a4",
+ "deletedDateTime": null,
+ "definition": [
+ "{\"TokenLifetimePolicy\":{\"Version\":1,\"AccessTokenLifetime\":\"5:30:00\"}}"
+ ],
+ "displayName": "Contoso token lifetime policy",
+ "isOrganizationDefault": true
+ }
+ ]
} ```
v1.0 Application Post Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-post-tokenlifetimepolicies.md
The following is an example of the request.
}--> ```http
-POST https://graph.microsoft.com/v1.0/applications/{id}/tokenLifetimePolicies/$ref
+POST https://graph.microsoft.com/v1.0/applications/3ccc9971-9ae7-45d6-8de8-263fd25fe116/tokenLifetimePolicies/$ref
Content-Type: application/json {
- "@odata.id":"https://graph.microsoft.com/v1.0/policies/tokenLifetimePolicies/cd3d9b57-0aee-4f25-8ee3-ac74ef5986a9"
+ "@odata.id":"https://graph.microsoft.com/v1.0/policies/tokenLifetimePolicies/4d2f137b-e8a9-46da-a5c3-cc85b2b840a4"
} ```
v1.0 Appmanagementpolicy Delete Appliesto https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appmanagementpolicy-delete-appliesto.md
+
+ Title: "Remove appliesTo"
+description: "Remove an appManagementPolicy from an application or service principal object."
+ms.localizationpriority: medium
+++
+# Remove appliesTo
+
+Namespace: microsoft.graph
+
+Remove an [appManagementPolicy](../resources/appManagementPolicy.md) policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide [tenantAppManagementPolicy](../resources/tenantappmanagementpolicy.md) setting.
+
+## 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) | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+DELETE /applications/{id}/appManagementPolicies/$ref
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, provide a reference to a single policy object from the [appManagementPolicies](../resources/appmanagementpolicy.md) collection.
+
+## Response
+
+If successful, this method returns `204 No Content` response code. It does not return anything in the response body.
+
+## Examples
+
+### Example 1: Remove an appManagementPolicy from an application object
+
+#### Request
+
+The following is an example of the request to remove an appManagementPolicy from an application.
+
+<!-- {
+ "blockType": "request",
+ "name": "remove_appliesTo"
+}-->
+
+```http
+DELETE https://graph.microsoft.com/v1.0/applications/{id}/appManagementPolicies/$ref
+Content-type: application/json
+
+{
+ "@odata.id":"https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}"
+}
+```
+
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+### Example 2: Remove an appManagementPolicy from a service principal object
+
+#### Request
+
+The following is an example of the request to remove an appManagementPolicy from a service principal.
+
+<!-- {
+ "blockType": "request",
+ "name": "remove_appliesTo"
+}-->
+
+``` http
+DELETE https://graph.microsoft.com/v1.0/servicePrincipals/{id}/appManagementPolicies/$ref
+
+{
+ "@odata.id":"https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}"
+}
+```
++
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "list resources for appManagementPolicies",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Appmanagementpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appmanagementpolicy-get.md
+
+ Title: "Get appManagementPolicy"
+description: "Get an application management policy."
+ms.localizationpriority: medium
+++
+# Get appManagementPolicy
+
+Namespace: microsoft.graph
+
+Read the properties of an [appManagementPolicy](../resources/appManagementPolicy.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.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /policies/appManagementPolicies/{id}
+```
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a single [appManagementPolicy](../resources/appManagementPolicy.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request. From the response, the app management policy defines the following restrictions for application and service principal objects:
+
+- Blocks creating of new passwords after 2019-10-19 at 10:37 AM UTC time.
+- Limits password secrets for apps created after 2019-10-19 at 10:37 AM UTC time to less than 4 days, 12 hours, 30 minutes and 5 seconds.
+
+<!-- {
+ "blockType": "request",
+ "name": "get_appManagementPolicy"
+}-->
+
+```http
+GET https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}
+```
+
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.appManagementPolicy"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/appManagementPolicies",
+ "value": [
+ {
+ "id": "db9d4b58-3488-4da4-9994-49773c454e33",
+ "displayName": "Custom app management policy",
+ "description": "Custom policy that enforces app management restrictions on specific applications and service principals.",
+ "isEnabled": false,
+ "restrictions": {
+ "passwordCredentials": [
+ {
+ "restrictionType": "passwordAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "passwordLifetime",
+ "maxLifetime": "P4DT12H30M5S",
+ "restrictForAppsCreatedAfterDateTime": "2017-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2021-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyLifetime",
+ "maxLifetime": "P4D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ],
+ "keyCredentials": [
+ {
+ "restrictionType": "asymmetricKeyLifetime",
+ "maxLifetime": "P90D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ]
+ }
+ }
+ ]
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "get appManagementPolicy",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Appmanagementpolicy List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appmanagementpolicy-list.md
+
+ Title: "List appManagementPolicies"
+description: "Get a list of application management policies."
+ms.localizationpriority: medium
+++
+# List appManagementPolicies
+
+Namespace: microsoft.graph
+
+Retrieve a list of [appManagementPolicy](../resources/appManagementPolicy.md) objects.
+
+## 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.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration |
+
+## Optional query parameters
+
+This method supports the `$select`, `$filter`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET /policies/appManagementPolicies
+```
+
+## 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 [appManagementPolicy](../resources/appManagementPolicy.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_appManagementPolicies"
+}-->
+
+```http
+GET https://graph.microsoft.com/v1.0/policies/appManagementPolicies
+```
+++
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.appManagementPolicy"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/appManagementPolicies",
+ "value": [
+ {
+ "id": "db9d4b58-3488-4da4-9994-49773c454e33",
+ "displayName": "Custom app management policy",
+ "description": "Custom policy that enforces app management restrictions on specific applications and service principals.",
+ "isEnabled": false,
+ "restrictions": {
+ "passwordCredentials": [
+ {
+ "restrictionType": "passwordAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "passwordLifetime",
+ "maxLifetime": "P4DT12H30M5S",
+ "restrictForAppsCreatedAfterDateTime": "2017-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2021-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyLifetime",
+ "maxLifetime": "P4D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ],
+ "keyCredentials": [
+ {
+ "restrictionType": "asymmetricKeyLifetime",
+ "maxLifetime": "P90D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ]
+ }
+ }
+ ]
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "get appManagementPolicies",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Appmanagementpolicy Post Appliesto https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appmanagementpolicy-post-appliesto.md
+
+ Title: "Assign appliesTo"
+description: "Assign an appManagementPolicy to an application or service principal object."
+ms.localizationpriority: medium
+++
+# Assign appliesTo
+
+Namespace: microsoft.graph
+
+Assign an [appManagementPolicy](../resources/appManagementPolicy.md) policy object to an application or service principal object. The application or service principal adopts this policy over the tenant-wide [tenantAppManagementPolicy](../resources/tenantappmanagementpolicy.md) setting. Only one policy object can be assigned to an application or service principal.
+
+## 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) | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+POST /applications/{id}/appManagementPolicies/$ref
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, provide a reference to a single policy object from the [appManagementPolicies](../resources/appmanagementpolicy.md) collection.
+
+## Response
+
+If successful, this method returns `204 No Content` response code. It does not return anything in the response body.
+
+## Examples
+
+### Example 1: Assign an appManagementPolicy to an application object
+
+#### Request
+
+The following is an example of the request to assign an appManagementPolicy to an application.
++
+<!-- {
+ "blockType": "request",
+ "name": "assign_appliesTo"
+}-->
+
+```http
+POST https://graph.microsoft.com/v1.0/applications/{id}/appManagementPolicies/$ref
+Content-type: application/json
+
+{
+ "@odata.id":"https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}"
+}
+```
+
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+### Example 2: Assign an appManagementPolicy to a service principal object
+
+#### Request
+
+The following is an example of the request to assign an appManagementPolicy to a service principal.
+
+<!-- {
+ "blockType": "request",
+ "name": "assign_appliesTo"
+}-->
+
+``` http
+POST https://graph.microsoft.com/v1.0/servicePrincipals/{id}/appManagementPolicies/$ref
+
+{
+ "@odata.id":"https://graph.microsoft.com/v1.0/policies/appManagementPolicies/{id}"
+}
+```
+
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "list resources for appManagementPolicies",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Appmanagementpolicy Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/appmanagementpolicy-post.md
+
+ Title: "Create appManagementPolicy"
+description: "Create an application management policy."
+ms.localizationpriority: medium
+++
+# Create appManagementPolicy
+
+Namespace: microsoft.graph
+
+Create an [appManagementPolicy](../resources/appManagementPolicy.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.ReadWrite.ApplicationConfiguration |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Policy.ReadWrite.ApplicationConfiguration |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+POST /policies/appManagementPolicies
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+> [!IMPORTANT]
+> Service principals with a createdDateTime `null` are treated as having being created on 01/01/2019.
+
+## Request body
+
+In the request body, supply a JSON representation of the [appManagementPolicy](../resources/appmanagementpolicy.md) object.
+
+You can specify the following properties when creating an **appManagementPolicy**.
+
+| Property | Type | Description |
+| :-- | :- | : |
+| displayName | String | The display name of the policy. Required. |
+| description | String | The description of the policy. Required. |
+| isEnabled | Boolean | Denotes whether the policy is enabled. Optional. |
+| restrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply to an application or service principal object. Optional. |
+
+## Response
+
+If successful, this method returns a `201 Created` response code with the new [appManagementPolicy ](../resources/appmanagementpolicy.md) object in the response payload.
+
+## Examples
+
+### Request
+
+The following is an example of the request. This request created an app management policy with the following settings:
+
+- Enables the policy.
+- Blocks creating of new passwords for applications and service principals created on or after 2019-10-19 at 10:37 AM UTC time.
+- Enforces lifetime on password secrets and key credentials for applications created on or after 2014-10-19 at 10:37 AM UTC time.
+- Limits password secrets for apps and service principals created after 2019-10-19 at 10:37 AM UTC time to less than 4 days, 12 hours, 30 minutes and 5 seconds.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_appManagementPolicy"
+}-->
+
+```http
+POST https://graph.microsoft.com/v1.0/policies/appManagementPolicies
+
+{
+ "displayName": "Credential management policy",
+ "description": "Cred policy sample",
+ "isEnabled": true,
+ "restrictions": {
+ "passwordCredentials": [
+ {
+ "restrictionType": "passwordAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "passwordLifetime",
+ "maxLifetime": "P4DT12H30M5S",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyLifetime",
+ "maxLifetime": "P4D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ],
+ "keyCredentials": [
+ {
+ "restrictionType": "asymmetricKeyLifetime",
+ "maxLifetime": "P90D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ]
+ }
+}
+
+```
+++
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.appManagementPolicy"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/appManagementPolicies/$entity",
+ "id": "a4ab1ed9-46bb-4bef-88d4-86fd6398dd5d",
+ "displayName": "credential management policy",
+ "description": "Lorem ipsum",
+ "isEnabled": true,
+ "restrictions": {
+ "passwordCredentials": [
+ {
+ "restrictionType": "passwordAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "passwordLifetime",
+ "maxLifetime": "P4DT12H30M5S",
+ "restrictForAppsCreatedAfterDateTime": "2018-10-19T10:37:00Z"
+ }
+ ]
+ }
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "create appManagementPolicies",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Authentication List Emailmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authentication-list-emailmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication List Methods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authentication-list-methods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Authentication List Softwareoathmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authentication-list-softwareoathmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs [one of the following directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global Reader
-* Authentication administrator
-* Privileged authentication administrator
-* Global administrator
## HTTP request
v1.0 Authentication List Temporaryaccesspassmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authentication-list-temporaryaccesspassmethods.md
One of the following permissions is required to call this API. To learn more, in
| Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication Post Emailmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authentication-post-emailmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication Post Phonemethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authentication-post-phonemethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authentication Post Temporaryaccesspassmethods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authentication-post-temporaryaccesspassmethods.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Authenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Authenticationmethod Resetpassword https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authenticationmethod-resetpassword.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | Not supported. |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global Administrator
-* Privileged Authentication Administrator
-* Authentication Administrator
## HTTP request
Content-type: application/json
} ```
+# [C#](#tab/csharp)
+ # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/passwordauthenticationmethod-resetpassword-adminprovided-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+
+# [PHP](#tab/php)
+ #### Response
The following is an example of the request.
POST https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/methods/28c10230-6103-485e-b985-444c60001490/resetPassword ```
+# [C#](#tab/csharp)
+ # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/passwordauthenticationmethod-resetpassword-systemgenerated-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
POST https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+
+# [PHP](#tab/php)
+ #### Response
v1.0 Authenticationmethodspolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authenticationmethodspolicy-get.md
Title: "Get authenticationMethodsPolicy" description: "Read the properties and relationships of an authenticationMethodsPolicy object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|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):
-
-* Global Reader
-* Authentication Policy Administrator
-* Global Administrator
## HTTP request
Content-Type: application/json
"targetType": "group", "id": "all_users", "isRegistrationRequired": false,
- "authenticationMode": "any"
+ "authenticationMode": "any",
+ "outlookMobileAllowedState": "default",
+ "displayAppInformationRequiredState": "default",
+ "numberMatchingRequiredState": "default"
+ }
+ ]
+ },
+ {
+ "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration",
+ "id": "Sms",
+ "state": "enabled",
+ "includeTargets": [
+ {
+ "targetType": "group",
+ "id": "all_users",
+ "isRegistrationRequired": false,
+ "isUsableForSignIn": true
+ }
+ ]
+ },
+ {
+ "@odata.type": "#microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration",
+ "id": "TemporaryAccessPass",
+ "state": "disabled",
+ "defaultLifetimeInMinutes": 60,
+ "defaultLength": 8,
+ "minimumLifetimeInMinutes": 60,
+ "maximumLifetimeInMinutes": 480,
+ "isUsableOnce": false,
+ "includeTargets": [
+ {
+ "targetType": "group",
+ "id": "all_users",
+ "isRegistrationRequired": false
} ] },
v1.0 Authenticationmethodspolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/authenticationmethodspolicy-update.md
Title: "Update authenticationMethodsPolicy" description: "Update the properties of an authenticationMethodsPolicy object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|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
PATCH /policies/authenticationMethodsPolicy
|Content-Type|application/json. Required.| ## Request body
-In the request body, supply a JSON representation of the [authenticationMethodConfigurations](../resources/authenticationmethodconfiguration.md) object to prompt users to set up targeted authentication methods.
+
+|Property|Type|Description|
+|:|:|:|
+|registrationEnforcement|[registrationEnforcement](../resources/registrationenforcement.md)|Enforce registration at sign-in time. This property can be used to prompt users to set up targeted authentication methods.|
## Response
-If successful, this method returns a `204 No Content` response code.
+If successful, this method returns a `200 OK` response code and an [authenticationMethodsPolicy](../resources/authenticationmethodspolicy.md) object in the response body.
## Examples
PATCH https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy
Content-Type: application/json {
- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#authenticationMethodsPolicy",
- "registrationEnforcement": {
+ "registrationEnforcement": {
"authenticationMethodsRegistrationCampaign": { "snoozeDurationInDays": 1, "state": "enabled",
Content-Type: application/json
"targetedAuthenticationMethod": "microsoftAuthenticator" } ]
- }
- },
- "authenticationMethodConfigurations": [
- {
- "@odata.type": "#microsoft.graph.fido2AuthenticationMethodConfiguration",
- "id": "Fido2",
- "state": "disabled",
- "isSelfServiceRegistrationAllowed": false,
- "isAttestationEnforced": false,
- "keyRestrictions": {
- "isEnforced": false,
- "enforcementType": "block",
- "aaGuids": []
- }
- }
- ]
+ }
+ }
} ```
Content-Type: application/json
### Response <!-- { "blockType": "response",
- "truncated": true
+ "truncated": true,
+ "@odata.type": "microsoft.graph.authenticationMethodsPolicy"
} --> ``` http
-HTTP/1.1 204 No Content
+HTTP/1.1 200 OK
+Content-Type: application/json
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#authenticationMethodsPolicy",
+ "id": "authenticationMethodsPolicy",
+ "displayName": "Authentication Methods Policy",
+ "description": "The tenant-wide policy that controls which authentication methods are allowed in the tenant, authentication method registration requirements, and self-service password reset settings",
+ "lastModifiedDateTime": "2021-05-25T01:08:08.6712279Z",
+ "policyVersion": "1.4",
+ "registrationEnforcement": {
+ "authenticationMethodsRegistrationCampaign": {
+ "snoozeDurationInDays": 1,
+ "state": "enabled",
+ "excludeTargets": [],
+ "includeTargets": [
+ {
+ "id": "3ee3a9de-0a86-4e12-a287-9769accf1ba2",
+ "targetType": "group",
+ "targetedAuthenticationMethod": "microsoftAuthenticator"
+ }
+ ]
+ }
+ }
+}
```
v1.0 Calendar List Events https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/calendar-list-events.md
Title: "List events"
-description: "Retrieve a list of events in a calendar. The list contains single instance meetings and series masters."
+description: "Retrieve a list of events in a calendar. The list contains single instance meetings and series masters."
ms.localizationpriority: high ms.prod: "outlook"
doc_type: apiPageType
Namespace: microsoft.graph
-Retrieve a list of events in a calendar. The calendar can be one for a [user](../resources/user.md), or the default calendar of a Microsoft 365 [group](../resources/group.md). The list of events contains single instance meetings and series masters.
+Retrieve a list of events in a calendar. The calendar can be one for a [user](../resources/user.md), or the default calendar of a Microsoft 365 [group](../resources/group.md). The list of events contains single instance meetings and series masters.
To get expanded event instances, you can [get the calendar view](calendar-list-calendarview.md), or [get the instances of an event](event-list-instances.md).
+> [!NOTE]
+> If your target mailbox calendar contains any private items, the caller must either:
+> * Be granted `FullAccess` mailbox permissions over the target mailbox (via the [Add-MailboxPermission](/powershell/module/exchange/add-mailboxpermission) cmdlet).
+> * Be granted the `Delegate` + `CanViewPrivateItems` flags (similar to the previous option, but through the [Add-MailboxFolderPermission](/powershell/module/exchange/add-mailboxfolderpermission) cmdlet). This option routes all meeting requests to the delegate mailbox. For a workaround, see [SharingPermissionFlags](/powershell/module/exchange/add-mailboxfolderpermission?view=exchange-ps#-sharingpermissionflags).
+>
+> Failure to meet these conditions will result in a `The specified object was not found in the store` response.
+ ## Permissions Depending on the type of calendar that the events are in and the permission type (delegated or application) requested, 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 Callrecords Callrecord Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/callrecords-callrecord-get.md
There are two ways to get the **id** of a **callRecord**:
* Subscribe to [change notifications](/graph/api/resources/webhooks?view=graph-rest-1.0&preserve-view=true) to the `/communications/callRecords` endpoint. * Use the **callChainId** property of a [call](../resources/call.md). The call record is available only after the associated call is completed.
+> [!WARNING]
+>
+> A call record is created after a call or meeting ends and will remain available for **30 days**. Requests for call records older than 30 days will receive a `404 Not Found` response.
+ ## 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.
## Response
-If successful, this method returns a `200 OK` response code and the requested [microsoft.graph.callRecords.callRecord](../resources/callrecords-callrecord.md) object in the response body.
+If successful, this method returns a `200 OK` response code and the requested [microsoft.graph.callRecords.callRecord](../resources/callrecords-callrecord.md) object in the response body. A request for a call record older than 30 days will receive a `404 Not Found` response.
## Examples
GET https://graph.microsoft.com/v1.0/communications/callRecords/{id}?$expand=ses
#### Response
-The following is an example of the response. If the sessions list is truncated, a `sessions@odata.nextLink` value will be provided to retrieve the next page of sessions.
+The following is an example of the response. If the sessions list is truncated, a `sessions@odata.nextLink` value will be provided to retrieve the next page of sessions. The default page size for sessions is 60 entries.
> **Note:** The response object shown here might be shortened for readability.
v1.0 Channel List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-list.md
GET /teams/{team-id}/channels
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** property for a channel is an expensive operation that results in slow performance. Use `$select` to exclude the **email** property to improve performance.
+ ## Request headers | Header | Value |
v1.0 Deletedteam Getallmessages https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/deletedteam-getallmessages.md
If successful, this function returns a `200 OK` response code and a [chatMessage
### Request The following is an example of a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "deletedteamthis.getallmessages"
The following is an example of a request.
GET https://graph.microsoft.com/v1.0/teamwork/deletedTeams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/getAllMessages ```
+# [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 Directory Deleteditems List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/directory-deleteditems-list.md
The OData cast type is a required part of the URI and calling `GET /directory/de
## Optional query parameters
-This method supports the query parameters that are supported by the resource that is specified by the OData cast. That is, `$count`, `$expand`, `$filter`, `$orderBy`, `$search`, `$select`, and `$top` query parameters. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For example:
+This method supports the query parameters that are supported by the resource that is specified by the OData cast. That is, `$count`, `$expand`, `$filter`, `$orderBy`, `$search`, `$select`, and `$top` query parameters. This API returns 100 objects by default and supports returning up to 999 objects per page using `$top`.
+
+Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For example:
```http GET https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?&$count=true&$orderBy=deletedDateTime desc&$select=id,displayName,deletedDateTime
v1.0 Directoryobject Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/directoryobject-delta.md
GET https://graph.microsoft.com/v1.0/directoryObjects/delta?filter=isof('microso
- #### Response The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization with `$filter=isof('{resource type}')`. Note the presence of the _members@delta_ property which includes the ids of member objects in the group.
GET https://graph.microsoft.com/v1.0/directoryObjects/delta?$filter=id eq '87d34
- #### Response The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization with `$filter=id eq '{id}'`.
Prefer: return=minimal
- #### Response The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization. Note that the `microsoft.graph.user/surname` property is not included, which means it has not changed since the last delta query; `microsoft.graph.group/displayName` is included which means its value has changed.
v1.0 Driveitem Createlink https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/driveitem-createlink.md
The request should be a JSON object with the following properties.
| **expirationDateTime** | string | A String with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission. | | **retainInheritedPermissions** | Boolean | Optional. If `true` (default), any existing inherited permissions are retained on the shared item when sharing this item for the first time. If `false`, all existing permissions are removed when sharing for the first time. | | **scope** | string | Optional. The scope of link to create. Either `anonymous`, `organization`, or `users`. |
-| **retainInheritedPermissions** | Boolean | If `true`, any current inherited permissions are retained on the shared item when sharing this item for the first time. If `false`, all current permissions are removed when sharing for the first time. The default value is `true`. Optional. |
### Link types
v1.0 Emailauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/emailauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Emailauthenticationmethod Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/emailauthenticationmethod-update.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Emailauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/emailauthenticationmethodconfiguration-delete.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Emailauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/emailauthenticationmethodconfiguration-get.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Emailauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/emailauthenticationmethodconfiguration-update.md
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Externalconnectors Externalconnection Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/externalconnectors-externalconnection-get.md
GET https://graph.microsoft.com/v1.0/external/connections/contosohr
[!INCLUDE [sample-code](../includes/snippets/go/get-externalconnection-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-externalconnection-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Fido2authenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/fido2authenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Fido2authenticationmethod List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/fido2authenticationmethod-list.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Fido2authenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/fido2authenticationmethodconfiguration-delete.md
Title: "Delete fido2AuthenticationMethodConfiguration" description: "Delete a fido2AuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: "apiPageType"
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Fido2authenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/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"
One of the following permissions is required to call this API. To learn more, in
|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
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/v1.0/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"
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Group Post Groups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-post-groups.md
The following table shows the properties that are required when you create the [
| :-- | : | :-- | | displayName | String | The name to display in the address book for the group. Maximum length: 256 characters. Required. | | mailEnabled | Boolean | Set to `true` for mail-enabled groups. Required. |
-| mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : . <> , SPACE`. Required. |
+| mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : <> , SPACE`. Required. |
| securityEnabled | Boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Azure portal always have **securityEnabled** initially set to `true`. | > [!IMPORTANT]
v1.0 Longrunningoperation Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/longrunningoperation-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | Not supported. | | Application | Not supported. | Not supported. |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-
-* Global Administrator
-* Global Reader
-* Privileged Authentication Administrator
-* Authentication Administrator
## HTTP request
v1.0 Microsoftauthenticatorauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/microsoftauthenticatorauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Microsoftauthenticatorauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/microsoftauthenticatorauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Microsoftauthenticatorauthenticationmethod List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/microsoftauthenticatorauthenticationmethod-list.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Microsoftauthenticatorauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/microsoftauthenticatorauthenticationmethodconfiguration-delete.md
Title: "Delete microsoftAuthenticatorAuthenticationMethodConfiguration" description: "Deletes a microsoftAuthenticatorAuthenticationMethodConfiguration object."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|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
v1.0 Microsoftauthenticatorauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/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
One of the following permissions is required to call this API. To learn more, in
|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
Content-Type: application/json
"authenticationMode": "any" } ],
+ "excludeTargets": [],
"featureSettings": { "displayAppContextRequiredState" : { "state": "enabled",
v1.0 Microsoftauthenticatorauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/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
One of the following permissions is required to call this API. To learn more, in
|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
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.microsoftAuthenticatorAuthenticationMethodConfiguration"
+ "truncated": true
} --> ``` http
-HTTP/1.1 200 OK
-Content-Type: application/json
-
-{
- "@odata.type": "#microsoft.graph.microsoftAuthenticatorAuthenticationMethodConfiguration",
- "id": "129ae788-e788-129a-88e7-9a1288e79a12",
- "state": "String"
-}
+HTTP/1.1 204 No Content
```
v1.0 Organizationalbranding Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/organizationalbranding-get.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) | User.Read, Organization.Read.All, User.ReadBasic.All, User.Read.All |
+| Delegated (work or school account) | User.Read, Organization.Read.All, User.Read.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Organization.Read.All |
v1.0 Organizationalbranding List Localizations https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/organizationalbranding-list-localizations.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) | User.Read, Organization.Read.All, User.ReadBasic.All, User.Read.All |
+| Delegated (work or school account) | User.Read, Organization.Read.All, User.Read.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Not supported. |
v1.0 Organizationalbrandinglocalization Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/organizationalbrandinglocalization-get.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) | User.Read, Organization.Read.All, User.ReadBasic.All, User.Read.All |
+| Delegated (work or school account) | User.Read, Organization.Read.All, User.Read.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Organization.Read.All |
v1.0 Phoneauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/phoneauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Phoneauthenticationmethod Disablesmssignin https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/phoneauthenticationmethod-disablesmssignin.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Phoneauthenticationmethod Enablesmssignin https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/phoneauthenticationmethod-enablesmssignin.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Phoneauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/phoneauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Global reader
-* Privileged authentication administrator
-* Authentication administrator (only sees masked phone numbers)
+
+> [!NOTE]
+> The authentication administrator only sees masked phone numbers.
## HTTP request
v1.0 Phoneauthenticationmethod Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/phoneauthenticationmethod-update.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs one of the following [Azure AD roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global administrator
-* Privileged authentication administrator
-* Authentication administrator
## HTTP request
v1.0 Plannerbucket Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/plannerbucket-get.md
Title: "Get plannerBucket"
-description: "Retrieve the properties and relationships of **plannerBucket** object."
+description: "Retrieve the properties and relationships of a plannerBucket object."
ms.localizationpriority: medium ms.prod: "planner"
doc_type: apiPageType
Namespace: microsoft.graph
-Retrieve the properties and relationships of **plannerBucket** object.
+Retrieve the properties and relationships of a [plannerBucket](../resources/plannerbucket.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).
Do not supply a request body for this method.
## Response
-If successful, this method returns a `200 OK` response code and [plannerBucket](../resources/plannerbucket.md) object in the response body.
+If successful, this method returns a `200 OK` response code and a [plannerBucket](../resources/plannerbucket.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) <!-- { "blockType": "request",
- "name": "get_plannerbucket"
+ "name": "get_plannerbucket",
+ "sampleKeys": ["hsOf2dhOJkqyYYZEtdzDe2QAIUCR"]
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/planner/buckets/{bucket-id}
+GET https://graph.microsoft.com/v1.0/planner/buckets/hsOf2dhOJkqyYYZEtdzDe2QAIUCR
``` # [C#](#tab/csharp)
GET https://graph.microsoft.com/v1.0/planner/buckets/{bucket-id}
-##### 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
"suppressions": [ ] }-->-
v1.0 Profilephoto Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/profilephoto-update.md
One of the following permissions is required to call this API. To learn more, in
|:--|:| |Delegated (work or school account) | Group.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.ReadWrite.All |
+|Application | Not supported. |
### To update the profile photo of a team
v1.0 Smsauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/smsauthenticationmethodconfiguration-delete.md
+
+ Title: "Delete smsAuthenticationMethodConfiguration"
+description: "Delete a smsAuthenticationMethodConfiguration object."
+
+ms.localizationpriority: medium
++
+# Delete smsAuthenticationMethodConfiguration
+Namespace: microsoft.graph
+
+Remove changes made to the [text message authentication method policy](../resources/smsauthenticationmethodconfiguration.md) by reverting the policy 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|
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms
+```
+
+## 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_smsauthenticationmethodconfiguration"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms
+```
+
+# [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 Smsauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/smsauthenticationmethodconfiguration-get.md
+
+ Title: "Get smsAuthenticationMethodConfiguration"
+description: "Read the properties and relationships of a smsAuthenticationMethodConfiguration object."
+
+ms.localizationpriority: medium
++
+# Get smsAuthenticationMethodConfiguration
+Namespace: microsoft.graph
+
+Read the properties and relationships of a [smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.md) object, which represents the Text Message 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|
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms
+```
+
+## 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 [smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.md) object in the response body.
+
+## Examples
+
+### Request
+The following is an example of a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_smsauthenticationmethodconfiguration"
+}
+-->
+``` http
+GET https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms
+```
+
+# [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.smsAuthenticationMethodConfiguration"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration",
+ "id": "Sms",
+ "state": "enabled",
+ "includeTargets": [
+ {
+ "targetType": "group",
+ "id": "all_users",
+ "isRegistrationRequired": false,
+ "isUsableForSignIn": true
+ }
+ ],
+ "excludeTargets": []
+ }
+}
+```
+
v1.0 Smsauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/smsauthenticationmethodconfiguration-update.md
+
+ Title: "Update smsAuthenticationMethodConfiguration"
+description: "Update the properties of a smsAuthenticationMethodConfiguration object."
+
+ms.localizationpriority: medium
++
+# Update smsAuthenticationMethodConfiguration
+Namespace: microsoft.graph
+
+Update the properties of a [smsAuthenticationMethodConfiguration](../resources/smsauthenticationmethodconfiguration.md) object, which represents the text message 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|
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+|Property|Type|Description|
+|:|:|:|
+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.|
+|state|authenticationMethodState|Possible values are: `enabled`, `disabled`.|
+
+>**Note:** The `@odata.type` property with a value of `#microsoft.graph.smsAuthenticationMethodConfiguration` 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_smsauthenticationmethodconfiguration"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration",
+ "id": "Sms",
+ "state": "enabled"
+}
+```
+
+# [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 Softwareoathauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/softwareoathauthenticationmethod-delete.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs [one of the following directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Authentication administrator
-* Privileged authentication administrator
-* Global administrator
## HTTP request
v1.0 Softwareoathauthenticationmethod Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/softwareoathauthenticationmethod-get.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | UserAuthenticationMethod.Read.All, UserAuthenticationMethod.ReadWrite.All |
-For delegated scenarios where an admin is acting on another user, the admin needs [one of the following directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles):
-* Global Reader
-* Authentication administrator
-* Privileged authentication administrator
-* Global administrator
## HTTP request
v1.0 Softwareoathauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/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|
++
+## 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/v1.0/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/v1.0/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|
++
+## 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/v1.0/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/v1.0/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|
++
+## 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/v1.0/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 Team Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/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 Teamwork List Deletedteams https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/teamwork-list-deletedteams.md
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", "name": "list_deletedteam"
The following is an example of a request.
GET https://graph.microsoft.com/v1.0/teamwork/deletedTeams ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PHP](#tab/php)
+++ ### Response The following is an example of the response
Content-Type: application/json
} ] }
-```
+```
v1.0 Teamworktag Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/teamworktag-delete.md
DELETE https://graph.microsoft.com/v1.0/teams/53c53217-fe77-4383-bc5a-ed4937a1ae
[!INCLUDE [sample-code](../includes/snippets/go/delete-teamworktag-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-teamworktag-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Temporaryaccesspassauthenticationmethod Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/temporaryaccesspassauthenticationmethod-delete.md