entitlement_management_catalogs_custom_workflow_extensions

Creates, updates, deletes, gets or lists an entitlement_management_catalogs_custom_workflow_extensions resource.

Overview

Name	entitlement_management_catalogs_custom_workflow_extensions
Type	Resource
Id	entra_id.identity_governance.entitlement_management_catalogs_custom_workflow_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.
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.
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.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_package_catalog_id, custom_callout_extension_id		Read the properties and relationships of an accessPackageAssignmentRequestWorkflowExtension object.
list	select	access_package_catalog_id		Get a list of the accessPackageAssignmentRequestWorkflowExtension and accessPackageAssignmentWorkflowExtension objects and their properties. The resulting list includes all the customAccessPackageWorkflowExtension objects for the catalog that the caller has access to read. Each object includes an @odata.type property that indicates whether the object is an accessPackageAssignmentRequestWorkflowExtension or an accessPackageAssignmentWorkflowExtension.
insert	insert	access_package_catalog_id		Create a new accessPackageAssignmentRequestWorkflowExtension or accessPackageAssignmentWorkflowExtension object and add it to an existing accessPackageCatalog object. You must explicitly provide an @odata.type property that indicates whether the object is an accessPackageAssignmentRequestWorkflowExtension or an accessPackageAssignmentWorkflowExtension.
update	update	access_package_catalog_id, custom_callout_extension_id		Update the properties of an accessPackageAssignmentRequestWorkflowExtension object.
delete	delete	access_package_catalog_id, custom_callout_extension_id	If-Match	Delete an accessPackageAssignmentRequestWorkflowExtension object. The custom workflow extension must first be removed from any associated policies before it can be deleted. Follow these steps to remove the custom workflow extension from any associated policies:

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
access_package_catalog_id	string	The unique identifier of accessPackageCatalog
custom_callout_extension_id	string	The unique identifier of customCalloutExtension
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an accessPackageAssignmentRequestWorkflowExtension object.

SELECT
id,
authenticationConfiguration,
clientConfiguration,
description,
displayName,
endpointConfiguration
FROM entra_id.identity_governance.entitlement_management_catalogs_custom_workflow_extensions
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
AND custom_callout_extension_id = '{{ custom_callout_extension_id }}' -- required
;

list

Get a list of the accessPackageAssignmentRequestWorkflowExtension and accessPackageAssignmentWorkflowExtension objects and their properties. The resulting list includes all the customAccessPackageWorkflowExtension objects for the catalog that the caller has access to read. Each object includes an @odata.type property that indicates whether the object is an accessPackageAssignmentRequestWorkflowExtension or an accessPackageAssignmentWorkflowExtension.

SELECT
id,
authenticationConfiguration,
clientConfiguration,
description,
displayName,
endpointConfiguration
FROM entra_id.identity_governance.entitlement_management_catalogs_custom_workflow_extensions
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
;

INSERT examples

insert

Create a new accessPackageAssignmentRequestWorkflowExtension or accessPackageAssignmentWorkflowExtension object and add it to an existing accessPackageCatalog object. You must explicitly provide an @odata.type property that indicates whether the object is an accessPackageAssignmentRequestWorkflowExtension or an accessPackageAssignmentWorkflowExtension.

INSERT INTO entra_id.identity_governance.entitlement_management_catalogs_custom_workflow_extensions (
id,
authenticationConfiguration,
clientConfiguration,
description,
displayName,
endpointConfiguration,
access_package_catalog_id
)
SELECT 
'{{ id }}',
'{{ authenticationConfiguration }}',
'{{ clientConfiguration }}',
'{{ description }}',
'{{ displayName }}',
'{{ endpointConfiguration }}',
'{{ access_package_catalog_id }}'
RETURNING
id,
authenticationConfiguration,
clientConfiguration,
description,
displayName,
endpointConfiguration
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_catalogs_custom_workflow_extensions
props:
  - name: access_package_catalog_id
    value: "{{ access_package_catalog_id }}"
    description: Required parameter for the entitlement_management_catalogs_custom_workflow_extensions resource.
  - 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.

UPDATE examples

update

Update the properties of an accessPackageAssignmentRequestWorkflowExtension object.

UPDATE entra_id.identity_governance.entitlement_management_catalogs_custom_workflow_extensions
SET 
id = '{{ id }}',
authenticationConfiguration = '{{ authenticationConfiguration }}',
clientConfiguration = '{{ clientConfiguration }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
endpointConfiguration = '{{ endpointConfiguration }}'
WHERE 
access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND custom_callout_extension_id = '{{ custom_callout_extension_id }}' --required
RETURNING
id,
authenticationConfiguration,
clientConfiguration,
description,
displayName,
endpointConfiguration;

DELETE examples

delete

Delete an accessPackageAssignmentRequestWorkflowExtension object. The custom workflow extension must first be removed from any associated policies before it can be deleted. Follow these steps to remove the custom workflow extension from any associated policies:

DELETE FROM entra_id.identity_governance.entitlement_management_catalogs_custom_workflow_extensions
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND custom_callout_extension_id = '{{ custom_callout_extension_id }}' --required
AND If-Match = '{{ If-Match }}'
;