RoleEligibilitySchedule.ReadWrite.Directory

Allows the app to read and manage the eligible role-based access control (RBAC) assignments for your company's directory, on behalf of the signed-in user. This includes managing eligible directory role membership, and reading directory role templates, directory roles and eligible memberships.

Merill's Note

For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the RoleEligibilitySchedule.ReadWrite.Directory permission.

If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the Export-MsIdAppConsentGrantReport command. See How To: Run a quick OAuth app audit of your tenant

Category	Application	Delegated
Identifier	fee28b28-e1f3-4841-818e-2704dc62245f	62ade113-f8e0-4bf9-a6ba-5acb31db32fd
DisplayText	Read, update, and delete all eligible role assignments and schedules for your company's directory	Read, update, and delete all eligible role assignments for your company's directory
Description	Allows the app to read and manage the eligible role-based access control (RBAC) assignments and schedules for your company's directory, without a signed-in user. This includes managing eligible directory role membership, and reading directory role templates, directory roles and eligible memberships.	Allows the app to read and manage the eligible role-based access control (RBAC) assignments for your company's directory, on behalf of the signed-in user. This includes managing eligible directory role membership, and reading directory role templates, directory roles and eligible memberships.
AdminConsentRequired	Yes	Yes

Graph Methods

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /roleManagement/directory/roleEligibilityScheduleInstances
	GET /roleManagement/directory/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstanceId}
	GET /roleManagement/directory/roleEligibilityScheduleInstances/filterByCurrentUser(on='parameterValue')
	GET /roleManagement/directory/roleEligibilityScheduleRequests
	GET /roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequestId}
	GET /roleManagement/directory/roleEligibilityScheduleRequests/filterByCurrentUser(on='parameterValue')
	GET /roleManagement/directory/roleEligibilitySchedules
	GET /roleManagement/directory/roleEligibilitySchedules/{unifiedRoleEligibilityScheduleId}
	GET /roleManagement/directory/roleEligibilitySchedules/filterByCurrentUser(on='parameterValue')
	POST /roleManagement/directory/roleEligibilityScheduleRequests
	POST /roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequestId}/cancel

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	GET /roleManagement/directory/roleEligibilityScheduleInstances
	GET /roleManagement/directory/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstancesId}
	GET /roleManagement/directory/roleEligibilityScheduleInstances/filterByCurrentUser(on='principal')
	GET /roleManagement/directory/roleEligibilityScheduleRequests
	GET /roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequestsId}
	GET /roleManagement/directory/RoleEligibilityScheduleRequests/filterByCurrentUser(on='principal')
	GET /roleManagement/directory/roleEligibilitySchedules
	GET /roleManagement/directory/roleEligibilitySchedules/{unifiedRoleEligibilitySchedulesId}
	GET roleManagement/directory/roleEligibilitySchedules/filterByCurrentUser(on='principal')
	POST /roleManagement/directory/roleEligibilityScheduleRequests
	POST /roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequestsId}/cancel

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgRoleManagementDirectoryRoleEligibilitySchedule
	Get-MgRoleManagementDirectoryRoleEligibilityScheduleInstance
	Get-MgRoleManagementDirectoryRoleEligibilityScheduleRequest
	Invoke-MgFilterRoleManagementDirectoryRoleEligibilityScheduleByCurrentUser
	Invoke-MgFilterRoleManagementDirectoryRoleEligibilityScheduleInstanceByCurrentUser
	Invoke-MgFilterRoleManagementDirectoryRoleEligibilityScheduleRequestByCurrentUser
	New-MgRoleManagementDirectoryRoleEligibilityScheduleRequest
	Stop-MgRoleManagementDirectoryRoleEligibilityScheduleRequest

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgBetaRoleManagementDirectoryRoleEligibilitySchedule
	Get-MgBetaRoleManagementDirectoryRoleEligibilityScheduleInstance
	Get-MgBetaRoleManagementDirectoryRoleEligibilityScheduleRequest
	Invoke-MgBetaFilterRoleManagementDirectoryRoleEligibilityScheduleByCurrentUser
	Invoke-MgBetaFilterRoleManagementDirectoryRoleEligibilityScheduleInstanceByCurrentUser
	Invoke-MgBetaFilterRoleManagementDirectoryRoleEligibilityScheduleRequestByCurrentUser
	New-MgBetaRoleManagementDirectoryRoleEligibilityScheduleRequest
	Stop-MgBetaRoleManagementDirectoryRoleEligibilityScheduleRequest

