Edit

Share via

task resource type (lifecycle workflow tasks)

  • Article

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 the built-in tasks available for lifecycle workflows. Tasks are the actions a workflow executes when triggered. The built-in task "Run a custom task extension" can be used to trigger custom task extensions when you reach the limits of the other available built-in tasks. This task allows integration with Azure Logic Apps.

A workflow can have up to 25 tasks.

Inherits from entity.

Methods

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

Properties

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 stops, and subsequent tasks aren't 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 runs 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 Configure the arguments for built-in Lifecycle Workflow tasks. Required.

Supports $filter(eq, ne).

Relationships

Relationship Type Description
taskProcessingResults microsoft.graph.identityGovernance.taskProcessingResult collection The result of processing the task.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.identityGovernance.task",
  "id": "String (identifier)",
  "arguments": [
    {
      "@odata.type": "microsoft.graph.keyValuePair"
    }
  ],
  "category": "String",
  "continueOnError": "Boolean",
  "description": "String",
  "displayName": "String",
  "executionSequence": "Integer",
  "isEnabled": "Boolean",
  "taskDefinitionId": "String"
}

Related content