Skip to main content

privileged_access_group_assignment_schedule_requests

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

Overview​

Nameprivileged_access_group_assignment_schedule_requests
TypeResource
Identra_id.identity_governance.privileged_access_group_assignment_schedule_requests

Fields​

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringThe unique identifier for an entity. Read-only.
accessIdThe identifier of a membership or ownership assignment relationship to the group. Required. The possible values are: owner, member, unknownFutureValue.
actionRepresents 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.
activatedUsingWhen 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.
approvalIdstringThe identifier of the approval of the request.
completedDateTimestring (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])$)
createdByThe principal that created the request.
createdDateTimestring (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])$)
customDatastringFree text field to define any custom data for the request. Not used.
groupReferences 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.
groupIdstringThe identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Required.
isValidationOnlybooleanDetermines 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.
justificationstringA message provided by users and administrators when create they create the privilegedAccessGroupAssignmentScheduleRequest object.
principalReferences 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.
principalIdstringThe identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Supports $filter (eq, ne).
scheduleInfoThe period of the group membership or ownership assignment. Recurring schedules are currently unsupported.
statusstringThe status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.
targetScheduleSchedule created by this request. Supports $expand.
targetScheduleIdstringThe identifier of the schedule that's created from the membership or ownership assignment request. Supports $filter (eq, ne).
ticketInfoTicket 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:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprivileged_access_group_assignment_schedule_request_idRead the properties and relationships of a privilegedAccessGroupAssignmentScheduleRequest object.
listselectGet a list of the privilegedAccessGroupAssignmentScheduleRequest objects and their properties.
insertinsertCreate a new privilegedAccessGroupAssignmentScheduleRequest object.
updateupdateprivileged_access_group_assignment_schedule_request_id
deletedeleteprivileged_access_group_assignment_schedule_request_idIf-Match
cancelexecprivileged_access_group_assignment_schedule_request_idCancel an access 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.

NameDatatypeDescription
privileged_access_group_assignment_schedule_request_idstringThe unique identifier of privilegedAccessGroupAssignmentScheduleRequest
If-MatchstringETag

SELECT examples​

Read the properties and relationships of a privilegedAccessGroupAssignmentScheduleRequest object.

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

INSERT examples​

Create a new privilegedAccessGroupAssignmentScheduleRequest object.

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

UPDATE examples​

No description available.

UPDATE entra_id.identity_governance.privileged_access_group_assignment_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 }}',
activatedUsing = '{{ activatedUsing }}',
group = '{{ group }}',
principal = '{{ principal }}',
targetSchedule = '{{ targetSchedule }}'
WHERE 
privileged_access_group_assignment_schedule_request_id = '{{ privileged_access_group_assignment_schedule_request_id }}' --required
RETURNING
id,
accessId,
action,
activatedUsing,
approvalId,
completedDateTime,
createdBy,
createdDateTime,
customData,
group,
groupId,
isValidationOnly,
justification,
principal,
principalId,
scheduleInfo,
status,
targetSchedule,
targetScheduleId,
ticketInfo;

DELETE examples​

No description available.

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

Lifecycle Methods​

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

EXEC entra_id.identity_governance.privileged_access_group_assignment_schedule_requests.cancel 
@privileged_access_group_assignment_schedule_request_id='{{ privileged_access_group_assignment_schedule_request_id }}' --required
;