Edit

Share via

privilegedAccessGroupAssignmentScheduleRequest resource type

Namespace: microsoft.graph

Represents requests for operations to create, update, delete, extend, and renew a membership or ownership assignment in PIM for Groups. The privilegedAccessGroupAssignmentScheduleRequest object is also created when an authorized principal requests a just-in-time activation of an eligible access assignment to a group's membership or ownership.

Inherits from privilegedAccessScheduleRequest.

Methods

Method Return type Description
List privilegedAccessGroupAssignmentScheduleRequest collection Get a list of the privilegedAccessGroupAssignmentScheduleRequest objects and their properties.
Create privilegedAccessGroupAssignmentScheduleRequest Create a new privilegedAccessGroupAssignmentScheduleRequest object.
Get privilegedAccessGroupAssignmentScheduleRequest Read the properties and relationships of a privilegedAccessGroupAssignmentScheduleRequest object.
Filter by current user privilegedAccessGroupAssignmentScheduleRequest collection Return assignment schedule requests for the calling principal.
Cancel None Cancel a pending request for a membership or ownership assignment to a group.

Properties

Property Type Description
accessId privilegedAccessGroupRelationships The identifier of a membership or ownership assignment 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 assignment request. The possible values are: adminAssign, adminUpdate, adminRemove, selfActivate, selfDeactivate, adminExtend, adminRenew.
  • adminAssign: For administrators to assign group membership or ownership to principals.
  • adminRemove: For administrators to remove principals from group membership or ownership.
  • adminUpdate: For administrators to change existing group membership or ownership assignments.
  • adminExtend: For administrators to extend expiring assignments.
  • adminRenew: For administrators to renew expired assignments.
  • selfActivate: For principals to activate their assignments.
  • selfDeactivate: For principals to deactivate their active 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 or ownership assignment through PIM for Groups. Required.
id String The unique identifier for the privilegedAccessGroupAssignmentScheduleRequest 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 privilegedAccessGroupAssignmentScheduleRequest object.
principalId String The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Supports $filter (eq, ne).
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 membership or ownership assignment request. Supports $filter (eq, ne).
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
activatedUsing privilegedAccessGroupEligibilitySchedule When the request activates a membership or ownership assignment in PIM for Groups, this object represents the eligibility policy for the group. Otherwise, it is null. Supports $expand.
group group References the group that is the scope of the membership or ownership assignment 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 this membership or ownership assignment 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. Supports $expand.

JSON representation

The following JSON representation shows the resource type.

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