unifiedRoleEligibilityScheduleInstance: filterByCurrentUser
Namespace: microsoft.graph
Get the instances of eligible roles for the calling principal.
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) | RoleEligibilitySchedule.Read.Directory | RoleEligibilitySchedule.ReadWrite.Directory, RoleManagement.Read.All, RoleManagement.Read.Directory, RoleManagement.ReadWrite.Directory |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | RoleEligibilitySchedule.Read.Directory | RoleEligibilitySchedule.ReadWrite.Directory, RoleManagement.Read.All, RoleManagement.Read.Directory, RoleManagement.ReadWrite.Directory |
In delegated scenarios with work or school accounts, the signed-in user must 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 read operations: Global Reader, Security Operator, Security Reader, Security Administrator, or Privileged Role Administrator
- For write operations: Privileged Role Administrator
HTTP request
GET /roleManagement/directory/roleEligibilityScheduleInstances/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 | roleEligibilityScheduleInstanceFilterByCurrentUserOptions | The possible values are principal , unknownFutureValue . |
Optional query parameters
This method supports the $select
, $filter
, and $expand
OData query parameters to help customize the response. For general information, see OData query parameters.
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 unifiedRoleEligibilityScheduleInstance collection in the response body.
Examples
Request
GET https://graph.microsoft.com/v1.0/roleManagement/directory/roleEligibilityScheduleInstances/filterByCurrentUser(on='principal')
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#Collection(unifiedRoleEligibilityScheduleInstance)",
"value": [
{
"@odata.type": "#microsoft.graph.unifiedRoleEligibilityScheduleInstance",
"id": "8MYkhImhnkm70CbBdTyW1BbHHAdHgZdDpbqyEFlRzAs-1-e",
"principalId": "071cc716-8147-4397-a5ba-b2105951cc0b",
"roleDefinitionId": "8424c6f0-a189-499e-bbd0-26c1753c96d4",
"directoryScopeId": "/",
"appScopeId": null,
"startDateTime": "2022-04-12T14:44:50.287Z",
"endDateTime": "2024-04-10T00:00:00Z",
"memberType": "Direct",
"roleEligibilityScheduleId": "77f71919-62f3-4d0c-9f88-0a0391b665cd"
}
]
}