Create customTaskExtensions

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.

Create a new customTaskExtension object.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	LifecycleWorkflows.ReadWrite.All
Delegated (personal Microsoft account)	Not supported
Application	Not supported

Important

The calling user also requires one of the following Azure Resource Manager roles for the specified Azure Logic App: Logic App contributor, Contributor, or Owner.

For delegated scenarios, the admin needs one of the following Azure AD roles:

• Global administrator
• Lifecycle workflows administrator

HTTP request

POST /identityGovernance/lifecycleWorkflows/customTaskExtensions

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the customTaskExtension object.

You can specify the following properties when creating a customTaskExtension.

Property	Type	Description
authenticationConfiguration	microsoft.graph.customExtensionAuthenticationConfiguration	The authentication configuration for the customTaskExtension.
clientConfiguration	microsoft.graph.customExtensionClientConfiguration	The client configuration for a custom extension.
description	String	The description of the customTaskExtension.
displayName	String	A unique string that identifies the customTaskExtension.
endpointConfiguration	microsoft.graph.customExtensionEndpointConfiguration	The endpoint configuration for a custom extension. Optional.
callbackConfiguration	microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration	The callback configuration for a custom extension. Optional.

Response

If successful, this method returns a 201 Created response code and a microsoft.graph.identityGovernance.customTaskExtension object in the response body.

Examples

Request

The following is an example of a request.

HTTP

POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/customTaskExtensions
Content-Type: application/json
Content-length: 588

{
    "displayName": "Grant manager access to mailbox and OneDrive",
    "description": "Grant manager access to mailbox and OneDrive",
    "endpointConfiguration": {
        "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
        "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",
        "resourceGroupName": "RG-LCM",
        "logicAppWorkflowName": "ManagerAccess"
    },
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
        "resourceId": "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"
    },
    "clientConfiguration": {
        "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",
        "maximumRetries": 1,
        "timeoutInMilliseconds": 1000
    },
    "callbackConfiguration": {
        "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",
        "timeoutDuration": "PT5M"
    }
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const customTaskExtension = {
    displayName: 'Grant manager access to mailbox and OneDrive',
    description: 'Grant manager access to mailbox and OneDrive',
    endpointConfiguration: {
        '@odata.type': '#microsoft.graph.logicAppTriggerEndpointConfiguration',
        subscriptionId: 'c500b67c-e9b7-4ad2-a90d-77d41385ae55',
        resourceGroupName: 'RG-LCM',
        logicAppWorkflowName: 'ManagerAccess'
    },
    authenticationConfiguration: {
        '@odata.type': '#microsoft.graph.azureAdTokenAuthentication',
        resourceId: '542dc01a-0b5d-4edc-b3f9-5cfe6393f557'
    },
    clientConfiguration: {
        '@odata.type': '#microsoft.graph.customExtensionClientConfiguration',
        maximumRetries: 1,
        timeoutInMilliseconds: 1000
    },
    callbackConfiguration: {
        '@odata.type': '#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration',
        timeoutDuration: 'PT5M'
    }
};

await client.api('/identityGovernance/lifecycleWorkflows/customTaskExtensions')
	.version('beta')
	.post(customTaskExtension);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

CustomTaskExtension customTaskExtension = new CustomTaskExtension();
customTaskExtension.displayName = "Grant manager access to mailbox and OneDrive";
customTaskExtension.description = "Grant manager access to mailbox and OneDrive";
LogicAppTriggerEndpointConfiguration endpointConfiguration = new LogicAppTriggerEndpointConfiguration();
endpointConfiguration.subscriptionId = "c500b67c-e9b7-4ad2-a90d-77d41385ae55";
endpointConfiguration.resourceGroupName = "RG-LCM";
endpointConfiguration.logicAppWorkflowName = "ManagerAccess";
customTaskExtension.endpointConfiguration = endpointConfiguration;
AzureAdTokenAuthentication authenticationConfiguration = new AzureAdTokenAuthentication();
authenticationConfiguration.resourceId = "542dc01a-0b5d-4edc-b3f9-5cfe6393f557";
customTaskExtension.authenticationConfiguration = authenticationConfiguration;
CustomExtensionClientConfiguration clientConfiguration = new CustomExtensionClientConfiguration();
clientConfiguration.maximumRetries = 1;
clientConfiguration.timeoutInMilliseconds = 1000;
customTaskExtension.clientConfiguration = clientConfiguration;
CustomTaskExtensionCallbackConfiguration callbackConfiguration = new CustomTaskExtensionCallbackConfiguration();
callbackConfiguration.timeoutDuration = DatatypeFactory.newInstance().newDuration("PT5M");
customTaskExtension.callbackConfiguration = callbackConfiguration;

graphClient.identityGovernance().lifecycleWorkflows().customTaskExtensions()
	.buildRequest()
	.post(customTaskExtension);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := graphmodels.NewCustomTaskExtension()
