privilegedAccessGroupEligibilityScheduleInstance resource type

Namespace: microsoft.graph

Represents an instance of a provisioned membership or ownership eligibility in PIM for groups.

Inherits from privilegedAccessScheduleInstance.

Methods

Method	Return type	Description
List eligibilityScheduleInstances	privilegedAccessGroupEligibilityScheduleInstance collection	Get a list of the privilegedAccessGroupEligibilityScheduleInstance objects and their properties.
Get privilegedAccessGroupEligibilityScheduleInstance	privilegedAccessGroupEligibilityScheduleInstance	Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleInstance object.
filterByCurrentUser	privilegedAccessGroupEligibilityScheduleInstance collection	Return instances of membership and ownership eligibility schedules for the calling principal.

Properties

Property	Type	Description
accessId	privilegedAccessGroupRelationships	The identifier of the membership or ownership eligibility relationship to the group. Required. The possible values are: owner, member. Supports $filter (eq).
eligibilityScheduleId	String	The identifier of the privilegedAccessGroupEligibilitySchedule from which this instance was created. Required. Supports $filter (eq, ne).
endDateTime	DateTimeOffset	When the schedule instance ends. Required.
groupId	String	The identifier of the group representing the scope of the membership or ownership eligibility through PIM for groups. Required. Supports $filter (eq).
id	String	The identifier of the access assignment schedule instance. Required. Inherited from entity. Supports $filter (eq, ne).
memberType	privilegedAccessGroupMemberType	Indicates whether the assignment is derived from a group assignment. It can further imply whether the calling principal can manage the assignment schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq).
principalId	String	The identifier of the principal whose membership or ownership eligibility to the group is managed through PIM for groups. Required. Supports $filter (eq).
startDateTime	DateTimeOffset	When this instance starts. Required.

Relationships

Relationship	Type	Description
group	group	References the group that is the scope of the membership or ownership eligibility through PIM for groups. Supports $expand.
principal	directoryObject	References the principal that's in the scope of the membership or ownership eligibility request through the group that's governed by PIM. Supports $expand.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance",
  "id": "String (identifier)",
  "startDateTime": "String (timestamp)",
  "endDateTime": "String (timestamp)",
  "principalId": "String",
  "accessId": "String",
  "groupId": "String",
  "memberType": "String",
  "eligibilityScheduleId": "String"
}