Show / Hide Table of Contents

LifecycleWorkflows.Read.All

Allows the app to list and read all workflows, tasks and related lifecycle workflows resources on behalf of the signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D GET /identityGovernance/lifecycleWorkflows/customTaskExtensions
V1 A,D GET /identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtensionId}
V1 A,D GET /identityGovernance/lifecycleWorkflows/deletedItems/workflows/
V1 A,D GET /identityGovernance/lifecycleWorkflows/settings
V1 A,D GET /identityGovernance/lifecycleWorkflows/taskDefinitions
V1 A,D GET /identityGovernance/lifecycleWorkflows/taskDefinitions/{taskDefinitionId}
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflow/{workflowId}/tasks
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflow/{workflowId}/tasks/{taskId}
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{{workflow_id}}/runs/{runId}/userProcessingResults/{userProcessingResultId}
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/{runId}
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/{runId}/userProcessingResults/
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/{runId}/userProcessingResults/{userProcessingResultId}/taskProcessingResults
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/summary(startDateTime={timestamp},endDateTime={timestamp})
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/{taskReportId}/taskProcessingResults
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/summary(startDateTime={timestamp},endDateTime={timestamp})
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/userProcessingResults/{userProcessingResultId}/taskProcessingResults
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions/{version number}/tasks
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions/{workflowVersionId}
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflowTemplates
V1 A,D GET /identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplateId}
V1 A,D GET /workflow/userProcessingResults
V1 A,D POST /identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflowId}/restore

Delegate Permission

Id 9bcb9916-765a-42af-bf77-02282e26b01a
Consent Type Admin
Display String Read all lifecycle workflows resources
Description Allows the app to list and read all workflows, tasks and related lifecycle workflows resources on behalf of the signed-in user.

Application Permission

Id 7c67316a-232a-4b84-be22-cea2c0906404
Display String Read all lifecycle workflows resources
Description Allows the app to list and read all workflows, tasks and related lifecycle workflows resources without a signed-in user.

Resources

customTaskExtension

Property Type Description
authenticationConfiguration microsoft.graph.customExtensionAuthenticationConfiguration Configuration for securing the API call to the logic app. Inherited from customCalloutExtension. Required.
callbackConfiguration microsoft.graph.customExtensionCallbackConfiguration The callback configuration for a custom extension.
clientConfiguration microsoft.graph.customExtensionClientConfiguration HTTP connection settings that define how long Azure AD can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed. Inherited from customCalloutExtension.
createdDateTime DateTimeOffset When the custom task extension was created.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
description String Describes the purpose of the custom task extension for administrative use. Inherited from customCalloutExtension. Optional.
displayName String A unique string that identifies the custom task extension. Inherited from customCalloutExtension. Required.

Supports $filter(eq, ne) and $orderby.
endpointConfiguration microsoft.graph.customExtensionEndpointConfiguration Details for allowing the custom task extension to call the logic app. Inherited from customCalloutExtension.
id String Inherited from entity.

Supports $filter(eq, ne) and $orderby.
lastModifiedDateTime DateTimeOffset When the custom extension was last modified.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

lifecycleManagementSettings

Property Type Description
id String Identifier used for individually addressing Lifecycle Workflow settings.
workflowScheduleIntervalInHours Int32 The interval in hours at which all workflows running in the tenant should be scheduled for execution. This interval has a minimum value of 1 and a maximum value of 24. The default value is 3 hours.

run

Property Type Description
completedDateTime DateTimeOffset The date time that the run completed. Value is null if the workflow hasn't completed.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
failedTasksCount Int32 The number of tasks that failed in the run execution.
failedUsersCount Int32 The number of users that failed in the run execution.
lastUpdatedDateTime DateTimeOffset The datetime that the run was last updated.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
processingStatus String The run execution status. The possible values are: queued, inProgress, completed, completedWithErrors, canceled, failed, unknownFutureValue.

Supports $filter(eq, ne) and $orderby.
startedDateTime DateTimeOffset The date time that the run execution started.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
scheduledDateTime DateTimeOffset The date time that the run is scheduled to be executed for a workflow.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
successfulUsersCount Int32 The number of successfully completed users in the run.
totalUsersCount Int32 The total number of users in the workflow execution.
totalUnprocessedTasksCount Int32 The total number of unprocessed tasks in the run execution.
workflowExecutionType String The execution type of the workflows associated with the run. The possible values are: scheduled, onDemand, unknownFutureValue.

Supports $filter(eq, ne) and $orderby.

runSummary

