+Retrieve an access package with a list of [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) objects. These objects represent the resource roles that an access package assigns to each subject. Each object links to an [accessPackageResourceRole](../resources/accesspackageresourcerole.md) and an [accessPackageResourceScope](../resources/accesspackageresourcescope.md).

+If successful, this method returns a `200 OK` response code and an [accessPackage](../resources/accesspackage.md) that contains a collection of [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) objects in the response body.

+The request contains an [accessPackageResourceRole](../resources/accesspackageresourcerole.md) object, which can be obtained from an earlier request to [list access package resource roles of a resource in a catalog](accesspackagecatalog-list-accesspackageresourceroles.md). Each type of resource defines the format of the originId field in a resource role. For a SharePoint Online site, the originId will be the sequence number of the role in the site.

+This is an example of retrieving the roles of a resource, to obtain the **originId** of each role. This would be used after a SharePoint Online site has been added as a resource to the catalog, as the **originId** of a SharePoint site role, the sequence number of the role in the site, is needed to add the role to an access package.

+ }

+ ]

+}

+```

+### Example 3: Retrieve all decisions for an instance of an access review along with insights

+#### Request

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "list_accessreviewinstancedecisionitem_expandinsights"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/60860cdd-fb4d-4054-91ba-444404f3baa6/instances/14444cdb-6a18-4c08-ba2c-48c02f0a0138/decisions?$expand=insights

+```

+# [C#](#tab/csharp)

+# [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": "Collection(microsoft.graph.accessReviewInstanceDecisionItem)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/accessReviews/definitions('5eac5a70-7cd7-4f20-92b0-f9dba70dd7f0')/instances('6444d4fd-ab55-4608-8cf9-c6702d172bcc')/decisions(insights())",

+ "@odata.count": 2,