Resources

Granting this permission allows the calling application to access (and/or update) the following information in your tenant.

Graph reference: requestSchedule

Property	Type	Description
expiration	expirationPattern	When the eligible or active assignment expires.
recurrence	patternedRecurrence	The frequency of the eligible or active assignment. This property is currently unsupported in PIM.
startDateTime	DateTimeOffset	When the eligible or active assignment becomes active.

Property	Type	Description
ticketNumber	String	The ticket number.
ticketSystem	String	The description of the ticket system.

Graph reference: unifiedRoleDefinition

Property	Type	Description
description	String	The description for the unifiedRoleDefinition. Read-only when isBuiltIn is `true`.
displayName	String	The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is `true`. Required. Supports $filter (`eq`, `in`).
id	String	The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (`eq`, `in`).
isBuiltIn	Boolean	Flag indicating whether the role definition is part of the default set included in Microsoft Entra or a custom definition. Read-only. Supports $filter (`eq`, `in`).
isEnabled	Boolean	Flag indicating whether the role is enabled for assignment. If `false` the role is not available for assignment. Read-only when isBuiltIn is true.
resourceScopes	String collection	List of the scopes or permissions the role definition applies to. Currently only `/` is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment.
rolePermissions	unifiedRolePermission collection	List of permissions included in the role. Read-only when isBuiltIn is `true`. Required.
templateId	String	Custom template identifier that can be set when isBuiltIn is `false` but is read-only when isBuiltIn is `true`. This identifier is typically used if one needs an identifier to be the same across different directories.
version	String	Indicates version of the role definition. Read-only when **i

Graph reference: unifiedRoleEligibilitySchedule

Property	Type	Description
appScopeId	String	Identifier of the app-specific scope when the role eligibility is scoped to an app. The scope of a role eligibility 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. Inherited from unifiedRoleScheduleBase. Supports `$filter` (`eq`, `ne`, and on `null` values).
createdDateTime	DateTimeOffset	When the schedule was created. Inherited from unifiedRoleScheduleBase.
createdUsing	String	Identifier of the object through which this schedule was created. Inherited from unifiedRoleScheduleBase. Supports `$filter` (`eq`, `ne`, and on `null` values).
directoryScopeId	String	Identifier of the directory object representing the scope of the role eligibility. The scope of a role eligibility 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. Inherited from unifiedRoleScheduleBase. Supports `$filter` (`eq`, `ne`, and on `null` values).
id	String	The unique identifier for the schedule object. Inherited from entity. Supports `$filter` (`eq`).
memberType	String	How the role eligibility is inherited. It can either be `Inherited`, `Direct`, or `Group`. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports `$filter` (`eq`, `ne`).
modifiedDateTime	DateTimeOffset	When the schedule was last modified. Inherited from unifiedRoleScheduleBase.
principalId	String	Identifier of the principal that is eligible for a role.Inherited from unifiedRoleScheduleBase. Supports `$filter` (`eq`, `ne`).
roleDefinitionId	String	Identifier of the unifiedRoleDefinition object that a principal is eligible for. Inherited from unifiedRoleScheduleBase.
scheduleInfo	requestSchedule	The period of the role eligibility.
status	String	The status of the role eligibility request. Inherited from unifiedRoleScheduleBase. The possible values are: `Canceled`, `Denied`, `Failed`, `Granted`, `PendingAdminDecision`, `PendingApproval`, `PendingProvisioning`, `PendingScheduleCreation`, `Provisioned`, `Revoked`, and `ScheduleCreated`. Not nullable. Supports `$filter` (`eq`, `ne`).

Graph reference: unifiedRoleEligibilityScheduleInstance

