Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph.identityGovernance
Create a new lifecyclePolicy object in the lifecycle workflows container. A policy is created for a specific subject type and takes effect according to its priority order.
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.
Agent identity policies
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | LifecyclePolicies-AgentId.ReadWrite.All | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | LifecyclePolicies-AgentId.ReadWrite.All | Not available. |
Guest policies
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | LifecyclePolicies-Guests.ReadWrite.All | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | LifecyclePolicies-Guests.ReadWrite.All | Not available. |
Important
For guest lifecycle policy writes, delegated access requires both the LifecyclePolicies-Guests.ReadWrite.All scope and a supported Microsoft Entra role. Lifecycle Workflows Administrator is the least privileged role supported for this operation. Scope alone or role alone is insufficient.
Application access requires the LifecyclePolicies-Guests.ReadWrite.All application permission, without an additional user directory-role requirement. These requirements apply to creating, updating, deleting, restoring, and permanently deleting guest policies, and to changing guest policy priority. They don't describe authorization for agent policies or guest user attestation.
Note
Each permissions table applies only to its specified policy subject type. Agent identity policy permissions and guest policy permissions are not interchangeable.
HTTP request
POST /identityGovernance/lifecycleWorkflows/lifecyclePolicies
Request headers
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the microsoft.graph.identityGovernance.lifecyclePolicy object. Because lifecyclePolicy is an abstract type, specify the @odata.type of a derived type, such as #microsoft.graph.identityGovernance.agentIdentityLifecyclePolicy.
You can specify the following properties when creating a lifecyclePolicy.
| Property | Type | Description |
|---|---|---|
| description | String | A description for the policy. Optional. |
| displayName | String | The display name for the policy. Required. |
| enforcementAction | microsoft.graph.identityGovernance.lifecyclePolicyEnforcementAction | The action taken against identities that fail to meet the policy's rules. This polymorphic type has the derived types disableOnlyEnforcementAction, deleteOnlyEnforcementAction, and disableThenDeleteEnforcementAction. Required. |
| isEnabled | Boolean | Indicates whether the policy is enabled and evaluated. Required. |
| gracePeriodInDays | Int32 | The policy-level grace period before enforcement. A rule-level value overrides this value for that rule. Optional. |
| notificationSchedule | microsoft.graph.identityGovernance.lifecyclePolicyNotificationSettings | The notification schedule that determines when reminders are sent before enforcement. Optional. |
| rules | microsoft.graph.identityGovernance.lifecyclePolicyRule collection | The inline compliance rules evaluated with AND logic. Each rule specifies its own @odata.type, such as #microsoft.graph.identityGovernance.periodicAttestationRule. A maximum of 10 rules are allowed per policy. Optional. |
| scope | microsoft.graph.subjectSet | The set of identities the policy applies to. Supports scope types such as selectedObjectsSubjectSet, allExcludingSpecificObjectsSubjectSet, and allExcludingGroupsSubjectSet. Optional. |
Response
If successful, this method returns a 201 Created response code and a microsoft.graph.identityGovernance.lifecyclePolicy object in the response body.
Errors
This method returns a 400 Bad Request response code with one of the following error codes when a tenant limit is exceeded:
| Error code | Description |
|---|---|
lifecyclePoliciesPerSubjectLimitExceeded |
A maximum of 10 lifecycle policies are allowed per subject type per tenant. |
lifecyclePolicyRulesLimitExceeded |
A maximum of 10 rules are allowed per lifecycle policy. |
lifecyclePolicyExcludedGroupsLimitExceeded |
A maximum of 10 excluded groups are allowed per lifecycle policy. |
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/lifecyclePolicies
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.identityGovernance.agentIdentityLifecyclePolicy",
"displayName": "Agent attestation with sponsor requirement",
"description": "Requires attestation every 90 days and at least 1 sponsor",
"isEnabled": true,
"enforcementAction": {
"@odata.type": "#microsoft.graph.identityGovernance.disableThenDeleteEnforcementAction",
"deletionGracePeriodInDays": 30
},
"scope": null,
"rules": [
{
"@odata.type": "#microsoft.graph.identityGovernance.periodicAttestationRule",
"isEnabled": true,
"attestationIntervalInDays": 90
},
{
"@odata.type": "#microsoft.graph.identityGovernance.sponsorPresenceRule",
"isEnabled": true,
"minimumSponsorCount": 1
}
],
"notificationSchedule": {
"@odata.type": "#microsoft.graph.identityGovernance.lifecyclePolicyNotificationSettings",
"additionalFallbackRecipients": ["admins@contoso.com"],
"offsetsAfterNonComplianceInDays": [14, 7, 1]
}
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.identityGovernance.agentIdentityLifecyclePolicy",
"id": "ba9191ab-e88f-4278-942c-4dcc6a4f05b1",
"displayName": "Agent attestation with sponsor requirement",
"description": "Requires attestation every 90 days and at least 1 sponsor",
"policySource": "userCreated",
"isEnabled": true,
"scope": null,
"versionNumber": 1,
"enforcementAction": {
"@odata.type": "#microsoft.graph.identityGovernance.disableThenDeleteEnforcementAction",
"deletionGracePeriodInDays": 30
},
"rules": [
{
"@odata.type": "#microsoft.graph.identityGovernance.periodicAttestationRule",
"isEnabled": true,
"attestationIntervalInDays": 90
},
{
"@odata.type": "#microsoft.graph.identityGovernance.sponsorPresenceRule",
"isEnabled": true,
"minimumSponsorCount": 1
}
],
"notificationSchedule": {
"@odata.type": "#microsoft.graph.identityGovernance.lifecyclePolicyNotificationSettings",
"additionalFallbackRecipients": ["admins@contoso.com"],
"offsetsAfterNonComplianceInDays": [14, 7, 1]
}
}