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
Represents the abstract base type for lifecycle policies that govern identities by evaluating compliance rules and applying enforcement actions when an identity becomes non-compliant. A maximum of 10 policies are allowed per subject type per tenant.
You can't create instances of this abstract type directly. Instead, use one of the following derived types:
Instances are differentiated by the @odata.type property.
Inherits from entity.
Methods
| Method | Return type | Description |
|---|---|---|
| List | microsoft.graph.identityGovernance.lifecyclePolicy collection | Get lifecycle policies. |
| Create | microsoft.graph.identityGovernance.lifecyclePolicy | Create a lifecycle policy of a concrete derived type. |
| List versions | microsoft.graph.identityGovernance.lifecyclePolicy collection | Get the read-only version history of a lifecycle policy. |
| List lifecyclePolicies | microsoft.graph.identityGovernance.lifecyclePolicy collection | Get soft-deleted lifecycle policies. |
| Get | microsoft.graph.identityGovernance.lifecyclePolicy | Read the properties and relationships of lifecyclePolicy object. |
| Update | None | Update the properties of a lifecyclePolicy object. |
| Delete | None | Delete a lifecyclePolicy object. |
| lifecyclePolicy: restore | microsoft.graph.identityGovernance.lifecyclePolicy | Restore a soft-deleted lifecyclePolicy object. |
| Get report | microsoft.graph.identityGovernance.lifecyclePolicyReport | Read the latest processing report for the policy. |
Properties
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time when the policy was created. |
| description | String | The description of the policy. |
| displayName | String | The display name of the policy. |
| enforcementAction | microsoft.graph.identityGovernance.lifecyclePolicyEnforcementAction | The action taken when an identity governed by the policy becomes non-compliant. This is a polymorphic type; the possible types are deleteOnlyEnforcementAction, disableOnlyEnforcementAction, and disableThenDeleteEnforcementAction. |
| gracePeriodInDays | Int32 | The number of days after an identity becomes non-compliant before the enforcement action is applied. |
| id | String | The unique identifier for the policy. Inherited from entity. |
| isEnabled | Boolean | Indicates whether the policy is enabled and actively evaluated. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the policy was last modified. |
| notificationSchedule | microsoft.graph.identityGovernance.lifecyclePolicyNotificationSettings | The notification settings for the policy, including the offsets, in days after non-compliance, at which notifications are sent. |
| policySource | microsoft.graph.identityGovernance.lifecyclePolicySource | Indicates whether the policy is system-managed (a built-in default) or created by an administrator. The possible values are: userCreated, systemDefault, unknownFutureValue. |
| scope | subjectSet | The set of subjects that the policy applies to. For example, use an allExcludingGroupsSubjectSet to exclude specific groups from evaluation. |
| versionNumber | Int32 | The version number of the policy, which increments each time the policy is updated. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| createdBy | directoryObject | The user or service principal that created the policy. |
| lastModifiedBy | directoryObject | The user or service principal that last modified the policy. |
| report | microsoft.graph.identityGovernance.lifecyclePolicyReport | The latest processing report for the policy. |
| rules | microsoft.graph.identityGovernance.lifecyclePolicyRule collection | The collection of inline compliance rules evaluated for the policy. Rules are combined with AND logic. A maximum of 10 rules are allowed per policy. |
| versions | microsoft.graph.identityGovernance.lifecyclePolicy collection | The collection of previous versions of the policy. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.identityGovernance.lifecyclePolicy",
"id": "String (identifier)",
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"isEnabled": "Boolean",
"lastModifiedDateTime": "String (timestamp)",
"scope": {
"@odata.type": "microsoft.graph.subjectSet"
},
"versionNumber": "Int32",
"policySource": "String",
"gracePeriodInDays": "Int32",
"enforcementAction": {
"@odata.type": "microsoft.graph.identityGovernance.lifecyclePolicyEnforcementAction"
},
"notificationSchedule": {
"@odata.type": "microsoft.graph.identityGovernance.lifecyclePolicyNotificationSettings"
}
}