LifecycleWorkflows.CreateWorkflows

Merill's Note

For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the LifecycleWorkflows.CreateWorkflows permission.

If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the Export-MsIdAppConsentGrantReport command. See How To: Run a quick OAuth app audit of your tenant

Category	Application	Delegated
Identifier	-	-
DisplayText	-	-
Description	-	-
AdminConsentRequired	Yes	No

Graph Methods

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /identityGovernance/lifecycleWorkflows/customTaskExtensions
	GET /identityGovernance/lifecycleWorkflows/taskDefinitions
	GET /identityGovernance/lifecycleWorkflows/taskDefinitions/{taskDefinitionId}
	GET /identityGovernance/lifecycleWorkflows/workflowTemplates
	GET /identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplateId}
	POST /identityGovernance/lifecycleWorkflows/workflows

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /identityGovernance/lifecycleWorkflows/customTaskExtensions
	GET /identityGovernance/lifecycleWorkflows/taskDefinitions
	GET /identityGovernance/lifecycleWorkflows/taskDefinitions/{taskDefinitionId}
	GET /identityGovernance/lifecycleWorkflows/workflowTemplates
	GET /identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplateId}
	POST /identityGovernance/lifecycleWorkflows/workflows

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgIdentityGovernanceLifecycleWorkflowCustomTaskExtension
	Get-MgIdentityGovernanceLifecycleWorkflowTaskDefinition
	Get-MgIdentityGovernanceLifecycleWorkflowTemplate
	New-MgIdentityGovernanceLifecycleWorkflow

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgBetaIdentityGovernanceLifecycleWorkflowCustomTaskExtension
	Get-MgBetaIdentityGovernanceLifecycleWorkflowTaskDefinition
	Get-MgBetaIdentityGovernanceLifecycleWorkflowTemplate
	New-MgBetaIdentityGovernanceLifecycleWorkflow

Resources

Granting this permission allows the calling application to access (and/or update) the following information in your tenant.

Graph reference: customTaskExtension

Property	Type	Description
authenticationConfiguration	microsoft.graph.customExtensionAuthenticationConfiguration	Configuration for securing the API call to the logic app. Inherited from customCalloutExtension. Required.
callbackConfiguration	microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration	The callback configuration for a custom task extension.
clientConfiguration	microsoft.graph.customExtensionClientConfiguration	HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed. Inherited from customCalloutExtension.
createdDateTime	DateTimeOffset	When the custom task extension was created. Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.
description	String	Describes the purpose of the custom task extension for administrative use. Inherited from customCalloutExtension. Optional.
displayName	String	A unique string that identifies the custom task extension. Inherited from customCalloutExtension. Required. Supports `$filter`(`eq`, `ne`) and `$orderby`.
endpointConfiguration	microsoft.graph.customExtensionEndpointConfiguration	Details for allowing the custom task extension to call the logic app. Inherited from customCalloutExtension.
id	String	Inherited from entity. Supports `$filter`(`eq`, `ne`) and `$orderby`.
lastModifiedDateTime	DateTimeOffset	When the custom extension was last modified. Supports `$filter`(`lt`, `le`, `gt`, `ge`, `eq`, `ne`) and `$orderby`.

Graph reference: identitygovernance-task

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`).

Graph reference: taskDefinition

Property	Type	Description
category	microsoft.graph.identityGovernance.lifecycleTaskCategory	The category of the HR function that the tasks created using this definition can be used with. The possible values are: `joiner`, `mover`, `leaver`, `unknownFutureValue`. This is a multi-valued enumeration whose allowed combinations are `joiner`, `joiner,leaver`, or `leaver`. Supports `$filter`(`eq`, `ne`, `has`) and `$orderby`.
continueOnError	Boolean	Defines if the workflow will continue if the task has an error.
description	String	The description of the taskDefinition.
displayName	String	The display name of the taskDefinition. Supports `$filter`(`eq`, `ne`) and `$orderby`.
id	String	The unique identifier for the taskDefinition. Inherited from entity.
parameters	microsoft.graph.identityGovernance.parameter collection	The parameters that must be supplied when creating a workflow task object. Supports `$filter`(`any`).
version	Int32	The version number of the taskDefinition. New records are pushed when we add support for new parameters. Supports `$filter`(`ge`, `gt`, `le`, `lt`, `eq`, `ne`) and `$orderby`.

Graph reference: workflow

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

Graph reference: workflowTemplate

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

Table of Contents

LifecycleWorkflows.CreateWorkflows

Graph Methods

Resources