workflow : createNewVersion

Article
07/16/2024

Espace de noms : microsoft.graph.identityGovernance

Créez une nouvelle version de l’objet de flux de travail .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	LifecycleWorkflows.ReadWrite.Workflows	LifecycleWorkflows.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	LifecycleWorkflows.ReadWrite.Workflows	LifecycleWorkflows.ReadWrite.All

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. L’administrateur des workflows de cycle de vie est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON des paramètres.

Le tableau suivant indique les paramètres utilisables avec cette action.

Paramètre	Type	Description
workflow	microsoft.graph.identityGovernance.workflow	Flux de travail pour lequel vous souhaitez créer une nouvelle version.

Réponse

Si elle réussit, cette action renvoie un 200 OK code de réponse et un microsoft.graph.identityGovernance.workflow dans le corps de la réponse.

Exemples

Exemple 1 : Créer une nouvelle version d’un workflow

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion
Content-Type: application/json
Content-length: 631

{
    "workflow":{
        "category": "joiner",
        "description": "Configure new hire tasks for onboarding employees on their first day",
        "displayName": "Global onboard new hire employee",
        "isEnabled": true,
        "isSchedulingEnabled": false,
        "executionConditions": {
            "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
            "scope": {
                "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
                "rule": "(department eq 'Marketing')"
            },
            "trigger": {
                "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
                "timeBasedAttribute": "employeeHireDate",
                "offsetInDays": 1
            }
        },
        "tasks": [
            {
                "continueOnError": false,
                "description": "Enable user account in the directory",
                "displayName": "Enable User Account",
                "isEnabled": true,
                "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
                "arguments": []
            },
            {
                "continueOnError": false,
                "description": "Send welcome email to new hire",
                "displayName": "Send Welcome Email",
                "isEnabled": true,
                "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
                "arguments": []
            }
        ]
    }
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.IdentityGovernance.LifecycleWorkflows.Workflows.Item.MicrosoftGraphIdentityGovernanceCreateNewVersion;
using Microsoft.Graph.Models.IdentityGovernance;
using Microsoft.Graph.Models;

var requestBody = new CreateNewVersionPostRequestBody
{
	Workflow = new Workflow
	{
		Category = LifecycleWorkflowCategory.Joiner,
		Description = "Configure new hire tasks for onboarding employees on their first day",
		DisplayName = "Global onboard new hire employee",
		IsEnabled = true,
		IsSchedulingEnabled = false,
		ExecutionConditions = new TriggerAndScopeBasedConditions
		{
			OdataType = "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
			Scope = new RuleBasedSubjectSet
			{
				OdataType = "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
				Rule = "(department eq 'Marketing')",
			},
			Trigger = new TimeBasedAttributeTrigger
			{
				OdataType = "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
				TimeBasedAttribute = WorkflowTriggerTimeBasedAttribute.EmployeeHireDate,
				OffsetInDays = 1,
			},
		},
		Tasks = new List<TaskObject>
		{
			new TaskObject
			{
				ContinueOnError = false,
				Description = "Enable user account in the directory",
				DisplayName = "Enable User Account",
				IsEnabled = true,
				TaskDefinitionId = "6fc52c9d-398b-4305-9763-15f42c1676fc",
				Arguments = new List<KeyValuePair>
				{
				},
			},
			new TaskObject
			{
				ContinueOnError = false,
				Description = "Send welcome email to new hire",
				DisplayName = "Send Welcome Email",
				IsEnabled = true,
				TaskDefinitionId = "70b29d51-b59a-4773-9280-8841dfd3f2ea",
				Arguments = new List<KeyValuePair>
				{
				},
			},
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.IdentityGovernance.LifecycleWorkflows.Workflows["{workflow-id}"].MicrosoftGraphIdentityGovernanceCreateNewVersion.PostAsync(requestBody);



mgc identity-governance lifecycle-workflows workflows microsoft-graph-identity-governance-create-new-version post --workflow-id {workflow-id} --body '{\
    "workflow":{\
        "category": "joiner",\
        "description": "Configure new hire tasks for onboarding employees on their first day",\
        "displayName": "Global onboard new hire employee",\
        "isEnabled": true,\
        "isSchedulingEnabled": false,\
        "executionConditions": {\
            "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",\
            "scope": {\
                "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",\
                "rule": "(department eq 'Marketing')"\
            },\
            "trigger": {\
                "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",\
                "timeBasedAttribute": "employeeHireDate",\
                "offsetInDays": 1\
            }\
        },\
        "tasks": [\
            {\
                "continueOnError": false,\
                "description": "Enable user account in the directory",\
                "displayName": "Enable User Account",\
                "isEnabled": true,\
                "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",\
                "arguments": []\
            },\
            {\
                "continueOnError": false,\
                "description": "Send welcome email to new hire",\
                "displayName": "Send Welcome Email",\
                "isEnabled": true,\
                "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",\
                "arguments": []\
            }\
        ]\
    }\
}\
'



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/identitygovernance"
	  graphmodelsidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/models/identitygovernance"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphidentitygovernance.NewCreateNewVersionPostRequestBody()
workflow := graphmodelsidentitygovernance.NewWorkflow()
category := graphmodels.JOINER_LIFECYCLEWORKFLOWCATEGORY 
workflow.SetCategory(&category) 
description := "Configure new hire tasks for onboarding employees on their first day"
workflow.SetDescription(&description) 
displayName := "Global onboard new hire employee"
workflow.SetDisplayName(&displayName) 
isEnabled := true
workflow.SetIsEnabled(&isEnabled) 
isSchedulingEnabled := false
workflow.SetIsSchedulingEnabled(&isSchedulingEnabled) 
executionConditions := graphmodelsidentitygovernance.NewTriggerAndScopeBasedConditions()
scope := graphmodelsidentitygovernance.NewRuleBasedSubjectSet()
rule := "(department eq 'Marketing')"
scope.SetRule(&rule) 
executionConditions.SetScope(scope)
trigger := graphmodelsidentitygovernance.NewTimeBasedAttributeTrigger()
timeBasedAttribute := graphmodels.EMPLOYEEHIREDATE_WORKFLOWTRIGGERTIMEBASEDATTRIBUTE 
trigger.SetTimeBasedAttribute(&timeBasedAttribute) 
offsetInDays := int32(1)
trigger.SetOffsetInDays(&offsetInDays) 
executionConditions.SetTrigger(trigger)
workflow.SetExecutionConditions(executionConditions)


task := graphmodelsidentitygovernance.NewTask()
continueOnError := false
task.SetContinueOnError(&continueOnError) 
description := "Enable user account in the directory"
task.SetDescription(&description) 
displayName := "Enable User Account"
task.SetDisplayName(&displayName) 
isEnabled := true
task.SetIsEnabled(&isEnabled) 
taskDefinitionId := "6fc52c9d-398b-4305-9763-15f42c1676fc"
task.SetTaskDefinitionId(&taskDefinitionId) 
arguments := []graphmodels.KeyValuePairable {

}
task.SetArguments(arguments)
task1 := graphmodelsidentitygovernance.NewTask()
continueOnError := false
task1.SetContinueOnError(&continueOnError) 
description := "Send welcome email to new hire"
task1.SetDescription(&description) 
displayName := "Send Welcome Email"
task1.SetDisplayName(&displayName) 
isEnabled := true
task1.SetIsEnabled(&isEnabled) 
taskDefinitionId := "70b29d51-b59a-4773-9280-8841dfd3f2ea"
task1.SetTaskDefinitionId(&taskDefinitionId) 
arguments := []graphmodels.KeyValuePairable {

}
task1.SetArguments(arguments)

tasks := []graphmodelsidentitygovernance.Taskable {
	task,
	task1,
}
workflow.SetTasks(tasks)
requestBody.SetWorkflow(workflow)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
microsoftGraphIdentityGovernanceCreateNewVersion, err := graphClient.IdentityGovernance().LifecycleWorkflows().Workflows().ByWorkflowId("workflow-id").MicrosoftGraphIdentityGovernanceCreateNewVersion().Post(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecreatenewversion.CreateNewVersionPostRequestBody createNewVersionPostRequestBody = new com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecreatenewversion.CreateNewVersionPostRequestBody();
com.microsoft.graph.models.identitygovernance.Workflow workflow = new com.microsoft.graph.models.identitygovernance.Workflow();
workflow.setCategory(com.microsoft.graph.models.identitygovernance.LifecycleWorkflowCategory.Joiner);
workflow.setDescription("Configure new hire tasks for onboarding employees on their first day");
workflow.setDisplayName("Global onboard new hire employee");
workflow.setIsEnabled(true);
workflow.setIsSchedulingEnabled(false);
com.microsoft.graph.models.identitygovernance.TriggerAndScopeBasedConditions executionConditions = new com.microsoft.graph.models.identitygovernance.TriggerAndScopeBasedConditions();
executionConditions.setOdataType("#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions");
com.microsoft.graph.models.identitygovernance.RuleBasedSubjectSet scope = new com.microsoft.graph.models.identitygovernance.RuleBasedSubjectSet();
scope.setOdataType("#microsoft.graph.identityGovernance.ruleBasedSubjectSet");
scope.setRule("(department eq 'Marketing')");
executionConditions.setScope(scope);
com.microsoft.graph.models.identitygovernance.TimeBasedAttributeTrigger trigger = new com.microsoft.graph.models.identitygovernance.TimeBasedAttributeTrigger();
trigger.setOdataType("#microsoft.graph.identityGovernance.timeBasedAttributeTrigger");
trigger.setTimeBasedAttribute(com.microsoft.graph.models.identitygovernance.WorkflowTriggerTimeBasedAttribute.EmployeeHireDate);
trigger.setOffsetInDays(1);
executionConditions.setTrigger(trigger);
workflow.setExecutionConditions(executionConditions);
LinkedList<com.microsoft.graph.models.identitygovernance.Task> tasks = new LinkedList<com.microsoft.graph.models.identitygovernance.Task>();
com.microsoft.graph.models.identitygovernance.Task task = new com.microsoft.graph.models.identitygovernance.Task();
task.setContinueOnError(false);
task.setDescription("Enable user account in the directory");
task.setDisplayName("Enable User Account");
task.setIsEnabled(true);
task.setTaskDefinitionId("6fc52c9d-398b-4305-9763-15f42c1676fc");
LinkedList<KeyValuePair> arguments = new LinkedList<KeyValuePair>();
task.setArguments(arguments);
tasks.add(task);
com.microsoft.graph.models.identitygovernance.Task task1 = new com.microsoft.graph.models.identitygovernance.Task();
task1.setContinueOnError(false);
task1.setDescription("Send welcome email to new hire");
task1.setDisplayName("Send Welcome Email");
task1.setIsEnabled(true);
task1.setTaskDefinitionId("70b29d51-b59a-4773-9280-8841dfd3f2ea");
LinkedList<KeyValuePair> arguments1 = new LinkedList<KeyValuePair>();
task1.setArguments(arguments1);
tasks.add(task1);
workflow.setTasks(tasks);
createNewVersionPostRequestBody.setWorkflow(workflow);
var result = graphClient.identityGovernance().lifecycleWorkflows().workflows().byWorkflowId("{workflow-id}").microsoftGraphIdentityGovernanceCreateNewVersion().post(createNewVersionPostRequestBody);


const options = {
	authProvider,
};

const client = Client.init(options);

const workflow = {
    workflow: {
        category: 'joiner',
        description: 'Configure new hire tasks for onboarding employees on their first day',
        displayName: 'Global onboard new hire employee',
        isEnabled: true,
        isSchedulingEnabled: false,
        executionConditions: {
            '@odata.type': '#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions',
            scope: {
                '@odata.type': '#microsoft.graph.identityGovernance.ruleBasedSubjectSet',
                rule: '(department eq \'Marketing\')'
            },
            trigger: {
                '@odata.type': '#microsoft.graph.identityGovernance.timeBasedAttributeTrigger',
                timeBasedAttribute: 'employeeHireDate',
                offsetInDays: 1
            }
        },
        tasks: [
            {
                continueOnError: false,
                description: 'Enable user account in the directory',
                displayName: 'Enable User Account',
                isEnabled: true,
                taskDefinitionId: '6fc52c9d-398b-4305-9763-15f42c1676fc',
                arguments: []
            },
            {
                continueOnError: false,
                description: 'Send welcome email to new hire',
                displayName: 'Send Welcome Email',
                isEnabled: true,
                taskDefinitionId: '70b29d51-b59a-4773-9280-8841dfd3f2ea',
                arguments: []
            }
        ]
    }
};

await client.api('/identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion')
	.post(workflow);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\IdentityGovernance\LifecycleWorkflows\Workflows\Item\MicrosoftGraphIdentityGovernanceCreateNewVersion\CreateNewVersionPostRequestBody;
use Microsoft\Graph\Generated\Models\IdentityGovernance\Workflow;
use Microsoft\Graph\Generated\Models\IdentityGovernance\LifecycleWorkflowCategory;
use Microsoft\Graph\Generated\Models\IdentityGovernance\TriggerAndScopeBasedConditions;
use Microsoft\Graph\Generated\Models\IdentityGovernance\RuleBasedSubjectSet;
use Microsoft\Graph\Generated\Models\IdentityGovernance\TimeBasedAttributeTrigger;
use Microsoft\Graph\Generated\Models\IdentityGovernance\WorkflowTriggerTimeBasedAttribute;
use Microsoft\Graph\Generated\Models\IdentityGovernance\Task;
use Microsoft\Graph\Generated\Models\KeyValuePair;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new CreateNewVersionPostRequestBody();
$workflow = new Workflow();
$workflow->setCategory(new LifecycleWorkflowCategory('joiner'));
$workflow->setDescription('Configure new hire tasks for onboarding employees on their first day');
$workflow->setDisplayName('Global onboard new hire employee');
$workflow->setIsEnabled(true);
$workflow->setIsSchedulingEnabled(false);
$workflowExecutionConditions = new TriggerAndScopeBasedConditions();
$workflowExecutionConditions->setOdataType('#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions');
$workflowExecutionConditionsScope = new RuleBasedSubjectSet();
$workflowExecutionConditionsScope->setOdataType('#microsoft.graph.identityGovernance.ruleBasedSubjectSet');
$workflowExecutionConditionsScope->setRule('(department eq \'Marketing\')');
$workflowExecutionConditions->setScope($workflowExecutionConditionsScope);
$workflowExecutionConditionsTrigger = new TimeBasedAttributeTrigger();
$workflowExecutionConditionsTrigger->setOdataType('#microsoft.graph.identityGovernance.timeBasedAttributeTrigger');
$workflowExecutionConditionsTrigger->setTimeBasedAttribute(new WorkflowTriggerTimeBasedAttribute('employeeHireDate'));
$workflowExecutionConditionsTrigger->setOffsetInDays(1);
$workflowExecutionConditions->setTrigger($workflowExecutionConditionsTrigger);
$workflow->setExecutionConditions($workflowExecutionConditions);
$tasksTask1 = new Task();
$tasksTask1->setContinueOnError(false);
$tasksTask1->setDescription('Enable user account in the directory');
$tasksTask1->setDisplayName('Enable User Account');
$tasksTask1->setIsEnabled(true);
$tasksTask1->setTaskDefinitionId('6fc52c9d-398b-4305-9763-15f42c1676fc');
$tasksTask1->setArguments([	]);
$tasksArray []= $tasksTask1;
$tasksTask2 = new Task();
$tasksTask2->setContinueOnError(false);
$tasksTask2->setDescription('Send welcome email to new hire');
$tasksTask2->setDisplayName('Send Welcome Email');
$tasksTask2->setIsEnabled(true);
$tasksTask2->setTaskDefinitionId('70b29d51-b59a-4773-9280-8841dfd3f2ea');
$tasksTask2->setArguments([	]);
$tasksArray []= $tasksTask2;
$workflow->setTasks($tasksArray);

$requestBody->setWorkflow($workflow);

$result = $graphServiceClient->identityGovernance()->lifecycleWorkflows()->workflows()->byWorkflowId('workflow-id')->microsoftGraphIdentityGovernanceCreateNewVersion()->post($requestBody)->wait();


Import-Module Microsoft.Graph.Identity.Governance

$params = @{
	workflow = @{
		category = "joiner"
		description = "Configure new hire tasks for onboarding employees on their first day"
		displayName = "Global onboard new hire employee"
		isEnabled = $true
		isSchedulingEnabled = $false
		executionConditions = @{
			"@odata.type" = "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions"
			scope = @{
				"@odata.type" = "#microsoft.graph.identityGovernance.ruleBasedSubjectSet"
				rule = "(department eq 'Marketing')"
			}
			trigger = @{
				"@odata.type" = "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger"
				timeBasedAttribute = "employeeHireDate"
				offsetInDays = 
			}
		}
		tasks = @(
			@{
				continueOnError = $false
				description = "Enable user account in the directory"
				displayName = "Enable User Account"
				isEnabled = $true
				taskDefinitionId = "6fc52c9d-398b-4305-9763-15f42c1676fc"
				arguments = @(
				)
			}
			@{
				continueOnError = $false
				description = "Send welcome email to new hire"
				displayName = "Send Welcome Email"
				isEnabled = $true
				taskDefinitionId = "70b29d51-b59a-4773-9280-8841dfd3f2ea"
				arguments = @(
				)
			}
		)
	}
}

New-MgIdentityGovernanceLifecycleWorkflowNewVersion -WorkflowId $workflowId -BodyParameter $params


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.identitygovernance.lifecycleworkflows.workflows.item.microsoft_graph_identity_governance_create_new_version.create_new_version_post_request_body import CreateNewVersionPostRequestBody
from msgraph.generated.models.identity_governance.workflow import Workflow
from msgraph.generated.models.lifecycle_workflow_category import LifecycleWorkflowCategory
from msgraph.generated.models.identity_governance.trigger_and_scope_based_conditions import TriggerAndScopeBasedConditions
from msgraph.generated.models.identity_governance.rule_based_subject_set import RuleBasedSubjectSet
from msgraph.generated.models.identity_governance.time_based_attribute_trigger import TimeBasedAttributeTrigger
from msgraph.generated.models.workflow_trigger_time_based_attribute import WorkflowTriggerTimeBasedAttribute
from msgraph.generated.models.identity_governance.task import Task
from msgraph.generated.models.key_value_pair import KeyValuePair
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CreateNewVersionPostRequestBody(
	workflow = Workflow(
		category = LifecycleWorkflowCategory.Joiner,
		description = "Configure new hire tasks for onboarding employees on their first day",
		display_name = "Global onboard new hire employee",
		is_enabled = True,
		is_scheduling_enabled = False,
		execution_conditions = TriggerAndScopeBasedConditions(
			odata_type = "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
			scope = RuleBasedSubjectSet(
				odata_type = "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
				rule = "(department eq 'Marketing')",
			),
			trigger = TimeBasedAttributeTrigger(
				odata_type = "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
				time_based_attribute = WorkflowTriggerTimeBasedAttribute.EmployeeHireDate,
				offset_in_days = 1,
			),
		),
		tasks = [
			Task(
				continue_on_error = False,
				description = "Enable user account in the directory",
				display_name = "Enable User Account",
				is_enabled = True,
				task_definition_id = "6fc52c9d-398b-4305-9763-15f42c1676fc",
				arguments = [
				],
			),
			Task(
				continue_on_error = False,
				description = "Send welcome email to new hire",
				display_name = "Send Welcome Email",
				is_enabled = True,
				task_definition_id = "70b29d51-b59a-4773-9280-8841dfd3f2ea",
				arguments = [
				],
			),
		],
	),
)

result = await graph_client.identity_governance.lifecycle_workflows.workflows.by_workflow_id('workflow-id').microsoft_graph_identity_governance_create_new_version.post(request_body)

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-Type: application/json


{
    "workflow":{
        "category": "joiner",
        "description": "Configure new hire tasks for onboarding employees on their first day",
        "displayName": "Global onboard new hire employee",
        "isEnabled": true,
        "isSchedulingEnabled": false,
        "executionConditions": {
            "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
            "scope": {
                "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
                "rule": "(department eq 'Marketing')"
            },
            "trigger": {
                "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
                "timeBasedAttribute": "employeeHireDate",
                "offsetInDays": 1
            }
        },
        "tasks": [
            {
                "continueOnError": false,
                "description": "Enable user account in the directory",
                "displayName": "Enable User Account",
                "isEnabled": true,
                "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
                "arguments": []
            },
            {
                "continueOnError": false,
                "description": "Send welcome email to new hire",
                "displayName": "Send Welcome Email",
                "isEnabled": true,
                "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
                "arguments": []
            }
        ]
    }
}

Exemple 2 : Créer une nouvelle version d’une tâche avec un e-mail personnalisé

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion
Content-Type: application/json
Content-length: 631

{
    "category": "joiner",
    "description": "Configure new hire tasks for onboarding employees on their first day",
    "displayName": "custom email marketing API test",
    "isEnabled": true,
    "isSchedulingEnabled": false,
    "executionConditions": {
        "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
        "scope": {
            "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
            "rule": "(department eq 'Marketing')"
        },
        "trigger": {
            "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
            "timeBasedAttribute": "employeeHireDate",
            "offsetInDays": 0
        }
    },
    "tasks": [
        {
            "continueOnError": false,
            "description": "Enable user account in the directory",
            "displayName": "Enable User Account",
            "isEnabled": true,
            "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
            "arguments": []
        },
        {
            "continueOnError": false,
            "description": "Send welcome email to new hire",
            "displayName": "Send Welcome Email",
            "isEnabled": true,
            "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
            "arguments": [
                {
                    "name": "cc",
                    "value": "1baa57fa-3c4e-4526-ba5a-db47a9df95f0"
                },
                {
                    "name": "customSubject",
                    "value": "Welcome to the organization {{userDisplayName}}!"
                },
                {
                    "name": "customBody",
                    "value": "Welcome to our organization {{userGivenName}}!"
                },
                {
                    "name": "locale",
                    "value": "en-us"
                }
            ]
        }
    ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.IdentityGovernance.LifecycleWorkflows.Workflows.Item.MicrosoftGraphIdentityGovernanceCreateNewVersion;
using Microsoft.Graph.Models.IdentityGovernance;
using Microsoft.Kiota.Abstractions.Serialization;

var requestBody = new CreateNewVersionPostRequestBody
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"category" , "joiner"
		},
		{
			"description" , "Configure new hire tasks for onboarding employees on their first day"
		},
		{
			"displayName" , "custom email marketing API test"
		},
		{
			"isEnabled" , true
		},
		{
			"isSchedulingEnabled" , false
		},
		{
			"executionConditions" , new TriggerAndScopeBasedConditions
			{
				OdataType = "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
				Scope = new RuleBasedSubjectSet
				{
					OdataType = "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
					Rule = "(department eq 'Marketing')",
				},
				Trigger = new TimeBasedAttributeTrigger
				{
					OdataType = "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
					TimeBasedAttribute = WorkflowTriggerTimeBasedAttribute.EmployeeHireDate,
					OffsetInDays = 0,
				},
			}
		},
		{
			"tasks" , new List<object>
			{
				new UntypedObject(new Dictionary<string, UntypedNode>
				{
					{
						"continueOnError", new UntypedBoolean(false)
					},
					{
						"description", new UntypedString("Enable user account in the directory")
					},
					{
						"displayName", new UntypedString("Enable User Account")
					},
					{
						"isEnabled", new UntypedBoolean(true)
					},
					{
						"taskDefinitionId", new UntypedString("6fc52c9d-398b-4305-9763-15f42c1676fc")
					},
					{
						"arguments", new UntypedArray(new List<UntypedNode>
						{
						})
					},
				}),
				new UntypedObject(new Dictionary<string, UntypedNode>
				{
					{
						"continueOnError", new UntypedBoolean(false)
					},
					{
						"description", new UntypedString("Send welcome email to new hire")
					},
					{
						"displayName", new UntypedString("Send Welcome Email")
					},
					{
						"isEnabled", new UntypedBoolean(true)
					},
					{
						"taskDefinitionId", new UntypedString("70b29d51-b59a-4773-9280-8841dfd3f2ea")
					},
					{
						"arguments", new UntypedArray(new List<UntypedNode>
						{
							new UntypedObject(new Dictionary<string, UntypedNode>
							{
								{
									"name", new UntypedString("cc")
								},
								{
									"value", new UntypedString("1baa57fa-3c4e-4526-ba5a-db47a9df95f0")
								},
							}),
							new UntypedObject(new Dictionary<string, UntypedNode>
							{
								{
									"name", new UntypedString("customSubject")
								},
								{
									"value", new UntypedString("Welcome to the organization {{userDisplayName}}!")
								},
							}),
							new UntypedObject(new Dictionary<string, UntypedNode>
							{
								{
									"name", new UntypedString("customBody")
								},
								{
									"value", new UntypedString("Welcome to our organization {{userGivenName}}!")
								},
							}),
							new UntypedObject(new Dictionary<string, UntypedNode>
							{
								{
									"name", new UntypedString("locale")
								},
								{
									"value", new UntypedString("en-us")
								},
							}),
						})
					},
				}),
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.IdentityGovernance.LifecycleWorkflows.Workflows["{workflow-id}"].MicrosoftGraphIdentityGovernanceCreateNewVersion.PostAsync(requestBody);



mgc identity-governance lifecycle-workflows workflows microsoft-graph-identity-governance-create-new-version post --workflow-id {workflow-id} --body '{\
    "category": "joiner",\
    "description": "Configure new hire tasks for onboarding employees on their first day",\
    "displayName": "custom email marketing API test",\
    "isEnabled": true,\
    "isSchedulingEnabled": false,\
    "executionConditions": {\
        "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",\
        "scope": {\
            "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",\
            "rule": "(department eq 'Marketing')"\
        },\
        "trigger": {\
            "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",\
            "timeBasedAttribute": "employeeHireDate",\
            "offsetInDays": 0\
        }\
    },\
    "tasks": [\
        {\
            "continueOnError": false,\
            "description": "Enable user account in the directory",\
            "displayName": "Enable User Account",\
            "isEnabled": true,\
            "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",\
            "arguments": []\
        },\
        {\
            "continueOnError": false,\
            "description": "Send welcome email to new hire",\
            "displayName": "Send Welcome Email",\
            "isEnabled": true,\
            "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",\
            "arguments": [\
                {\
                    "name": "cc",\
                    "value": "1baa57fa-3c4e-4526-ba5a-db47a9df95f0"\
                },\
                {\
                    "name": "customSubject",\
                    "value": "Welcome to the organization {{userDisplayName}}!"\
                },\
                {\
                    "name": "customBody",\
                    "value": "Welcome to our organization {{userGivenName}}!"\
                },\
                {\
                    "name": "locale",\
                    "value": "en-us"\
                }\
            ]\
        }\
    ]\
}\
\
'

Snippet not available


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecreatenewversion.CreateNewVersionPostRequestBody createNewVersionPostRequestBody = new com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecreatenewversion.CreateNewVersionPostRequestBody();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("category", "joiner");
additionalData.put("description", "Configure new hire tasks for onboarding employees on their first day");
additionalData.put("displayName", "custom email marketing API test");
additionalData.put("isEnabled", true);
additionalData.put("isSchedulingEnabled", false);
com.microsoft.graph.models.identitygovernance.TriggerAndScopeBasedConditions executionConditions = new com.microsoft.graph.models.identitygovernance.TriggerAndScopeBasedConditions();
executionConditions.setOdataType("#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions");
com.microsoft.graph.models.identitygovernance.RuleBasedSubjectSet scope = new com.microsoft.graph.models.identitygovernance.RuleBasedSubjectSet();
scope.setOdataType("#microsoft.graph.identityGovernance.ruleBasedSubjectSet");
scope.setRule("(department eq 'Marketing')");
executionConditions.setScope(scope);
com.microsoft.graph.models.identitygovernance.TimeBasedAttributeTrigger trigger = new com.microsoft.graph.models.identitygovernance.TimeBasedAttributeTrigger();
trigger.setOdataType("#microsoft.graph.identityGovernance.timeBasedAttributeTrigger");
trigger.setTimeBasedAttribute(com.microsoft.graph.models.identitygovernance.WorkflowTriggerTimeBasedAttribute.EmployeeHireDate);
trigger.setOffsetInDays(0);
executionConditions.setTrigger(trigger);
additionalData.put("executionConditions", executionConditions);
LinkedList<Object> tasks = new LinkedList<Object>();
 property = new ();
property.setContinueOnError(false);
property.setDescription("Enable user account in the directory");
property.setDisplayName("Enable User Account");
property.setIsEnabled(true);
property.setTaskDefinitionId("6fc52c9d-398b-4305-9763-15f42c1676fc");
LinkedList<Object> arguments = new LinkedList<Object>();
property.setArguments(arguments);
tasks.add(property);
 property1 = new ();
property1.setContinueOnError(false);
property1.setDescription("Send welcome email to new hire");
property1.setDisplayName("Send Welcome Email");
property1.setIsEnabled(true);
property1.setTaskDefinitionId("70b29d51-b59a-4773-9280-8841dfd3f2ea");
LinkedList<Object> arguments1 = new LinkedList<Object>();
 property2 = new ();
property2.setName("cc");
property2.setValue("1baa57fa-3c4e-4526-ba5a-db47a9df95f0");
arguments1.add(property2);
 property3 = new ();
property3.setName("customSubject");
property3.setValue("Welcome to the organization {{userDisplayName}}!");
arguments1.add(property3);
 property4 = new ();
property4.setName("customBody");
property4.setValue("Welcome to our organization {{userGivenName}}!");
arguments1.add(property4);
 property5 = new ();
property5.setName("locale");
property5.setValue("en-us");
arguments1.add(property5);
property1.setArguments(arguments1);
tasks.add(property1);
additionalData.put("tasks", tasks);
createNewVersionPostRequestBody.setAdditionalData(additionalData);
var result = graphClient.identityGovernance().lifecycleWorkflows().workflows().byWorkflowId("{workflow-id}").microsoftGraphIdentityGovernanceCreateNewVersion().post(createNewVersionPostRequestBody);


const options = {
	authProvider,
};

const client = Client.init(options);

const workflow = {
    category: 'joiner',
    description: 'Configure new hire tasks for onboarding employees on their first day',
    displayName: 'custom email marketing API test',
    isEnabled: true,
    isSchedulingEnabled: false,
    executionConditions: {
        '@odata.type': '#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions',
        scope: {
            '@odata.type': '#microsoft.graph.identityGovernance.ruleBasedSubjectSet',
            rule: '(department eq \'Marketing\')'
        },
        trigger: {
            '@odata.type': '#microsoft.graph.identityGovernance.timeBasedAttributeTrigger',
            timeBasedAttribute: 'employeeHireDate',
            offsetInDays: 0
        }
    },
    tasks: [
        {
            continueOnError: false,
            description: 'Enable user account in the directory',
            displayName: 'Enable User Account',
            isEnabled: true,
            taskDefinitionId: '6fc52c9d-398b-4305-9763-15f42c1676fc',
            arguments: []
        },
        {
            continueOnError: false,
            description: 'Send welcome email to new hire',
            displayName: 'Send Welcome Email',
            isEnabled: true,
            taskDefinitionId: '70b29d51-b59a-4773-9280-8841dfd3f2ea',
            arguments: [
                {
                    name: 'cc',
                    value: '1baa57fa-3c4e-4526-ba5a-db47a9df95f0'
                },
                {
                    name: 'customSubject',
                    value: 'Welcome to the organization {{userDisplayName}}!'
                },
                {
                    name: 'customBody',
                    value: 'Welcome to our organization {{userGivenName}}!'
                },
                {
                    name: 'locale',
                    value: 'en-us'
                }
            ]
        }
    ]
};

await client.api('/identityGovernance/lifecycleWorkflows/workflows/{workflowId}/createNewVersion')
	.post(workflow);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\IdentityGovernance\LifecycleWorkflows\Workflows\Item\MicrosoftGraphIdentityGovernanceCreateNewVersion\CreateNewVersionPostRequestBody;
use Microsoft\Graph\Generated\Models\IdentityGovernance\TriggerAndScopeBasedConditions;
use Microsoft\Graph\Generated\Models\IdentityGovernance\RuleBasedSubjectSet;
use Microsoft\Graph\Generated\Models\IdentityGovernance\TimeBasedAttributeTrigger;
use Microsoft\Graph\Generated\Models\IdentityGovernance\WorkflowTriggerTimeBasedAttribute;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new CreateNewVersionPostRequestBody();
$additionalData = [
	'category' => 'joiner',
	'description' => 'Configure new hire tasks for onboarding employees on their first day',
	'displayName' => 'custom email marketing API test',
	'isEnabled' => true,
	'isSchedulingEnabled' => false,
	'executionConditions' => [
		'@odata.type' => '#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions',
		'scope' => [
			'@odata.type' => '#microsoft.graph.identityGovernance.ruleBasedSubjectSet',
			'rule' => '(department eq \'Marketing\')',
		],
		'trigger' => [
			'@odata.type' => '#microsoft.graph.identityGovernance.timeBasedAttributeTrigger',
			'timeBasedAttribute' => new WorkflowTriggerTimeBasedAttribute('employeeHireDate'),
			'offsetInDays' => 0,
		],
	],
	'tasks' => [
			[
				'continueOnError' => false,
				'description' => 'Enable user account in the directory',
				'displayName' => 'Enable User Account',
				'isEnabled' => true,
				'taskDefinitionId' => '6fc52c9d-398b-4305-9763-15f42c1676fc',
				'arguments' => [],
			],
			[
				'continueOnError' => false,
				'description' => 'Send welcome email to new hire',
				'displayName' => 'Send Welcome Email',
				'isEnabled' => true,
				'taskDefinitionId' => '70b29d51-b59a-4773-9280-8841dfd3f2ea',
				'arguments' => [
						[
							'name' => 'cc',
							'value' => '1baa57fa-3c4e-4526-ba5a-db47a9df95f0',
						],
						[
							'name' => 'customSubject',
							'value' => 'Welcome to the organization {{userDisplayName}}!',
						],
						[
							'name' => 'customBody',
							'value' => 'Welcome to our organization {{userGivenName}}!',
						],
						[
							'name' => 'locale',
							'value' => 'en-us',
						],
					],
			],
		],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->identityGovernance()->lifecycleWorkflows()->workflows()->byWorkflowId('workflow-id')->microsoftGraphIdentityGovernanceCreateNewVersion()->post($requestBody)->wait();


Import-Module Microsoft.Graph.Identity.Governance

$params = @{
	category = "joiner"
	description = "Configure new hire tasks for onboarding employees on their first day"
	displayName = "custom email marketing API test"
	isEnabled = $true
	isSchedulingEnabled = $false
	executionConditions = @{
		"@odata.type" = "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions"
		scope = @{
			"@odata.type" = "#microsoft.graph.identityGovernance.ruleBasedSubjectSet"
			rule = "(department eq 'Marketing')"
		}
		trigger = @{
			"@odata.type" = "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger"
			timeBasedAttribute = "employeeHireDate"
			offsetInDays = 
		}
	}
	tasks = @(
		@{
			continueOnError = $false
			description = "Enable user account in the directory"
			displayName = "Enable User Account"
			isEnabled = $true
			taskDefinitionId = "6fc52c9d-398b-4305-9763-15f42c1676fc"
			arguments = @(
			)
		}
		@{
			continueOnError = $false
			description = "Send welcome email to new hire"
			displayName = "Send Welcome Email"
			isEnabled = $true
			taskDefinitionId = "70b29d51-b59a-4773-9280-8841dfd3f2ea"
			arguments = @(
				@{
					name = "cc"
					value = "1baa57fa-3c4e-4526-ba5a-db47a9df95f0"
				}
				@{
					name = "customSubject"
					value = "Welcome to the organization {{userDisplayName}}!"
				}
				@{
					name = "customBody"
					value = "Welcome to our organization {{userGivenName}}!"
				}
				@{
					name = "locale"
					value = "en-us"
				}
			)
		}
	)
}

New-MgIdentityGovernanceLifecycleWorkflowNewVersion -WorkflowId $workflowId -BodyParameter $params


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.identitygovernance.lifecycleworkflows.workflows.item.microsoft_graph_identity_governance_create_new_version.create_new_version_post_request_body import CreateNewVersionPostRequestBody
from msgraph.generated.models.identity_governance.trigger_and_scope_based_conditions import TriggerAndScopeBasedConditions
from msgraph.generated.models.identity_governance.rule_based_subject_set import RuleBasedSubjectSet
from msgraph.generated.models.identity_governance.time_based_attribute_trigger import TimeBasedAttributeTrigger
from msgraph.generated.models.workflow_trigger_time_based_attribute import WorkflowTriggerTimeBasedAttribute
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CreateNewVersionPostRequestBody(
	additional_data = {
			"category" : "joiner",
			"description" : "Configure new hire tasks for onboarding employees on their first day",
			"display_name" : "custom email marketing API test",
			"is_enabled" : True,
			"is_scheduling_enabled" : False,
			"execution_conditions" : {
					"@odata_type" : "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
					"scope" : {
							"@odata_type" : "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
							"rule" : "(department eq 'Marketing')",
					},
					"trigger" : {
							"@odata_type" : "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
							"time_based_attribute" : WorkflowTriggerTimeBasedAttribute.EmployeeHireDate,
							"offset_in_days" : 0,
					},
			},
			"tasks" : [
				{
						"continue_on_error" : False,
						"description" : "Enable user account in the directory",
						"display_name" : "Enable User Account",
						"is_enabled" : True,
						"task_definition_id" : "6fc52c9d-398b-4305-9763-15f42c1676fc",
						"arguments" : [
						],
				},
				{
						"continue_on_error" : False,
						"description" : "Send welcome email to new hire",
						"display_name" : "Send Welcome Email",
						"is_enabled" : True,
						"task_definition_id" : "70b29d51-b59a-4773-9280-8841dfd3f2ea",
						"arguments" : [
							{
									"name" : "cc",
									"value" : "1baa57fa-3c4e-4526-ba5a-db47a9df95f0",
							},
							{
									"name" : "customSubject",
									"value" : "Welcome to the organization {{userDisplayName}}!",
							},
							{
									"name" : "customBody",
									"value" : "Welcome to our organization {{userGivenName}}!",
							},
							{
									"name" : "locale",
									"value" : "en-us",
							},
						],
				},
			],
	}
)

result = await graph_client.identity_governance.lifecycle_workflows.workflows.by_workflow_id('workflow-id').microsoft_graph_identity_governance_create_new_version.post(request_body)

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "workflow":{
        "category": "joiner",
        "description": "Configure new hire tasks for onboarding employees on their first day",
        "displayName": "Global onboard new hire employee",
        "isEnabled": true,
        "isSchedulingEnabled": false,
        "executionConditions": {
            "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
            "scope": {
                "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
                "rule": "(department eq 'Marketing')"
            },
            "trigger": {
                "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
                "timeBasedAttribute": "employeeHireDate",
                "offsetInDays": 1
            }
        },
        "tasks": [
            {
                "continueOnError": false,
                "description": "Enable user account in the directory",
                "displayName": "Enable User Account",
                "isEnabled": true,
                "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
                "arguments": []
            },
            {
                "continueOnError": false,
                "description": "Send welcome email to new hire",
                "displayName": "Send Welcome Email",
                "isEnabled": true,
                "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
                "arguments": [
                    {
                    "name": "cc",
                    "value": "b47471b9-af8f-4a5a-bfa2-b78e82398f6e, a7a23ce0-909b-40b9-82cf-95d31f0aaca2"
                },
                {
                "name": "customSubject",
                "value": "Welcome to the organization {{userDisplayName}}!"
                },
                {
                "name": "customBody",
                "value": "Welcome to our organization {{userGivenName}} {{userSurname}}. \nFor more information, reach out to your manager {{managerDisplayName}} at {{managerEmail}}."
                },
                {
                "name": "locale",
                "value": "en-us"
                }, 
    ]
            }
        ]
    }
}

Partager via

workflow : createNewVersion

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemples

Exemple 1 : Créer une nouvelle version d’un workflow

Demande

Réponse

Exemple 2 : Créer une nouvelle version d’une tâche avec un e-mail personnalisé

Demande

Réponse

Commentaires

Ressources supplémentaires