You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/active-directory/governance/check-status-workflow.md
+6-65Lines changed: 6 additions & 65 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,90 +69,31 @@ To get further information than just the runs summary for a workflow, you're als
69
69
70
70
To view a status list of users processed by a workflow, which are UserProcessingResults, you'd make the following API call:
71
71
72
-
```http
73
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults
74
-
```
75
-
76
-
By default **userProcessingResults** returns only information from the last 7 days. To get information as far back as 30 days, you would run the following API call:
77
-
78
-
```http
79
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults?$filter=<Date range for processing results>
80
-
```
81
-
82
-
by default **userProcessingResults** returns only information from the last 7 days. To filter information as far back as 30 days, you would run the following API call:
83
-
84
-
```http
85
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<id>/userProcessingResults?$filter=<Date range for processing results>
86
-
```
87
-
88
-
An example of a call to get **userProcessingResults** for a month would be as follows:
89
-
90
-
```http
91
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults?$filter=< startedDateTime ge 2022-05-23T00:00:00Z and startedDateTime le 2022-06-22T00:00:00Z
92
-
```
72
+
To view a list of user processing results using API via Microsoft Graph, see: [List userProcessingResults](/graph/api/identitygovernance-workflow-list-userprocessingresults)
93
73
94
74
### User processing results using Microsoft Graph
95
75
96
-
When multiple user events are processed by a workflow, running the **userProcessingResults** may give incomprehensible information. To get a summary of information such as total users and tasks, and failed users and tasks, Lifecycle Workflows provides a call to get count totals.
97
-
98
-
To view a summary in count form, you would run the following API call:
99
-
```http
100
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/summary(<Date Range>)
101
-
```
102
-
103
-
An example to get the summary between May 1, and May 30, you would run the following call:
76
+
To view a summary of user processing results via API using Microsoft Graph, see: [userProcessingResult: summary](/graph/api/identitygovernance-userprocessingresult-summary)
104
77
105
-
```http
106
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/summary(startDateTime=2022-05-01T00:00:00Z,endDateTime=2022-05-30T00:00:00Z)
107
-
```
108
78
109
-
### List task processing results of a given user processing result
110
-
111
-
```http
112
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/userProcessingResults/<userProcessingResultId>/taskProcessingResults/
113
-
```
114
79
115
80
## Run workflow history via Microsoft Graph
116
81
117
82
### List runs using Microsoft Graph
118
83
119
-
With Microsoft Graph, you're able to get full details of workflow and user processing run information.
120
-
121
-
To view a list of runs, you'd make the following API call:
84
+
To view runs of a workflow via API using Microsoft Graph, see: [runs](/graph/api/resources/identitygovernance-run)
122
85
123
-
```http
124
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs
125
-
```
126
86
127
87
### Get a summary of runs using Microsoft Graph
128
88
129
-
To get a summary of runs for a workflow, which includes detailed information for counts of failed runs and tasks, along with successful runs and tasks for a time range, you'd make the following API call:
130
-
131
-
```http
132
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/summary(startDateTime=<time>,endDateTime=<time>)
133
-
```
134
-
An example to get a summary of runs of a workflow through the time interval of May 2022 would be as follows:
135
-
136
-
```http
137
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/summary(startDateTime=2022-05-01T00:00:00Z,endDateTime=202205-31T00:00:00Z)
138
-
```
89
+
To view run summary via API using Microsoft Graph, see: [run summary of a lifecycle workflow](/graph/api/identitygovernance-run-summary)
139
90
140
91
### List user and task processing results of a given run using Microsoft Graph
141
92
142
-
With Lifecycle Workflows, you're able to check the status of each user and task who had a workflow processed for them as part of a run.
143
-
144
-
145
-
You're also able to use **userProcessingResults** with the run call to get users processed for a run by making the following API call:
146
-
147
-
```http
148
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId>/runs/<runId>/userProcessingResults
149
-
```
93
+
To get user processing result for a run of a lifecycle workflow via API using Microsoft Graph, see: [Get userProcessingResult (for a run of a lifecycle workflow)](/graph/api/identitygovernance-userprocessingresult-get)
150
94
151
-
This API call will also return a **userProcessingResults ID** value, which can be used to retrieve task processing information in the following call:
95
+
To list task processing results for a user processing result via API using Microsoft Graph, see: [List taskProcessingResults (for a userProcessingResult)](/graph/api/identitygovernance-userprocessingresult-list-taskprocessingresults)
152
96
153
-
```http
154
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/<workflowId> /runs/<runId>/userProcessingResults/<userProcessingResultId>/taskProcessingResults
155
-
```
156
97
157
98
> [!NOTE]
158
99
> A workflow must have activity in the past 7 days to get **userProcessingResults ID**. If there has not been any activity in that time-frame, the **userProcessingResults** call will not return a value.
Copy file name to clipboardExpand all lines: articles/active-directory/governance/create-lifecycle-workflow.md
+1-226Lines changed: 1 addition & 226 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,234 +64,9 @@ If you are using the Azure portal to create a workflow, you can customize existi
64
64
65
65
## Create a workflow using Microsoft Graph
66
66
67
-
Workflows can be created using Microsoft Graph API. Creating a workflow using the Graph API allows you to automatically set it to enabled. Setting it to enabled is done using the `isEnabled` parameter.
68
-
69
-
The table below shows the parameters that must be defined during workflow creation:
70
-
71
-
|Parameter |Description |
72
-
|---------|---------|
73
-
|category | A string that identifies the category of the workflow. String is "joiner", "mover", or "leaver. Category of tasks within a workflow must also contain the category of the workflow to run. For full task definitions, see: [Lifecycle workflow tasks and definitions](lifecycle-workflow-tasks.md)|
74
-
|displayName | A unique string that identifies the workflow. |
75
-
|description | A string that describes the purpose of the workflow for administrative use. (Optional) |
76
-
|isEnabled | A boolean value that denotes whether the workflow is set to run or not. If set to “true" then the workflow will run. |
77
-
|IsSchedulingEnabled | A Boolean value that denotes whether scheduling is enabled or not. Unlike isEnbaled, a workflow can still be run on demand if this value is set to false. |
78
-
|executionConditions | An argument that contains: A time-based attribute and an integer parameter defining when a workflow will run between -60 and a scope attribute defining who the workflow runs for. |
79
-
|tasks | An argument in a workflow that has a unique displayName and a description. It defines the specific tasks to be executed in the workflow. The specified task is outlined by the taskDefinitionID and its parameters. For a list of supported tasks, and their corresponding IDs, see [Lifecycle Workflow tasks and definitions](lifecycle-workflow-tasks.md). |
80
-
81
-
82
-
83
-
84
-
To create a joiner workflow, in Microsoft Graph, use the following request and body:
85
-
```http
86
-
POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows
"rule": "employeeType eq '<Employee type attribute>' AND department -eq '<department attribute>'"
116
-
}
117
-
}
118
-
}
119
-
120
-
> [!NOTE]
121
-
> time based trigger arguments can be from -60 to 60. The negative value denotes **Before** a time based argument, while a positive value denotes **After**. For example the -7 in the workflow example above denotes the workflow will run 1 week before the time-based argument happens.
122
-
123
-
```
124
-
125
-
To change this workflow from joiner to leaver, replace the category parameters to "leaver". To get a list of the task definitions that can be added to your workflow run the following call:
126
-
127
-
```http
128
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions
"description": "Disable user account in the directory",
155
-
"displayName": "Disable User Account",
156
-
"id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",
157
-
"version": 1,
158
-
"parameters": []
159
-
},
160
-
{
161
-
"category": "joiner,leaver",
162
-
"description": "Enable user account in the directory",
163
-
"displayName": "Enable User Account",
164
-
"id": "6fc52c9d-398b-4305-9763-15f42c1676fc",
165
-
"version": 1,
166
-
"parameters": []
167
-
},
168
-
{
169
-
"category": "joiner,leaver",
170
-
"description": "Run a custom task extension",
171
-
"displayName": "run a Custom Task Extension",
172
-
"id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
173
-
"version": 1,
174
-
"parameters":
175
-
{
176
-
"name": "customtaskextensionID",
177
-
"values": [],
178
-
"valueType": "string"
179
-
}
180
-
]
181
-
},
182
-
{
183
-
"category": "joiner,leaver",
184
-
"description": "Remove user from membership of selected Azure AD groups",
185
-
"displayName": "Remove user from selected groups",
186
-
"id": "1953a66c-751c-45e5-8bfe-01462c70da3c",
187
-
"version": 1,
188
-
"parameters": [
189
-
{
190
-
"name": "groupID",
191
-
"values": [],
192
-
"valueType": "string"
193
-
}
194
-
]
195
-
},
196
-
{
197
-
"category": "joiner",
198
-
"description": "Generate Temporary Access Password and send via email to user's manager",
199
-
"displayName": "Generate TAP And Send Email",
200
-
"id": "1b555e50-7f65-41d5-b514-5894a026d10d",
201
-
"version": 1,
202
-
"parameters": [
203
-
{
204
-
"name": "tapLifetimeMinutes",
205
-
"values": [],
206
-
"valueType": "string"
207
-
},
208
-
{
209
-
"name": "tapIsUsableOnce",
210
-
"values": [
211
-
"true",
212
-
"false"
213
-
],
214
-
"valueType": "enum"
215
-
}
216
-
]
217
-
},
218
-
{
219
-
"category": "joiner",
220
-
"description": "Send welcome email to new hire",
221
-
"displayName": "Send Welcome Email",
222
-
"id": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
223
-
"version": 1,
224
-
"parameters": []
225
-
},
226
-
{
227
-
"category": "joiner,leaver",
228
-
"description": "Add user to a team",
229
-
"displayName": "Add User To Team",
230
-
"id": "e440ed8d-25a1-4618-84ce-091ed5be5594",
231
-
"version": 1,
232
-
"parameters": [
233
-
{
234
-
"name": "teamID",
235
-
"values": [],
236
-
"valueType": "string"
237
-
}
238
-
]
239
-
},
240
-
{
241
-
"category": "leaver",
242
-
"description": "Delete user account in Azure AD",
243
-
"displayName": "Delete User Account",
244
-
"id": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",
245
-
"version": 1,
246
-
"parameters": []
247
-
},
248
-
{
249
-
"category": "joiner,leaver",
250
-
"description": "Remove user from membership of selected Teams",
251
-
"displayName": "Remove user from selected Teams",
252
-
"id": "06aa7acb-01af-4824-8899-b14e5ed788d6",
253
-
"version": 1,
254
-
"parameters": [
255
-
{
256
-
"name": "teamID",
257
-
"values": [],
258
-
"valueType": "string"
259
-
}
260
-
]
261
-
},
262
-
{
263
-
"category": "leaver",
264
-
"description": "Remove user from all Azure AD groups memberships",
265
-
"displayName": "Remove user from all groups",
266
-
"id": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",
267
-
"version": 1,
268
-
"parameters": []
269
-
},
270
-
{
271
-
"category": "leaver",
272
-
"description": "Remove user from all Teams memberships",
273
-
"displayName": "Remove user from all Teams",
274
-
"id": "81f7b200-2816-4b3b-8c5d-dc556f07b024",
275
-
"version": 1,
276
-
"parameters": []
277
-
},
278
-
{
279
-
"category": "leaver",
280
-
"description": "Remove all licenses assigned to the user",
281
-
"displayName": "Remove all licenses for user",
282
-
"id": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",
283
-
"version": 1,
284
-
"parameters": []
285
-
}
286
-
]
287
-
}
288
-
289
-
```
290
-
For further details on task definitions and their parameters, see [Lifecycle Workflow Tasks](lifecycle-workflow-tasks.md).
291
-
67
+
To create a workflow using Microsoft Graph API, see [Create workflow (lifecycle workflow)](/graph/api/identitygovernance-lifecycleworkflowscontainer-post-workflows)
Copy file name to clipboardExpand all lines: articles/active-directory/governance/delete-lifecycle-workflow.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,35 +58,32 @@ After deleting workflows, you can view them on the **Deleted Workflows (Preview)
58
58
59
59
60
60
## Delete a workflow using Microsoft Graph
61
-
You're also able to delete, view deleted, and restore deleted Lifecycle workflows using Microsoft Graph.
61
+
62
+
To delete a workflow using API via Microsoft Graph, see: [Delete workflow (lifecycle workflow)](/graph/api/identitygovernance-workflow-delete?view=graph-rest-beta).
63
+
64
+
65
+
To view
62
66
63
67
Workflows can be deleted by running the following call:
You can view a list of deleted workflows by running the following call:
69
-
```http
70
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows
71
-
```
72
+
73
+
To View a list of deleted workflows using API via Microsoft Graph, see: [List deleted workflows](/graph/api/identitygovernance-lifecycleworkflowscontainer-list-deleteditems).
74
+
72
75
73
76
## Permanently delete a workflow using Microsoft Graph
74
-
Deleted workflows can be permanently deleted by running the following call:
To permanently delete a workflow using API via Microsoft Graph, see: [Permanently delete a deleted workflow](/graph/api/identitygovernance-deleteditemcontainer-delete)
78
79
79
80
## Restore deleted workflows using Microsoft Graph
80
81
81
-
Deleted workflows are available to be restored for 30 days before they're permanently deleted. To restore a deleted workflow, run the following API call:
82
-
```http
83
-
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/<id>/restore
84
-
```
82
+
To restore a deleted workflow using API via Microsoft Graph, see: [Restore a deleted workflow](/graph/api/identitygovernance-workflow-restore)
85
83
> [!NOTE]
86
84
> Permanently deleted workflows are not able to be restored.
0 commit comments