+ "value": [

+ "id": "e6cafba0-cbf0-4748-8868-0810c7f4cc06",

+ "accessReviewId": "6444d4fd-ab55-4608-8cf9-c6702d172bcc",

+ "applyResult": "New",

+ "recommendation": "Approve",

+ "principalLink": "https://graph.microsoft.com/v1.0/users/04777c4b-4d43-4d32-a2e7-1eba5d03f8cf",

+ "resourceLink": "https://graph.microsoft.com/v1.0/groups/98f41dad-68d5-42f6-a50f-ddd75c5c5539",

+ "reviewedBy": {

+ "id": "00000000-0000-0000-0000-000000000000"

+ "appliedBy": {

+ "id": "00000000-0000-0000-0000-000000000000"

+ "id": "98f41dad-68d5-42f6-a50f-ddd75c5c5539",

+ "displayName": "poltest1_g01",

+ "type": "group"

+ "@odata.type": "#microsoft.graph.userIdentity",

+ "id": "04777c4b-4d43-4d32-a2e7-1eba5d03f8cf"

+ "insights@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/accessReviews/definitions('5eac5a70-7cd7-4f20-92b0-f9dba70dd7f0')/instances('6444d4fd-ab55-4608-8cf9-c6702d172bcc')/decisions('e6cafba0-cbf0-4748-8868-0810c7f4cc06')/insights",

+ "insights": [

+ {

+ "@odata.type": "#microsoft.graph.userSignInInsight",

+ "id": "00000000-0000-0000-0000-000000000000",

+ "insightCreatedDateTime": null,

+ "lastSignInDateTime": "2022-02-11T20:00:34Z"

+ },

+ {

+ "@odata.type": "#microsoft.graph.membershipOutlierInsight",

+ "id": "f8b5b125-2df6-405c-9cab-6c0e477cbf0a",

+ "insightCreatedDateTime": "2022-08-09T08:25:00Z",

+ "memberId": "04777c4b-4d43-4d32-a2e7-1eba5d03f8cf",

+ "containerId": "98f41dad-68d5-42f6-a50f-ddd75c5c5539",

+ "outlierMemberType": "user",

+ "outlierContainerType": "group"

+ ]

+ "query": "/users"

+ "query": "/servicePrincipals/bae11f90-7d5d-46ba-9f55-8112b59d92ae"

+ "query": "./manager"

+ "query": "/groups/072ac5f4-3f13-4088-ab30-0a276f3e6322/transitiveMembers"

+ ]

+ "id": "957f1027-c0ee-460d-9269-b8444459e0fe"

+ "query": "/groups/b74444cb-038a-4802-8fc9-b9d1ed0cf11f/transitiveMembers"

+ ]

+}

+```

+### Example 5: Create an access review on a group with membership outlier insights and user sign in insights for recommendations

+The following example creates an access review with the following settings:

+#### Request

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "create_accessReviewScheduleDefinition_insights"

+}-->

+```http

+POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions

+Content-type: application/json

+{

+ "displayName": "Test create",

+ "descriptionForAdmins": "New scheduled access review",

+ "descriptionForReviewers": "If you have any questions, contact jerry@contoso.com",

+ "scope": {

+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",

+ "query": "/groups/02f3bafb-448c-487c-88c2-5fd65ce49a41/transitiveMembers",

+ "queryType": "MicrosoftGraph"

+ "reviewers": [

+ {

+ "query": "/users/398164b1-5196-49dd-ada2-364b49f99b27",

+ "queryType": "MicrosoftGraph"

+ }

+ ],

+ "settings": {

+ "instanceDurationInDays": 1,

+ "recurrence": {

+ "pattern": {

+ "type": "weekly",

+ "interval": 1

+ },

+ "range": {

+ "type": "noEnd",

+ "startDate": "2020-09-08T12:02:30.667Z"

+ }

+ },

+ "recommendationInsightSettings": [

+ {

+ "@odata.type": "#microsoft.graph.userLastSignInRecommendationInsightSetting",

+ "recommendationLookBackDuration": "P30D",

+ "signInScope": "tenant"

+ },

+ {

+ "@odata.type": "#microsoft.graph.groupPeerOutlierRecommendationInsightSettings"

+ }

+ ]

+ }

+# [C#](#tab/csharp)

+# [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.accessReviewScheduleDefinition"

+} -->

+```http

+HTTP/1.1 201 Created

+Content-type: application/json

+ "id": "29f2d16e-9ca6-4052-bbfe-802c48944448",

+ "displayName": "Test create",

+ "createdBy": {

+ "id": "957f1027-c0ee-460d-9269-b8444459e0fe"

+ },

+ "scope": {

+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",

+ "query": "/groups/b74444cb-038a-4802-8fc9-b9d1ed0cf11f/transitiveMembers"

+ },

+ "reviewers": [

+ {

+ "query": "/users/7eae986b-d425-48b2-adf2-3c777f4444f3"

+ }

+ ],

+ "settings": {

+ "recommendationInsightSettings": [

+ {

+ "@odata.type": "#microsoft.graph.userLastSignInRecommendationInsightSetting",

+ "recommendationLookBackDuration": "P30D",

+ "signInScope": "tenant"

+ },

+ {

+ "@odata.type": "#microsoft.graph.groupPeerOutlierRecommendationInsightSettings"

+ }

+ ]

+ }

+```

+ Title: List activities

+# List activities (preview)

+>**Note:** Activities is in a limited preview and is not yet available to all tenants.

+### Request

+### Response

+> **Note:** You must include the **alert** ID as a parameter and **vendorInformation** containing the `provider` and `vendor` with this method.

+|comments|String collection|Analyst comments on the alert (for customer alert management). This method can update the **comments** field with the following values only: `Closed in IPC`, `Closed in MCAS`.|

+|tags|String collection|User-definable labels that can be applied to an alert and can serve as filter conditions (for example, "HVA", "SAW").|

+|vendorInformation |[securityVendorInformation](../resources/securityvendorinformation.md)|Complex type that contains details about the security product/service vendor, provider, and subprovider (for example, `vendor=Microsoft`; `provider=Windows Defender ATP`; `subProvider=AppLocker`). **Provider and vendor fields are required.**|

+If the optional request header is used, the method returns a `200 OK` response code and an updated [alert](../resources/alert.md) object in the response body.

+> You can continue to use the [Create application](../api/application-post-applications.md) and [Update application](../api/application-update.md) operations to add and update key credentials for any application with or without a user's context.

+>

+> You should only provide the public key value when adding a certificate credential to your application. Adding a private key certificate to your application risks compromising the application.

+This method supports the `$count`, `$expand`, `$filter`, `$orderBy`, `$search`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. Some relationships also support `$filter`. The default and maximum page sizes are 100 and 999 application objects respectively. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).

+ Title: "Delete authenticationContextClassReference"

+description: "Delete an authenticationContextClassReference object."

+ms.localizationpriority: medium

+# Delete authenticationContextClassReference

+Namespace: microsoft.graph

+Delete an [authenticationContextClassReference](../resources/authenticationcontextclassreference.md) object that's not published or used by a conditional access 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) | Policy.Read.ConditionalAccess |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Policy.Read.ConditionalAccess |

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+DELETE /identity/conditionalAccess/authenticationContextClassReferences/{authenticationContextClassReferenceId}

+```

+## 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_authenticationcontextclassreference"

+}

+-->

+``` http

+DELETE https://graph.microsoft.com/beta/identity/conditionalAccess/authenticationContextClassReferences/c1

+```

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+If successful, this method returns a `200 OK` response code and an [authenticationContextClassReference](../resources/authenticationcontextclassreference.md) object in the response body.

+|Property|Type|Description|

+|:|:|:|

+|displayName|String|A friendly name that identifies the authenticationContextClassReference object when building user-facing admin experiences. For example, a selection UX. |

+|description|String|A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user-facing admin experiences. For example, a selection UX. |

+|isAvailable|Boolean|Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it is set to `false`, it should not be shown in admin UX experiences because the value is not currently available for selection. |

+ "id": "c1",

+ "displayName": "Contoso medium",

+ "description": "Medium protection level defined for Contoso policy",

+ "isAvailable": true

+|Delegated (work or school account)|UserAuthenticationMethod.Read.All and AuditLog.Read.All|

+|Application|UserAuthenticationMethod.Read.All and AuditLog.Read.All|

+|Delegated (work or school account)| Chat.ReadWrite |

+|Delegated (work or school account)| Chat.ReadWrite |

+The update only works for chats where members are Microsoft Teams users. If one of the participants is using Skype, the operation will fail.

+ Title: "cloudPC: restore"

+description: "Restore a specific Cloud PC."

+ms.localizationpriority: medium

+# cloudPC: restore

+Namespace: microsoft.graph

+Restore a specific Cloud PC. Use this API to trigger a remote action that restores a Cloud PC device to a previous 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)|CloudPC.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|CloudPC.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /deviceManagement/virtualEndpoint/cloudPCs/{id}/restore

+```

+## 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|

+|:|:|:|

+|cloudPcSnapshotId|String|The unique identifier for the snapshot of the Cloud PC device at a specific point in time.|

+## 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": "cloudpc_restore",

+ "sampleKeys": ["4b5ad5e0-6a0b-4ffc-818d-36bb23cf4dbd"]

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/4b5ad5e0-6a0b-4ffc-818d-36bb23cf4dbd/restore

+Content-Type: application/json

+Content-length: 37

+{

+ "cloudPcSnapshotId": "A00009UV000_93aff428-61f2-467f-a879-1102af6fd4a8"

+}

+```

+# [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

+```

+This method supports the `$filter` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+> **Note:** The response object shown here might be shortened for readability.

+You can specify the following properties when creating an **authenticationContextClassReference**.

+|Property|Type|Description|

+|:|:|:|

+| id | String|Identifier used to reference the authentication context class. The id is used to trigger step-up authentication for the referenced authentication requirements and is the value that will be issued in the `acrs` claim of an access token. This value in the claim is used to verify that the required authentication context has been satisfied. The allowed values are `c1` through `c25`. Required.|

+|displayName|String|A friendly name that identifies the authenticationContextClassReference object when building user-facing admin experiences. For example, a selection UX. Optional.|

+|description|String|A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user-facing admin experiences. For example, a selection UX. Optional.|

+|isAvailable|Boolean|Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it is set to `false`, it should not be shown in admin UX experiences because the value is not currently available for selection. Optional.|

+HTTP/1.1 201 Created

+Permanently delete a recently deleted [application](../resources/application.md), [group](../resources/group.md), [servicePrincipal](../resources/serviceprincipal.md), or [user](../resources/user.md) object from [deleted items](../resources/directory.md). After an item is permanently deleted, it **cannot** be restored.

+Retrieve a list of recently deleted directory objects. Currently, deleted items functionality is only supported for the [application](../resources/application.md), [servicePrincipal](../resources/serviceprincipal.md), [group](../resources/group.md), and [user](../resources/user.md) resources.

+The calling user must be assigned the Global Administrator [Azure AD role](/azure/active-directory/roles/permissions-reference).

+ Title: "driveItem: assignSensitivityLabel"

+description: "Asynchronously assign a sensitivity label to a driveItem."

+ms.localizationpriority: medium

+# driveItem: assignSensitivityLabel

+Namespace: microsoft.graph

+Asynchronously assign a sensitivity label to a [driveItem][item-resource].

+This API is part of Microsoft SharePoint and OneDrive APIs that perform advanced premium administrative functions and is considered a protected API. Protected APIs require you to have additional validation, beyond permission and consent, before you can use them.

+For more information about sensitivity labels from an administrator's perspective, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files?view=o365-worldwide&preserve-view=true).

+> [!NOTE]

+> Before you call this API with application permissions, you must request access. To request access, fill out the [request form](https://aka.ms/PreviewSPOPremiumAPI).

+## 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) | Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All |

+|Delegated (personal Microsoft account) | Files.ReadWrite, Files.ReadWrite.All |

+|Application | Files.ReadWrite.All, Sites.ReadWrite.All |

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /drives/{drive-id}/items/{item-id}/assignSensitivityLabel

+POST /drives/{drive-id}/root:/{item-path}/assignSensitivityLabel

+POST /groups/{group-id}/drive/items/{item-id}/assignSensitivityLabel

+POST /groups/{group-id}/drive/root:/{item-path}/assignSensitivityLabel

+POST /me/drive/items/{item-id}/assignSensitivityLabel

+POST /me/drive/root:/{item-path}/assignSensitivityLabel

+POST /sites/{site-id}/drive/items/{item-id}/assignSensitivityLabel

+POST /sites/{site-id}/drive/root:/{item-path}/assignSensitivityLabel

+POST /users/{user-id}/drive/items/{item-id}/assignSensitivityLabel

+POST /users/{user-id}/drive/root:/{item-path}/assignSensitivityLabel

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+In the request body, provide the ID for the sensitivity label that is to be assigned to a given file. The following table lists the required and optional input parameters.

+| Name | Value |Description |

+|:--|:--|:|

+| sensitivityLabelId | String | Required. ID of the sensitivity label to be assigned, or empty string to remove the sensitivity label. |

+| assignmentMethod | [sensitivityLabelAssignmentMethod](/graph/api/resources/sensitivitylabelassignment?view=graph-rest-beta&preserve-view=true#sensitivitylabelassignmentmethod-values) | Optional. The assignment method of the label on the document. Indicates whether the assignment of the label was done automatically, standard, or as a privileged operation (the equivalent of an administrator operation). |

+| justificationText | String | Optional. Justification text for audit purposes. Required when downgrading/removing a label. |

+## Response

+If successful, the API returns a `202 Accepted` HTTP response code with an empty response body. The `Location` header provides the URL to get operation details.

+For more details about how to monitor the progress of an assign sensitivity label operation, see [monitoring long-running operations](/graph/long-running-actions-overview).

+In addition to general errors that apply to Microsoft Graph, this API returns the `423 Locked` response code, which indicates that the file being accessed is locked. In such cases, the **code** property of the response object indicates the error type that blocks the operation.

+The following table lists the possible values for the error types.

+| Value | Description |

+|:-|:--|

+| fileDoubleKeyEncrypted | Indicates that the file is protected via double key encryption; therefore, it cannot be opened. |

+| fileDecryptionNotSupported | Indicates that the encrypted file has specific properties that do not allow these files to be opened by SharePoint.|

+| fileDecryptionDeferred | Indicates that the file is being processed for decryption; therefore, it cannot be opened. |

+| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- { "blockType": "request", "name": "assignSensitivityLabel", "tags": "service.graph" } -->

+``` http

+POST https://graph.microsoft.com/beta/drive/root/items/016GVDAP3RCQS5VBQHORFIVU2ZMOSBL25U/assignSensitivityLabel

+Content-Type: application/json

+{

+ "sensitivityLabelId": "5feba255-812e-446a-ac59-a7044ef827b5",

+ "assignmentMethod": "standard",

+ "justificationText": "test_justification"

+}

+```

+# [JavaScript](#tab/javascript)

+### Response

+The following is an example of the response.

+<!-- { "blockType": "response" } -->

+```http

+HTTP/1.1 202 Accepted

+Location: https://contoso.sharepoint.com/_api/v2.0/monitor/QXNzaWduU2Vuc2l0aXZpdHlMYWJlbCxiMzc3ODY3OS04OWQ3LTRkYmYtYjg0MC1jYWM1NzRhY2FlNmE?tempAuth=eyJ0eXAiOiJKV1QiLCJhb....

+```

+The value of the `Location` header provides a URL for a service that will return the current state of the assign sensitivity label operation.

+You can use this information to [determine when the assign sensitivity label operation has finished](/graph/long-running-actions-overview).

+### Remarks

+The response from the API only indicates that the assign sensitivity label operation was accepted or rejected. The operation might be rejected, for example, if the file type is not supported, or the file is double encrypted.

+[item-resource]: ../resources/driveitem.md

+For more information about sensitivity labels from an administrator's perspective, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files?view=o365-worldwide&preserve-view=true).

+ Title: Get driveItem

+# Get driveItem

+Retrieve the metadata for a [driveItem](../resources/driveitem.md) in a [drive](../resources/drive.md) by file system path or ID.

+### Response

+## See also

+For details about how errors are returned, see [Error responses][error-response].

+Restore a [driveItem](../resources/driveitem.md) that has been deleted and is currently in the recycle bin.

+>**Note**: This functionality is currently only available for OneDrive Personal.

+>Starting in September 2021, this API will create a large case type. To learn more about large cases, see [Use the new case format in eDiscovery](/microsoft-365/compliance/advanced-ediscovery-new-case-format). For details, see the [Changes to the Microsoft 365 advanced eDiscovery create case API](https://devblogs.microsoft.com/microsoft365dev/changes-to-the-microsoft-365-advanced-ediscovery-create-case-api-beta/) blog post.

+The following is an example of a request.

+The following is an example of the response.

+ "dueTime": "2021-08-30T23:59:00Z",

+ "dueTime": "2021-08-30T23:59:00Z",

+Indicate that a student is done with the work and is ready to hand in the assignment.

+This method changes the status of the submission from `working` to `submitted`. During the submit process, all the resources are copied to the **submittedResources** bucket. The teacher will be looking at the submitted resources list for grading.

+A teacher can also submit a student's assignment on their behalf.

+Indicate that a student wants to work on the submitted assignment after it was turned in.

+This method changes the status of the submission from `submitted` to `working`. During the submit process, all the resources are copied from **submittedResources** to **workingResources**. The teacher will be looking at the working resources list for grading.

+A teacher can also unsubmit a student's assignment on their behalf.

+# [PowerShell](#tab/powershell)

+description: "Retrieve a submitted resource."

+Retrieve a [submitted resource](../resources/educationsubmissionresource.md).

+Resources will be available to a teacher or an application with application permissions after a student submits it, and will be available to the student after the teacher releases the submission. Note that teachers can leave notes in some resources.

+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response.

+### Request

+### Response

+| Delegated (personal Microsoft account) |Not supported.|

+| Application |Not supported.|

+### Request

+The following is an example of the request.

+### Response

+The following is an example of the response.

+Create a new [accessPackageResourceRequest](../resources/accesspackageresourcerequest.md) object to request the addition of a resource to an access package catalog, or the removal of a resource from a catalog. A resource must be included in an access package catalog before a [role of that resource](../resources/accesspackageresourcerole.md) can be added to an access package.

+| connection-id | string | The **id** property of the containing [externalConnection](../resources/externalconnectors-externalconnection.md). |

+| item-id | string | The developer-provided **id** property of the [externalItem](../resources/externalconnectors-externalitem.md). |

+ Title: "filter: apply"

+# filter: apply

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+ Title: "filter: clear"

+# filter: clear

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+ Title: "Get formatProtection"

+# Get formatProtection

+If successful, this method returns a `200 OK` response code and a [formatProtection](../resources/formatprotection.md) object in the response body.

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+ Title: "Update formatProtection"

+# Update formatProtection

+|formulaHidden|Boolean|Indicates whether Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.|

+|locked|Boolean|Indicates whether Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.|

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference#privileged-access-permissions).

+> To remove members from a role-assignable group, the calling user must also be assigned the _RoleManagement.ReadWrite.Directory_ permission.

+The following is an example of the request. The calling user must be assigned the _RoleManagement.ReadWrite.Directory_ permission to set the **isAssignableToRole** property or update the membership of such groups.

+> To add members to a role-assignable group, the calling user must also be assigned the _RoleManagement.ReadWrite.Directory_ permission.

+ Title: "Get icon"

+# Get icon

+Retrieve the properties and relationships of an icon object.

+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response.

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+Update the properties of an icon object.

+In the request body, supply the values for relevant 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.

+If successful, this method returns a `200 OK` response code and an updated [workbookIcon](../resources/workbookicon.md) object in the response body.

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+ Title: "Delete customTaskExtension"

+description: "Delete a customTaskExtension object."

+ms.localizationpriority: medium

+# Delete customTaskExtension

+Namespace: microsoft.graph.identityGovernance

+Delete a [customTaskExtension](../resources/identitygovernance-customtaskextension.md) object. Can only be deleted if it is not referenced in any task objects in a lifecycle workflow.

+## 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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+DELETE /identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtensionId}/

+```

+## 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": "lifecycleworkflows_delete_customtaskextension"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Get customTaskExtension"

+description: "Read the properties and relationships of a customTaskExtension object."

+ms.localizationpriority: medium

+# Get customTaskExtension

+Namespace: microsoft.graph.identityGovernance

+Read the properties and relationships of a [customTaskExtension](../resources/identitygovernance-customtaskextension.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtensionId}

+```

+## Optional query parameters

+This method supports the `$select` and `$expand` 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 [customTaskExtension](../resources/identitygovernance-customtaskextension.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_customtaskextension"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.customTaskExtension"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/customTaskExtensions/$entity",

+ "id": "ffcc4c85-5a14-448e-a390-77abf2700369",

+ "displayName": "Grant manager access to mailbox and OneDrive",

+ "description": "Grant manager access to mailbox and OneDrive",

+ "createdDateTime": "2022-08-24T20:36:14.7006029Z",

+ "lastModifiedDateTime": "2022-08-24T22:42:34.0744491Z",

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",

+ "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",

+ "resourceGroupName": "RG-LCM",

+ "logicAppWorkflowName": "ManagerAccess"

+ },

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",

+ "resourceId": "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"

+ },

+ "clientConfiguration": {

+ "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",

+ "maximumRetries": 1,

+ "timeoutInMilliseconds": 1000

+ },

+ "callbackConfiguration": {

+ "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",

+ "timeoutDuration": "PT10M"

+ },

+ "createdBy": {

+ "@odata.type": "#microsoft.graph.user",

+ "id": "a698128f-b34f-44db-a9f9-7661c7aba8d8"

+ },

+ "lastModifiedBy": {

+ "@odata.type": "#microsoft.graph.user",

+ "id": "a698128f-b34f-44db-a9f9-7661c7aba8d8"

+ }

+}

+```

+ Title: "Update customTaskExtension"

+description: "Update the properties of a customTaskExtension object."

+ms.localizationpriority: medium

+# Update customTaskExtension

+Namespace: microsoft.graph.identityGovernance

+Update the properties of a [customTaskExtension](../resources/identitygovernance-customtaskextension.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)|LifecycleWorkflows.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|Not supported|

+> [!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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtensionId}

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|authenticationConfiguration|[microsoft.graph.customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for the customTaskExtension.|

+|clientConfiguration|[microsoft.graph.customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|The client configuration for a custom extension.|

+|description|String|The description of the customTaskExtension.|

+|displayName|String|The display name of the customTaskExtension.|

+|endpointConfiguration|[microsoft.graph.customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The endpoint configuration for a custom extension.|

+|callbackConfiguration|[microsoft.graph.identitygovernance.customTaskExtensionCallbackConfiguration](../resources/identitygovernance-customtaskextensioncallbackconfiguration.md)|The callback configuration for a custom extension.|

+## Response

+If successful, this action returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_update_customtaskextension"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/customTaskExtensions/ffcc4c85-5a14-448e-a390-77abf2700369

+Content-Type: application/json

+Content-length: 588

+{

+ "displayName": "Grant manager access to mailbox and OneDrive",

+ "description": "Grant manager access to mailbox and OneDrive",

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",

+ "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",

+ "resourceGroupName": "RG-LCM",

+ "logicAppWorkflowName": "ManagerAccess"

+ },

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",

+ "resourceId": "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"

+ },

+ "clientConfiguration": {

+ "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",

+ "maximumRetries": 1,

+ "timeoutInMilliseconds": 1000

+ },

+ "callbackConfiguration": {

+ "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",

+ "timeoutDuration": "PT20M"

+ }

+}

+```

+# [JavaScript](#tab/javascript)

+# [Java](#tab/java)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Delete deletedItemContainer (permanently delete a deleted lifecycle workflow)"

+description: "Permanently delete a deleted lifecycle workflow."

+ms.localizationpriority: medium

+# Delete deletedItemContainer (permanently delete a deleted lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Delete a [workflow](../resources/identitygovernance-workflow.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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+DELETE /identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflowId}/

+```

+## 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": "lifecycleworkflows_delete_deleteditems"

+}

+-->

+``` http

+DELETE https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflowId}

+```

+# [C#](#tab/csharp)

+# [JavaScript](#tab/javascript)

+# [Java](#tab/java)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Get deletedItemContainer (a deleted lifecycle workflow)"

+description: "Read the properties and relationships of a deleted lifecycle workflow."

+ms.localizationpriority: medium

+# Get deletedItemContainer (a deleted lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Retrieve a deleted [workflow](../resources/identitygovernance-workflow.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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflowId}/

+```

+## Optional query parameters

+This method supports the `$select` and `$expand` 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 [workflow](../resources/identitygovernance-workflow.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_deleteditemcontainer"

+}

+-->

+``` http

+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)

+# [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.identityGovernance.workflow"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/deletedItems/workflows/$entity",

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Australia Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T19:06:39.4291388Z",

+ "createdDateTime": "2022-08-24T19:06:07.9926094Z",

+ "deletedDateTime": "2022-08-24T19:06:39.6981917Z",

+ "id": "4557805a-1af5-4c29-b271-2cd7fb5de9bf",

+ "isEnabled": false,

+ "isSchedulingEnabled": false,

+ "nextScheduleRunDateTime": null,

+ "version": 1,

+ "executionConditions": {

+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",

+ "scope": {

+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",

+ "rule": "(country eq 'Australia')"

+ },

+ "trigger": {

+ "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",

+ "timeBasedAttribute": "employeeHireDate",

+ "offsetInDays": 0

+ }

+ },

+ "lastModifiedBy": {

+ "id": "537b3620-fab7-435e-81bb-03fee751b789"

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/deletedItems/workflows('4557805a-1af5-4c29-b271-2cd7fb5de9bf')/tasks",

+ "tasks": [],

+ "createdBy": {

+ "id": "537b3620-fab7-435e-81bb-03fee751b789"

+ }

+}

+```

+ Title: "Get lifecycleManagementSettings (tenant settings for Lifecycle Workflows)"

+description: "Read the properties and relationships of a lifecycleManagementSettings object."

+ms.localizationpriority: medium

+# Get lifecycleManagementSettings (tenant settings for Lifecycle Workflows)

+Namespace: microsoft.graph.identityGovernance

+Read the properties and relationships of a [lifecycleManagementSettings](../resources/identitygovernance-lifecyclemanagementsettings.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/settings

+```

+## 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 a [lifecycleManagementSettings](../resources/identitygovernance-lifecyclemanagementsettings.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_lifecyclemanagementsettings"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/settings

+```

+# [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,

+ "@odata.type": "microsoft.graph.identityGovernance.lifecycleManagementSettings"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",

+ "workflowScheduleIntervalInHours": 1

+}

+```

+ Title: "Update lifecycleManagementSettings (tenant settings for Lifecycle Workflows)"

+description: "Update the properties of a lifecycleManagementSettings object."

+ms.localizationpriority: medium

+# Update lifecycleManagementSettings (tenant settings for Lifecycle Workflows)

+Namespace: microsoft.graph.identityGovernance

+Update the properties of a [lifecycleManagementSettings](../resources/identitygovernance-lifecyclemanagementsettings.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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /identityGovernance/lifecycleWorkflows/settings

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|workflowScheduleIntervalInHours|Int32|The workflow schedule interval. Required.|

+## Response

+If successful, this action returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_update_lifecyclemanagementsettings"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/settings

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",

+ "workflowScheduleIntervalInHours": 3

+}

+```

+# [C#](#tab/csharp)

+# [JavaScript](#tab/javascript)

+# [Java](#tab/java)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "List customTaskExtensions"

+description: "Get a list of the customTaskExtension objects and their properties."

+ms.localizationpriority: medium

+# List customTaskExtensions

+Namespace: microsoft.graph.identityGovernance

+Get a list of the [customTaskExtension](../resources/identitygovernance-customtaskextension.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/customTaskExtensions

+```

+## Optional query parameters

+This method supports the `$select` `$search`, `$orderby`, and `$filter` 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 [customTaskExtension](../resources/identitygovernance-customtaskextension.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_customtaskextension"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/customTaskExtensions

+```

+# [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,

+ "@odata.type": "Collection(microsoft.graph.identityGovernance.customTaskExtension)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/customTaskExtensions",

+ "@odata.count": 2,

+ "value": [

+ {

+ "id": "c0c5b05b-6b5b-4c8d-8060-2ae8df425f4b",

+ "displayName": "Query and assign Teams phone number",

+ "description": "Query and assign Teams phone number",

+ "createdDateTime": "2022-08-24T20:34:52.3028938Z",

+ "lastModifiedDateTime": "2022-08-24T20:35:07.716353Z",

+ "callbackConfiguration": null,

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",

+ "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",

+ "resourceGroupName": "RG-LCM",

+ "logicAppWorkflowName": "TeamsPhoneNumber"

+ },

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",

+ "resourceId": "b9c29c27-b116-47a9-925b-ff3b19bafa3b"

+ },

+ "clientConfiguration": {

+ "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",

+ "maximumRetries": 1,

+ "timeoutInMilliseconds": 1000

+ }

+ },

+ {

+ "id": "ffcc4c85-5a14-448e-a390-77abf2700369",

+ "displayName": "Grant manager access to mailbox and OneDrive",

+ "description": "Grant manager access to mailbox and OneDrive",

+ "createdDateTime": "2022-08-24T20:36:14.7006029Z",

+ "lastModifiedDateTime": "2022-08-24T20:42:07.9885265Z",

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",

+ "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",

+ "resourceGroupName": "RG-LCM",

+ "logicAppWorkflowName": "ManagerAccess"

+ },

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",

+ "resourceId": "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"

+ },

