Skip to content

Commit 2633262

Browse files
DanipocketDanipocket
authored
Merge pull request #28531 from microsoftgraph/owinfreyATL-CancelWorkflowProcessing
[Public Preview] Cancel Workflow Runs
2 parents 506941f + 66a42b7 commit 2633262

13 files changed

Lines changed: 280 additions & 19 deletions

‎api-reference/beta/api/identitygovernance-workflow-cancelprocessing.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: "workflow: cancelProcessing"
3+
description: "Cancel workflow runs that are currently in progress or queued."
4+
author: "KristinaSmith"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-id-governance"
7+
doc_type: apiPageType
8+
ms.date: 03/26/2026
9+
---
10+
11+
# workflow: cancelProcessing
12+
13+
Namespace: microsoft.graph.identityGovernance
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Cancel one or more [workflow](../resources/identitygovernance-workflow.md) runs that are currently in `queued` or `inProgress` status. Currently limited to canceling one run per request.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- { "blockType": "permissions", "name": "identitygovernance_workflow_cancelprocessing" } -->
24+
25+
[!INCLUDE [permissions-table](../includes/permissions/identitygovernance-workflow-cancelprocessing-permissions.md)]
26+
27+
[!INCLUDE [rbac-lifecycle-workflows-apis-write](../includes/rbac-for-apis/rbac-lifecycle-workflows-apis-write.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
```http
36+
POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/cancelProcessing
37+
```
38+
39+
## Request headers
40+
41+
|Name|Description|
42+
|:---|:---|
43+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
44+
|Content-Type|application/json. Required.|
45+
46+
## Request body
47+
48+
In the request body, supply a JSON representation of the parameters.
49+
50+
The following table shows the parameters that are required with this action.
51+
52+
|Parameter|Type|Description|
53+
|:---|:---|:---|
54+
|scope|[microsoft.graph.identityGovernance.cancelScope](../resources/identitygovernance-cancelscope.md)|Defines the scope of workflow runs to cancel. Currently only [cancelRunsScope](../resources/identitygovernance-cancelrunsscope.md) is supported. Required.|
55+
56+
### cancelRunsScope properties
57+
58+
When using [cancelRunsScope](../resources/identitygovernance-cancelrunsscope.md), the `@odata.type` property is required in the request body.
59+
60+
|Property|Type|Description|
61+
|:---|:---|:---|
62+
|@odata.type|String|Must be `#microsoft.graph.identityGovernance.cancelRunsScope`. Required.|
63+
|runs|[microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) collection|The workflow runs to cancel. Currently limited to one run per request. Required.|
64+
65+
## Response
66+
67+
If successful, this action returns a `204 No Content` response code.
68+
69+
## Examples
70+
71+
### Example 1: Successfully cancel a workflow run
72+
73+
The following example shows a request that successfully cancels a single workflow run.
74+
75+
#### Request
76+
77+
The following example shows a request.
78+
79+
<!-- {
80+
"blockType": "request",
81+
"name": "lifecycleworkflows_workflow_cancelprocessing_success"
82+
}
83+
-->
84+
```http
85+
POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/cancelProcessing
86+
Content-Type: application/json
87+
88+
{
89+
"scope": {
90+
"@odata.type": "#microsoft.graph.identityGovernance.cancelRunsScope",
91+
"runs": [
92+
{
93+
"id": "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"
94+
}
95+
]
96+
}
97+
}
98+
```
99+
100+
---
101+
102+
#### Response
103+
104+
The following example shows the response.
105+
106+
<!-- {
107+
"blockType": "response",
108+
"truncated": true
109+
} -->
110+
```http
111+
HTTP/1.1 204 No Content
112+
```

‎api-reference/beta/includes/permissions/identitygovernance-workflow-cancelprocessing-permissions.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|LifecycleWorkflows-Workflow.ReadWrite.All|LifecycleWorkflows.ReadWrite.All|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|LifecycleWorkflows-Workflow.ReadWrite.All|LifecycleWorkflows.ReadWrite.All|

‎api-reference/beta/resources/enums-identitygovernance-lifecycleworkflowprocessingstatus.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "lifecycleWorkflowProcessingStatus enum type"
3+
description: "Microsoft Graph identityGovernance lifecycleWorkflowProcessingStatus enumeration type"
4+
author: "owinfreyATL"
5+
ms.date: 03/27/2026
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-id-governance"
8+
doc_type: enumPageType
9+
---
10+
11+
# lifecycleWorkflowProcessingStatus enum type
12+
13+
Namespace: microsoft.graph.identityGovernance
14+
15+
Describes the execution status of a lifecycle workflow run, task processing result, task report, or user processing result.
16+
17+
## lifecycleWorkflowProcessingStatus values
18+
19+
The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `canceling`.
20+
21+
|Member|
22+
|:---|
23+
|queued|
24+
|inProgress|
25+
|completed|
26+
|completedWithErrors|
27+
|canceled|
28+
|failed|
29+
|unknownFutureValue|
30+
|canceling|
31+
32+
<!--
33+
{
34+
"type": "#page.annotation",
35+
"namespace": "microsoft.graph.identityGovernance"
36+
}
37+
-->

‎api-reference/beta/resources/enums-identitygovernance.md‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,6 @@ Namespace: microsoft.graph.identityGovernance
5757
|unknownFutureValue|
5858

5959

60-
### lifecycleWorkflowProcessingStatus values
61-
62-
63-
64-
|Member|
65-
|:---|
66-
|queued|
67-
|inProgress|
68-
|completed|
69-
|completedWithErrors|
70-
|canceled|
71-
|failed|
72-
|unknownFutureValue|
73-
7460
### valueType values
7561

7662

‎api-reference/beta/resources/identitygovernance-cancelrunsscope.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: "cancelRunsScope resource type"
3+
description: "Defines a set of workflow runs to cancel when using the cancelProcessing action."
4+
author: "AlexFilipin"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-id-governance"
7+
doc_type: resourcePageType
8+
ms.date: 03/26/2026
9+
---
10+
11+
# cancelRunsScope resource type
12+
13+
Namespace: microsoft.graph.identityGovernance
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Defines a set of [workflow](identitygovernance-workflow.md) runs to cancel when using the [cancelProcessing](../api/identitygovernance-workflow-cancelprocessing.md) action. Only runs that are currently in `queued` or `inProgress` status can be cancelled.
18+
19+
Inherits from [cancelScope](identitygovernance-cancelscope.md).
20+
21+
## Properties
22+
23+
None.
24+
25+
## Relationships
26+
27+
|Property|Type|Description|
28+
|:---|:---|:---|
29+
|runs|[microsoft.graph.identityGovernance.run](identitygovernance-run.md) collection|The workflow runs to cancel. Currently limited to 1 run per request. Required.|
30+
31+
## JSON representation
32+
33+
The following JSON representation shows the resource type.
34+
35+
<!-- {
36+
"blockType": "resource",
37+
"@odata.type": "microsoft.graph.identityGovernance.cancelRunsScope",
38+
"baseType": "microsoft.graph.identityGovernance.cancelScope"
39+
}
40+
-->
41+
```json
42+
{
43+
"@odata.type": "#microsoft.graph.identityGovernance.cancelRunsScope"
44+
}
45+
```

‎api-reference/beta/resources/identitygovernance-cancelscope.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "cancelScope resource type"
3+
description: "An abstract base type that defines the scope for canceling workflow processing."
4+
author: "KristinaSmith"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-id-governance"
7+
doc_type: resourcePageType
8+
ms.date: 03/26/2026
9+
---
10+
11+
# cancelScope resource type
12+
13+
Namespace: microsoft.graph.identityGovernance
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
An abstract base type that defines the scope for canceling workflow processing when using the [cancelProcessing](../api/identitygovernance-workflow-cancelprocessing.md) action. This type can't be instantiated directly; use one of the derived types such as [cancelRunsScope](identitygovernance-cancelrunsscope.md) instead.
18+
19+
Base type of [cancelRunsScope](identitygovernance-cancelrunsscope.md).
20+
21+
## Properties
22+
23+
None.
24+
25+
## Relationships
26+
27+
None.
28+
29+
## JSON representation
30+
31+
The following JSON representation shows the resource type.
32+
33+
<!-- {
34+
"blockType": "resource",
35+
"@odata.type": "microsoft.graph.identityGovernance.cancelScope"
36+
}
37+
-->
38+
```json
39+
{
40+
"@odata.type": "#microsoft.graph.identityGovernance.cancelScope"
41+
}
42+
```

‎api-reference/beta/resources/identitygovernance-run.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Inherits from [entity](../resources/entity.md).
3939
|failedUsersCount|Int32|The number of users that failed in the run execution.|
4040
|id|String|A unique identifier for the workflow run.|
4141
|lastUpdatedDateTime|DateTimeOffset|The datetime that the run was last updated.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
42-
|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`.|
42+
|processingStatus|[microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus](../resources/enums-identitygovernance-lifecycleworkflowprocessingstatus.md)|The run execution status. <br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
4343
|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`.|
4444
|startedDateTime|DateTimeOffset|The date time that the run execution started.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
4545
|successfulUsersCount|Int32|The number of successfully completed users in the run.|

‎api-reference/beta/resources/identitygovernance-taskprocessingresult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Inherits from [entity](../resources/entity.md).
3232
|createdDateTime|DateTimeOffset|The date time when the taskProcessingResult was created.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
3333
|failureReason|String|Describes why the taskProcessingResult has failed.|
3434
|id|String|Identifier used for individually addressing a specific task processing result. Inherited from [entity](../resources/entity.md).<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
35-
|processingStatus|[microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus](../resources/identitygovernance-taskprocessingresult.md)|Describes the execution status of the `taskProcessingResult`. The possible values are: `queued`, `inProgress`, `completed`, `completedWithErrors`, `canceled`, `failed`, `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
35+
|processingStatus|[microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus](../resources/enums-identitygovernance-lifecycleworkflowprocessingstatus.md)|Describes the execution status of the `taskProcessingResult`. <br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
3636
|startedDateTime|DateTimeOffset|The date time when taskProcessingResult execution started. Value is `null` if task execution has not yet started.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
3737

3838
## Relationships

‎api-reference/beta/resources/identitygovernance-taskreport.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Inherits from [entity](../resources/entity.md).
3434
|failedUsersCount|Int32|The number of users in the run execution for which the associated task failed.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
3535
|id|String|The unique identifier of the task report. Inherited from [entity](../resources/entity.md).<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
3636
|lastUpdatedDateTime|DateTimeOffset|The date and time that the task report was last updated.|
37-
|processingStatus|[microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus](../resources/identitygovernance-taskprocessingresult.md)|The processing status of the associated task based on the taskProcessingResults. The possible values are based on the number of `queued`, `inProgress`, `completed`, `completedWithErrors`, `canceled`, `failed`, and `unknownFutureValue`.<br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
37+
|processingStatus|[microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus](../resources/enums-identitygovernance-lifecycleworkflowprocessingstatus.md)|The processing status of the associated task based on the taskProcessingResults. <br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
3838
|runId|String|The unique identifier of the associated [run](../resources/identitygovernance-run.md).|
3939
|startedDateTime|DateTimeOffset|The date time that the associated run started. Value is `null` if the run has not started.|
4040
|successfulUsersCount|Int32|The number of users in the run execution for which the associated task succeeded.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|

‎api-reference/beta/resources/identitygovernance-userprocessingresult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Inherits from [entity](../resources/entity.md).
3636
|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`.|
3737
|failedTasksCount|Int32|The number of tasks that failed in the workflow execution.|
3838
|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`.|
39-
|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`.|
39+
|processingStatus|[microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus](../resources/enums-identitygovernance-lifecycleworkflowprocessingstatus.md)|The workflow execution status. <br><br>Supports `$filter`(`eq`, `ne`) and `$orderby`.|
4040
|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`.|
4141
|startedDateTime|DateTimeOffset|The date time that the workflow execution started. Value is `null` if the workflow execution hasn't started.<br><br>Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.|
4242
|totalTasksCount|Int32|The total number of tasks that in the workflow execution.|

0 commit comments

Comments
 (0)