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.
Update the properties of a lifecycleManagementSettings object.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type |
Least privileged permissions |
Higher privileged permissions |
Delegated (work or school account) |
LifecycleWorkflows.ReadWrite.All |
Not available. |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
LifecycleWorkflows.ReadWrite.All |
Not available. |
Important
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Lifecycle Workflows Administrator is the least privileged role supported for this operation.
HTTP request
PATCH /identityGovernance/lifecycleWorkflows/settings
Request body
In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
Property |
Type |
Description |
workflowScheduleIntervalInHours |
Int32 |
The workflow schedule interval. Required. |
emailSettings |
microsoft.graph.emailSettings |
The settings for emails sent from email-specific tasks within a workflow. Required. |
Response
If successful, this action returns a 204 No Content
response code.
Examples
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/settings
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",
"workflowScheduleIntervalInHours": 3,
"emailSettings": {
"senderDomain": "ContosoIndustries.net",
"useCompanyBranding": true
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.IdentityGovernance;
using Microsoft.Graph.Beta.Models;
var requestBody = new LifecycleManagementSettings
{
WorkflowScheduleIntervalInHours = 3,
EmailSettings = new EmailSettings
{
SenderDomain = "ContosoIndustries.net",
UseCompanyBranding = true,
},
AdditionalData = new Dictionary<string, object>
{
{
"@odata.context" , "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity"
},
},
};
// 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.Settings.PatchAsync(requestBody);
mgc-beta identity-governance lifecycle-workflows settings patch --body '{\
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",\
"workflowScheduleIntervalInHours": 3,\
"emailSettings": {\
"senderDomain": "ContosoIndustries.net",\
"useCompanyBranding": true\
}\
}\
'
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelsidentitygovernance "github.com/microsoftgraph/msgraph-beta-sdk-go/models/identitygovernance"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodelsidentitygovernance.NewLifecycleManagementSettings()
workflowScheduleIntervalInHours := int32(3)
requestBody.SetWorkflowScheduleIntervalInHours(&workflowScheduleIntervalInHours)
emailSettings := graphmodels.NewEmailSettings()
senderDomain := "ContosoIndustries.net"
emailSettings.SetSenderDomain(&senderDomain)
useCompanyBranding := true
emailSettings.SetUseCompanyBranding(&useCompanyBranding)
requestBody.SetEmailSettings(emailSettings)
additionalData := map[string]interface{}{
"@odata.context" : "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",
}
requestBody.SetAdditionalData(additionalData)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
settings, err := graphClient.IdentityGovernance().LifecycleWorkflows().Settings().Patch(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.beta.models.identitygovernance.LifecycleManagementSettings lifecycleManagementSettings = new com.microsoft.graph.beta.models.identitygovernance.LifecycleManagementSettings();
lifecycleManagementSettings.setWorkflowScheduleIntervalInHours(3);
EmailSettings emailSettings = new EmailSettings();
emailSettings.setSenderDomain("ContosoIndustries.net");
emailSettings.setUseCompanyBranding(true);
lifecycleManagementSettings.setEmailSettings(emailSettings);
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("@odata.context", "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity");
lifecycleManagementSettings.setAdditionalData(additionalData);
com.microsoft.graph.models.identitygovernance.LifecycleManagementSettings result = graphClient.identityGovernance().lifecycleWorkflows().settings().patch(lifecycleManagementSettings);
const options = {
authProvider,
};
const client = Client.init(options);
const lifecycleManagementSettings = {
'@odata.context': 'https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity',
workflowScheduleIntervalInHours: 3,
emailSettings: {
senderDomain: 'ContosoIndustries.net',
useCompanyBranding: true
}
};
await client.api('/identityGovernance/lifecycleWorkflows/settings')
.version('beta')
.update(lifecycleManagementSettings);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\IdentityGovernance\LifecycleManagementSettings;
use Microsoft\Graph\Beta\Generated\Models\EmailSettings;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new LifecycleManagementSettings();
$requestBody->setWorkflowScheduleIntervalInHours(3);
$emailSettings = new EmailSettings();
$emailSettings->setSenderDomain('ContosoIndustries.net');
$emailSettings->setUseCompanyBranding(true);
$requestBody->setEmailSettings($emailSettings);
$additionalData = [
'@odata.context' => 'https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity',
];
$requestBody->setAdditionalData($additionalData);
$result = $graphServiceClient->identityGovernance()->lifecycleWorkflows()->settings()->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.Governance
$params = @{
"@odata.context" = "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity"
workflowScheduleIntervalInHours = 3
emailSettings = @{
senderDomain = "ContosoIndustries.net"
useCompanyBranding = $true
}
}
Update-MgBetaIdentityGovernanceLifecycleWorkflowSetting -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.identity_governance.lifecycle_management_settings import LifecycleManagementSettings
from msgraph_beta.generated.models.email_settings import EmailSettings
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = LifecycleManagementSettings(
workflow_schedule_interval_in_hours = 3,
email_settings = EmailSettings(
sender_domain = "ContosoIndustries.net",
use_company_branding = True,
),
additional_data = {
"@odata_context" : "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/settings/$entity",
}
)
result = await graph_client.identity_governance.lifecycle_workflows.settings.patch(request_body)
Response
HTTP/1.1 204 No Content