lifecycle_workflows_custom_task_extensions

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

Overview

Name	lifecycle_workflows_custom_task_extensions
Type	Resource
Id	entra_id.identity_governance.lifecycle_workflows_custom_task_extensions

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
authenticationConfiguration		Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.
callbackConfiguration		The callback configuration for a custom task extension.
clientConfiguration		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.
createdBy		The unique identifier of the Microsoft Entra user that created the custom task extension.Supports $filter(eq, ne) and $expand.
createdDateTime	string (date-time)	When the custom task extension was created.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])$)
description	string	Description for the customCalloutExtension object.
displayName	string	Display name for the customCalloutExtension object.
endpointConfiguration		The type and details for configuring the endpoint to call the logic app's workflow.
lastModifiedBy		The unique identifier of the Microsoft Entra user that modified the custom task extension last.Supports $filter(eq, ne) and $expand.
lastModifiedDateTime	string (date-time)	When the custom extension was last modified.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])$)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
authenticationConfiguration		Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.
callbackConfiguration		The callback configuration for a custom task extension.
clientConfiguration		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.
createdBy		The unique identifier of the Microsoft Entra user that created the custom task extension.Supports $filter(eq, ne) and $expand.
createdDateTime	string (date-time)	When the custom task extension was created.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])$)
description	string	Description for the customCalloutExtension object.
displayName	string	Display name for the customCalloutExtension object.
endpointConfiguration		The type and details for configuring the endpoint to call the logic app's workflow.
lastModifiedBy		The unique identifier of the Microsoft Entra user that modified the custom task extension last.Supports $filter(eq, ne) and $expand.
lastModifiedDateTime	string (date-time)	When the custom extension was last modified.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])$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	custom_task_extension_id		Read the properties and relationships of a customTaskExtension object.
list	select			Get a list of the customTaskExtension objects and their properties.
insert	insert			Create a new customTaskExtension object.
update	update	custom_task_extension_id		Update the properties of a customTaskExtension object.
delete	delete	custom_task_extension_id	If-Match	Delete a customTaskExtension object. A custom task extension can only be deleted if it is not referenced in any task objects in a lifecycle workflow.

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.

Name	Datatype	Description
custom_task_extension_id	string	The unique identifier of customTaskExtension
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a customTaskExtension object.

SELECT
id,
authenticationConfiguration,
callbackConfiguration,
clientConfiguration,
createdBy,
createdDateTime,
description,
displayName,
endpointConfiguration,
lastModifiedBy,
lastModifiedDateTime
FROM entra_id.identity_governance.lifecycle_workflows_custom_task_extensions
WHERE custom_task_extension_id = '{{ custom_task_extension_id }}' -- required
;

list

Get a list of the customTaskExtension objects and their properties.

SELECT
id,
authenticationConfiguration,
callbackConfiguration,
clientConfiguration,
createdBy,
createdDateTime,
description,
displayName,
endpointConfiguration,
lastModifiedBy,
lastModifiedDateTime
FROM entra_id.identity_governance.lifecycle_workflows_custom_task_extensions
;

INSERT examples

insert

Create a new customTaskExtension object.

INSERT INTO entra_id.identity_governance.lifecycle_workflows_custom_task_extensions (
id,
authenticationConfiguration,
clientConfiguration,
description,
displayName,
endpointConfiguration,
callbackConfiguration,
createdDateTime,
lastModifiedDateTime,
createdBy,
lastModifiedBy
)
SELECT 
'{{ id }}',
'{{ authenticationConfiguration }}',
'{{ clientConfiguration }}',
'{{ description }}',
'{{ displayName }}',
'{{ endpointConfiguration }}',
'{{ callbackConfiguration }}',
'{{ createdDateTime }}',
'{{ lastModifiedDateTime }}',
'{{ createdBy }}',
'{{ lastModifiedBy }}'
RETURNING
id,
authenticationConfiguration,
callbackConfiguration,
clientConfiguration,
createdBy,
createdDateTime,
description,
displayName,
endpointConfiguration,
lastModifiedBy,
lastModifiedDateTime
;

Manifest

# Description fields are for documentation purposes
- name: lifecycle_workflows_custom_task_extensions
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: authenticationConfiguration
    value: "{{ authenticationConfiguration }}"
    description: |
      Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.
  - name: clientConfiguration
    value: "{{ clientConfiguration }}"
    description: |
      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.
  - name: description
    value: "{{ description }}"
    description: |
      Description for the customCalloutExtension object.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name for the customCalloutExtension object.
  - name: endpointConfiguration
    value: "{{ endpointConfiguration }}"
    description: |
      The type and details for configuring the endpoint to call the logic app's workflow.
  - name: callbackConfiguration
    value: "{{ callbackConfiguration }}"
    description: |
      The callback configuration for a custom task extension.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      When the custom task extension was created.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
  - name: lastModifiedDateTime
    value: "{{ lastModifiedDateTime }}"
    description: |
      When the custom extension was last modified.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
  - name: createdBy
    value: "{{ createdBy }}"
    description: |
      The unique identifier of the Microsoft Entra user that created the custom task extension.Supports $filter(eq, ne) and $expand.
  - name: lastModifiedBy
    value: "{{ lastModifiedBy }}"
    description: |
      The unique identifier of the Microsoft Entra user that modified the custom task extension last.Supports $filter(eq, ne) and $expand.

UPDATE examples

update

Update the properties of a customTaskExtension object.

UPDATE entra_id.identity_governance.lifecycle_workflows_custom_task_extensions
SET 
id = '{{ id }}',
authenticationConfiguration = '{{ authenticationConfiguration }}',
clientConfiguration = '{{ clientConfiguration }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
endpointConfiguration = '{{ endpointConfiguration }}',
callbackConfiguration = '{{ callbackConfiguration }}',
createdDateTime = '{{ createdDateTime }}',
lastModifiedDateTime = '{{ lastModifiedDateTime }}',
createdBy = '{{ createdBy }}',
lastModifiedBy = '{{ lastModifiedBy }}'
WHERE 
custom_task_extension_id = '{{ custom_task_extension_id }}' --required
RETURNING
id,
authenticationConfiguration,
callbackConfiguration,
clientConfiguration,
createdBy,
createdDateTime,
description,
displayName,
endpointConfiguration,
lastModifiedBy,
lastModifiedDateTime;

DELETE examples

delete

Delete a customTaskExtension object. A custom task extension can only be deleted if it is not referenced in any task objects in a lifecycle workflow.

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