Edit

agentIdentityLifecyclePolicy resource type

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.

Represents a lifecycle policy that governs the lifecycle of agent identities through compliance rules and enforcement actions.

Inherits from lifecyclePolicy.

Methods

For the list of operations, see the methods of the lifecyclePolicy base type.

Properties

Property Type Description
createdDateTime DateTimeOffset The date and time when the policy was created. Inherited from lifecyclePolicy.
description String The description of the policy. Inherited from lifecyclePolicy.
displayName String The display name of the policy. Inherited from lifecyclePolicy.
enforcementAction microsoft.graph.identityGovernance.lifecyclePolicyEnforcementAction The action taken when an agent identity governed by the policy becomes non-compliant. Inherited from lifecyclePolicy.
gracePeriodInDays Int32 The number of days after an identity becomes non-compliant before the enforcement action is applied. Inherited from lifecyclePolicy.
id String The unique identifier for the policy. Inherited from entity.
isEnabled Boolean Indicates whether the policy is enabled and actively evaluated. Inherited from lifecyclePolicy.
lastModifiedDateTime DateTimeOffset The date and time when the policy was last modified. Inherited from lifecyclePolicy.
notificationSchedule microsoft.graph.identityGovernance.lifecyclePolicyNotificationSettings The notification settings for the policy, including the offsets, in days after non-compliance, at which notifications are sent. Inherited from lifecyclePolicy.
policySource microsoft.graph.identityGovernance.lifecyclePolicySource Indicates whether the policy is system-managed (a built-in default) or created by an administrator. Inherited from lifecyclePolicy. The possible values are: userCreated, systemDefault, unknownFutureValue.
scope subjectSet The set of agent identities that the policy applies to. Inherited from lifecyclePolicy.
versionNumber Int32 The version number of the policy, which increments each time the policy is updated. Inherited from lifecyclePolicy.

Relationships

Relationship Type Description
createdBy directoryObject The user or service principal that created the policy. Inherited from lifecyclePolicy.
lastModifiedBy directoryObject The user or service principal that last modified the policy. Inherited from lifecyclePolicy.
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. Inherited from lifecyclePolicy.
versions microsoft.graph.identityGovernance.lifecyclePolicy collection The collection of previous versions of the policy. Inherited from lifecyclePolicy.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.identityGovernance.agentIdentityLifecyclePolicy",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "enforcementAction": {
    "@odata.type": "microsoft.graph.identityGovernance.lifecyclePolicyEnforcementAction"
  },
  "gracePeriodInDays": "Integer",
  "id": "String (identifier)",
  "isEnabled": "Boolean",
  "lastModifiedDateTime": "String (timestamp)",
  "notificationSchedule": {
    "@odata.type": "microsoft.graph.identityGovernance.lifecyclePolicyNotificationSettings"
  },
  "policySource": "String",
  "scope": {
    "@odata.type": "microsoft.graph.subjectSet"
  },
  "versionNumber": "Integer"
}