+ "clientConfiguration": {

+ "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",

+ "maximumRetries": 1,

+ "timeoutInMilliseconds": 1000

+ },

+ "callbackConfiguration": {

+ "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",

+ "timeoutDuration": "PT5M"

+ }

+ }

+ ]

+}

+```

+ Title: "List deletedItems (deleted lifecycle workflows)"

+description: "Get a list of the deleted workflows objects and their properties."

+ms.localizationpriority: medium

+# List deletedItems (deleted lifecycle workflows)

+Namespace: microsoft.graph

+Get a list of the deleted workflow 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows/

+```

+## Optional query parameters

+This method supports the `$select`, `$search`, `$orderby`, and `$filter` 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 [workflow](../resources/identitygovernance-workflow.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_deleteditemcontainer"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/deletedItems/workflows

+```

+# [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": "Collection(microsoft.graph.deletedItemContainer)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/deletedItems/workflows",

+ "value": [

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "US Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T18:25:09.4212828Z",

+ "createdDateTime": "2022-08-24T18:24:14.4067873Z",

+ "deletedDateTime": "2022-08-24T18:25:09.5729865Z",

+ "id": "f1937e0c-c509-4250-ab51-d5e6e35fcbda",

+ "version": 1

+ },

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "EU Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T18:25:09.4050443Z",

+ "createdDateTime": "2022-08-24T18:24:40.0689833Z",

+ "deletedDateTime": "2022-08-24T18:25:09.5542954Z",

+ "id": "21d2c0fb-dcaa-4abb-88db-891d76c84e9a",

+ "version": 1

+ }

+ ]

+}

+```

+ Title: "List taskDefinitions"

+description: "Get a list of the taskDefinition objects and their properties."

+ms.localizationpriority: medium

+# List taskDefinitions

+Namespace: microsoft.graph.identityGovernance

+Get a list of the [taskDefinition](../resources/identitygovernance-taskdefinition.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/taskDefinitions

+```

+## Optional query parameters

+This method supports the `$select`, `$orderBy`, and `$filter` 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 [taskDefinition](../resources/identitygovernance-taskdefinition.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_taskdefinition"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskDefinitions

+```

+# [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,

+ "@odata.type": "Collection(microsoft.graph.identityGovernance.taskDefinition)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",

+ "@odata.count": 16,

+ "value": [

+ {

+ "category": "joiner,leaver",

+ "description": "Add user to selected groups",

+ "displayName": "Add User To Groups",

+ "id": "22085229-5809-45e8-97fd-270d28d66910",

+ "version": 1,

+ "parameters": [

+ {

+ "name": "groupID",

+ "values": [],

+ "valueType": "string"

+ }

+ ]

+ },

+ {

+ "category": "joiner,leaver",

+ "description": "Disable user account in the directory",

+ "displayName": "Disable User Account",

+ "id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "joiner,leaver",

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "id": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "joiner,leaver",

+ "description": "Remove user from membership of selected Azure AD groups",

+ "displayName": "Remove user from selected groups",

+ "id": "1953a66c-751c-45e5-8bfe-01462c70da3c",

+ "version": 1,

+ "parameters": [

+ {

+ "name": "groupID",

+ "values": [],

+ "valueType": "string"

+ }

+ ]

+ },

+ {

+ "category": "joiner",

+ "description": "Generate Temporary Access Pass and send via email to user's manager",

+ "displayName": "Generate TAP And Send Email",

+ "id": "1b555e50-7f65-41d5-b514-5894a026d10d",

+ "version": 1,

+ "parameters": [

+ {

+ "name": "tapLifetimeMinutes",

+ "values": [],

+ "valueType": "string"

+ },

+ {

+ "name": "tapIsUsableOnce",

+ "values": [

+ "true",

+ "false"

+ ],

+ "valueType": "enum"

+ }

+ ]

+ },

+ {

+ "category": "joiner",

+ "description": "Send welcome email to new hire",

+ "displayName": "Send Welcome Email",

+ "id": "70b29d51-b59a-4773-9280-8841dfd3f2ea",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "joiner,leaver",

+ "description": "Add user to selected teams",

+ "displayName": "Add User To Teams",

+ "id": "e440ed8d-25a1-4618-84ce-091ed5be5594",

+ "version": 1,

+ "parameters": [

+ {

+ "name": "teamID",

+ "values": [],

+ "valueType": "string"

+ }

+ ]

+ },

+ {

+ "category": "leaver",

+ "description": "Delete user account in Azure AD",

+ "displayName": "Delete User Account",

+ "id": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "joiner,leaver",

+ "description": "Remove user from membership of selected Teams",

+ "displayName": "Remove user from selected Teams",

+ "id": "06aa7acb-01af-4824-8899-b14e5ed788d6",

+ "version": 1,

+ "parameters": [

+ {

+ "name": "teamID",

+ "values": [],

+ "valueType": "string"

+ }

+ ]

+ },

+ {

+ "category": "leaver",

+ "description": "Remove user from all Azure AD groups memberships",

+ "displayName": "Remove user from all groups",

+ "id": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "leaver",

+ "description": "Remove user from all Teams memberships",

+ "displayName": "Remove user from all Teams",

+ "id": "81f7b200-2816-4b3b-8c5d-dc556f07b024",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "leaver",

+ "description": "Remove all licenses assigned to the user",

+ "displayName": "Remove all licenses for user",

+ "id": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "joiner,leaver",

+ "description": "Run a Custom Task Extension to callout to an external system.",

+ "displayName": "Run a Custom Task Extension",

+ "id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",

+ "version": 1,

+ "parameters": [

+ {

+ "name": "customTaskExtensionID",

+ "values": [],

+ "valueType": "string"

+ }

+ ]

+ },

+ {

+ "category": "leaver",

+ "description": "Send offboarding email to userΓÇÖs manager before the last day of work",

+ "displayName": "Send email before userΓÇÖs last day",

+ "id": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "leaver",

+ "description": "Send offboarding email to userΓÇÖs manager on the last day of work",

+ "displayName": "Send email on userΓÇÖs last day",

+ "id": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411",

+ "version": 1,

+ "parameters": []

+ },

+ {

+ "category": "leaver",

+ "description": "Send offboarding email to userΓÇÖs manager after the last day of work",

+ "displayName": "Send email after userΓÇÖs last day",

+ "id": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce",

+ "version": 1,

+ "parameters": []

+ }

+ ]

+}

+```

+ Title: "List workflows (lifecycle workflows)"

+description: "Get a list of the workflow objects and their properties."

+ms.localizationpriority: medium

+# List workflows (lifecycle workflows)

+Namespace: microsoft.graph.identityGovernance

+Get the workflow resources from the workflows navigation property.

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows

+```

+## Optional query parameters

+This method supports the `$search`, `$select`, `$orderBy`, and `$filter` 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 [workflow](../resources/identitygovernance-workflow.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_workflow"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows

+```

+# [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,

+ "@odata.type": "Collection(microsoft.graph.identityGovernance.workflow)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows",

+ "value": [

+ {

+ "category": "joiner",

+ "description": "Configure pre-hire tasks for onboarding employees before their first day",

+ "displayName": "Global pre hire",

+ "lastModifiedDateTime": "2022-08-16T20:05:51.4618603Z",

+ "createdDateTime": "2022-01-10T20:04:30.619368Z",

+ "id": "c007a148-5bf1-4f38-82b4-377fb23b1711",

+ "isEnabled": true,

+ "isSchedulingEnabled": true,

+ "version": 12

+ },

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Global new hire",

+ "lastModifiedDateTime": "2022-08-18T17:24:42.6051254Z",

+ "createdDateTime": "2022-05-06T14:10:39.9700268Z",

+ "id": "559d8339-ab4e-4c41-a517-ed5d8dd9fbf5",

+ "isEnabled": true,

+ "isSchedulingEnabled": true,

+ "version": 5

+ },

+ {

+ "category": "joiner",

+ "description": "Configure pre-hire tasks for onboarding employees before their first day",

+ "displayName": "Onboard pre-hire employee",

+ "lastModifiedDateTime": "2022-08-16T20:01:28.3589067Z",

+ "createdDateTime": "2022-08-16T17:48:55.2262907Z",

+ "id": "d0454160-b8e9-432f-8a85-790021e64c9e",

+ "isEnabled": false,

+ "isSchedulingEnabled": false,

+ "version": 1

+ },

+ {

+ "category": "leaver",

+ "description": "Configure offboarding tasks for employees after their last day of work",

+ "displayName": "Post-Offboarding of an employee",

+ "lastModifiedDateTime": "2022-08-17T18:57:30.5091553Z",

+ "createdDateTime": "2022-08-17T18:57:07.1840042Z",

+ "id": "15f9c6db-ada8-4417-927f-17ac24b54b9b",

+ "isEnabled": true,

+ "isSchedulingEnabled": false,

+ "version": 1

+ },

+ {

+ "category": "leaver",

+ "description": "Execute real-time termination tasks for employees on their last day of work",

+ "displayName": "Real-time employee termination",

+ "lastModifiedDateTime": "2022-08-19T20:34:15.4212506Z",

+ "createdDateTime": "2022-08-19T20:34:15.4212481Z",

+ "id": "57bc6612-2c20-4141-9dab-aa11a95b8fbc",

+ "isEnabled": true,

+ "isSchedulingEnabled": false,

+ "version": 1

+ },

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T15:39:17.6496744Z",

+ "createdDateTime": "2022-08-24T15:39:17.6496704Z",

+ "id": "156ce798-1eb6-4e0a-8515-e79f54d04390",

+ "isEnabled": true,

+ "isSchedulingEnabled": false,

+ "version": 1

+ }

+ ]

+}

+```

+ Title: "List workflowTemplates"

+description: "Get a list of the workflowTemplate objects and their properties."

+ms.localizationpriority: medium

+# List workflowTemplates

+Namespace: microsoft.graph.identityGovernance

+Get a list of the [workflowTemplate](../resources/identitygovernance-workflowtemplate.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflowTemplates

+```

+## Optional query parameters

+This method supports the `$select`, `$orderby`, and `$filter` 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 [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_workflowtemplate"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflowTemplates

+```

+# [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,

+ "@odata.type": "Collection(microsoft.graph.identityGovernance.workflowTemplate)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates",

+ "value": [

+ {

+ "category": "joiner",

+ "description": "Configure pre-hire tasks for onboarding employees before their first day",

+ "displayName": "Onboard pre-hire employee",

+ "id": "77179007-8114-41b5-922e-2e22109df41f",

+ "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": -7

+ }

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('77179007-8114-41b5-922e-2e22109df41f')/tasks",

+ "tasks": [

+ {

+ "category": "joiner",

+ "continueOnError": false,

+ "description": "Generate Temporary Access Pass and send via email to user's manager",

+ "displayName": "Generate TAP And Send Email",

+ "executionSequence": 1,

+ "id": "3e062c24-d219-483d-9258-288f2a039b94",

+ "isEnabled": true,

+ "taskDefinitionId": "1b555e50-7f65-41d5-b514-5894a026d10d",

+ "arguments": [

+ {

+ "name": "tapLifetimeMinutes",

+ "value": "480"

+ },

+ {

+ "name": "tapIsUsableOnce",

+ "value": "true"

+ }

+ ]

+ }

+ ]

+ },

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Onboard new hire employee",

+ "id": "4e06785d-7c1d-4b24-b9e1-bba2b890c58b",

+ "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": 0

+ }

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('4e06785d-7c1d-4b24-b9e1-bba2b890c58b')/tasks",

+ "tasks": [

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "e18f3208-311c-46a3-a27b-d9c15cd595bc",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ },

+ {

+ "category": "joiner",

+ "continueOnError": false,

+ "description": "Send welcome email to new hire",

+ "displayName": "Send Welcome Email",

+ "executionSequence": 2,

+ "id": "e9551045-4302-499f-9108-60b9e23c067a",

+ "isEnabled": true,

+ "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",

+ "arguments": []

+ },

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Add user to selected groups",

+ "displayName": "Add User To Groups",

+ "executionSequence": 3,

+ "id": "560acd0c-321e-4e7e-9f31-ff8899c55878",

+ "isEnabled": true,

+ "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",

+ "arguments": [

+ {

+ "name": "groupID",

+ "value": ""

+ }

+ ]

+ }

+ ]

