privileged_access_group_eligibility_schedule_requests

Creates, updates, deletes, gets or lists a privileged_access_group_eligibility_schedule_requests resource.

Overview

Name	`privileged_access_group_eligibility_schedule_requests`
Type	Resource
Id	`entra_id.identity_governance.privileged_access_group_eligibility_schedule_requests`

Fields

The following fields are returned by SELECT queries:

get
list

Retrieved navigation property

Name	Datatype	Description
`id`	`string`	The unique identifier for an entity. Read-only.
`accessId`		The identifier of membership or ownership eligibility relationship to the group. Required. The possible values are: owner, member, unknownFutureValue.
`action`		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.
`completedDateTime`	`string (date-time)`	The request completion date time. (pattern: `^[0-9]{4,}-(0[1-9]\|1[012])-(0[1-9]\|[12][0-9]\|3[01])T([01][0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z\|[+-][0-9][0-9]:[0-9][0-9])$`)
`createdBy`		The principal that created the request.
`createdDateTime`	`string (date-time)`	The request creation date time. (pattern: `^[0-9]{4,}-(0[1-9]\|1[012])-(0[1-9]\|[12][0-9]\|3[01])T([01][0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z\|[+-][0-9][0-9]:[0-9][0-9])$`)
`customData`	`string`	Free text field to define any custom data for the request. Not used.
`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.
`groupId`	`string`	The identifier of the group representing the scope of the membership and ownership eligibility through PIM for Groups. Required.
`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 create they create the privilegedAccessGroupAssignmentScheduleRequest object.
`principal`		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.
`principalId`	`string`	The identifier of the principal whose membership or ownership eligibility to the group is managed through PIM for Groups. Required.
`scheduleInfo`		The period of the group membership or ownership assignment. Recurring schedules are currently unsupported.
`status`	`string`	The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.
`targetSchedule`		Schedule created by this request.
`targetScheduleId`	`string`	The identifier of the schedule that's created from the eligibility request. Optional.
`ticketInfo`		Ticket details linked to the group membership or ownership assignment request including details of the ticket number and ticket system.

Retrieved collection

Name	Datatype	Description
`id`	`string`	The unique identifier for an entity. Read-only.
`accessId`		The identifier of membership or ownership eligibility relationship to the group. Required. The possible values are: owner, member, unknownFutureValue.
`action`		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.
`completedDateTime`	`string (date-time)`	The request completion date time. (pattern: `^[0-9]{4,}-(0[1-9]\|1[012])-(0[1-9]\|[12][0-9]\|3[01])T([01][0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z\|[+-][0-9][0-9]:[0-9][0-9])$`)
`createdBy`		The principal that created the request.
`createdDateTime`	`string (date-time)`	The request creation date time. (pattern: `^[0-9]{4,}-(0[1-9]\|1[012])-(0[1-9]\|[12][0-9]\|3[01])T([01][0-9]\|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z\|[+-][0-9][0-9]:[0-9][0-9])$`)
`customData`	`string`	Free text field to define any custom data for the request. Not used.
`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.
`groupId`	`string`	The identifier of the group representing the scope of the membership and ownership eligibility through PIM for Groups. Required.
`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 create they create the privilegedAccessGroupAssignmentScheduleRequest object.
`principal`		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.
`principalId`	`string`	The identifier of the principal whose membership or ownership eligibility to the group is managed through PIM for Groups. Required.
`scheduleInfo`		The period of the group membership or ownership assignment. Recurring schedules are currently unsupported.
`status`	`string`	The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.
`targetSchedule`		Schedule created by this request.
`targetScheduleId`	`string`	The identifier of the schedule that's created from the eligibility request. Optional.
`ticketInfo`		Ticket details linked to the group membership or ownership assignment request including details of the ticket number and ticket system.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`privileged_access_group_eligibility_schedule_request_id`		Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleRequest object.
`list`	`select`			Get a list of the privilegedAccessGroupEligibilityScheduleRequest objects and their properties.
`insert`	`insert`			Create a new privilegedAccessGroupEligibilityScheduleRequest object.
`update`	`update`	`privileged_access_group_eligibility_schedule_request_id`
`delete`	`delete`	`privileged_access_group_eligibility_schedule_request_id`	`If-Match`
`cancel`	`exec`	`privileged_access_group_eligibility_schedule_request_id`		Cancel an eligibility assignment request to a group whose membership and ownership are governed by PIM.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`privileged_access_group_eligibility_schedule_request_id`	`string`	The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
`If-Match`	`string`	ETag

`SELECT` examples

get
list

Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleRequest object.

SELECT
id,
accessId,
action,
approvalId,
completedDateTime,
createdBy,
createdDateTime,
customData,
group,
groupId,
isValidationOnly,
justification,
principal,
principalId,
scheduleInfo,
status,
targetSchedule,
targetScheduleId,
ticketInfo
FROM entra_id.identity_governance.privileged_access_group_eligibility_schedule_requests
WHERE privileged_access_group_eligibility_schedule_request_id = '{{ privileged_access_group_eligibility_schedule_request_id }}' -- required
;

Get a list of the privilegedAccessGroupEligibilityScheduleRequest objects and their properties.

SELECT
id,
accessId,
action,
approvalId,
completedDateTime,
createdBy,
createdDateTime,
customData,
group,
groupId,
isValidationOnly,
justification,
principal,
principalId,
scheduleInfo,
status,
targetSchedule,
targetScheduleId,
ticketInfo
FROM entra_id.identity_governance.privileged_access_group_eligibility_schedule_requests
;

