Show / Hide Table of Contents

EntitlementManagement.ReadWrite.All

Allows the app to request access to and management of access packages and related entitlement management resources on behalf of the signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D DELETE /roleManagement/directory/roleAssignments/{id}
V1 D GET /identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{accessPackageAssignmentRequestId}
V1 D GET /identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{accessPackageAssignmentRequestId}/stages
V1 D GET /identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{accessPackageAssignmentRequestId}/stages/{approvalStageId}
V1 D GET /identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{id}
V1 D GET /identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/filterByCurrentUser(on='approver')
V1 D GET /roleManagement/cloudPC/roleDefinitions
V1 A,D GET /roleManagement/cloudPC/roleDefinitions/{id}
V1 A,D GET /roleManagement/directory/roleAssignments
V1 A,D GET /roleManagement/directory/roleAssignments/{id}
V1 A,D GET /roleManagement/directory/roleDefinitions
V1 A,D GET /roleManagement/directory/roleDefinitions/{id}
V1 D PATCH /identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{accessPackageAssignmentRequestId}/stages/{approvalStageId}
V1 A,D POST /roleManagement/directory/roleAssignments

Delegate Permission

Id ae7a573d-81d7-432b-ad44-4ed5c9d89038
Consent Type Admin
Display String Read and write entitlement management resources
Description Allows the app to request access to and management of access packages and related entitlement management resources on behalf of the signed-in user.

Application Permission

Id 9acd699f-1e81-4958-b001-93b1d2506e19
Display String Read and write all entitlement management resources
Description Allows the app to read and write access packages and related entitlement management resources without a signed-in user.

Resources

accessPackageAssignmentRequest

Property Type Description
answers accessPackageAnswer collection Answers provided by the requestor to accessPackageQuestions asked of them at the time of request.
completedDateTime DateTimeOffset The date of the end of processing, either successful or failure, of a request. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
customExtensionCalloutInstances customExtensionCalloutInstance collection Information about all the custom extension calls that were made during the access package assignment workflow.
createdDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter.
id String Read-only.
requestType accessPackageRequestType The type of the request. The possible values are: notSpecified, userAdd, UserExtend, userUpdate, userRemove, adminAdd, adminUpdate, adminRemove, systemAdd, systemUpdate, systemRemove, onBehalfAdd (not supported), unknownFutureValue. A request from the user themselves would have requestType of userAdd, userUpdate or userRemove. This property can't be changed once set.
schedule entitlementManagementSchedule The range of dates that access is to be assigned to the requestor. This property can't be changed once set.
state accessPackageRequestState The state of the request. The possible values are: submitted, pendingApproval, delivering, delivered, deliveryFailed, denied, scheduled, canceled, partiallyDelivered, unknownFutureValue. Read-only. Supports $filter (eq).
status String More information on the request processing status. Read-only.

approval

Property Type Description
id String Identifier of the approval decision.
  • In PIM for groups, it is the same identifier as the identifier of the assignment schedule request.
  • approvalStage

    Property Type Description
    assignedToMe Boolean Indicates whether the stage is assigned to the calling user to review. Read-only.
    displayName String The label provided by the policy creator to identify an approval stage. Read-only.
    id String The identifier of the stage associated with an approval object. Read-only.
    justification String The justification associated with the approval stage decision.
    reviewResult String The result of this approval record. Possible values include: NotReviewed, Approved, Denied.
    reviewedBy identity The identifier of the reviewer. 00000000-0000-0000-0000-000000000000 if the assigned reviewer hasn't reviewed. Read-only.
    reviewedDateTime DateTimeOffset The date and time when a decision was recorded. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
    status String The stage status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.

    directoryObject

    Property Type Description
    deletedDateTime DateTimeOffset Date and time when this object was deleted. Always null when the object hasn't been deleted.
    id String The unique identifier for the object. For example, 12345678-9abc-def0-1234-56789abcde. The value of the **i

    entitlementmanagement-overview

    privilegedAccessGroupAssignmentScheduleRequest

    Property Type Description
    accessId privilegedAccessGroupRelationships The identifier of a membership or ownership assignment relationship to the group. Required. The possible values are: owner, member, unknownFutureValue.
    action String Represents the type of operation on the group membership or ownership assignment request. The possible values are: adminAssign, adminUpdate, adminRemove, selfActivate, selfDeactivate, adminExtend, adminRenew.
    • adminAssign: For administrators to assign group membership or ownership to principals.
    • adminRemove: For administrators to remove principals from group membership or ownership.
    • adminUpdate: For administrators to change existing group membership or ownership 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.
    approvalId String The identifier of the approval of the request. Inherited from request.
    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.
    groupId String The identifier of the group representing the scope of the membership or ownership assignment through PIM for groups. Required.
    id String The unique identifier for the privilegedAccessGroupAssignmentScheduleRequest 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 they create the privilegedAccessGroupAssignmentScheduleRequest object.
    principalId String The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for groups. Supports $filter (eq, ne).
    scheduleInfo requestSchedule The period of the group membership or ownership assignment. Recurring schedules are currently unsupported.
    status String The status of the group membership or ownership assignment request. Inherited from request. Read-only. Supports $filter (eq, ne).
    targetScheduleId String The identifier of the schedule that's created from the membership or ownership assignment request. Supports $filter (eq, ne).
    ticketInfo ticketInfo Ticket details linked to the group membership or ownership assignment request including details of the ticket number and ticket system.

    privilegedidentitymanagement-for-groups-api-overview

    privilegedidentitymanagementv3-overview

    unifiedRoleAssignment

    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 a resource application only. For the entitlement management provider, use this property to specify a catalog, for example /AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997. Supports $filter (eq, in). For example /roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'.
    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, unlike app scopes that are defined and understood by a resource application only. Supports $filter (eq, in).
    id String The unique identifier for the unifiedRoleAssignment. Key, not nullable, Read-only.
    principalId String Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports $filter (eq, in).
    roleDefinitionId String Identifier of the unifiedRoleDefinition the assignment is for. Read-only. Supports $filter (eq, in).

    unifiedRoleAssignmentScheduleRequest

    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.

    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
    In This Article
    Back to top Created by merill | Submit feedback