rbacApplication: roleSchedules
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Retrieve both roleAssignmentSchedules and roleEligibilitySchedules.
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) | PrivilegedAccess.ReadWrite.AzureAD | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | PrivilegedAccess.Read.AzureAD | Not available. |
HTTP request
GET /roleManagement/directory/roleSchedules(directoryScopeId='@directoryScopeId',appScopeId='@appScopeId',principalId='@principalId',roleDefinitionId='@roleDefinitionId')
Function parameters
The following table shows the query parameters that can be used with this method.
| Parameter | Type | Description |
|---|---|---|
| directoryScopeId | String | Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. |
| appScopeId | String | Identifier of the app-specific scope when the assignment scope is app-specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. |
| principalId | String | Identifier of the principal to which the assignment is being granted to. Can be a group or a user. |
| roleDefinitionId | String | Identifier of the unifiedRoleDefinition for the assignment. Read only. |
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 method returns a 200 OK response code and a collection of unifiedRoleScheduleBase objects in the response body.
Examples
Request
GET https://graph.microsoft.com/beta/roleManagement/directory/roleSchedules(directoryScopeId='a3bb8764-cb92-4276-9d2a-ca1e895e55ea',appScopeId='a3bb8764-cb92-4276-9d2a-ca1e895e55ea',principalId='a3bb8764-cb92-4276-9d2a-ca1e895e55ea',roleDefinitionId='a3bb8764-cb92-4276-9d2a-ca1e895e55ea')
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.Identity.Governance.Common.Data.ExternalModels.V1.unifiedRoleScheduleBase",
"id": "String (identifier)",
"principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"roleDefinitionId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"directoryScopeId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"appScopeId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"createdUsing": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"createdDateTime": "2020-09-09T21:32:27.91Z",
"modifiedDateTime": "2020-09-09T21:32:27.91Z",
"status": "Provisioned"
}
]
}