Property Type Description
failedRuns Int32 The number of failed workflow runs.
failedTasks Int32 The number of failed tasks of a workflow.
successfulRuns Int32 The number of successful workflow runs.
totalRuns Int32 The total number of runs for a workflow.

identitygovernance-task

Property Type Description
arguments microsoft.graph.keyValuePair collection Arguments included within the task.
For guidance to configure this property, see Configure the arguments for built-in Lifecycle Workflow tasks. Required.
category microsoft.graph.identityGovernance.lifecycleTaskCategory The category of the task. The possible values are: joiner, leaver, unknownFutureValue. This property is multi-valued and the same task can apply to both joiner and leaver categories.

Supports $filter(eq, ne).
continueOnError Boolean A boolean value that specifies whether, if this task fails, the workflow will stop, and subsequent tasks will not run. Optional.
description String A string that describes the purpose of the task for administrative use. Optional.
displayName String A unique string that identifies the task. Required.

Supports $filter(eq, ne) and orderBy.
executionSequence Int32 An integer that states in what order the task will run in a workflow.

Supports $orderby.
id String Identifier used for individually addressing a specific task. Inherited from entity.

Supports $filter(eq, ne) and $orderby.
isEnabled Boolean A boolean value that denotes whether the task is set to run or not. Optional.

Supports $filter(eq, ne) and orderBy.
taskDefinitionId String A unique template identifier for the task. For more information about the tasks that Lifecycle Workflows currently supports and their unique identifiers, see supported tasks. Required.

Supports $filter(eq, ne).

taskDefinition

Property Type Description
category microsoft.graph.identityGovernance.lifecycleTaskCategory The category of the HR function that the tasks created using this definition can be used with. The possible values are: joiner, leaver. This is a multi-valued enumeration whose allowed combinations are joiner, joiner,leaver, or leaver.

Supports $filter(eq, ne, has) and $orderby.
description String The description of the taskDefinition.
displayName String The display name of the taskDefinition.

Supports $filter(eq, ne) and $orderby.
id String The unique identifier for the taskDefinition. Inherited from entity.
parameters microsoft.graph.identityGovernance.parameter collection The parameters that must be supplied when creating a workflow task object.

Supports $filter(any).
version Int32 The version number of the taskDefinition. New records are pushed when we add support for new parameters.

Supports $filter(ge, gt, le, lt, eq, ne) and $orderby.

taskProcessingResult

Property Type Description
completedDateTime DateTimeOffset The date time when taskProcessingResult execution ended. Value is null if task execution is still in progress.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
createdDateTime DateTimeOffset The date time when the taskProcessingResult was created.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
failureReason String Describes why the taskProcessingResult has failed.
id String Identifier used for individually addressing a specific task processing result. Inherited from entity.

Supports $filter(eq, ne) and $orderby.
processingStatus microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus Describes the execution status of the taskProcessingResult. The possible values are: queued, inProgress, completed, completedWithErrors, canceled, failed, unknownFutureValue.

Supports $filter(eq, ne) and $orderby.
startedDateTime DateTimeOffset The date time when taskProcessingResult execution started. Value is null if task execution has not yet started.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

taskReport

Property Type Description
completedDateTime DateTimeOffset The date time that the associated run completed. Value is null if the run has not completed.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
failedUsersCount Int32 The number of users in the run execution for which the associated task failed.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
id String The unique identifier of the task report. Inherited from entity.

Supports $filter(eq, ne) and $orderby.
lastUpdatedDateTime DateTimeOffset The date and time that the task report was last updated.
processingStatus microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus The processing status of the associated task based on the taskProcessingResults. The possible values are based on the number of queued, inProgress, completed, completedWithErrors, canceled, failed, and unknownFutureValue.

Supports $filter(eq, ne) and $orderby.
runId String The unique identifier of the associated run.
startedDateTime DateTimeOffset The date time that the associated run started. Value is null if the run has not started.
successfulUsersCount Int32 The number of users in the run execution for which the associated task succeeded.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
totalUsersCount Int32 The total number of users in the run execution for which the associated task was scheduled to execute.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
unprocessedUsersCount Int32 The number of users in the run execution for which the associated task is queued, in progress, or canceled.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

taskReportSummary

Property Type Description
failedTasks Int32 The number of failed tasks in a report.
successfulTasks Int32 The total number of successful tasks in a report.
totalTasks Int32 The total number of tasks in a report.
unprocessedTasks Int32 The number of unprocessed tasks in a report.

userProcessingResult

