Edit

accessPackage resource type

  • Article

Namespace: microsoft.graph

In Microsoft Entra Entitlement Management, an access package defines the collections of resource roles and the policies for how one or more users can get access to those resources.

Each access package is referenced by a single access package catalog, and has links to the resources from that catalog via the resource-specific role scopes that define the access the package provides. An access package also links to the access package assignment policies, each of which define who can request or be assigned an access package assignment.

Methods

Method Return type Description
List accessPackages accessPackage collection Retrieve a list of accesspackage objects.
Create accessPackage accessPackage Create a new accesspackage object.
Get accessPackage accessPackage Read properties and relationships of an accesspackage object.
Update accessPackage None Update the properties of an accesspackage object.
Delete accessPackage None Delete an accesspackage.
List incompatibleAccessPackages accessPackage collection Retrieve a list of the incompatible accesspackage objects for this access package.
Add accessPackage to incompatibleAccessPackages None Add a link to indicate another accesspackage is incompatible with a specified access package.
Remove accessPackage from incompatibleAccessPackages None Remove a link that indicated an accesspackage was incompatible.
List incompatibleGroups group collection Retrieve a list of the incompatible group objects for this access package.
Add group to incompatibleGroups None Add a link to indicate membership of a group is incompatible with a specified access package.
Remove group from incompatibleGroups None Remove a link that indicated a group membership was incompatible.
List accessPackagesIncompatibleWith accessPackage collection Retrieve a list of the accesspackage objects that list this access package as incompatible.
filterByCurrentUser accessPackage collection Retrieve the list of accessPackage objects filtered on the signed-in user.
getApplicablePolicyRequirements accessPackageAssignmentRequestRequirements collection Retrieve a list of accessPackageAssignmentRequestRequirement objects with request requirements.
List accessPackageResourceRoleScopes accessPackageResourceRoleScope collection Retrieve a list of accessPackageResourceRoleScope objects for an access package.
Create accessPackageResourceRoleScope Create a new accessPackageResourceRoleScope object for an access package.
Delete accessPackageResourceRoleScope Delete an accessPackageResourceRoleScope object from an access package.

Properties

Property Type Description
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.
description String The description of the access package.
displayName String Required. The display name of the access package. Supports $filter (eq, contains).
id String Read-only.
isHidden Boolean Whether the access package is hidden from the requestor.
modifiedDateTime 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.

Relationships

Relationship Type Description
accessPackagesIncompatibleWith accessPackage collection The access packages that are incompatible with this package. Read-only.
assignmentPolicies accessPackageAssignmentPolicy collection Read-only. Nullable. Supports $expand.
catalog accessPackageCatalog Required when creating the access package. Read-only. Nullable.
incompatibleAccessPackages accessPackage collection The access packages whose assigned users are ineligible to be assigned this access package.
incompatibleGroups group collection The groups whose members are ineligible to be assigned this access package.
resourceRoleScopes accessPackageResourceRoleScope collection The resource roles and scopes in this access package.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.accessPackage",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String", 
  "id": "String (identifier)",
  "isHidden": "Boolean",
  "modifiedDateTime": "String (timestamp)"
}