privilegedAccessGroupEligibilityScheduleRequest: filterByCurrentUser
Namespace: microsoft.graph
In PIM for groups, retrieve the requests for membership or ownership eligibilities 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) | PrivilegedEligibilitySchedule.Read.AzureADGroup | PrivilegedEligibilitySchedule.ReadWrite.AzureADGroup |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | PrivilegedEligibilitySchedule.Read.AzureADGroup | PrivilegedEligibilitySchedule.ReadWrite.AzureADGroup |
The calling user must also be the owner or member of the group or be assigned one of the following Microsoft Entra roles.
- 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/eligibilityScheduleRequests/filterByCurrentUser(on='parameterValue')
Function parameters
In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function.
Parameter | Type | Description |
---|---|---|
on | eligibilityScheduleRequestFilterByCurrentUserOptions | Filter used to query eligibilityScheduleRequests. 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 privilegedAccessGroupEligibilityScheduleRequest collection in the response body.
Examples
Request
The following example shows a request.
GET https://graph.microsoft.com/v1.0/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/filterByCurrentUser(on='principal')
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
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/$entity",
"value": [
{
"@odata.type": "#microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest",
"id": "50877283-9d40-433c-bab8-7986dc10458a",
"status": "Provisioned",
"createdDateTime": "2022-04-12T09:05:41.807Z",
"completedDateTime": "2022-04-12T09:05:41.853Z",
"approvalId": null,
"customData": null,
"createdBy": {
"user": {
"displayName": null,
"id": "3fbd929d-8c56-4462-851e-0eb9a7b3a2a5"
}
},
"action": "adminAssign",
"isValidationOnly": false,
"justification": "Assign eligibility to user for PIM for Groups membership.",
"scheduleInfo": {
"startDateTime": "2022-04-12T09:05:41.8532931Z",
"recurrence": null,
"expiration": {
"type": "afterDateTime",
"endDateTime": "2024-04-10T00:00:00Z",
"duration": null
}
},
"ticketInfo": {
"ticketNumber": null,
"ticketSystem": null
},
"accessId": "member",
"principalId": "3cce9d87-3986-4f19-8335-7ed075408ca2",
"groupId": "2b5ed229-4072-478d-9504-a047ebd4b07d",
"targetScheduleId": "50877283-9d40-433c-bab8-7986dc10458a"
}
]
}
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per