unifiedRoleEligibilitySchedule resource type

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.

Represents a schedule for a role eligibility in your tenant and is used to instantiate a unifiedRoleEligibilityScheduleInstance.

Inherits from unifiedRoleScheduleBase.

Methods

Method	Return type	Description
List unifiedRoleEligibilitySchedules	unifiedRoleEligibilitySchedule collection	Get the schedules for role eligibility operations.
Get unifiedRoleEligibilitySchedule	unifiedRoleEligibilitySchedule	Retrieve the schedule for a role eligibility operation.
filterByCurrentUser	unifiedRoleEligibilitySchedule collection	Retrieve the schedules for role eligibilities for which the signed-in user is the principal.

Properties

Property	Type	Description
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. Inherited from unifiedRoleScheduleBase. Supports $filter (eq, ne, and on null values).
createdDateTime	DateTimeOffset	Time that the schedule was created. Inherited from unifiedRoleScheduleBase.
createdUsing	String	Identifier of the roleEligibilityScheduleRequest that created this schedule. Inherited from unifiedRoleScheduleBase. Supports $filter (eq, ne, and on null values).
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. Inherited from unifiedRoleScheduleBase. Supports $filter (eq, ne, and on null values).
id	String	The unique identifier for the unifiedRoleEligibilitySchedule. Key, not nullable, Read-only. Inherited from unifiedRoleScheduleBase. Supports $filter (eq).
memberType	String	Membership type of the eligible assignment. It can either be Inherited, Direct, or Group. Supports $filter (eq).
modifiedDateTime	DateTimeOffset	Last time the schedule was updated. Inherited from unifiedRoleScheduleBase.
principalId	String	Identifier of the principal to which the eligible assignment is being granted to. Can be a group or a user. Inherited from unifiedRoleScheduleBase. Supports $filter (eq).
roleDefinitionId	String	Identifier of the unifiedRoleDefinition the assignment is for. Inherited from unifiedRoleScheduleBase. Supports $filter (eq).
scheduleInfo	requestSchedule	The schedule object of the eligible role assignment request.
status	String	Status for the roleEligibilitySchedule. It can include state related messages like Provisioned, Revoked, Pending Provisioning, and Pending Approval. Inherited from unifiedRoleScheduleBase. Supports $filter (eq).

Relationships

Relationship	Type	Description
appScope	appScope	Read-only property with details of the app specific scope when the assignment scope is app specific. Containment entity. Inherited from unifiedRoleScheduleBase
directoryScope	directoryObject	Property referencing the directory object that is the scope of the eligible assignment. Provided so that callers can get the directory object using $expand at the same time as getting the eligible role assignment. Read-only. Inherited from unifiedRoleScheduleBase
principal	directoryObject	Property referencing the principal that is getting an eligible role assignment through the request. Provided so that callers can get the principal using $expand at the same time as getting the eligible role assignment. Read-only. Inherited from unifiedRoleScheduleBase
roleDefinition	unifiedRoleDefinition	Property indicating the roleDefinition the eligible assignment is for. Provided so that callers can get the role definition using $expand at the same time as getting the eligible role assignment. roleDefinition.Id will be auto expanded. Inherited from unifiedRoleScheduleBase

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.unifiedRoleEligibilitySchedule",
  "id": "String (identifier)",
  "principalId": "String",
  "roleDefinitionId": "String",
  "directoryScopeId": "String",
  "appScopeId": "String",
  "createdUsing": "String",
  "createdDateTime": "String (timestamp)",
  "modifiedDateTime": "String (timestamp)",
  "status": "String",
  "scheduleInfo": {
    "@odata.type": "microsoft.graph.requestSchedule"
  },
  "memberType": "String"
}