unifiedRoleAssignmentSchedule 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 an active role assignment in your tenant and is used to instantiate a unifiedRoleAssignmentScheduleInstance. The active assignment might have been made through PIM assignments and activation requests, or directly through the role assignments API.
Inherits from unifiedRoleScheduleBase.
Methods
| Method | Return type | Description |
|---|---|---|
| List | unifiedRoleAssignmentSchedule collection | Get the schedules for active role assignment operations. |
| Get | unifiedRoleAssignmentSchedule | Retrieve the schedule for an active role assignment operation. |
| Filter by current user | unifiedRoleAssignmentSchedule collection | Retrieve the schedules for active role assignment operations for which the signed-in user is the principal. |
Properties
| Property | Type | Description |
|---|---|---|
| appScopeId | String | Identifier of the app-specific scope when the assignment is scoped to an app. 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. Supports $filter (eq, ne, and on null values). Inherited from unifiedRoleScheduleBase. |
| assignmentType | String | The type of the assignment that can either be Assigned or Activated. Supports $filter (eq, ne). |
| createdDateTime | DateTimeOffset | When the schedule was created. Inherited from unifiedRoleScheduleBase. |
| createdUsing | String | Identifier of the unifiedRoleAssignmentScheduleRequest object through which this schedule was created. Nullable. 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. Supports $filter (eq, ne, and on null values). Inherited from unifiedRoleScheduleBase. |
| id | String | The unique identifier for the unifiedRoleAssignmentScheduleRequest object. Supports $filter (eq). Inherited from entity. |
| memberType | String | How the assignment is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule 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 has been granted the role assignment. Inherited from unifiedRoleScheduleBase. Supports $filter (eq, ne). |
| roleDefinitionId | String | Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Inherited from unifiedRoleScheduleBase. Supports $filter (eq, ne). |
| scheduleInfo | requestSchedule | The period of the role assignment. It can represent a single occurrence or multiple recurrences. |
| status | String | The status of the unifiedRoleAssignmentScheduleRequest object. 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). |
Relationships
| Relationship | Type | Description |
|---|---|---|
| activatedUsing | unifiedRoleEligibilitySchedule | If the request is from an eligible administrator to activate a role, this parameter shows the related eligible assignment for that activation. Otherwise, it's null. Supports $expand. |
| appScope | appScope | Read-only property with details of the app-specific scope when the assignment is scoped to an app. Nullable. Supports $expand. |
| directoryScope | directoryObject | The directory object that is the scope of the assignment. Read-only. Supports $expand. |
| principal | directoryObject | The principal that's getting a role assignment through the request. Supports $expand and $select nested in $expand for id only. |
| roleDefinition | unifiedRoleDefinition | Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property. Supports $expand and $select nested in $expand. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.unifiedRoleAssignmentSchedule",
"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"
},
"assignmentType": "String",
"memberType": "String"
}