privilegedAccessGroupAssignmentScheduleInstance resource type
Namespace: microsoft.graph
Represents an instance of a provisioned membership or ownership assignment in PIM for groups.
Inherits from privilegedAccessScheduleInstance.
Methods
| Method | Return type | Description |
|---|---|---|
| List | privilegedAccessGroupAssignmentScheduleInstance collection | Get a list of the privilegedAccessGroupAssignmentScheduleInstance objects and their properties. |
| Get | privilegedAccessGroupAssignmentScheduleInstance | Read the properties and relationships of a privilegedAccessGroupAssignmentScheduleInstance object. |
| Filter by current user | privilegedAccessGroupAssignmentScheduleInstance collection | Return instances of membership and ownership assignment schedules for the calling principal. |
Properties
| Property | Type | Description |
|---|---|---|
| accessId | privilegedAccessGroupRelationships | The identifier of the membership or ownership assignment relationship to the group. Required. The possible values are: owner, member, unknownFutureValue. Supports $filter (eq). |
| assignmentScheduleId | String | The identifier of the privilegedAccessGroupAssignmentSchedule from which this instance was created. Required. Supports $filter (eq, ne). |
| assignmentType | privilegedAccessGroupAssignmentType | Indicates whether the membership or ownership assignment is granted through activation of an eligibility or through direct assignment. Required. The possible values are: assigned, activated, unknownFutureValue. Supports $filter (eq). |
| endDateTime | DateTimeOffset | When the schedule instance ends. Required. |
| groupId | String | The identifier of the group representing the scope of the membership or ownership assignment through PIM for groups. Optional. Supports $filter (eq). |
| id | String | The identifier of the access assignment schedule instance. Required. Inherited from entity. Supports $filter (eq, ne). |
| memberType | privilegedAccessGroupMemberType | Indicates whether the assignment is derived from a group assignment. It can further imply whether the caller can manage the assignment schedule. Required. The possible values are: direct, group, unknownFutureValue. Supports $filter (eq). |
| principalId | String | The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for groups. Required. Supports $filter (eq). |
| startDateTime | DateTimeOffset | When this instance starts. Required. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| activatedUsing | privilegedAccessGroupEligibilityScheduleInstance | When the request activates a membership or ownership in PIM for groups, this object represents the eligibility request for the group. Otherwise, it is null. |
| group | group | References the group that is the scope of the membership or ownership assignment through PIM for groups. Supports $expand. |
| principal | directoryObject | References the principal that's in the scope of the membership or ownership assignment request through the group that's governed by PIM. Supports $expand. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance",
"id": "String (identifier)",
"startDateTime": "String (timestamp)",
"endDateTime": "String (timestamp)",
"principalId": "String",
"accessId": "String",
"groupId": "String",
"memberType": "String",
"assignmentType": "String",
"assignmentScheduleId": "String"
}