unifiedRoleAssignmentScheduleRequest 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.

In PIM, represents a request for an active role assignment to a principal. The role assignment can be permanently active with or without an expiry date, or temporarily active after activation of an eligible assignment. Inherits from request.

For more information about PIM scenarios you can define through the unifiedRoleAssignmentScheduleRequest resource type, see Overview of role management through the privileged identity management (PIM) API.

Methods

Method	Return type	Description
List	unifiedRoleAssignmentScheduleRequest collection	Retrieve the requests for active role assignments made through the unifiedRoleAssignmentScheduleRequest object.
Create	unifiedRoleAssignmentScheduleRequest	Create a request for an active and persistent role assignment or activate, deactivate, extend, or renew an eligible role assignment.
Get	unifiedRoleAssignmentScheduleRequest	Retrieve a request for an active role assignment made through the unifiedRoleAssignmentScheduleRequest object.
Cancel	None	Cancel a request for an active role assignment.
Filter by current user	unifiedRoleAssignmentScheduleRequest collection	Retrieve the requests for active role assignments for a particular principal.

Properties

Property	Type	Description
action	String	Represents the type of the operation on the role assignment request. The possible values are: adminAssign, adminUpdate, adminRemove, selfActivate, selfDeactivate, adminExtend, adminRenew, selfExtend, selfRenew, unknownFutureValue. adminAssign: For administrators to assign roles to principals. adminRemove: For administrators to remove principals from roles. adminUpdate: For administrators to change existing role assignments. adminExtend: For administrators to extend expiring assignments. adminRenew: For administrators to renew expired assignments. selfActivate: For principals to activate their assignments. selfDeactivate: For principals to deactivate their active assignments. selfExtend: For principals to request to extend their expiring assignments. selfRenew: For principals 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 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).
completedDateTime	DateTimeOffset	The request completion date time. Inherited from request.
createdBy	identitySet	The principal that created this request. Inherited from request. Read-only. Supports $filter (eq, ne, and on null values).
createdDateTime	DateTimeOffset	The request creation date time. Inherited from request. Read-only.
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 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).
id	String	The unique identifier for the unifiedRoleAssignmentScheduleRequest object. Key, not nullable, Read-only. Inherited from entity. Supports $filter (eq, ne).
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 unifiedRoleAssignmentScheduleRequest object.
principalId	String	Identifier of the principal that has been granted the assignment. Can be a user, role-assignable group, or a service principal. 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 assignment. Recurring schedules are currently unsupported.
status	String	The status of the role assignment request. Inherited from request. Read-only. Supports $filter (eq, ne).
targetScheduleId	String	Identifier of the schedule object that's linked to the assignment request. Supports $filter (eq, ne).
ticketInfo	ticketInfo	Ticket details linked to the role assignment request including details of the ticket number and ticket system.

Relationships

Relationship	Type	Description
activatedUsing	unifiedRoleEligibilitySchedule	If the request is from an eligible administrator to activate a role, this parameter will show the related eligible assignment for that activation. Otherwise, it's null. Supports $expand and $select nested in $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 unifiedRoleDefinition object that is referenced through the roleDefinitionId property. Supports $expand and $select nested in $expand.
targetSchedule	unifiedRoleAssignmentSchedule	The schedule for an eligible role assignment that is referenced through the targetScheduleId property. Supports $expand and $select nested in $expand.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.unifiedRoleAssignmentScheduleRequest",
  "id": "String (identifier)",
  "status": "String",
  "completedDateTime": "String (timestamp)",
  "createdDateTime": "String (timestamp)",
  "approvalId": "String",
  "customData": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "action": "String",
  "principalId": "String",
  "roleDefinitionId": "String",
  "directoryScopeId": "String",
  "appScopeId": "String",
  "isValidationOnly": "Boolean",
  "targetScheduleId": "String",
  "justification": "String",
  "scheduleInfo": {
    "@odata.type": "microsoft.graph.requestSchedule"
  },
  "ticketInfo": {
    "@odata.type": "microsoft.graph.ticketInfo"
  }
}