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/lifecycle-workflow-tasks.md
+55-18Lines changed: 55 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,11 +33,11 @@ Common task parameters are the non-unique parameters contained in every task. Wh
33
33
|Parameter |Definition |
34
34
|---------|---------|
35
35
|category | A read-only string that identifies the category or categories of the task. Automatically determined when the taskDefinitionID is chosen. |
36
-
|taskDefinitionId | A string referencing a taskDefinition which determines which task to run. |
36
+
|taskDefinitionId | A string referencing a taskDefinition that determines which task to run. |
37
37
|isEnabled | A boolean value that denotes whether the task is set to run or not. If set to “true" then the task will run. Defaults to true. |
38
38
|displayName | A unique string that identifies the task. |
39
39
|description | A string that describes the purpose of the task for administrative use. (Optional) |
40
-
|executionSequence |An integer that is read-only which states in what order the task will run in a workflow. For more information about executionSequence and workflow order, see: [Configure Scope](understanding-lifecycle-workflows.md#configure-scope). |
40
+
|executionSequence |A read-only integer that states in what order the task will run in a workflow. For more information about executionSequence and workflow order, see: [Configure Scope](understanding-lifecycle-workflows.md#configure-scope). |
41
41
|continueOnError | A boolean value that determines if the failure of this task stops the subsequent workflows from running. |
42
42
|arguments | Contains unique parameters relevant for the given task. |
43
43
@@ -52,7 +52,7 @@ Below is each specific task, and detailed information such as parameters and pre
52
52
53
53
54
54
Lifecycle Workflows allow you to automate the sending of welcome emails to new hires in your organization. You're able to customize the task name and description for this task in the Azure portal.
55
-
:::image type="content" source="media/lifecycle-workflow-task/email-task.png" alt-text="Screenshot of Workflows task: Email task.":::
55
+
:::image type="content" source="media/lifecycle-workflow-task/welcome-email-task.png" alt-text="Screenshot of Workflows task: Welcome email task.":::
56
56
57
57
58
58
The Azure AD prerequisite to run the **Send welcome email to new hire** task is:
@@ -84,11 +84,48 @@ For Microsoft Graph the parameters for the **Send welcome email to new hire** ta
84
84
85
85
```
86
86
87
+
### Send onboarding reminder email
88
+
89
+
90
+
Lifecycle Workflows allow you to automate the sending of onboarding reminder emails to managers of new hires in your organization. You're able to customize the task name and description for this task in the Azure portal.
### Generate Temporary Access Pass and send via email to user's manager
88
125
89
-
When a compatible user joins your organization, Lifecycle Workflows allow you to automatically generate a Temporary Access Pass(TAP) and have it sent to the new user's manager.
126
+
When a compatible user joins your organization, Lifecycle Workflows allow you to automatically generate a Temporary Access Pass(TAP), and have it sent to the new user's manager.
90
127
91
-
With this task in the Azure portal, you're able to give the task a name and description. You must also set the following:
128
+
With this task in the Azure portal, you're able to give the task a name and description. You must also set:
92
129
93
130
**Activation duration**- How long the password is active.
94
131
**One time use**- If the password is one use only.
@@ -154,11 +191,11 @@ For Microsoft Graph the parameters for the **Add user to groups** task are as fo
154
191
155
192
|Parameter |Definition |
156
193
|---------|---------|
157
-
|category | joiner,leaver |
194
+
|category | joiner,leaver |
158
195
|displayName | AddUserToGroup (Customizable by user) |
159
196
|description | Add user to groups (Customizable by user) |
|arguments | Argument contains a name parameter that is the "groupID", and a value parameter which is the group ID of the group you are adding the user to. |
198
+
|arguments | Argument contains a name parameter that is the "groupID", and a value parameter that is the group ID of the group you're adding the user to. |
162
199
163
200
164
201
```Example for usage within the workflow
@@ -190,11 +227,11 @@ For Microsoft Graph the parameters for the **Add user to teams** task are as fol
190
227
191
228
|Parameter |Definition |
192
229
|---------|---------|
193
-
|category | joiner,leaver |
230
+
|category | joiner,leaver |
194
231
|displayName | AddUserToTeam (Customizable by user) |
195
232
|description | Add user to teams (Customizable by user) |
|argument | Argument contains a name parameter that is the "teamID", and a value parameter which is the team ID of the existing team you are adding a user to. |
234
+
|argument | Argument contains a name parameter that is the "teamID", and a value parameter that is the team ID of the existing team you're adding a user to. |
198
235
199
236
200
237
@@ -227,7 +264,7 @@ For Microsoft Graph the parameters for the **Enable user account** task are as f
227
264
228
265
|Parameter |Definition |
229
266
|---------|---------|
230
-
|category | joiner,leaver |
267
+
|category | joiner,leaver |
231
268
|displayName | EnableUserAccount (Customizable by user) |
232
269
|description | Enable user account (Customizable by user) |
|argument | Argument contains a name parameter that is the "groupID", and a value parameter which is the group Id(s) of the group or groups you are removing the user from. |
377
+
|argument | Argument contains a name parameter that is the "groupID", and a value parameter that is the group Id(s) of the group or groups you're removing the user from. |
341
378
342
379
343
380
@@ -361,7 +398,7 @@ For Microsoft Graph the parameters for the **Remove user from selected groups**
361
398
362
399
### Remove users from all groups
363
400
364
-
Allows users to be removed from every cloud-only group they are a member of. Dynamic and Privileged Access Groups not supported. To control access to on-premises applications and resources, you need to enable group writeback. For more information, see [Azure AD Connect group writeback](../hybrid/how-to-connect-group-writeback-v2.md).
401
+
Allows users to be removed from every cloud-only group they're a member of. Dynamic and Privileged Access Groups not supported. To control access to on-premises applications and resources, you need to enable group writeback. For more information, see [Azure AD Connect group writeback](../hybrid/how-to-connect-group-writeback-v2.md).
365
402
366
403
367
404
You're able to customize the task name and description for this task in the Azure portal.
@@ -402,11 +439,11 @@ For Microsoft Graph the parameters for the **Remove User from Teams** task are a
402
439
403
440
|Parameter |Definition |
404
441
|---------|---------|
405
-
|category | joiner,leaver |
442
+
|category | joiner,leaver |
406
443
|displayName | Remove user from selected Teams (Customizable by user) |
407
444
|description | Remove user from membership of selected Teams (Customizable by user) |
|arguments | Argument contains a name parameter that is the "teamID", and a value parameter which is the Teams ID of the Teams you are removing the user from. |
446
+
|arguments | Argument contains a name parameter that is the "teamID", and a value parameter that is the Teams ID of the Teams you're removing the user from. |
410
447
411
448
412
449
```Example for usage within the workflow
@@ -429,7 +466,7 @@ For Microsoft Graph the parameters for the **Remove User from Teams** task are a
429
466
430
467
### Remove users from all teams
431
468
432
-
Allows users to be removed from every static team they are a member of. You're able to customize the task name and description for this task in the Azure portal.
469
+
Allows users to be removed from every static team they're a member of. You're able to customize the task name and description for this task in the Azure portal.
433
470
:::image type="content" source="media/lifecycle-workflow-task/remove-user-all-team-task.png" alt-text="Screenshot of Workflows task: remove user from all teams.":::
434
471
435
472
For Microsoft Graph the parameters for the **Remove users from all teams** task are as follows:
0 commit comments