workflow resource type

Namespace: microsoft.graph.identityGovernance

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents workflows created using Lifecycle Workflows. Workflows, when triggered by execution conditions, automate parts of the lifecycle management process using tasks. These tasks can either be built-in tasks, or a custom task can be called using the custom task extension which integrate with Azure Logic Apps.

You can create up to 100 workflows in a tenant.

Inherits from workflowBase.

Methods

Method	Return type	Description
List	microsoft.graph.identityGovernance.workflow collection	Get a list of the workflow objects and their properties.
Create	microsoft.graph.identityGovernance.workflow	Create a new workflow object.
Get	microsoft.graph.identityGovernance.workflow	Read the properties and relationships of a workflow object.
Update	microsoft.graph.identityGovernance.workflow	Update the properties of a workflow object.
Delete	None	Deletes a workflow object.
Activate	None	Run a workflow on-demand.
List users in scope	microsoft.graph.user collection	Get a list of users who are in the scope of the execution conditions of a workflow object.
Deleted workflows	:---	:---
List	microsoft.graph.identityGovernance.workflow collection	Get a list of deleted workflow objects and their properties.
Get	microsoft.graph.identityGovernance.workflow	Get a deleted workflow.
Restore	microsoft.graph.identityGovernance.workflow	Restore a deleted workflow.
Permanently delete	None	Permanently delete a workflow object from the deleted items container.

Properties

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, mover,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.

Relationships

Relationship	Type	Description
createdBy	user	The unique identifier of the Microsoft Entra user that created the workflow object. Inherited from workflowBase. Supports $filter(eq, ne) and $expand.
executionScope	microsoft.graph.user collection	The unique identifier of the Microsoft Entra identity that last modified the workflow object.
lastModifiedBy	user	The user who last modified the workflow object. Inherited from workflowBase. Supports $filter(eq, ne) and $expand.
runs	microsoft.graph.identityGovernance.run collection	Workflow runs.
taskReports	microsoft.graph.identityGovernance.taskReport collection	Represents the aggregation of task execution data for tasks within a workflow object.
tasks	microsoft.graph.identityGovernance.task collection	Represents the configured tasks to execute and their execution sequence within a workflow object. Inherited from workflowBase. Required.
userProcessingResults	microsoft.graph.identityGovernance.userProcessingResult collection	Per-user workflow execution results.
versions	microsoft.graph.identityGovernance.workflowVersion collection	The workflow versions that are available.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.identityGovernance.workflow",
  "category": "String",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "executionConditions": {
    "@odata.type": "microsoft.graph.identityGovernance.workflowExecutionConditions"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "deletedDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "isEnabled": "Boolean",
  "isSchedulingEnabled": "Boolean",
  "nextScheduleRunDateTime": "String (timestamp)",
  "version": "Integer"
}