Skip to main content

lifecycle_workflows_workflows

Creates, updates, deletes, gets or lists a lifecycle_workflows_workflows resource.

Overview

Namelifecycle_workflows_workflows
TypeResource
Identra_id.identity_governance.lifecycle_workflows_workflows

Fields

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringIdentifier used for individually addressing a specific workflow.Supports $filter(eq, ne) and $orderby.
administrationScopeTargetsarrayThe administrative units in the scope of the workflow. Optional. Supports $expand.
categorystring (joiner, leaver, unknownFutureValue, mover) (title: lifecycleWorkflowCategory)
createdByobjectThe user who created the workflow. (title: entity)
createdDateTimestring (date-time)When a workflow was created. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
deletedDateTimestring (date-time)When the workflow was deleted.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
descriptionstringA string that describes the purpose of the workflow.
displayNamestringA string to identify the workflow.
executionConditionsobjectDefines when and for who the workflow will run. (title: workflowExecutionConditions)
executionScopearrayThe list of users that meet the workflowExecutionConditions of a workflow.
isEnabledbooleanWhether 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.
isSchedulingEnabledbooleanIf 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).
lastModifiedByobjectThe unique identifier of the Microsoft Entra identity that last modified the workflow. (title: entity)
lastModifiedDateTimestring (date-time)When the workflow was last modified. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
nextScheduleRunDateTimestring (date-time)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. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
runsarrayWorkflow runs.
taskReportsarrayRepresents the aggregation of task execution data for tasks within a workflow object.
tasksarrayThe tasks in the workflow.
userProcessingResultsarrayPer-user workflow execution results.
versionnumber (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.
versionsarrayThe workflow versions that are available.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectworkflow_idRead the properties and relationships of a workflow object.
listselectGet a list of workflow resources that are associated with lifecycle workflows.
insertinsertCreate a new workflow object. You can create up to 100 workflows in a tenant.
updateupdateworkflow_idUpdate the properties of a workflow object. Only the properties listed in the request body table can be updated. To update any other workflow properties, see workflow: createNewVersion.
deletedeleteworkflow_idIf-MatchDelete a workflow object and its associated tasks, taskProcessingResults and versions. You can restore a deleted workflow and its associated objects within 30 days of deletion.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
workflow_idstringThe unique identifier of workflow
If-MatchstringETag

SELECT examples

Read the properties and relationships of a workflow object.

SELECT
id,
administrationScopeTargets,
category,
createdBy,
createdDateTime,
deletedDateTime,
description,
displayName,
executionConditions,
executionScope,
isEnabled,
isSchedulingEnabled,
lastModifiedBy,
lastModifiedDateTime,
nextScheduleRunDateTime,
runs,
taskReports,
tasks,
userProcessingResults,
version,
versions
FROM entra_id.identity_governance.lifecycle_workflows_workflows
WHERE workflow_id = '{{ workflow_id }}' -- required
;

INSERT examples

Create a new workflow object. You can create up to 100 workflows in a tenant.

INSERT INTO entra_id.identity_governance.lifecycle_workflows_workflows (
category,
createdDateTime,
description,
displayName,
executionConditions,
isEnabled,
isSchedulingEnabled,
lastModifiedDateTime,
administrationScopeTargets,
createdBy,
lastModifiedBy,
tasks,
deletedDateTime,
id,
nextScheduleRunDateTime,
version,
executionScope,
runs,
taskReports,
userProcessingResults,
versions
)
SELECT
'{{ category }}',
'{{ createdDateTime }}',
'{{ description }}',
'{{ displayName }}',
'{{ executionConditions }}',
{{ isEnabled }},
{{ isSchedulingEnabled }},
'{{ lastModifiedDateTime }}',
'{{ administrationScopeTargets }}',
'{{ createdBy }}',
'{{ lastModifiedBy }}',
'{{ tasks }}',
'{{ deletedDateTime }}',
'{{ id }}',
'{{ nextScheduleRunDateTime }}',
{{ version }},
'{{ executionScope }}',
'{{ runs }}',
'{{ taskReports }}',
'{{ userProcessingResults }}',
'{{ versions }}'
RETURNING
id,
administrationScopeTargets,
category,
createdBy,
createdDateTime,
deletedDateTime,
description,
displayName,
executionConditions,
executionScope,
isEnabled,
isSchedulingEnabled,
lastModifiedBy,
lastModifiedDateTime,
nextScheduleRunDateTime,
runs,
taskReports,
tasks,
userProcessingResults,
version,
versions
;

UPDATE examples

Update the properties of a workflow object. Only the properties listed in the request body table can be updated. To update any other workflow properties, see workflow: createNewVersion.

UPDATE entra_id.identity_governance.lifecycle_workflows_workflows
SET
category = '{{ category }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
executionConditions = '{{ executionConditions }}',
isEnabled = {{ isEnabled }},
isSchedulingEnabled = {{ isSchedulingEnabled }},
lastModifiedDateTime = '{{ lastModifiedDateTime }}',
administrationScopeTargets = '{{ administrationScopeTargets }}',
createdBy = '{{ createdBy }}',
lastModifiedBy = '{{ lastModifiedBy }}',
tasks = '{{ tasks }}',
deletedDateTime = '{{ deletedDateTime }}',
id = '{{ id }}',
nextScheduleRunDateTime = '{{ nextScheduleRunDateTime }}',
version = {{ version }},
executionScope = '{{ executionScope }}',
runs = '{{ runs }}',
taskReports = '{{ taskReports }}',
userProcessingResults = '{{ userProcessingResults }}',
versions = '{{ versions }}'
WHERE
workflow_id = '{{ workflow_id }}' --required
RETURNING
id,
administrationScopeTargets,
category,
createdBy,
createdDateTime,
deletedDateTime,
description,
displayName,
executionConditions,
executionScope,
isEnabled,
isSchedulingEnabled,
lastModifiedBy,
lastModifiedDateTime,
nextScheduleRunDateTime,
runs,
taskReports,
tasks,
userProcessingResults,
version,
versions;

DELETE examples

Delete a workflow object and its associated tasks, taskProcessingResults and versions. You can restore a deleted workflow and its associated objects within 30 days of deletion.

DELETE FROM entra_id.identity_governance.lifecycle_workflows_workflows
WHERE workflow_id = '{{ workflow_id }}' --required
AND If-Match = '{{ If-Match }}'
;