Edit

accessPackageCatalog resource type

  • Article

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 Microsoft Entra entitlement management, an access package catalog is a container for zero or more access packages. Microsoft Entra entitlement management includes a built-in catalog named General.

An access package catalog might also have linked resources that are used in those access packages to provide access. To view or change the membership of catalog-scoped roles, use the role assignments API with the entitlement management RBAC provider.

Methods

Method Return Type Description
List accessPackageCatalogs accessPackageCatalog collection Retrieve a list of accesspackagecatalog objects.
Create accessPackageCatalog accessPackageCatalog Create a new accessPackageCatalog object.
Get accessPackageCatalog accessPackageCatalog Read properties and relationships of an accessPackageCatalog object.
Update accessPackageCatalog None Update the properties of an accessPackageCatalog object.
Delete accessPackageCatalog Delete accessPackageCatalog.
Access package resources
List accessPackageCatalog resources accessPackageResource collection Retrieve a list of accessPackageResource objects in a catalog.
Access package resource roles
List accessPackageCatalog resource roles accessPackageResourceRole collection Retrieve a list of accessPackageResourceRole objects for resources in a catalog.
Access package custom package workflow extensions
List accessPackageCustomWorkflowExtensions accessPackageAssignmentRequestWorkflowExtension and accessPackageAssignmentWorkflowExtension collection Get a list of the accessPackageAssignmentRequestWorkflowExtension and accessPackageAssignmentWorkflowExtension objects and their properties.
Create accessPackageCustomWorkflowExtensions accessPackageAssignmentRequestWorkflowExtension or accessPackageAssignmentWorkflowExtension Create a new accessPackageAssignmentRequestWorkflowExtension or accessPackageAssignmentWorkflowExtension object.
Get accessPackageAssignmentRequestWorkflowExtension accessPackageAssignmentRequestWorkflowExtension Read the properties and relationships of a accessPackageAssignmentRequestWorkflowExtension object.
Update accessPackageAssignmentRequestWorkflowExtension accessPackageAssignmentRequestWorkflowExtension Update the properties of a accessPackageAssignmentRequestWorkflowExtension object.
Delete accessPackageAssignmentRequestWorkflowExtension None Deletes a accessPackageAssignmentRequestWorkflowExtension object.
Get accessPackageAssignmentWorkflowExtension accessPackageAssignmentWorkflowExtension Read the properties and relationships of a accessPackageAssignmentWorkflowExtension object.
Update accessPackageAssignmentWorkflowExtension accessPackageAssignmentWorkflowExtension Update the properties of a accessPackageAssignmentWorkflowExtension object.
Delete accessPackageAssignmentWorkflowExtension None Deletes a accessPackageAssignmentWorkflowExtension object.
Custom access package package workflow extensions
List customAccessPackageWorkflowExtensions customAccessPackageWorkflowExtension collection Get a list of the customAccessPackageWorkflowExtension objects and their properties.
Create customAccessPackageWorkflowExtensions customAccessPackageWorkflowExtension Create a new customAccessPackageWorkflowExtension object.
Get customAccessPackageWorkflowExtension customAccessPackageWorkflowExtension Read the properties and relationships of a customAccessPackageWorkflowExtension object.
Update customAccessPackageWorkflowExtension customAccessPackageWorkflowExtension Update the properties of a customAccessPackageWorkflowExtension object.
Delete customAccessPackageWorkflowExtension None Deletes a customAccessPackageWorkflowExtension object.

Properties

Property Type Description
catalogStatus String Has the value Published if the access packages are available for management.
catalogType String One of UserManaged or ServiceDefault.
createdBy String UPN of the user who created this resource. Read-only.
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 catalog.
displayName String The display name of the access package catalog. Supports $filter (eq, contains).
id String Read-only.
isExternallyVisible Boolean Whether the access packages in this catalog can be requested by users outside of the tenant.
modifiedBy String The UPN of the user who last modified this resource. Read-only.
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
accessPackages accessPackage collection The access packages in this catalog. Read-only. Nullable. Supports $expand.
accessPackageCustomWorkflowExtensions customCalloutExtension collection The attributes of a logic app, which can be called at various stages of an access package request and assignment cycle.
accessPackageResources accessPackageResource collection Read-only. Nullable.
accessPackageResourceRoles accessPackageResourceRole collection The roles in each resource in a catalog. Read-only.
accessPackageResourceScopes accessPackageResourceScope collection Read-only.
customAccessPackageWorkflowExtension customAccessPackageWorkflowExtension collection The attributes of a logic app, which can be called at various stages of an access package request and assignment cycle.

JSON representation

The following is a JSON representation of the resource.

{
    "id":"360fa7de-90be-48dc-a2ce-fc40094a93dd",
    "description":"Sample access package catalog",
    "displayName":"Access package catalog for testing",
    "isExternallyVisible":false,
    "catalogType":"UserManaged",
    "catalogStatus":"Published",
    "createdDateTime":"2019-01-27T18:19:50.74Z",
    "modifiedDateTime":"2019-01-27T18:19:50.74Z",
    "createdBy":"TestGA@example.com",
    "modifiedBy":"TestGA@example.com"
}