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
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ ms.date: 01/26/2023
12
12
---
13
13
# Lifecycle Workflow built-in tasks (Preview)
14
14
15
-
Lifecycle Workflows come with many pre-configured tasks that are designed to automate common lifecycle management scenarios. These built-in tasks can be utilized to make customized workflows to suit your organization's needs. These tasks can be configured within seconds to create new workflows. These tasks also have categories based on the Joiner-Mover-Leaver model so that they can be easily placed into workflows based on need. In this article you'll get the complete list of tasks, information on common parameters each task has, and a list of unique parameters needed for each specific task.
15
+
Lifecycle Workflows come with many pre-configured tasks that are designed to automate common lifecycle management scenarios. These built-in tasks can be utilized to make customized workflows to suit your organization's needs. These tasks can be configured within seconds to create new workflows. These tasks also have categories based on the Joiner-Mover-Leaver model so that they can be easily placed into workflows based on need. In this article you get the complete list of tasks, information on common parameters each task has, and a list of unique parameters needed for each specific task.
16
16
17
17
18
18
## Supported tasks
@@ -30,10 +30,10 @@ Common task parameters are the non-unique parameters contained in every task. Wh
30
30
|---------|---------|
31
31
|category | A read-only string that identifies the category or categories of the task. Automatically determined when the taskDefinitionID is chosen. |
32
32
|taskDefinitionId | A string referencing a taskDefinition that determines which task to run. |
33
-
|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. |
33
+
|isEnabled | A boolean value that denotes whether the task is set to run or not. If set to “true" then the task runs. Defaults to true. |
34
34
|displayName | A unique string that identifies the task. |
35
35
|description | A string that describes the purpose of the task for administrative use. (Optional) |
36
-
|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). |
36
+
|executionSequence | A read-only integer that states in what order the task runs in a workflow. For more information about executionSequence and workflow order, see: [Configure Scope](understanding-lifecycle-workflows.md#configure-scope). |
37
37
|continueOnError | A boolean value that determines if the failure of this task stops the subsequent workflows from running. |
38
38
|arguments | Contains unique parameters relevant for the given task. |
39
39
@@ -43,7 +43,7 @@ Emails, sent from tasks, are able to be customized. If you choose to customize t
43
43
44
44
-**Subject:** Customizes the subject of emails.
45
45
-**Message body:** Customizes the body of the emails being sent out.
46
-
-**Email language translation:** Overrides the email recipient's language settings. Custom text is not customized, and it is recommended to set this language to the same language as the custom text.
46
+
-**Email language translation:** Overrides the email recipient's language settings. Custom text isn't customized, and it's recommended to set this language to the same language as the custom text.
47
47
48
48
:::image type="content" source="media/lifecycle-workflow-task/customize-email-concept.png" alt-text="Screenshot of the customization email options.":::
49
49
@@ -87,7 +87,7 @@ The Azure AD prerequisite to run the **Send welcome email to new hire** task is:
87
87
- A populated mail attribute for the user.
88
88
89
89
90
-
For Microsoft Graph the parameters for the **Send welcome email to new hire** task are as follows:
90
+
For Microsoft Graph, the parameters for the **Send welcome email to new hire** task are as follows:
91
91
92
92
|Parameter |Definition |
93
93
|---------|---------|
@@ -141,7 +141,7 @@ The Azure AD prerequisite to run the **Send onboarding reminder email** task is:
141
141
- A populated manager's mail attribute for the user.
142
142
143
143
144
-
For Microsoft Graph the parameters for the **Send onboarding reminder email** task are as follows:
144
+
For Microsoft Graph, the parameters for the **Send onboarding reminder email** task are as follows:
145
145
146
146
|Parameter |Definition |
147
147
|---------|---------|
@@ -204,7 +204,7 @@ The Azure AD prerequisites to run the **Generate Temporary Access Pass and send
204
204
> [!IMPORTANT]
205
205
> A user having this task run for them in a workflow must also not have any other authentication methods, sign-ins, or AAD role assignments for this task to work for them.
206
206
207
-
For Microsoft Graph the parameters for the **Generate Temporary Access Pass and send via email to user's manager** task are as follows:
207
+
For Microsoft Graph, the parameters for the **Generate Temporary Access Pass and send via email to user's manager** task are as follows:
208
208
209
209
|Parameter |Definition |
210
210
|---------|---------|
@@ -256,14 +256,14 @@ For Microsoft Graph the parameters for the **Generate Temporary Access Pass and
256
256
### Add user to groups
257
257
258
258
259
-
Allows users to be added to Microsoft 365 and cloud-only security groups. Mail-enabled, distribution, dynamic and role-assignable groups are 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).
259
+
Allows users to be added to Microsoft 365 and cloud-only security groups. Mail-enabled, distribution, dynamic and role-assignable groups aren't 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).
260
260
261
261
262
262
You're able to customize the task name and description for this task.
263
263
:::image type="content" source="media/lifecycle-workflow-task/add-group-task.png" alt-text="Screenshot of Workflows task: Add user to group task.":::
264
264
265
265
266
-
For Microsoft Graph the parameters for the **Add user to groups** task are as follows:
266
+
For Microsoft Graph, the parameters for the **Add user to groups** task are as follows:
267
267
268
268
|Parameter |Definition |
269
269
|---------|---------|
@@ -299,7 +299,7 @@ You're able to add a user to an existing static team. You're able to customize t
299
299
:::image type="content" source="media/lifecycle-workflow-task/add-team-task.png" alt-text="Screenshot of Workflows task: add user to team.":::
300
300
301
301
302
-
For Microsoft Graph the parameters for the **Add user to teams** task are as follows:
302
+
For Microsoft Graph, the parameters for the **Add user to teams** task are as follows:
303
303
304
304
|Parameter |Definition |
305
305
|---------|---------|
@@ -331,12 +331,12 @@ For Microsoft Graph the parameters for the **Add user to teams** task are as fol
331
331
332
332
### Enable user account
333
333
334
-
Allows cloud-only user accounts to be enabled. Users with Azure AD role assignments are not supported, nor are users with membership or ownership of role-assignable groups. You can utilize Azure Active Directory's HR driven provisioning to on-premises Active Directory to disable and enable synchronized accounts with an attribute mapping to `accountDisabled` based on data from your HR source. For more information, see: [Workday Configure attribute mappings](../saas-apps/workday-inbound-tutorial.md#part-4-configure-attribute-mappings) and [SuccessFactors Configure attribute mappings](../saas-apps/sap-successfactors-inbound-provisioning-tutorial.md#part-4-configure-attribute-mappings). You're able to customize the task name and description for this task in the Azure portal.
334
+
Allows cloud-only user accounts to be enabled. Users with Azure AD role assignments aren't supported, nor are users with membership or ownership of role-assignable groups. You can utilize Azure Active Directory's HR driven provisioning to on-premises Active Directory to disable and enable synchronized accounts with an attribute mapping to `accountDisabled` based on data from your HR source. For more information, see: [Workday Configure attribute mappings](../saas-apps/workday-inbound-tutorial.md#part-4-configure-attribute-mappings) and [SuccessFactors Configure attribute mappings](../saas-apps/sap-successfactors-inbound-provisioning-tutorial.md#part-4-configure-attribute-mappings). You're able to customize the task name and description for this task in the Azure portal.
335
335
336
336
:::image type="content" source="media/lifecycle-workflow-task/enable-task.png" alt-text="Screenshot of Workflows task: enable user account.":::
337
337
338
338
339
-
For Microsoft Graph the parameters for the **Enable user account** task are as follows:
339
+
For Microsoft Graph, the parameters for the **Enable user account** task are as follows:
340
340
341
341
|Parameter |Definition |
342
342
|---------|---------|
@@ -370,7 +370,7 @@ The Azure AD prerequisite to run the **Run a Custom Task Extension** task is:
370
370
371
371
- A Logic App that is compatible with the custom task extension. For more information, see: [Lifecycle workflow extensibility](lifecycle-workflow-extensibility.md).
372
372
373
-
For Microsoft Graph the parameters for the **Run a Custom Task Extension** task are as follows:
373
+
For Microsoft Graph, the parameters for the **Run a Custom Task Extension** task are as follows:
374
374
375
375
|Parameter |Definition |
376
376
|---------|---------|
@@ -405,12 +405,12 @@ For more information on setting up a Logic app to run with Lifecycle Workflows,
405
405
406
406
### Disable user account
407
407
408
-
Allows cloud-only user accounts to be disabled. Users with Azure AD role assignments are not supported, nor are users with membership or ownership of role-assignable groups. You can utilize Azure Active Directory's HR driven provisioning to on-premises Active Directory to disable and enable synchronized accounts with an attribute mapping to `accountDisabled` based on data from your HR source. For more information, see: [Workday Configure attribute mappings](../saas-apps/workday-inbound-tutorial.md#part-4-configure-attribute-mappings) and [SuccessFactors Configure attribute mappings](../saas-apps/sap-successfactors-inbound-provisioning-tutorial.md#part-4-configure-attribute-mappings). You're able to customize the task name and description for this task in the Azure portal.
408
+
Allows cloud-only user accounts to be disabled. Users with Azure AD role assignments aren't supported, nor are users with membership or ownership of role-assignable groups. You can utilize Azure Active Directory's HR driven provisioning to on-premises Active Directory to disable and enable synchronized accounts with an attribute mapping to `accountDisabled` based on data from your HR source. For more information, see: [Workday Configure attribute mappings](../saas-apps/workday-inbound-tutorial.md#part-4-configure-attribute-mappings) and [SuccessFactors Configure attribute mappings](../saas-apps/sap-successfactors-inbound-provisioning-tutorial.md#part-4-configure-attribute-mappings). You're able to customize the task name and description for this task in the Azure portal.
409
409
410
410
:::image type="content" source="media/lifecycle-workflow-task/disable-task.png" alt-text="Screenshot of Workflows task: disable user account.":::
411
411
412
412
413
-
For Microsoft Graph the parameters for the **Disable user account** task are as follows:
413
+
For Microsoft Graph, the parameters for the **Disable user account** task are as follows:
414
414
415
415
|Parameter |Definition |
416
416
|---------|---------|
@@ -435,15 +435,15 @@ For Microsoft Graph the parameters for the **Disable user account** task are as
435
435
436
436
### Remove user from selected groups
437
437
438
-
Allows users to be removed from Microsoft 365 and cloud-only security groups. Mail-enabled, distribution, dynamic and role-assignable groups are 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).
438
+
Allows users to be removed from Microsoft 365 and cloud-only security groups. Mail-enabled, distribution, dynamic and role-assignable groups aren't 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).
439
439
440
440
441
441
You're able to customize the task name and description for this task in the Azure portal.
442
442
:::image type="content" source="media/lifecycle-workflow-task/remove-group-task.png" alt-text="Screenshot of Workflows task: Remove user from select groups.":::
443
443
444
444
445
445
446
-
For Microsoft Graph the parameters for the **Remove user from selected groups** task are as follows:
446
+
For Microsoft Graph, the parameters for the **Remove user from selected groups** task are as follows:
447
447
448
448
|Parameter |Definition |
449
449
|---------|---------|
@@ -475,7 +475,7 @@ For Microsoft Graph the parameters for the **Remove user from selected groups**
475
475
476
476
### Remove users from all groups
477
477
478
-
Allows users to be removed from every Microsoft 365 and cloud-only security group they're a member of. Mail-enabled, distribution, dynamic and role-assignable groups are 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).
478
+
Allows users to be removed from every Microsoft 365 and cloud-only security group they're a member of. Mail-enabled, distribution, dynamic and role-assignable groups aren't 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).
479
479
480
480
481
481
@@ -484,7 +484,7 @@ You're able to customize the task name and description for this task in the Azur
484
484
:::image type="content" source="media/lifecycle-workflow-task/remove-all-groups-task.png" alt-text="Screenshot of Workflows task: remove user from all groups.":::
485
485
486
486
487
-
For Microsoft Graph the parameters for the **Remove users from all groups** task are as follows:
487
+
For Microsoft Graph, the parameters for the **Remove users from all groups** task are as follows:
488
488
489
489
|Parameter |Definition |
490
490
|---------|---------|
@@ -513,7 +513,7 @@ For Microsoft Graph the parameters for the **Remove users from all groups** task
513
513
Allows a user to be removed from one or multiple static teams. You're able to customize the task name and description for this task in the Azure portal.
514
514
:::image type="content" source="media/lifecycle-workflow-task/remove-user-team-task.png" alt-text="Screenshot of Workflows task: remove user from teams.":::
515
515
516
-
For Microsoft Graph the parameters for the **Remove User from Teams** task are as follows:
516
+
For Microsoft Graph, the parameters for the **Remove User from Teams** task are as follows:
517
517
518
518
|Parameter |Definition |
519
519
|---------|---------|
@@ -547,7 +547,7 @@ For Microsoft Graph the parameters for the **Remove User from Teams** task are a
547
547
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.
548
548
:::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.":::
549
549
550
-
For Microsoft Graph the parameters for the **Remove users from all teams** task are as follows:
550
+
For Microsoft Graph, the parameters for the **Remove users from all teams** task are as follows:
551
551
552
552
|Parameter |Definition |
553
553
|---------|---------|
@@ -578,7 +578,7 @@ Allows all direct license assignments to be removed from a user. For group-based
578
578
You're able to customize the task name and description for this task in the Azure portal.
579
579
:::image type="content" source="media/lifecycle-workflow-task/remove-license-assignment-task.png" alt-text="Screenshot of Workflows task: remove all licenses from users.":::
580
580
581
-
For Microsoft Graph the parameters for the **Remove all license assignment from user** task are as follows:
581
+
For Microsoft Graph, the parameters for the **Remove all license assignment from user** task are as follows:
582
582
583
583
|Parameter |Definition |
584
584
|---------|---------|
@@ -604,11 +604,11 @@ For Microsoft Graph the parameters for the **Remove all license assignment from
604
604
605
605
### Delete User
606
606
607
-
Allows cloud-only user accounts to be deleted. Users with Azure AD role assignments are not supported, nor are users with membership or ownership of role-assignable groups. You're able to customize the task name and description for this task in the Azure portal.
607
+
Allows cloud-only user accounts to be deleted. Users with Azure AD role assignments aren't supported, nor are users with membership or ownership of role-assignable groups. You're able to customize the task name and description for this task in the Azure portal.
608
608
:::image type="content" source="media/lifecycle-workflow-task/delete-user-task.png" alt-text="Screenshot of Workflows task: Delete user account.":::
609
609
610
610
611
-
For Microsoft Graph the parameters for the **Delete User** task are as follows:
611
+
For Microsoft Graph, the parameters for the **Delete User** task are as follows:
612
612
613
613
|Parameter |Definition |
614
614
|---------|---------|
@@ -692,7 +692,7 @@ The Azure AD prerequisite to run the **Send email on user last day** task are:
692
692
- A populated manager attribute for the user.
693
693
- A populated manager's mail attribute for the user.
694
694
695
-
For Microsoft Graph the parameters for the **Send email on user last day** task are as follows:
695
+
For Microsoft Graph, the parameters for the **Send email on user last day** task are as follows:
696
696
697
697
|Parameter |Definition |
698
698
|---------|---------|
@@ -742,7 +742,7 @@ The Azure AD prerequisite to run the **Send email to users manager after their l
742
742
- A populated manager's mail attribute for the user.
743
743
744
744
745
-
For Microsoft Graph the parameters for the **Send email to users manager after their last day** task are as follows:
745
+
For Microsoft Graph, the parameters for the **Send email to users manager after their last day** task are as follows:
0 commit comments