+ },

+ {

+ "category": "leaver",

+ "description": "Execute real-time termination tasks for employees on their last day of work",

+ "displayName": "Real-time employee termination",

+ "id": "145735f1-57cc-48c2-81ec-727f07a10096",

+ "executionConditions": {

+ "@odata.type": "#microsoft.graph.identityGovernance.onDemandExecutionOnly"

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('145735f1-57cc-48c2-81ec-727f07a10096')/tasks",

+ "tasks": [

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Remove user from all Azure AD groups memberships",

+ "displayName": "Remove user from all groups",

+ "executionSequence": 1,

+ "id": "1b89bb69-a8cf-416b-a69e-4f6d8108834c",

+ "isEnabled": true,

+ "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",

+ "arguments": []

+ },

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Remove user from all Teams memberships",

+ "displayName": "Remove user from all Teams",

+ "executionSequence": 2,

+ "id": "d3cea676-ccce-4426-825c-63c63e9a64c7",

+ "isEnabled": true,

+ "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024",

+ "arguments": []

+ },

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Delete user account in Azure AD",

+ "displayName": "Delete User Account",

+ "executionSequence": 3,

+ "id": "adbd4f05-99f0-4260-a155-7657623ca071",

+ "isEnabled": true,

+ "taskDefinitionId": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",

+ "arguments": []

+ }

+ ]

+ },

+ {

+ "category": "leaver",

+ "description": "Configure pre-offboarding tasks for employees before their last day of work",

+ "displayName": "Pre-Offboarding of an employee",

+ "id": "25abd83d-3b5d-4d6f-bb9a-4ed366fd96b1",

+ "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": "employeeLeaveDateTime",

+ "offsetInDays": -7

+ }

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('25abd83d-3b5d-4d6f-bb9a-4ed366fd96b1')/tasks",

+ "tasks": [

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Remove user from membership of selected Azure AD groups",

+ "displayName": "Remove user from selected groups",

+ "executionSequence": 1,

+ "id": "7e9aac8a-d239-4867-be60-b3c999c50ee7",

+ "isEnabled": true,

+ "taskDefinitionId": "1953a66c-751c-45e5-8bfe-01462c70da3c",

+ "arguments": [

+ {

+ "name": "groupID",

+ "value": ""

+ }

+ ]

+ },

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Remove user from membership of selected Teams",

+ "displayName": "Remove user from selected Teams",

+ "executionSequence": 2,

+ "id": "40eab675-1aaf-432d-b17e-053d93b0fe2e",

+ "isEnabled": true,

+ "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6",

+ "arguments": [

+ {

+ "name": "teamID",

+ "value": ""

+ }

+ ]

+ }

+ ]

+ },

+ {

+ "category": "leaver",

+ "description": "Configure offboarding tasks for employees on their last day of work",

+ "displayName": "Offboard an employee",

+ "id": "e821c59e-d28c-44d7-902f-5fed05e926f1",

+ "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": "employeeLeaveDateTime",

+ "offsetInDays": 0

+ }

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('e821c59e-d28c-44d7-902f-5fed05e926f1')/tasks",

+ "tasks": [

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Disable user account in the directory",

+ "displayName": "Disable User Account",

+ "executionSequence": 1,

+ "id": "8d9eab35-6c32-4b76-acbd-6a22cb07aa6a",

+ "isEnabled": true,

+ "taskDefinitionId": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",

+ "arguments": []

+ },

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Remove user from all Azure AD groups memberships",

+ "displayName": "Remove user from all groups",

+ "executionSequence": 2,

+ "id": "4f5d8835-5d38-4106-ac7e-ebc407749bd2",

+ "isEnabled": true,

+ "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",

+ "arguments": []

+ },

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Remove user from all Teams memberships",

+ "displayName": "Remove user from all Teams",

+ "executionSequence": 3,

+ "id": "8087b303-e7d5-492d-ab75-31d4aa34bd73",

+ "isEnabled": true,

+ "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024",

+ "arguments": []

+ }

+ ]

+ },

+ {

+ "category": "leaver",

+ "description": "Configure offboarding tasks for employees after their last day of work",

+ "displayName": "Post-Offboarding of an employee",

+ "id": "50149a4a-7c2d-4fd8-8018-761f4eb915cb",

+ "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": "employeeLeaveDateTime",

+ "offsetInDays": 7

+ }

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('50149a4a-7c2d-4fd8-8018-761f4eb915cb')/tasks",

+ "tasks": [

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Remove all licenses assigned to the user",

+ "displayName": "Remove all licenses for user",

+ "executionSequence": 1,

+ "id": "760ab754-8249-4bce-9315-1ad06488e434",

+ "isEnabled": true,

+ "taskDefinitionId": "8fa97d28-3e52-4985-b3a9-a1126f9b8b4e",

+ "arguments": []

+ },

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Remove user from all Teams memberships",

+ "displayName": "Remove user from all Teams",

+ "executionSequence": 2,

+ "id": "17b4e37b-c50b-4e04-a11c-93479f487d1d",

+ "isEnabled": true,

+ "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024",

+ "arguments": []

+ },

+ {

+ "category": "leaver",

+ "continueOnError": false,

+ "description": "Delete user account in Azure AD",

+ "displayName": "Delete User Account",

+ "executionSequence": 3,

+ "id": "46849618-30e7-4b67-abf0-f8c7f0d54b95",

+ "isEnabled": true,

+ "taskDefinitionId": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff",

+ "arguments": []

+ }

+ ]

+ }

+ ]

+}

+```

+ Title: "Create Custom Task Extension"

+description: "Create a new customTaskExtension object."

+ms.localizationpriority: medium

+# Create customTaskExtensions

+Namespace: microsoft.graph.identityGovernance

+Create a new [customTaskExtension](../resources/identitygovernance-customtaskextension.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)|LifecycleWorkflows.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported|

+|Application|Not supported|

+> [!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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /identityGovernance/lifecycleWorkflows/customTaskExtensions

+```

+## 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 [customTaskExtension](../resources/identitygovernance-customtaskextension.md) object.

