customTaskExtension resource type
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.
Defines the attributes of a customTaskExtension that allows you to integrate Lifecycle Workflows with Azure Logic Apps. While Lifecycle Workflows provide multiple built-in tasks (known as taskDefinitions) to automate common scenarios during the user lifecycle, you may eventually reach the limits of these built-in tasks. You can create a customTaskExtension that contains information about an Azure Logic app, and trigger the Azure Logic app with the built-in task "Run a custom task extension" that references the corresponding customTaskExtension.
Inherits from customCalloutExtension.
For more information about using custom task extensions, refer to the links in the see also section.
Methods
| Method | Return type | Description |
|---|---|---|
| List | microsoft.graph.identityGovernance.customTaskExtension collection | Get a list of the customTaskExtension objects and their properties. |
| Create | microsoft.graph.identityGovernance.customTaskExtension | Create a new customTaskExtension object. |
| Get | microsoft.graph.identityGovernance.customTaskExtension | Read the properties and relationships of a customTaskExtension object. |
| Update | microsoft.graph.identityGovernance.customTaskExtension | Update the properties of a customTaskExtension object. |
| Delete | None | Deletes a customTaskExtension object. |
Properties
| 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. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| createdBy | user | The unique identifier of the Microsoft Entra user that created the custom task extension. Supports $filter(eq, ne) and $expand. |
| lastModifiedBy | user | The unique identifier of the Microsoft Entra user that modified the custom task extension last. Supports $filter(eq, ne) and $expand. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.identityGovernance.customTaskExtension",
"id": "String (identifier)",
"authenticationConfiguration": {
"@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
},
"clientConfiguration": {
"@odata.type": "microsoft.graph.customExtensionClientConfiguration"
},
"description": "String",
"displayName": "String",
"endpointConfiguration": {
"@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
},
"callbackConfiguration": {
"@odata.type": "microsoft.graph.customExtensionCallbackConfiguration"
},
"createdDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)"
}