workflowBase 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.

An abstract type that exposes the properties for configuring a custom lifecycle workflow. This resource is inherited by the following resource types:

Methods

None.

Properties

Property Type Description
category microsoft.graph.identityGovernance.lifecycleWorkflowCategory The category of the workflow. The possible values are: joiner, leaver, mover, unknownFutureValue.
createdDateTime DateTimeOffset When a workflow was created.
description String A string that describes the purpose of the workflow.
displayName String A string to identify the workflow.
executionConditions microsoft.graph.identityGovernance.workflowExecutionConditions Defines when and for who the workflow will run.
isEnabled Boolean Determines 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.
isSchedulingEnabled Boolean If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Can't be true for a disabled workflow (where isEnabled is false).
lastModifiedDateTime DateTimeOffset When the workflow was last modified.

Relationships

Relationship Type Description
createdBy user The user who created the workflow.
lastModifiedBy user The user who last modified the workflow.
tasks microsoft.graph.identityGovernance.task collection The tasks in the workflow.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.identityGovernance.workflowBase",
  "category": "String",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "executionConditions": {
    "@odata.type": "microsoft.graph.identityGovernance.workflowExecutionConditions"
  },
  "isEnabled": "Boolean",
  "isSchedulingEnabled": "Boolean",
  "lastModifiedDateTime": "String (timestamp)"
}