privilegedAccessGroupEligibilityScheduleRequest resource type

Namespace: microsoft.graph

Represents requests for operations to create, update, delete, extend, and renew group membership and ownership eligibility in PIM for groups.

Inherits from privilegedAccessScheduleRequest.

Methods

Method	Return type	Description
List eligibilityScheduleRequests	privilegedAccessGroupEligibilityScheduleRequest collection	Get a list of the privilegedAccessGroupEligibilityScheduleRequest objects and their properties.
Create eligibilityScheduleRequest	privilegedAccessGroupEligibilityScheduleRequest	Create a new privilegedAccessGroupEligibilityScheduleRequest object.
Get privilegedAccessGroupEligibilityScheduleRequest	privilegedAccessGroupEligibilityScheduleRequest	Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleRequest object.
filterByCurrentUser	privilegedAccessGroupEligibilityScheduleRequest collection	Return eligibility schedule requests for the calling principal.
cancel	None	Cancel membership or ownership eligibility schedule requests for the calling principal.

Properties

Property	Type	Description
accessId	privilegedAccessGroupRelationships	The identifier of membership or ownership eligibility relationship to the group. Required. The possible values are: owner, member, unknownFutureValue.
action	String	Represents the type of operation on the group membership or ownership eligibility assignment request. The possible values are: adminAssign, adminUpdate, adminRemove, selfActivate, selfDeactivate, adminExtend, adminRenew. adminAssign: For administrators to assign group membership or ownership eligibility to principals. adminRemove: For administrators to remove principals from group membership or ownership eligibilities. adminUpdate: For administrators to change existing eligible assignments. adminExtend: For administrators to extend expiring eligible assignments. adminRenew: For administrators to renew expired eligible assignments. selfActivate: For principals to activate their eligible assignments. selfDeactivate: For principals to deactivate their eligible assignments.
approvalId	String	The identifier of the approval of the request. Inherited from request.
completedDateTime	DateTimeOffset	The request completion date time. Inherited from request.
createdBy	identitySet	The principal that created this request. Inherited from request. Read-only. Supports $filter (eq, ne, and on null values).
createdDateTime	DateTimeOffset	The request creation date time. Inherited from request. Read-only.
customData	String	Free text field to define any custom data for the request. Not used. Inherited from request.
groupId	String	The identifier of the group representing the scope of the membership and ownership eligibility through PIM for groups. Required.
id	String	The unique identifier for the privilegedAccessGroupEligibilityScheduleRequest object. Key, not nullable, read-only. Inherited from entity. Supports $filter (eq, ne).
isValidationOnly	Boolean	Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
justification	String	A message provided by users and administrators when they create the privilegedAccessGroupEligibilityScheduleRequest object.
principalId	String	The identifier of the principal whose membership or ownership eligibility to the group is managed through PIM for groups. Required.
scheduleInfo	requestSchedule	The period of the group membership or ownership assignment. Recurring schedules are currently unsupported.
status	String	The status of the group membership or ownership assignment request. Inherited from request. Read-only. Supports $filter (eq, ne).
targetScheduleId	String	The identifier of the schedule that's created from the eligibility request. Optional.
ticketInfo	ticketInfo	Ticket details linked to the group membership or ownership assignment request including details of the ticket number and ticket system.

Relationships

Relationship	Type	Description
group	group	References the group that is the scope of the membership or ownership eligibility request through PIM for groups. Supports $expand and $select nested in $expand for select properties like id, displayName, and mail.
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 and $select nested in $expand for id only.
targetSchedule	privilegedAccessGroupEligibilitySchedule	Schedule created by this request.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest",
  "id": "String (identifier)",
  "status": "String",
  "completedDateTime": "String (timestamp)",
  "createdDateTime": "String (timestamp)",
  "approvalId": "String",
  "customData": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "action": "String",
  "isValidationOnly": "Boolean",
  "justification": "String",
  "scheduleInfo": {
    "@odata.type": "microsoft.graph.requestSchedule"
  },
  "ticketInfo": {
    "@odata.type": "microsoft.graph.ticketInfo"
  },
  "principalId": "String",
  "accessId": "String",
  "groupId": "String",
  "targetScheduleId": "String"
}