privilegedAccessGroupEligibilitySchedule resource type

Namespace: microsoft.graph

Represents the schedule of eligible ownership and membership to groups that are governed by PIM.

Inherits from privilegedAccessSchedule.

Methods

Method	Return type	Description
List	privilegedAccessGroupEligibilitySchedule collection	Get a list of the privilegedAccessGroupEligibilitySchedule objects and their properties.
Get	privilegedAccessGroupEligibilitySchedule	Read the properties and relationships of a privilegedAccessGroupEligibilitySchedule object.
Filter by current user	privilegedAccessGroupEligibilitySchedule collection	Return schedules of membership and ownership eligibility requests for the calling principal.

Properties

Property	Type	Description
accessId	privilegedAccessGroupRelationships	The identifier of the membership or ownership eligibility to the group that is governed by PIM. Required. The possible values are: owner, member. Supports $filter (eq).
createdDateTime	DateTimeOffset	When the schedule was created. Optional. Inherited from privilegedAccessSchedule.
createdUsing	String	The identifier of the access assignment or eligibility request that creates this schedule. Optional. Inherited from privilegedAccessSchedule. Supports $filter (eq, ne, and on null values).
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 schedule. 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 caller can manage the schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq).
modifiedDateTime	DateTimeOffset	When the schedule was last modified. Optional. Inherited from privilegedAccessSchedule.
principalId	String	The identifier of the principal whose membership or ownership eligibility is granted through PIM for groups. Required. Supports $filter (eq).
scheduleInfo	requestSchedule	Represents the period of the access assignment or eligibility. The scheduleInfo can represent a single occurrence or multiple recurring instances. Required. Inherited from privilegedAccessSchedule.
status	String	The status of the access assignment or eligibility request. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable. Optional. Inherited from privilegedAccessSchedule. Supports $filter (eq, ne).

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 this membership or ownership eligibility request to the group that's governed by PIM. Supports $expand.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.privilegedAccessGroupEligibilitySchedule",
  "id": "String (identifier)",
  "scheduleInfo": {
    "@odata.type": "microsoft.graph.requestSchedule"
  },
  "createdDateTime": "String (timestamp)",
  "modifiedDateTime": "String (timestamp)",
  "createdUsing": "String",
  "status": "String",
  "principalId": "String",
  "accessId": "String",
  "groupId": "String",
  "memberType": "String"
}