Property	Type	Description
appScopeId	String	Identifier of the app-specific scope when the role eligibility is scoped to an app. The scope of the role eligibility 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. Inherited from unifiedRoleScheduleInstanceBase. Supports `$filter` (`eq`, `ne`, and on `null` values).
directoryScopeId	String	Identifier of the directory object representing the scope of the role eligibility. The scope of the role eligibility 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. Inherited from unifiedRoleScheduleInstanceBase. Supports `$filter` (`eq`, `ne`, and on `null` values).
endDateTime	DateTimeOffset	The end date of the schedule instance.
id	String	The unique identifier for the schedule object. Inherited from entity.
memberType	String	How the role eligibility is inherited. It can either be `Inherited`, `Direct`, or `Group`. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports `$filter` (`eq`, `ne`).
principalId	String	Identifier of the principal that's eligible for a role. Inherited from unifiedRoleScheduleInstanceBase. Supports `$filter` (`eq`, `ne`).
roleDefinitionId	String	Identifier of the unifiedRoleDefinition object that the principal is eligible for. Inherited from unifiedRoleScheduleInstanceBase. Supports `$filter` (`eq`, `ne`).
roleEligibilityScheduleId	String	The identifier of the unifiedRoleEligibilitySchedule object from which this instance was created. Supports `$filter` (`eq`, `ne`).
startDateTime	DateTimeOffset	When this instance starts.

Graph reference: unifiedRoleEligibilityScheduleRequest

Property	Type	Description
action	unifiedRoleScheduleRequestActions	Represents the type of operation on the role eligibility request. The possible values are: `adminAssign`, `adminUpdate`, `adminRemove`, `selfActivate`, `selfDeactivate`, `adminExtend`, `adminRenew`, `selfExtend`, `selfRenew`, `unknownFutureValue`. `adminAssign`: For administrators to assign eligible roles to principals. `adminRemove`: For administrators to remove eligible roles from principals. `adminUpdate`: For administrators to change existing role eligibilities. `adminExtend`: For administrators to extend expiring role eligibilities. `adminRenew`: For administrators to renew expired eligibilities. `selfActivate`: For users to activate their assignments. `selfDeactivate`: For users to deactivate their active assignments. `selfExtend`: For users to request to extend their expiring assignments. `selfRenew`: For users to request to renew their expired assignments.
approvalId	String	The identifier of the approval of the request. Inherited from request.
appScopeId	String	Identifier of the app-specific scope when the role eligibility is scoped to an app. The scope of a role eligibility determines the set of resources for which the principal is eligible to 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. Supports `$filter` (`eq`, `ne`, and on `null` values).
completedDateTime	DateTimeOffset	The request completion date time. Inherited from request.
createdBy	identitySet	The principal that created this request. Inherited from request.
createdDateTime	DateTimeOffset	The request creation date time. Inherited from request.
customData	String	Free text field to define any custom data for the request. Not used. Inherited from request.
directoryScopeId	String	Identifier of the directory object representing the scope of the role eligibility. The scope of a role eligibility 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. Supports `$filter` (`eq`, `ne`, and on `null` values).
id	String	The unique identifier for the unifiedRoleEligibilityScheduleRequest object. Key, not nullable, Read-only. Inherited from entity.
isValidationOnly	Boolean	Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
justification	String	A message provided by users and administrators when create they create the unifiedRoleEligibilityScheduleRequest object.
principalId	String	Identifier of the principal that has been granted the role eligibility. Can be a user or a role-assignable group. You can grant only active assignments service principals.Supports `$filter` (`eq`, `ne`).
roleDefinitionId	String	Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Supports `$filter` (`eq`, `ne`).
scheduleInfo	requestSchedule	The period of the role eligibility. Recurring schedules are currently unsupported.
status	String	The status of the role eligibility request. Inherited from request. Read-only. Supports `$filter` (`eq`, `ne`).
targetScheduleId	String	Identifier of the schedule object that's linked to the eligibility request. Supports `$filter` (`eq`, `ne`).
ticketInfo	ticketInfo	Ticket details linked to the role eligibility request including details of the ticket number and ticket system. Optional.

Table of Contents

RoleEligibilitySchedule.ReadWrite.Directory

Graph Methods

Resources