+You can specify the following properties when creating a **customTaskExtension**.

+|Property|Type|Description|

+|:|:|:|

+|authenticationConfiguration|[microsoft.graph.customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for the `customTaskExtension`.|

+|clientConfiguration|[microsoft.graph.customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|The client configuration for a custom extension.|

+|description|String|The description of the `customTaskExtension`.|

+|displayName|String|The display name of the `customTaskExtension`.|

+|endpointConfiguration|[microsoft.graph.customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The endpoint configuration for a custom extension. Optional.|

+|callbackConfiguration|[microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration](../resources/identitygovernance-customtaskextensioncallbackconfiguration.md)|The callback configuration for a custom extension. Optional.|

+## Response

+If successful, this method returns a `201 Created` response code and a [customTaskExtension](../resources/identitygovernance-customtaskextension.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_create_customtaskextension_from_"

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/customTaskExtensions

+Content-Type: application/json

+Content-length: 588

+{

+ "displayName": "Grant manager access to mailbox and OneDrive",

+ "description": "Grant manager access to mailbox and OneDrive",

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",

+ "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",

+ "resourceGroupName": "RG-LCM",

+ "logicAppWorkflowName": "ManagerAccess"

+ },

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",

+ "resourceId": "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"

+ },

+ "clientConfiguration": {

+ "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",

+ "maximumRetries": 1,

+ "timeoutInMilliseconds": 1000

+ },

+ "callbackConfiguration": {

+ "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",

+ "timeoutDuration": "PT5M"

+ }

+}

+```

+# [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.identityGovernance.customTaskExtension"

+}

+-->

+``` http

+HTTP/1.1 201 Created

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/customTaskExtensions/$entity",

+ "id": "ee2590e4-4572-4820-a397-969ecd7bd6a9",

+ "displayName": "Grant manager access to mailbox and OneDrive",

+ "description": "Grant manager access to mailbox and OneDrive",

+ "createdDateTime": "2022-08-24T22:37:46.1790566Z",

+ "lastModifiedDateTime": "2022-08-24T22:37:46.179062Z",

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",

+ "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",

+ "resourceGroupName": "RG-LCM",

+ "logicAppWorkflowName": "ManagerAccess"

+ },

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",

+ "resourceId": "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"

+ },

+ "clientConfiguration": {

+ "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",

+ "maximumRetries": 1,

+ "timeoutInMilliseconds": 1000

+ },

+ "callbackConfiguration": {

+ "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",

+ "timeoutDuration": "PT5M"

+ }

+}

+```

+ Title: "Create workflow (lifecycle workflow)"

+description: "Create a new workflow object."

+ms.localizationpriority: medium

+# Create workflow (lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Create a new [workflow](../resources/identitygovernance-workflow.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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /identityGovernance/lifecycleWorkflows/workflows

+```

+## 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 [workflow](../resources/identitygovernance-workflow.md) object.

+You can specify the following properties when creating a **workflow**.

+|Property|Type|Description|

+|:|:|:|

+|category|[microsoft.graph.identityGovernance.lifecycleWorkflowCategory](../resources/identitygovernance-workflow.md)|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. Can be only one value.|

+|description|String|A string that describes the purpose of the workflow for administrative use.|

+|displayName|String|A unique string that identifies the workflow. |

+|executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines for who and when a workflow will run. |

+|id|String|Identifier used for individually addressing a specific workflow.|

+|isEnabled|Boolean|A Boolean value that denotes whether the workflow is set to run or not.|

+|isSchedulingEnabled|Boolean|A Boolean value that denotes whether scheduling is enabled or not. |

+|tasks|[microsoft.graph.identityGovernance.task](../resources/identitygovernance-task.md) collection| Represents the configured tasks to execute and their execution sequence within the workflow. Required. |

+## Response

+If successful, this method returns a `201 Created` response code and a [workflow](../resources/identitygovernance-workflow.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_create_workflow_from_"

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows

+Content-Type: application/json

+Content-length: 454

+{

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Australia Onboard new hire employee",

+ "isEnabled": true,

+ "isSchedulingEnabled": false,

+ "executionConditions": {

+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",

+ "scope": {

+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",

+ "rule": "(country eq 'Australia')"

+ },

+ "trigger": {

+ "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",

+ "timeBasedAttribute": "employeeHireDate",

+ "offsetInDays": 0

+ }

+ },

+ "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": []

+ }

+ ]

+}

+```

+# [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.identityGovernance.workflow"

+}

+-->

+``` http

+HTTP/1.1 201 Created

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows/$entity",

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "New Zealand new hire",

+ "lastModifiedDateTime": "2022-08-26T04:51:27.521792Z",

+ "createdDateTime": "2022-08-26T04:51:27.5217824Z",

+ "deletedDateTime": null,

+ "id": "818cd47f-138c-4a83-b3f5-afa92bfcf391",

+ "isEnabled": true,

+ "isSchedulingEnabled": false,

+ "nextScheduleRunDateTime": null,

+ "version": 1,

+ "executionConditions": {

+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",

+ "scope": {

+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",

+ "rule": "(country eq 'New Zealand')"

+ },

+ "trigger": {

+ "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",

+ "timeBasedAttribute": "employeeHireDate",

+ "offsetInDays": 0

+ }

+ }

+}

+```

+ Title: "Get run (for a lifecycle workflow)"

+description: "Read the properties and relationships of a run object."

+ms.localizationpriority: medium

+# Get run (for a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Read the properties and relationships of a [run](../resources/identitygovernance-run.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/{runId}

+```

+## 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 a [run](../resources/identitygovernance-run.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_workflow_run"

+}

+-->

+``` http

+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)

+# [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.identityGovernance.run"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/runs/$entity",

+ "id": "dad77a47-6eda-4de7-bc37-fe8eb5aaf17d",

+ "completedDateTime": "2022-08-24T23:28:11.1348863Z",

+ "failedTasksCount": 0,

+ "failedUsersCount": 0,

+ "lastUpdatedDateTime": "2022-08-24T23:33:09.186588Z",

+ "processingStatus": "completed",

+ "scheduledDateTime": "2022-08-24T23:28:01.6476554Z",

+ "startedDateTime": "2022-08-24T23:28:04.5688752Z",

+ "successfulUsersCount": 2,

+ "totalTasksCount": 4,

+ "totalUsersCount": 2,

+ "totalUnprocessedTasksCount": 0,

+ "workflowExecutionType": "onDemand"

+}

+```

+ Title: "List taskProcessingResults (for a userProcessingResult in a run)"

+description: "Get the taskProcessingResult resources for a userProcessingResult from a run."

+ms.localizationpriority: medium

+# List taskProcessingResults (for a userProcessingResult in a run)

+Namespace: microsoft.graph.identityGovernance

+Get the taskProcessingResult resources for a [userProcessingResult](../resources/identitygovernance-userprocessingresult.md) from a [run](../resources/identitygovernance-run.md).

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/{runId}/userProcessingResults/{userProcessingResultId}/taskProcessingResults

+```

+## Optional query parameters

+This method supports the `$select`, `$orderby`, `$expand`, and `$filter` 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 [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_run_taskprocessingresult"

+}

+-->

+``` http

+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)

+# [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": "Collection(microsoft.graph.identityGovernance.taskProcessingResult)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/runs('dad77a47-6eda-4de7-bc37-fe8eb5aaf17d')/userProcessingResults('78b83505-6967-4168-a7ea-4921c0543ce9')/taskProcessingResults",

+ "value": [

+ {

+ "completedDateTime": "2022-08-24T23:28:05.3529197Z",

+ "createdDateTime": "2022-08-24T23:28:04.5490995Z",

+ "id": "05a96d7a-0e00-459c-b6c8-1870099e8275",

+ "processingStatus": "completed",

+ "startedDateTime": "2022-08-24T23:28:05.1234966Z",

+ "failureReason": null,

+ "subject": {

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ },

+ "task": {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "917e9eab-415d-4e45-b39d-87eb5e30de38",

+ "isEnabled": false,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ }

+ },

+ {

+ "completedDateTime": "2022-08-24T23:28:06.760333Z",

+ "createdDateTime": "2022-08-24T23:28:04.5571759Z",

+ "id": "e30b12e1-45fa-4463-8d54-48f43fd8942a",

+ "processingStatus": "completed",

+ "startedDateTime": "2022-08-24T23:28:06.3926865Z",

+ "failureReason": null,

+ "subject": {

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ },

+ "task": {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Add user to selected groups",

+ "displayName": "Add User To Groups",

+ "executionSequence": 2,

+ "id": "eedd8043-90a1-4e3c-9112-b2a8917ea3ae",

+ "isEnabled": true,

+ "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",

+ "arguments": [

+ {

+ "name": "groupID",

+ "value": "e5659cb0-bcbb-4a9f-9092-90f72bd19028"

+ }

+ ]

+ }

+ }

+ ]

+}

+```

+ Title: "List userProcessingResults (for a run of a lifecycle workflow)"

+description: "List user processing results of a workflow run."

+ms.localizationpriority: medium

+# List userProcessingResults (for a run of a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get user processing results of a workflow [run](../resources/identitygovernance-run.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/{runId}/userProcessingResults/

+```

+## Optional query parameters

+This method supports the `$select`, `$orderBy`, `$expand`, and `$filter` 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 [userProcessingResults](../resources/identitygovernance-userprocessingresult.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_run_taskprocessingresult"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.run"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/runs('dad77a47-6eda-4de7-bc37-fe8eb5aaf17d')/userProcessingResults",

+ "value": [

+ {

+ "id": "78b83505-6967-4168-a7ea-4921c0543ce9",

+ "completedDateTime": "2022-08-24T23:28:11.1348863Z",

+ "failedTasksCount": 0,

+ "processingStatus": "completed",

+ "scheduledDateTime": "2022-08-24T23:28:01.6476554Z",

+ "startedDateTime": "2022-08-24T23:28:04.490313Z",

+ "totalTasksCount": 2,

+ "totalUnprocessedTasksCount": 0,

+ "workflowExecutionType": "onDemand",

+ "workflowVersion": 1,

+ "subject": {

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ }

+ },

+ {

+ "id": "16db611b-2518-48cf-89c0-3763abf8d0ab",

+ "completedDateTime": "2022-08-24T23:28:11.1100134Z",

+ "failedTasksCount": 0,

+ "processingStatus": "completed",

+ "scheduledDateTime": "2022-08-24T23:28:01.6476554Z",

+ "startedDateTime": "2022-08-24T23:28:04.5469497Z",

+ "totalTasksCount": 2,

+ "totalUnprocessedTasksCount": 0,

+ "workflowExecutionType": "onDemand",

+ "workflowVersion": 1,

+ "subject": {

+ "id": "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"

+ }

+ }

+ ]

+}

+```

+ Title: "run: summary (of a lifecycle workflow)"

+description: "A summary of runs for a specified time period. Since the amount of runs returned by the List API call can be overwhelming, this summary allows the administrator to get a quick overview based on counts."

+ms.localizationpriority: medium

+# run: summary (of a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+A summary of runs for a specified time period. Since the amount of runs returned by the List API call can be overwhelming, this summary allows the administrator to get a quick overview based on counts.

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/summary(startDateTime={timestamp},endDateTime={timestamp})

+```

+## Function parameters

+In the request URL, provide the following query parameters with values.

+The following table shows the parameters that are required with this function.

+|Parameter|Type|Description|

+|:|:|:|

+|startDateTime|DateTimeOffset|The start date and time of the workflow run|

+|endDateTime|DateTimeOffset|The end date and time of the workflow run|

+## 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 [runSummary](../resources/identitygovernance-runsummary.md) in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_runthis.summary"

+}

+-->

+``` http

+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)

+# [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.identityGovernance.runSummary"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.identityGovernance.runSummary",

+ "failedRuns": 0,

+ "failedTasks": 0,

+ "successfulRuns": 1,

+ "totalRuns": 2,

+ "totalTasks": 4,

+ "totalUsers": 2

+}

+```

+ Title: "Get task (in a lifecycle workflow)"

+description: "Read the properties of a task object in a lifecycle workflow."

+ms.localizationpriority: medium

+# Get task (in a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get a task specific from a [workflow](../resources/identitygovernance-workflow.md) or [workflowVersion](../resources/identitygovernance-workflowversion.md).

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+Fetch tasks for a lifecycle workflow.

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflow/{workflowId}/tasks/{taskId}

+```

+Fetch tasks for a lifecycle workflow version.

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/2/tasks/4d9d41d7-a8e1-4f2f-8c8c-a883bc02e6ee

+```

