Skip to content

identitygovernance-workflowtemplate.md

Latest commit

 

History

History
74 lines (57 loc) · 3.71 KB

identitygovernance-workflowtemplate.md

File metadata and controls

74 lines (57 loc) · 3.71 KB
title workflowTemplate resource type
description Represents a pre-configured template for lifecycle workflows that you can use to create a workflow. Workflow templates are available for common scenarios such as new hires and users that are leaving the organization.
author KristinaSmith
ms.localizationpriority medium
ms.subservice entra-id-governance
doc_type resourcePageType
ms.date 07/22/2024

workflowTemplate resource type

Namespace: microsoft.graph.identityGovernance

[!INCLUDE beta-disclaimer]

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.

Methods

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

Properties

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

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:

[!INCLUDE identitygovernance-lifecycleworkflows-workflowtemplates]

Relationships

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 JSON representation shows the resource type.

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