編輯

共用方式為


privilegedAccessGroupAssignmentScheduleRequest: filterByCurrentUser

Namespace: microsoft.graph

In PIM for groups, retrieve the requests for membership or ownership assignments for the calling principal to groups that are governed by PIM.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) PrivilegedAssignmentSchedule.Read.AzureADGroup PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup
Delegated (personal Microsoft account) Not supported. Not supported.
Application PrivilegedAssignmentSchedule.Read.AzureADGroup PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup

In delegated scenarios with work or school accounts, the signed-in user must be an owner or member of the group or be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • For role-assignable groups: Global Reader or Privileged Role Administrator
  • For non-role-assignable groups: Global Reader, Directory Writer, Groups Administrator, Identity Governance Administrator, or User Administrator

The role assignments for the calling user should be scoped at the directory level.

Other roles with permissions to manage groups (such as Exchange Administrators for non-role-assignable Microsoft 365 groups) and administrators with assignments scoped at administrative unit level can manage groups through groups API and override changes made in Microsoft Entra PIM through PIM for groups APIs.

HTTP request

GET /identityGovernance/privilegedAccess/group/assignmentScheduleRequests/filterByCurrentUser(on='parameterValue')

Function parameters

In the request URL, provide the following query parameters with values. The following table shows the parameters that can be used with this function.

Parameter Type Description
on assignmentScheduleRequestFilterByCurrentUserOptions Filter used to query assignmentScheduleRequests. The possible values are principal, createdBy, approver, unknownFutureValue. Required.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a privilegedAccessGroupAssignmentScheduleRequest collection in the response body.

Examples

Example 1: Retrieve a principal's requests scoped to a specific group and that are pending approval

Request

GET https://graph.microsoft.com/v1.0/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/filterByCurrentUser(on='principal')?$filter=status eq 'PendingApproval' and groupId eq 'd5f0ad2e-6b34-401b-b6da-0c8fc2c5a3fc'

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest",
      "id": "12345",
      "accessId": "member",
      "principalId": "c277c8cb-6bb7-42e5-a17f-0add9a718151",
      "groupId": "d5f0ad2e-6b34-401b-b6da-0c8fc2c5a3fc",
      "status": "PendingApproval",
      "createdDateTIme": "2022-02-26T08:00:00.000Z",
      "completedDateTIme": null,
      "isValidationOnly": false,
      "action": "SelfActivate",
      "scheduleInfo":
        {
          "startDateTime": "2022-04-01T08:00:00.000Z",
          "expiration":
            {
              "type": "AfterDuration",
              "duration" : "PT8H",
            }
        },
      "justification":"Activate access",
      "ticketInfo":
        {
          "ticketNumber": "09876"
        }
    }
  ]
}