+## Optional query parameters

+This method does not support 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 [task](../resources/identitygovernance-task.md) object in the response body.

+## Examples

+### Example 1: Get a task from a workflow

+#### Request

+The following is an example of a request to get a task from a workflow.

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_workflow_task"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflow/156ce798-1eb6-4e0a-8515-e79f54d04390/tasks/fafa2189-cd62-4643-a825-06cab8817086

+```

+#### Response

+The following is an example of the response of a request to get a task from a workflow.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.task"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/tasks/$entity",

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "fafa2189-cd62-4643-a825-06cab8817086",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+}

+```

+### Example 2: Get a task from a workflow version

+#### Request

+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"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/2/tasks/4d9d41d7-a8e1-4f2f-8c8c-a883bc02e6ee

+```

+# [C#](#tab/csharp)

+# [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.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.task"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/versions(1)/tasks/$entity",

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Add user to selected groups",

+ "displayName": "Add User To Groups",

+ "executionSequence": 2,

+ "id": "eedd8043-90a1-4e3c-9112-b2a8917ea3ae",

+ "isEnabled": true,

+ "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",

+ "arguments": [

+ {

+ "name": "groupID",

+ "value": "e5659cb0-bcbb-4a9f-9092-90f72bd19028"

+ }

+ ]

+}

+```

+ Title: "Get taskDefinition"

+description: "Read the properties and relationships of a taskDefinition object."

+ms.localizationpriority: medium

+# Get taskDefinition

+Namespace: microsoft.graph.identityGovernance

+Read the properties and relationships of a [taskDefinition](../resources/identitygovernance-taskdefinition.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/taskDefinitions/{taskDefinitionId}

+```

+## 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 a [taskDefinition](../resources/identitygovernance-taskdefinition.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_taskdefinition"

+}

+-->

+``` http

+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)

+# [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.identityGovernance.taskDefinition"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions/$entity",

+ "category": "joiner,leaver",

+ "description": "Disable user account in the directory",

+ "displayName": "Disable User Account",

+ "id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950",

+ "version": 1,

+ "parameters": []

+}

+```

+ Title: "taskProcessingResult: resume"

+description: "An Azure Logic Apps system-assigned managed identity calls this API to resume the task processing result that's in progress."

+ms.localizationpriority: medium

+# taskProcessingResult: resume

+Namespace: microsoft.graph.identityGovernance

+Resume a task processing result that's `inProgress`. An Azure Logic Apps system-assigned managed identity calls this API.

+## 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)|Not supported.|

+|Application|Not Supported.|

+> [!IMPORTANT]

+> Only the Azure Logic Apps system-assigned managed identity that's specified in the [custom task extension authentication Configuration](../resources/identitygovernance-customtaskextension.md) can call this API. The authorized resource doesn't require any Microsoft Graph permissions.

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/tasks/{taskId}/taskProcessingResults/{taskProcessingResultsId}/resume

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+In the request body, supply a [custom extension callout response](../resources/customextensioncalloutresponse.md).

+The following table shows the parameters that can be used with this action.

+|Parameter|Type|Description|

+|:|:|:|

+|source|String|The source of the `taskProcessingResult`.|

+|type|String|The type of the `taskProcessingResult`.|

+|data|[microsoft.graph.identityGovernance.customTaskExtensionCallbackData](../resources/identitygovernance-customtaskextensioncallbackdata.md)|The customtaskextensionCallbackData of the taskProcessingResult. The logic app returns an operation status of whether or not it successfully ran. The taskprocessingresult resumes based on how the task was designed in the workflow. |

+## Response

+If successful, this action returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_taskprocessingresultthis.resume"

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta//identityGovernance/lifecycleWorkflows/workflows/4f36da05-5df8-457d-adb3-b132e7b59571/tasks/e07dcdb2-0a77-4ee3-8645-3801fbe1cf9f/taskProcessingResults/6e1ec336-8d06-4386-a377-79dbab1a2eb6/resume

+Content-Type: application/json

+Content-length: 155

+{

+ "data": {

+ "operationStatus": "Completed"

+ },

+ "source": "sample",

+ "type": "lifecycleEvent"

+}

+```

+# [C#](#tab/csharp)

+# [JavaScript](#tab/javascript)

+# [Java](#tab/java)

+### Response

+The following is an example of the response.

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "List taskProcessingResult (for a taskReport)"

+description: "Get a list of taskProcessingResult objects and their properties for a taskReport."

+ms.localizationpriority: medium

+# List taskProcessingResult (for a taskReport)

+Namespace: microsoft.graph.identityGovernance

+Get the task processing result resources from the [taskReport](../resources/identitygovernance-taskreport.md).

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/{taskReportId}/taskProcessingResults

+```

+## Optional query parameters

+This method supports the `$select`, `$orderby`, `$expand`, and `$filter` 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 [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_taskreport_taskprocessingresult"

+}

+-->

+``` http

+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)

+# [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": "Collection(microsoft.graph.identityGovernance.taskProcessingResult)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/taskReports('3a3bea11-99ca-462d-86fb-d283db8d734a')/taskProcessingResults",

+ "value": [

+ {

+ "completedDateTime": "2022-08-24T23:28:05.3529197Z",

+ "createdDateTime": "2022-08-24T23:28:04.5490995Z",

+ "id": "05a96d7a-0e00-459c-b6c8-1870099e8275",

+ "processingStatus": "completed",

+ "startedDateTime": "2022-08-24T23:28:05.1234966Z",

+ "failureReason": null,

+ "subject": {

+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ },

+ "task": {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "917e9eab-415d-4e45-b39d-87eb5e30de38",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ }

+ },

+ {

+ "completedDateTime": "2022-08-24T23:28:05.3665043Z",

+ "createdDateTime": "2022-08-24T23:28:04.6062005Z",

+ "id": "bf3cf897-d08d-41fe-b874-bbaca883f2d4",

+ "processingStatus": "completed",

+ "startedDateTime": "2022-08-24T23:28:05.1438145Z",

+ "failureReason": null,

+ "subject": {

+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",

+ "id": "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"

+ },

+ "task": {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "917e9eab-415d-4e45-b39d-87eb5e30de38",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ }

+ }

+ ]

+}

+```

+ Title: "taskReport: summary (of a lifecycle workflow)"

+description: "A summary of task processing results for a specified time period. Since the amount of task processing results and task reports returned by the List API calls can be overwhelming, this summary allows the administrator to get a quick overview based on counts."

+ms.localizationpriority: medium

+# taskReport: summary (of a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get a [taskReportSummary](../resources/identitygovernance-taskreportsummary.md) object.

+This API provides a summary of task processing results for a specified time period. Because the volume of task processing results and task reports returned by the List API calls can be overwhelming, this summary allows the administrator to get a quick overview based on counts.

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/summary(startDateTime={timestamp},endDateTime={timestamp})

+```

+## Function parameters

+In the request URL, provide the following query parameters with values.

+|Parameter|Type|Description|

+|:|:|:|

+|startDateTime|DateTimeOffset|The start date and time of the period for which the **taskReport** summary will be generated.|

+|endDateTime|DateTimeOffset|The end date and time of the period for which the **taskReport** summary will be generated.|

+## Optional query parameters

+This method supports the `$count`, `$orderBy`, `$expand`, and `$filter` 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 [taskReportSummary](../resources/identitygovernance-taskreportsummary.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_taskreport.summary"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.taskReport"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.identityGovernance.taskReportSummary",

+ "successfulTasks": 8,

+ "failedTasks": 0,

+ "unprocessedTasks": 0,

+ "totalTasks": 8

+}

+```

+ Title: "Get userProcessingResult (for a run of a lifecycle workflow)"

+description: "Read the properties of a userProcessingResult for a run of a lifecycle workflow."

+ms.localizationpriority: medium

+# Get userProcessingResult (for a run of a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get the user processing result of a [run](../resources/identitygovernance-run.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{{workflow_id}}/runs/{runId}/userProcessingResults/{userProcessingResultId}

+```

+## 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 a [userProcessingResult](../resources/identitygovernance-userprocessingresult.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_run_userprocessingresult"

+}

+-->

+``` http

+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)

+# [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.identityGovernance.run"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/runs('dad77a47-6eda-4de7-bc37-fe8eb5aaf17d')/userProcessingResults/$entity",

+ "id": "78b83505-6967-4168-a7ea-4921c0543ce9",

+ "completedDateTime": "2022-08-24T23:28:11.1348863Z",

+ "failedTasksCount": 0,

+ "processingStatus": "completed",

+ "scheduledDateTime": "2022-08-24T23:28:01.6476554Z",

+ "startedDateTime": "2022-08-24T23:28:04.490313Z",

+ "totalTasksCount": 2,

+ "totalUnprocessedTasksCount": 0,

+ "workflowExecutionType": "onDemand",

+ "workflowVersion": 1,

+ "subject": {

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ }

+}

+```

+ Title: "List taskProcessingResults (for a userProcessingResult)"

+description: "Get the taskProcessingResult resources from the taskProcessingResults object."

+ms.localizationpriority: medium

+# List taskProcessingResults (for a userProcessingResult)

+Namespace: microsoft.graph.identityGovernance

+Get the task processing result from a [userProcessingResult](../resources/identitygovernance-userprocessingresult.md).

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/userProcessingResults/{userProcessingResultId}/taskProcessingResults

+```

+## Optional query parameters

+This method supports the `$select`, `$orderby`, `$expand`, and `$filter` 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 [taskProcessingResult](../resources/identitygovernance-taskprocessingresult.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_workflow_userprocessingresult_taskprocessingresult"

+}

+-->

+``` http

+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)

+# [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": "Collection(microsoft.graph.identityGovernance.taskProcessingResult)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/userProcessingResults('78b83505-6967-4168-a7ea-4921c0543ce9')/taskProcessingResults",

+ "value": [

+ {

+ "completedDateTime": "2022-08-24T23:28:05.3529197Z",

+ "createdDateTime": "2022-08-24T23:28:04.5490995Z",

+ "id": "05a96d7a-0e00-459c-b6c8-1870099e8275",

+ "processingStatus": "completed",

+ "startedDateTime": "2022-08-24T23:28:05.1234966Z",

+ "failureReason": null,

+ "subject": {

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ },

+ "task": {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "917e9eab-415d-4e45-b39d-87eb5e30de38",

+ "isEnabled": false,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ }

+ },

+ {

+ "completedDateTime": "2022-08-24T23:28:06.760333Z",

+ "createdDateTime": "2022-08-24T23:28:04.5571759Z",

+ "id": "e30b12e1-45fa-4463-8d54-48f43fd8942a",

+ "processingStatus": "completed",

+ "startedDateTime": "2022-08-24T23:28:06.3926865Z",

+ "failureReason": null,

+ "subject": {

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ },

+ "task": {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Add user to selected groups",

+ "displayName": "Add User To Groups",

+ "executionSequence": 2,

+ "id": "eedd8043-90a1-4e3c-9112-b2a8917ea3ae",

+ "isEnabled": true,

+ "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",

+ "arguments": [

+ {

+ "name": "groupID",

+ "value": "e5659cb0-bcbb-4a9f-9092-90f72bd19028"

+ }

+ ]

+ }

+ }

+ ]

+}

+```

+ Title: "userProcessingResult: summary"

+description: "The summary of userProcessingResult for a lifecycle workflow."

+ms.localizationpriority: medium

+# userProcessingResult: summary

+Namespace: microsoft.graph.identityGovernance

+Provide a summary of user processing results for a specified time period. Because the amount of user processing results returned by the List API call can be overwhelming, this summary allows the administrator to get a quick overview based on counts.

+## 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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/userProcessingResults/summary(startDateTime={TimeStamp},endDateTime={TimeStamp})

+```

+## Function parameters

+In the request URL, provide the following query parameters with values.

+|Parameter|Type|Description|

+|:|:|:|

+|startDateTime|DateTimeOffset|The start date and time of the user processing result summary.|

+|endDateTime|DateTimeOffset|The end date and time of the user processing result summary|

+## 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 [userSummary](../resources/identitygovernance-usersummary.md) in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_userprocessingresultthis.summary"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.usersProcessingSummary"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.identityGovernance.userSummary",

+ "failedTasks": 0,

+ "failedUsers": 0,

+ "successfulUsers": 2,

+ "totalTasks": 4,

+ "totalUsers": 2

+}

