unifiedRoleEligibilityScheduleRequest 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 request for a role eligibility for a principal through PIM. The role eligibility can be permanently eligible without an expiry date or temporarily eligible with an expiry date. Inherits from request.
For more information about PIM scenarios you can define through the unifiedRoleEligibilityScheduleRequest resource type, see Overview of role management through the privileged identity management (PIM) API.
Methods
| Method | Return type | Description |
|---|---|---|
| List | unifiedRoleEligibilityScheduleRequest collection | Retrieve the requests for role eligibilities for principals made through the unifiedRoleEligibilityScheduleRequest object. |
| Create | unifiedRoleEligibilityScheduleRequest | Request for a role eligibility for a principal through the unifiedRoleEligibilityScheduleRequest object. |
| Get | unifiedRoleEligibilityScheduleRequest | Read the details of a request for a role eligibility request made through the unifiedRoleEligibilityScheduleRequest object. |
| Filter by current user | unifiedRoleEligibilityScheduleRequest collection | In PIM, retrieve the requests for role eligibilities for a particular principal. The principal can be the creator or approver of the unifiedRoleEligibilityScheduleRequest object, or they can be the target of the role eligibility. |
| Cancel | None | Immediately cancel a unifiedRoleEligibilityScheduleRequest object whose status is Granted and have the system automatically delete the canceled request after 30 days. |
Properties
| Property | Type | Description |
|---|---|---|
| action | String | Represents the type of operation on the role eligibility request. The possible values are:
|
| 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. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| appScope | appScope | Read-only property with details of the app-specific scope when the role eligibility is scoped to an app. Nullable. Supports $expand. |
| directoryScope | directoryObject | The directory object that is the scope of the role eligibility. Read-only. Supports $expand. |
| principal | directoryObject | The principal that's getting a role eligibility through the request. Supports $expand. |
| roleDefinition | unifiedRoleDefinition | Detailed information for the unifiedRoleDefinition object that is referenced through the roleDefinitionId property. Supports $expand. |
| targetSchedule | unifiedRoleEligibilitySchedule | The schedule for a role eligibility that is referenced through the targetScheduleId property. Supports $expand. |
JSON representation
The following JSON representation shows the resource type.
{
"id": "String (identifier)",
"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"
}
}