List deletedItems (deleted lifecycle workflows)

Namespace: microsoft.graph

Get a list of the deleted workflow objects and their properties.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) LifecycleWorkflows.Read.Workflows LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All, LifecycleWorkflows.ReadWrite.Workflows
Delegated (personal Microsoft account) Not supported. Not supported.
Application LifecycleWorkflows.Read.Workflows LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All, LifecycleWorkflows.ReadWrite.Workflows

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Global Reader and Lifecycle Workflows Administrator are the least privileged roles supported for this operation.

HTTP request

GET /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.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of microsoft.graph.identityGovernance.workflow objects in the response body.

Examples

Example 1: Retrieve all deleted workflows

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/deletedItems/workflows

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$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
        }
    ]
}

Example 2: Retrieve deleted workflows for "leaver" scenarios and return only specific properties

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/deletedItems/workflows?$select=id,category,displayName,description,version&$filter=category eq 'leaver'

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/lifecycleWorkflows/deletedItems/workflows(category,displayName,description,version)",
    "value": [
        {
            "category": "leaver",
            "description": "Employee offboarding for Contoso Germany.",
            "displayName": "Germany offboard employees",
            "id": "952b23c5-cc25-48c9-8848-95da4dd9dc6d",
            "version": 4
        }
    ]
}