Property Type Description
completedDateTime DateTimeOffset The date time that the workflow execution for a user completed. Value is null if the workflow hasn't completed.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
failedTasksCount Int32 The number of tasks that failed in the workflow execution.
id String Identifier used for individually addressing a specific user processing result. Inherited from entity.

Supports $filter(eq, ne) and $orderby.
processingStatus String The workflow execution status. The possible values are: queued, inProgress, completed, completedWithErrors, canceled, failed, unknownFutureValue.

Supports $filter(eq, ne) and $orderby.
scheduledDateTime DateTimeOffset The date time that the workflow is scheduled to be executed for a user.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
startedDateTime DateTimeOffset The date time that the workflow execution started. Value is null if the workflow execution has not started.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
totalTasksCount Int32 The total number of tasks that in the workflow execution.
totalUnprocessedTasksCount Int32 The total number of unprocessed tasks for the workflow.
workflowExecutionType String Describes the execution type of the workflow. The possible values are: scheduled, onDemand, unknownFutureValue.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
workflowVersion Int32 The version of the workflow that was executed.

workflow

Property Type Description
category microsoft.graph.identityGovernance.lifecycleWorkflowCategory The category of the HR function supported by the workflows created using this template. A workflow can only belong to one category. The possible values are: joiner, leaver, unknownFutureValue. Inherited from workflowBase. Required.

Supports $filter(eq,ne) and $orderBy
createdDateTime DateTimeOffset When the workflow was created. Inherited from workflowBase.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
deletedDateTime DateTimeOffset When the workflow was deleted.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
description String The description of the workflow. Inherited from workflowBase. Optional.
displayName String The display name of the workflow. Inherited from workflowBase. Required.

Supports $filter(eq, ne) and orderby.
executionConditions microsoft.graph.identityGovernance.workflowExecutionConditions Conditions describing when to execute the workflow and the criteria to identify in-scope subject set. Inherited from workflowBase. Required.
id String Identifier used for individually addressing a specific workflow.

Supports $filter(eq, ne) and $orderby.
isEnabled Boolean Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true. Inherited from workflowBase. Optional. Defaults to true.

Supports $filter(eq, ne) and orderBy.
isSchedulingEnabled Boolean If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Cannot be true for a disabled workflow (where isEnabled is false). Inherited from workflowBase. Optional. Defaults to false.

Supports $filter(eq, ne) and orderBy.
lastModifiedDateTime DateTimeOffset The date time when the workflow was last modified. Inherited from workflowBase.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
nextScheduleRunDateTime DateTimeOffset The date time when the workflow is expected to run next based on the schedule interval, if there are any users matching the execution conditions.

Supports $filter(lt,gt) and $orderBy.
version Int32 The current version number of the workflow. Value is 1 when the workflow is first created.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

workflowTemplate

Property Type Description
category microsoft.graph.identityGovernance.lifecycleWorkflowCategory The category of the workflow template. The possible values are: joiner, leaver.

Supports $filter(eq, ne) and $orderby.
description String The description of the workflowTemplate.
displayName String The display name of the workflowTemplate.

Supports $filter(eq, ne) and $orderby.
executionConditions microsoft.graph.identityGovernance.workflowExecutionConditions Conditions describing when to execute the workflow and the criteria to identify in-scope subject set.
id String The unique identifier for the workflowTemplate. Inherited from entity.

Supports $filter(eq, ne) and $orderby.

workflowVersion

Property Type Description
category microsoft.graph.identityGovernance.lifecycleWorkflowCategory The category of the HR function supported by the workflows created using this template. A workflow can only belong to one category. The possible values are: joiner, leaver, unknownFutureValue. Inherited from workflowBase.

Supports $filter(eq,ne) and $orderby
createdDateTime DateTimeOffset The date time when the workflow was versioned. Inherited from workflowBase.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
description String The description of the workflowversion. Inherited from workflowBase.
displayName String The display name of the workflowversion. Inherited from workflowBase.

Supports $filter(eq, ne) and orderby.
executionConditions microsoft.graph.identityGovernance.workflowExecutionConditions Conditions describing when to execute the workflow and the criteria to identify in-scope subject set. Inherited from workflowBase.
isEnabled Boolean Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true. Inherited from workflowBase.

Supports $filter(eq, ne) and orderBy.
isSchedulingEnabled Boolean If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Cannot be true for a disabled workflow (where isEnabled is false). Inherited from workflowBase.

Supports $filter(eq, ne) and orderBy.
lastModifiedDateTime DateTimeOffset The date time when the workflow was last modified. Inherited from workflowBase.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
versionNumber Int32 The version of the workflow.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
In This Article
Back to top Created by merill | Submit feedback