+```

+ Title: "workflow: activate (run a workflow on-demand)"

+description: "Run a workflow on-demand for time critical execution and testing."

+ms.localizationpriority: medium

+# workflow: activate (run a workflow on-demand)

+Namespace: microsoft.graph.identityGovernance

+Activate (run on-demand) a [workflow](../resources/identitygovernance-workflow.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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/activate

+```

+## 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 are required with this action.

+|Parameter|Type|Description|

+|:|:|:|

+|subjects|[microsoft.graph.user](../resources/user.md) collection|The subjects for whom the workflow is activated.|

+## Response

+If successful, this action returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_workflowthis.activate"

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/activate

+Content-Type: application/json

+{

+ "subjects": [

+ { "id": "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"},

+ { "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"}

+ ]

+}

+```

+# [C#](#tab/csharp)

+# [JavaScript](#tab/javascript)

+# [Java](#tab/java)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "workflow: createNewVersion"

+description: "Create a new version of a lifecycle workflow object."

+ms.localizationpriority: medium

+# workflow: createNewVersion

+Namespace: microsoft.graph.identityGovernance

+Create a new version of the [workflow](../resources/identitygovernance-workflow.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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion

+```

+## 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|

+|:|:|:|

+|workflow|[microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md)|The workflow for which you want to create a new version.|

+## Response

+If successful, this action returns a `200 OK` response code and a [workflow](../resources/identitygovernance-workflow.md) in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_workflowthis.createnewversion"

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion

+Content-Type: application/json

+Content-length: 631

+{

+ "workflow":{

+ "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": []

+ }

+ ]

+ }

+}

+```

+# [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.identityGovernance.workflow"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "workflow":{

+ "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": []

+ }

+ ]

+ }

+}

+```

+ Title: "Delete workflow (lifecycle workflow)"

+description: "Deletes a workflow object."

+ms.localizationpriority: medium

+# Delete workflow (lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Delete a [workflow](../resources/identitygovernance-workflow.md) object and its associated [tasks](../resources/identitygovernance-task.md), [taskProcessingResults](../resources/identitygovernance-taskprocessingresult.md) and [versions](../resources/identitygovernance-workflowversion.md). You can restore a deleted workflow and its associated objects within 30 days of deletion.

+## 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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+DELETE /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/

+```

+## 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": "lifecycleworkflows_delete_workflow"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Get workflow (lifecycle workflow)"

+description: "Read the properties and relationships of a workflow object."

+ms.localizationpriority: medium

+# Get workflow (lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Read the properties and relationships of a [workflow](../resources/identitygovernance-workflow.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}

+```

+## Optional query parameters

+This method supports the `$select` and `$expand` 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 [workflow](../resources/identitygovernance-workflow.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_workflow"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.workflow"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows/$entity",

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T15:39:17.6496744Z",

+ "createdDateTime": "2022-08-24T15:39:17.6496704Z",

+ "deletedDateTime": null,

+ "id": "156ce798-1eb6-4e0a-8515-e79f54d04390",

+ "isEnabled": true,

+ "isSchedulingEnabled": false,

+ "nextScheduleRunDateTime": null,

+ "version": 1,

+ "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": 0

+ }

+ },

+ "lastModifiedBy": {

+ "id": "a698128f-b34f-44db-a9f9-7661c7aba8d8"

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/tasks",

+ "tasks": [

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "4469d2ee-0626-4aa6-a792-84afcb9f3759",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ },

+ {

+ "category": "joiner",

+ "continueOnError": false,

+ "description": "Send welcome email to new hire",

+ "displayName": "Send Welcome Email",

+ "executionSequence": 2,

+ "id": "e93e4d5d-1bcd-4175-b8a1-81729e3b4df9",

+ "isEnabled": true,

+ "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",

+ "arguments": []

+ },

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Add user to selected groups",

+ "displayName": "Add User To Groups",

+ "executionSequence": 3,

+ "id": "072a6872-6052-4d4a-93f0-a0ff3f1dec19",

+ "isEnabled": true,

+ "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",

+ "arguments": [

+ {

+ "name": "groupID",

+ "value": "e5659cb0-bcbb-4a9f-9092-90f72bd19028"

+ }

+ ]

+ }

+ ],

+ "createdBy": {

+ "id": "a698128f-b34f-44db-a9f9-7661c7aba8d8"

+ }

+}

+```

+ Title: "List runs (for a lifecycle workflow)"

+description: "Get a list of the run objects and their properties for a lifecycle workflow."

+ms.localizationpriority: medium

+# List runs (for a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get a list of the run objects and their properties for a [lifecycle workflow](../resources/identitygovernance-workflow.md).

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/

+```

+## Optional query parameters

+This method supports the `$select`, `$orderby`, and `$filter` 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 [run](../resources/identitygovernance-run.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_run"

+}

+-->

+``` http

+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)

+# [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": "Collection(microsoft.graph.identityGovernance.run)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/runs",

+ "@odata.count": 2,

+ "value": [

+ {

+ "id": "dad77a47-6eda-4de7-bc37-fe8eb5aaf17d",

+ "completedDateTime": "2022-08-24T23:28:11.1348863Z",

+ "failedTasksCount": 0,

+ "failedUsersCount": 0,

+ "lastUpdatedDateTime": "2022-08-24T23:33:09.186588Z",

+ "processingStatus": "completed",

+ "scheduledDateTime": "2022-08-24T23:28:01.6476554Z",

+ "startedDateTime": "2022-08-24T23:28:04.5688752Z",

+ "successfulUsersCount": 2,

+ "totalTasksCount": 4,

+ "totalUsersCount": 2,

+ "totalUnprocessedTasksCount": 0,

+ "workflowExecutionType": "onDemand"

+ },

+ {

+ "id": "a512bb50-3423-4bdc-ad5e-9731095b3b9a",

+ "completedDateTime": "2022-08-25T00:15:11.8535443Z",

+ "failedTasksCount": 0,

+ "failedUsersCount": 0,

+ "lastUpdatedDateTime": "2022-08-25T00:20:05.8667912Z",

+ "processingStatus": "completed",

+ "scheduledDateTime": "2022-08-25T00:15:04.0253846Z",

+ "startedDateTime": "2022-08-25T00:15:05.1818741Z",

+ "successfulUsersCount": 2,

+ "totalTasksCount": 4,

+ "totalUsersCount": 2,

+ "totalUnprocessedTasksCount": 0,

+ "workflowExecutionType": "onDemand"

+ }

+ ]

+}

+```

+ Title: "List tasks (in a lifecycle workflow)"

+description: "Get a list of the task objects and their properties in a lifecycle workflow."

+ms.localizationpriority: medium

+# List tasks (in a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get the task resources from the tasks navigation property.

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflow/{workflowId}/tasks

+```

+## Optional query parameters

+This method supports the `$search`, `$orderby`, and `$filter` 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 [task](../resources/identitygovernance-task.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_task"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflow/156ce798-1eb6-4e0a-8515-e79f54d04390/tasks

+```

+### 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.identityGovernance.task)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/tasks",

+ "@odata.count": 2,

+ "value": [

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "4d9d41d7-a8e1-4f2f-8c8c-a883bc02e6ee",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ },

+ {

+ "category": "joiner",

+ "continueOnError": false,

+ "description": "Send welcome email to new hire",

+ "displayName": "Send Welcome Email",

+ "executionSequence": 2,

+ "id": "a51a6a57-2ef7-4006-b0ca-285b19d5e1c8",

+ "isEnabled": true,

+ "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",

+ "arguments": []

+ }

+ ]

+}

+```

+ Title: "List taskReports (for a lifecycle workflow)"

+description: "Get a list of the taskReport objects and their properties for a lifecycle workflow."

+ms.localizationpriority: medium

+# List taskReports (for a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get a list of the [taskReport](../resources/identitygovernance-taskreport.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports

+```

+## Optional query parameters

+This method supports the `$select`, `$orderBy`, `$expand`, and `$filter` 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 [taskReport](../resources/identitygovernance-taskreport.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_taskreport"

+}

+-->

+``` http

+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)

+# [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": "Collection(microsoft.graph.identityGovernance.taskReport)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/taskReports",

+ "@odata.count": 4,

+ "value": [

+ {

+ "id": "3a3bea11-99ca-462d-86fb-d283db8d734a",

+ "runId": "dad77a47-6eda-4de7-bc37-fe8eb5aaf17d",

+ "processingStatus": "completed",

+ "successfulUsersCount": 2,

+ "failedUsersCount": 0,

+ "unprocessedUsersCount": 0,

+ "totalUsersCount": 2,

+ "startedDateTime": "2022-08-24T23:28:04.5785337Z",

+ "completedDateTime": "2022-08-24T23:28:11.1348863Z",

+ "lastUpdatedDateTime": "2022-08-24T23:33:09.1980352Z"

+ },

+ {

+ "id": "23f37fcb-040d-4ee9-91df-1234700ebeb6",

+ "runId": "dad77a47-6eda-4de7-bc37-fe8eb5aaf17d",

+ "processingStatus": "completed",

+ "successfulUsersCount": 2,

+ "failedUsersCount": 0,

+ "unprocessedUsersCount": 0,

+ "totalUsersCount": 2,

+ "startedDateTime": "2022-08-24T23:28:04.5861287Z",

+ "completedDateTime": "2022-08-24T23:28:11.1348863Z",

+ "lastUpdatedDateTime": "2022-08-24T23:33:09.2051571Z"

+ },

+ {

+ "id": "462e6deb-a7b4-4777-a494-389c495862b8",

+ "runId": "a512bb50-3423-4bdc-ad5e-9731095b3b9a",

+ "processingStatus": "completed",

+ "successfulUsersCount": 2,

+ "failedUsersCount": 0,

+ "unprocessedUsersCount": 0,

+ "totalUsersCount": 2,

+ "startedDateTime": "2022-08-25T00:15:05.25581Z",

+ "completedDateTime": "2022-08-25T00:15:11.8535443Z",

+ "lastUpdatedDateTime": "2022-08-25T00:20:05.8759088Z"

+ },

+ {

+ "id": "e3dd0719-a50a-463d-b32d-7176fa4519e4",

+ "runId": "a512bb50-3423-4bdc-ad5e-9731095b3b9a",

+ "processingStatus": "completed",

+ "successfulUsersCount": 2,

+ "failedUsersCount": 0,

+ "unprocessedUsersCount": 0,

+ "totalUsersCount": 2,

+ "startedDateTime": "2022-08-25T00:15:05.2771389Z",

+ "completedDateTime": "2022-08-25T00:15:11.8535443Z",

+ "lastUpdatedDateTime": "2022-08-25T00:20:05.9002556Z"

+ }

+ ]

+}

+```

+ Title: "List userProcessingResults (for a lifecycle workflow)"

+description: "Get a list of the userProcessingResult objects and their properties for a lifecycle workflow."

+ms.localizationpriority: medium

+# List userProcessingResults (for a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get the **userProcessingResult** resources for a [workflow](../resources/identitygovernance-workflow.md).

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /workflow/userProcessingResults

+```

+## Optional query parameters

+This method supports the `$select`, `$orderBy`, `$expand`, and `$filter` 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 [userProcessingResult](../resources/identitygovernance-userprocessingresult.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_userprocessingresult"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/{workflowid}/userProcessingResults

+```

+# [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": "Collection(microsoft.graph.identityGovernance.userProcessingResult)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/userProcessingResults",

+ "value": [

+ {

+ "id": "e831ffea-4156-482a-ba43-a8161f83efa8",

+ "completedDateTime": "2022-08-24T18:27:43.1283747Z",

+ "failedTasksCount": 1,

+ "processingStatus": "failed",

+ "scheduledDateTime": "2022-08-24T18:27:28.4105696Z",

+ "startedDateTime": "2022-08-24T18:27:34.47941Z",

+ "totalTasksCount": 3,

+ "totalUnprocessedTasksCount": 2,

+ "workflowExecutionType": "onDemand",

+ "workflowVersion": 1,

+ "subject": {

+ "@odata.type": "microsoft.graph.user",

+ "id": "b276ff04-835d-414c-a2a7-5c59e37cccc9"

+ }

+ },

+ {

+ "id": "c1fab0b4-222d-4bdf-ab09-eb99fc5a8061",

+ "completedDateTime": "2022-08-24T18:35:53.5871731Z",

+ "failedTasksCount": 1,

+ "processingStatus": "failed",

+ "scheduledDateTime": "2022-08-24T18:35:39.0021384Z",

+ "startedDateTime": "2022-08-24T18:35:48.0824202Z",

+ "totalTasksCount": 3,

+ "totalUnprocessedTasksCount": 2,

+ "workflowExecutionType": "onDemand",

+ "workflowVersion": 1,

+ "subject": {

+ "@odata.type": "microsoft.graph.user",

+ "id": "b276ff04-835d-414c-a2a7-5c59e37cccc9"

+ }

+ },

+ {

+ "id": "0481a153-f437-45f0-b07c-ebe1008f10c5",

+ "completedDateTime": "2022-08-24T23:26:41.4425594Z",

+ "failedTasksCount": 0,

+ "processingStatus": "completed",

+ "scheduledDateTime": "2022-08-24T23:26:24.1178409Z",

+ "startedDateTime": "2022-08-24T23:26:29.315238Z",

+ "totalTasksCount": 2,

+ "totalUnprocessedTasksCount": 0,

+ "workflowExecutionType": "onDemand",

+ "workflowVersion": 13,

+ "subject": {

+ "@odata.type": "microsoft.graph.user",

+ "id": "ea09ac2e-77e3-4134-85f2-25ccf3c33387"

+ }

+ }

+ ]