displayName := "Grant manager access to mailbox and OneDrive"
requestBody.SetDisplayName(&displayName) 
description := "Grant manager access to mailbox and OneDrive"
requestBody.SetDescription(&description) 
endpointConfiguration := graphmodels.NewCustomExtensionEndpointConfiguration()
additionalData := map[string]interface{}{
	"subscriptionId" : "c500b67c-e9b7-4ad2-a90d-77d41385ae55", 
	"resourceGroupName" : "RG-LCM", 
	"logicAppWorkflowName" : "ManagerAccess", 
}
endpointConfiguration.SetAdditionalData(additionalData)
requestBody.SetEndpointConfiguration(endpointConfiguration)
authenticationConfiguration := graphmodels.NewCustomExtensionAuthenticationConfiguration()
additionalData := map[string]interface{}{
	"resourceId" : "542dc01a-0b5d-4edc-b3f9-5cfe6393f557", 
}
authenticationConfiguration.SetAdditionalData(additionalData)
requestBody.SetAuthenticationConfiguration(authenticationConfiguration)
clientConfiguration := graphmodels.NewCustomExtensionClientConfiguration()
timeoutInMilliseconds := int32(1000)
clientConfiguration.SetTimeoutInMilliseconds(&timeoutInMilliseconds) 
additionalData := map[string]interface{}{
	"maximumRetries" : int32(1) , 
}
clientConfiguration.SetAdditionalData(additionalData)
requestBody.SetClientConfiguration(clientConfiguration)
callbackConfiguration := graphmodels.NewCustomExtensionCallbackConfiguration()
timeoutDuration , err := abstractions.ParseISODuration("PT5M")
callbackConfiguration.SetTimeoutDuration(&timeoutDuration) 
requestBody.SetCallbackConfiguration(callbackConfiguration)

result, err := graphClient.IdentityGovernance().LifecycleWorkflows().CustomTaskExtensions().Post(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Identity.Governance

$params = @{
	DisplayName = "Grant manager access to mailbox and OneDrive"
	Description = "Grant manager access to mailbox and OneDrive"
	EndpointConfiguration = @{
		"@odata.type" = "#microsoft.graph.logicAppTriggerEndpointConfiguration"
		SubscriptionId = "c500b67c-e9b7-4ad2-a90d-77d41385ae55"
		ResourceGroupName = "RG-LCM"
		LogicAppWorkflowName = "ManagerAccess"
	}
	AuthenticationConfiguration = @{
		"@odata.type" = "#microsoft.graph.azureAdTokenAuthentication"
		ResourceId = "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"
	}
	ClientConfiguration = @{
		"@odata.type" = "#microsoft.graph.customExtensionClientConfiguration"
		MaximumRetries = 
		TimeoutInMilliseconds = 1000
	}
	CallbackConfiguration = @{
		"@odata.type" = "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration"
		TimeoutDuration = "PT5M"
	}
}

New-MgIdentityGovernanceLifecycleWorkflowCustomTaskExtension -BodyParameter $params

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new CustomTaskExtension();
$requestBody->setDisplayName('Grant manager access to mailbox and OneDrive');

$requestBody->setDescription('Grant manager access to mailbox and OneDrive');

$endpointConfiguration = new CustomExtensionEndpointConfiguration();
$endpointConfiguration->set@odatatype('#microsoft.graph.logicAppTriggerEndpointConfiguration');

$additionalData = [
'subscriptionId' => 'c500b67c-e9b7-4ad2-a90d-77d41385ae55', 
'resourceGroupName' => 'RG-LCM', 
'logicAppWorkflowName' => 'ManagerAccess', 
];
$endpointConfiguration->setAdditionalData($additionalData);



$requestBody->setEndpointConfiguration($endpointConfiguration);
$authenticationConfiguration = new CustomExtensionAuthenticationConfiguration();
$authenticationConfiguration->set@odatatype('#microsoft.graph.azureAdTokenAuthentication');

$additionalData = [
'resourceId' => '542dc01a-0b5d-4edc-b3f9-5cfe6393f557', 
];
$authenticationConfiguration->setAdditionalData($additionalData);



$requestBody->setAuthenticationConfiguration($authenticationConfiguration);
$clientConfiguration = new CustomExtensionClientConfiguration();
$clientConfiguration->set@odatatype('#microsoft.graph.customExtensionClientConfiguration');

$clientConfiguration->setTimeoutInMilliseconds(1000);

$additionalData = [
'maximumRetries' => 1,
];
$clientConfiguration->setAdditionalData($additionalData);



$requestBody->setClientConfiguration($clientConfiguration);
$callbackConfiguration = new CustomExtensionCallbackConfiguration();
$callbackConfiguration->set@odatatype('#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration');

$callbackConfiguration->setTimeoutDuration(new \DateInterval('PT5M'));


$requestBody->setCallbackConfiguration($callbackConfiguration);


$requestResult = $graphServiceClient->identityGovernance()->lifecycleWorkflows()->customTaskExtensions()->post($requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/customTaskExtensions/$entity",
    "id": "ee2590e4-4572-4820-a397-969ecd7bd6a9",
    "displayName": "Grant manager access to mailbox and OneDrive",
    "description": "Grant manager access to mailbox and OneDrive",
    "createdDateTime": "2022-08-24T22:37:46.1790566Z",
    "lastModifiedDateTime": "2022-08-24T22:37:46.179062Z",
    "endpointConfiguration": {
        "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
        "subscriptionId": "c500b67c-e9b7-4ad2-a90d-77d41385ae55",
        "resourceGroupName": "RG-LCM",
        "logicAppWorkflowName": "ManagerAccess"
    },
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
        "resourceId": "542dc01a-0b5d-4edc-b3f9-5cfe6393f557"
    },
    "clientConfiguration": {
        "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",
        "maximumRetries": 1,
        "timeoutInMilliseconds": 1000
    },
    "callbackConfiguration": {
        "@odata.type": "#microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration",
        "timeoutDuration": "PT5M"
    }
}