workflowTemplate resource type

Namespace: microsoft.graph.identityGovernance

Represents the pre-configured templates of Lifecycle Workflows that are available in Microsoft Entra ID. Workflow templates are available for common scenarios such as new hires and users that are leaving the organization.

Workflow templates allow you to set up workflows based on common lifecycle management scenarios. You can also create custom workflows from the workflow templates to achieve specific situations.

Inherits from entity.


Method Return type Description
List workflowTemplates microsoft.graph.identityGovernance.workflowTemplate collection Get a list of the workflowTemplate objects and their properties.
Get workflowTemplate microsoft.graph.identityGovernance.workflowTemplate Read the properties and relationships of a workflowTemplate object.


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

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.

Supported workflow templates

Lifecycle Workflows currently provide the following predefined workflow templates:

Workflow template type Lifecycle category
Onboard pre-hire employee Joiner
Onboard new hire employee Joiner
Post-Onboarding new hire employee Joiner
Real-time employee change Mover
Real-time employee termination Leaver
Pre-Offboarding of an employee Leaver
Offboard an employee Leaver
Post-Offboarding of an employee Leaver


Relationship Type Description
tasks microsoft.graph.identityGovernance.task collection Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default.

JSON representation

The following is a JSON representation of the resource.

  "@odata.type": "#microsoft.graph.identityGovernance.workflowTemplate",
  "id": "String (identifier)",
  "category": "String",
  "description": "String",
  "displayName": "String",
  "executionConditions": {
    "@odata.type": "microsoft.graph.identityGovernance.workflowExecutionConditions"