+}

+```

+ Title: "List workflowVersions"

+description: "Get a list of the workflowVersion objects and their properties."

+ms.localizationpriority: medium

+# List versions (of a lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Get a list of the [workflowVersion](../resources/identitygovernance-workflowversion.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions

+```

+## Optional query parameters

+This method supports the `$select`, `$count`, `$search`, `$orderby`, `$expand`, and `$filter` 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 [workflowVersion](../resources/identitygovernance-workflowversion.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_workflowversion"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "Collection(microsoft.graph.identityGovernance.workflowVersion)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/versions",

+ "value": [

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Global onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T19:33:03.8664941Z",

+ "versionNumber": 3,

+ "createdDateTime": "2022-08-24T19:31:33.5534766Z"

+ },

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T19:31:33.4303233Z",

+ "versionNumber": 2,

+ "createdDateTime": "2022-08-24T19:18:18.6841471Z"

+ },

+ {

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T19:18:18.5633638Z",

+ "versionNumber": 1,

+ "createdDateTime": "2022-08-24T15:39:17.6496784Z"

+ }

+ ]

+}

+```

+ Title: "workflow: restore (a deleted workflow)"

+description: "Restore a lifecycle workflow."

+ms.localizationpriority: medium

+# workflow: restore (a deleted workflow)

+Namespace: microsoft.graph.identityGovernance

+Restore a workflow that has been deleted. You can only restore a workflow that was deleted within the last 30 days before Azure AD automatically permanently deletes it.

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /identityGovernance/deletedItems/lifecycleWorkflows/workflows/{workflowId}/restore

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this action returns a `200 OK` response code and a [workflow](../resources/identitygovernance-workflow.md) in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_workflowthis.restore"

+}

+-->

+``` http

+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

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.workflow"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#workflow",

+ "@odata.type": "#microsoft.graph.identityGovernance.workflow",

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Australia Onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T18:51:29.4301671Z",

+ "createdDateTime": "2022-08-24T18:30:33.1050022Z",

+ "deletedDateTime": null,

+ "id": "4c9c57b9-e1e9-4bed-a936-4fad9d8f5638",

+ "isEnabled": true,

+ "isSchedulingEnabled": false,

+ "nextScheduleRunDateTime": null,

+ "version": 1,

+ "executionConditions": null,

+ "lastModifiedBy": {

+ "id": "537b3620-fab7-435e-81bb-03fee751b789"

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/deletedItems/workflows('4c9c57b9-e1e9-4bed-a936-4fad9d8f5638')('4c9c57b9-e1e9-4bed-a936-4fad9d8f5638')/tasks",

+ "tasks": [],

+ "createdBy": {

+ "id": "537b3620-fab7-435e-81bb-03fee751b789"

+ }

+}

+```

+ Title: "Update workflow (lifecycle workflow)"

+description: "Update the properties of a workflow object."

+ms.localizationpriority: medium

+# Update workflow (lifecycle workflow)

+Namespace: microsoft.graph.identityGovernance

+Update the properties of a [workflow](../resources/identitygovernance-workflow.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)|LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /identityGovernance/lifecycleWorkflows/workflows/{workflowId}

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|description|String|Describes the purpose of the workflow for administrative use.|

+|displayName|String|A unique string that identifies the workflow.|

+|isEnabled|Boolean|A boolean value that denotes whether the workflow is set to run or not.|

+|isSchedulingEnabled|Boolean|A Boolean value that denotes whether scheduling is enabled or not. |

+## Response

+If successful, this action returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_update_workflow"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390

+Content-Type: application/json

+Content-length: 454

+{

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Australia Onboard new hire employee",

+ "isEnabled": true,

+ "isSchedulingEnabled": false

+}

+```

+# [C#](#tab/csharp)

+# [JavaScript](#tab/javascript)

+# [Java](#tab/java)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Get workflowTemplate"

+description: "Read the properties and relationships of a workflowTemplate object."

+ms.localizationpriority: medium

+# Get workflowTemplate

+Namespace: microsoft.graph.identityGovernance

+Read the properties and relationships of a [workflowTemplate](../resources/identitygovernance-workflowtemplate.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplateId}

+```

+## Optional query parameters

+This method does not support any 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 [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_workflowtemplate"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.workflowTemplate"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates/$entity",

+ "category": "joiner",

+ "description": "Configure pre-hire tasks for onboarding employees before their first day",

+ "displayName": "Onboard pre-hire employee",

+ "id": "77179007-8114-41b5-922e-2e22109df41f",

+ "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": -7

+ }

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('77179007-8114-41b5-922e-2e22109df41f')/tasks",

+ "tasks": [

+ {

+ "category": "joiner",

+ "continueOnError": false,

+ "description": "Generate Temporary Access Pass and send via email to user's manager",

+ "displayName": "Generate TAP And Send Email",

+ "executionSequence": 1,

+ "id": "3e062c24-d219-483d-9258-288f2a039b94",

+ "isEnabled": true,

+ "taskDefinitionId": "1b555e50-7f65-41d5-b514-5894a026d10d",

+ "arguments": [

+ {

+ "name": "tapLifetimeMinutes",

+ "value": "480"

+ },

+ {

+ "name": "tapIsUsableOnce",

+ "value": "true"

+ }

+ ]

+ }

+ ]

+}

+```

+ Title: "Get workflowVersion"

+description: "Read the properties and relationships of a workflowVersion object."

+ms.localizationpriority: medium

+# Get workflowVersion

+Namespace: microsoft.graph.identityGovernance

+Read the properties and relationships of a [workflowVersion](../resources/identitygovernance-workflowversion.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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions/{workflowVersionId}

+```

+## Optional query parameters

+This method supports the `$select` and `$expand` 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 [workflowVersion](../resources/identitygovernance-workflowversion.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_get_workflowversion"

+}

+-->

+``` http

+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)

+# [PHP](#tab/php)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.identityGovernance.workflowVersion"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/versions/$entity",

+ "category": "joiner",

+ "description": "Configure new hire tasks for onboarding employees on their first day",

+ "displayName": "Global onboard new hire employee",

+ "lastModifiedDateTime": "2022-08-24T19:33:03.8664941Z",

+ "versionNumber": 3,

+ "createdDateTime": "2022-08-24T19:31:33.5534766Z",

+ "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": 0

+ }

+ },

+ "lastModifiedBy": {

+ "id": "a698128f-b34f-44db-a9f9-7661c7aba8d8"

+ },

+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/versions(3)/tasks",

+ "tasks": [

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "fafa2189-cd62-4643-a825-06cab8817086",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ },

+ {

+ "category": "joiner",

+ "continueOnError": false,

+ "description": "Send welcome email to new hire",

+ "displayName": "Send Welcome Email",

+ "executionSequence": 2,

+ "id": "5d7cb666-4f02-40c1-b300-dffb79b60e45",

+ "isEnabled": true,

+ "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",

+ "arguments": []

+ },

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Add user to selected groups",

+ "displayName": "Add user to groups",

+ "executionSequence": 3,

+ "id": "96e30311-566d-4959-ab79-3a2685c2a4b2",

+ "isEnabled": true,

+ "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",

+ "arguments": [

+ {

+ "name": "groupID",

+ "value": "e5659cb0-bcbb-4a9f-9092-90f72bd19028"

+ }

+ ]

+ }

+ ],

+ "createdBy": {

+ "id": "a698128f-b34f-44db-a9f9-7661c7aba8d8"

+ }

+}

+```

+ Title: "List tasks (in a workflowVersion)"

+description: "Get a list of the task objects and their properties in a workflowVersion."

+ms.localizationpriority: medium

+# List tasks (in a workflowVersion)

+Namespace: microsoft.graph.identityGovernance

+Get a list of [task](../resources/identitygovernance-task.md) objects in a [workflowVersion](../resources/identitygovernance-workflowversion.md).

+## 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)|LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All|

+|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

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions/{version number}/tasks

+```

+## Optional query parameters

+This method supports the `$select`, `$top`, `$count`, `$search`, `$orderby`, `$expand`, and `$filter` 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 [task](../resources/identitygovernance-task.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "lifecycleworkflows_list_workflowversion_task"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions/2/tasks

+```

+# [C#](#tab/csharp)

+# [JavaScript](#tab/javascript)

+# [Java](#tab/java)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "Collection(microsoft.graph.identityGovernance.workflowVersion)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/versions(2)/tasks",

+ "@odata.count": 2,

+ "value": [

+ {

+ "category": "joiner,leaver",

+ "continueOnError": false,

+ "description": "Enable user account in the directory",

+ "displayName": "Enable User Account",

+ "executionSequence": 1,

+ "id": "4d9d41d7-a8e1-4f2f-8c8c-a883bc02e6ee",

+ "isEnabled": true,

+ "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",

+ "arguments": []

+ },

+ {

+ "category": "joiner",

+ "continueOnError": false,

+ "description": "Send welcome email to new hire",

+ "displayName": "Send Welcome Email",

+ "executionSequence": 2,

+ "id": "a51a6a57-2ef7-4006-b0ca-285b19d5e1c8",

+ "isEnabled": true,

+ "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",

+ "arguments": []

+ }

+ ]

+}

+```

+Create a [focused Inbox](../resources/manage-focused-inbox.md) override for a sender identified by an SMTP address. Future messages from that SMTP address will be consistently classified

+>[!NOTE]

+>- If an override already exists with the same SMTP address, then the **classifyAs** and **name** fields of that override are updated with the provided values.

+>- The maximum number of overrides supported for a mailbox is 1000, based on unique sender SMTP addresses.

+>- The POST operation supports creating only one override at a time.

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+Delete a [focused Inbox](../resources/manage-focused-inbox.md) override specified by its ID.

+### Request

+The following is an example of a request.

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+Change the **classifyAs** field of a [focused Inbox](../resources/manage-focused-inbox.md) override as specified.

+### Request

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+For more details, see [customize insights privacy](/graph/insights-customize-item-insights-privacy).

+For more details, see [customize insights privacy](/graph/insights-customize-item-insights-privacy).

+The calling user must be assigned the Global Administrator [Azure AD role](/azure/active-directory/roles/permissions-reference).

+The calling user must be assigned the Global Administrator [Azure AD role](/azure/active-directory/roles/permissions-reference).

+The calling user must be assigned the Global Administrator [Azure AD role](/azure/active-directory/roles/permissions-reference).

+|configureWifi|Boolean|Boolean that indicates that the Wi-Fi network should be configured during device provisioning. When set to TRUE, device provisioning will use Wi-Fi related properties to automatically connect to Wi-Fi networks. When set to FALSE or undefined, other Wi-Fi related properties will be ignored. Default value is TRUE. Returned by default.|

+Content-length: 948

+ "configureWifi": true,

+Content-Length: 1120

+ "configureWifi": true,

+Content-Length: 1195

+ "configureWifi": true,

+Content-Length: 1265

+ "configureWifi": true,

+|configureWifi|Boolean|Boolean that indicates that the Wi-Fi network should be configured during device provisioning. When set to TRUE, device provisioning will use Wi-Fi related properties to automatically connect to Wi-Fi networks. When set to FALSE or undefined, other Wi-Fi related properties will be ignored. Default value is TRUE. Returned by default.|

+Content-length: 948

+ "configureWifi": true,

+Content-Length: 1120

+ "configureWifi": true,

+|sessionId|String|Not yet documented|

+Content-length: 278

+ "sessionId": "Session Id value",