privilegedAccessGroupAssignmentSchedule resource type
Namespace: microsoft.graph
Represents the schedule of membership or ownership assignments to groups that are governed through PIM.
Inherits from privilegedAccessSchedule.
Method | Return type | Description |
---|---|---|
List | privilegedAccessGroupAssignmentSchedule collection | Get a list of the privilegedAccessGroupAssignmentSchedule objects and their properties. |
Get | privilegedAccessGroupAssignmentSchedule | Read the properties and relationships of a privilegedAccessGroupAssignmentSchedule object. |
Filter by current user | privilegedAccessGroupAssignmentSchedule collection | Return schedules of membership and ownership assignment requests for the calling principal. |
Property | Type | Description |
---|---|---|
accessId | privilegedAccessGroupRelationships | The identifier of the membership or ownership assignment to the group that is governed through PIM. Required. The possible values are: owner , member , unknownFutureValue . Supports $filter (eq ). |
assignmentType | privilegedAccessGroupAssignmentType | Indicates whether the membership or ownership assignment for the principal is granted through activation or direct assignment. Required. The possible values are: assigned , activated , unknownFutureValue . Supports $filter (eq ). |
createdDateTime | DateTimeOffset | When the schedule was created. Optional. |
createdUsing | String | The identifier of the access assignment or eligibility request that created this schedule. Optional. Supports $filter (eq , ne , and on null values). |
groupId | String | The identifier of the group representing the scope of the membership or ownership assignment 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 direct group assignment or through a transitive assignment. The possible values are: direct , group , unknownFutureValue . Supports $filter (eq ). |
modifiedDateTime | DateTimeOffset | When the schedule was last modified. Optional. |
principalId | String | The identifier of the principal whose membership or ownership assignment 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. |
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. Supports $filter (eq , ne ). |
Relationship | Type | Description |
---|---|---|
activatedUsing | privilegedAccessGroupEligibilitySchedule | When the request activates an ownership or membership assignment in PIM for groups, this object represents the eligibility relationship. Otherwise, it's null . Supports $expand . |
group | group | References the group that is the scope of the membership or ownership assignment 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 to the group that's governed through PIM. Supports $expand and $select nested in $expand for id only. |
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.privilegedAccessGroupAssignmentSchedule",
"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",
"assignmentType": "String"
}