`INSERT` examples

insert
Manifest

Create a new privilegedAccessGroupEligibilityScheduleRequest object.

INSERT INTO entra_id.identity_governance.privileged_access_group_eligibility_schedule_requests (
id,
approvalId,
completedDateTime,
createdBy,
createdDateTime,
customData,
status,
action,
isValidationOnly,
justification,
scheduleInfo,
ticketInfo,
accessId,
groupId,
principalId,
targetScheduleId,
group,
principal,
targetSchedule
)
SELECT 
'{{ id }}',
'{{ approvalId }}',
'{{ completedDateTime }}',
'{{ createdBy }}',
'{{ createdDateTime }}',
'{{ customData }}',
'{{ status }}',
'{{ action }}',
{{ isValidationOnly }},
'{{ justification }}',
'{{ scheduleInfo }}',
'{{ ticketInfo }}',
'{{ accessId }}',
'{{ groupId }}',
'{{ principalId }}',
'{{ targetScheduleId }}',
'{{ group }}',
'{{ principal }}',
'{{ targetSchedule }}'
RETURNING
id,
accessId,
action,
approvalId,
completedDateTime,
createdBy,
createdDateTime,
customData,
group,
groupId,
isValidationOnly,
justification,
principal,
principalId,
scheduleInfo,
status,
targetSchedule,
targetScheduleId,
ticketInfo
;

# Description fields are for documentation purposes
- name: privileged_access_group_eligibility_schedule_requests
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: approvalId
    value: "{{ approvalId }}"
    description: |
      The identifier of the approval of the request.
  - name: completedDateTime
    value: "{{ completedDateTime }}"
    description: |
      The request completion date time.
  - name: createdBy
    value: "{{ createdBy }}"
    description: |
      The principal that created the request.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The request creation date time.
  - name: customData
    value: "{{ customData }}"
    description: |
      Free text field to define any custom data for the request. Not used.
  - name: status
    value: "{{ status }}"
    description: |
      The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.
  - name: action
    value: "{{ action }}"
    description: |
      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.
  - name: isValidationOnly
    value: {{ isValidationOnly }}
    description: |
      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.
  - name: justification
    value: "{{ justification }}"
    description: |
      A message provided by users and administrators when create they create the privilegedAccessGroupAssignmentScheduleRequest object.
  - name: scheduleInfo
    value: "{{ scheduleInfo }}"
    description: |
      The period of the group membership or ownership assignment. Recurring schedules are currently unsupported.
  - name: ticketInfo
    value: "{{ ticketInfo }}"
    description: |
      Ticket details linked to the group membership or ownership assignment request including details of the ticket number and ticket system.
  - name: accessId
    value: "{{ accessId }}"
    description: |
      The identifier of membership or ownership eligibility relationship to the group. Required. The possible values are: owner, member, unknownFutureValue.
  - name: groupId
    value: "{{ groupId }}"
    description: |
      The identifier of the group representing the scope of the membership and ownership eligibility through PIM for Groups. Required.
  - name: principalId
    value: "{{ principalId }}"
    description: |
      The identifier of the principal whose membership or ownership eligibility to the group is managed through PIM for Groups. Required.
  - name: targetScheduleId
    value: "{{ targetScheduleId }}"
    description: |
      The identifier of the schedule that's created from the eligibility request. Optional.
  - name: group
    value: "{{ group }}"
    description: |
      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.
  - name: principal
    value: "{{ principal }}"
    description: |
      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.
  - name: targetSchedule
    value: "{{ targetSchedule }}"
    description: |
      Schedule created by this request.

`UPDATE` examples

update

No description available.

UPDATE entra_id.identity_governance.privileged_access_group_eligibility_schedule_requests
SET 
id = '{{ id }}',
approvalId = '{{ approvalId }}',
completedDateTime = '{{ completedDateTime }}',
createdBy = '{{ createdBy }}',
createdDateTime = '{{ createdDateTime }}',
customData = '{{ customData }}',
status = '{{ status }}',
action = '{{ action }}',
isValidationOnly = {{ isValidationOnly }},
justification = '{{ justification }}',
scheduleInfo = '{{ scheduleInfo }}',
ticketInfo = '{{ ticketInfo }}',
accessId = '{{ accessId }}',
groupId = '{{ groupId }}',
principalId = '{{ principalId }}',
targetScheduleId = '{{ targetScheduleId }}',
group = '{{ group }}',
principal = '{{ principal }}',
targetSchedule = '{{ targetSchedule }}'
WHERE 
privileged_access_group_eligibility_schedule_request_id = '{{ privileged_access_group_eligibility_schedule_request_id }}' --required
RETURNING
id,
accessId,
action,
approvalId,
completedDateTime,
createdBy,
createdDateTime,
customData,
group,
groupId,
isValidationOnly,
justification,
principal,
principalId,
scheduleInfo,
status,
targetSchedule,
targetScheduleId,
ticketInfo;

`DELETE` examples

delete

No description available.

DELETE FROM entra_id.identity_governance.privileged_access_group_eligibility_schedule_requests
WHERE privileged_access_group_eligibility_schedule_request_id = '{{ privileged_access_group_eligibility_schedule_request_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

cancel

Cancel an eligibility assignment request to a group whose membership and ownership are governed by PIM.

EXEC entra_id.identity_governance.privileged_access_group_eligibility_schedule_requests.cancel 
@privileged_access_group_eligibility_schedule_request_id='{{ privileged_access_group_eligibility_schedule_request_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​