Edit

guestLifecyclePolicy 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 guest users in an organization. Inherits from microsoft.graph.identityGovernance.lifecyclePolicy.

Methods

This resource is part of a polymorphic collection managed by the lifecyclePolicy resource base type. Operations are performed through the base type endpoints.

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 applied when a guest user governed by the policy becomes noncompliant. Inherited from lifecyclePolicy.
gracePeriodInDays Int32 The number of days 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. 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 schedule for noncompliant guest users. Inherited from lifecyclePolicy.
policySource microsoft.graph.identityGovernance.lifecyclePolicySource Indicates whether the policy is system-managed or user-created. The possible values are: userCreated, systemDefault, unknownFutureValue. Inherited from lifecyclePolicy.
scope microsoft.graph.subjectSet The guest users included in the policy. Inherited from lifecyclePolicy.
versionNumber Int32 The version number of the policy. 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.
report microsoft.graph.identityGovernance.lifecyclePolicyReport The latest processing report for the policy.
rules microsoft.graph.identityGovernance.lifecyclePolicyRule collection The compliance rules evaluated by the policy. Inherited from lifecyclePolicy.
versions microsoft.graph.identityGovernance.lifecyclePolicy collection The previous versions of the policy. Inherited from lifecyclePolicy.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.identityGovernance.guestLifecyclePolicy",
  "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"
}