Skip to content

accesspackagecatalog-list-accesspackageresourceroles.md

Latest commit

 

History

History
330 lines (242 loc) · 12.3 KB

accesspackagecatalog-list-accesspackageresourceroles.md

File metadata and controls

330 lines (242 loc) · 12.3 KB
title List accessPackageResourceRoles
description Retrieve a list of accessPackageResourceRole objects of an accessPackageResource in an accessPackageCatalog.
ms.localizationpriority medium
author markwahl-msft
ms.subservice entra-id-governance
doc_type apiPageType
ms.date 11/20/2024

List accessPackageResourceRoles

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve a list of accessPackageResourceRole objects of an accessPackageResource in an accessPackageCatalog. The resource should have been added to the catalog by creating an accessPackageResourceRequest. This list of roles can then be used by the caller to select a role, which is needed when later creating an accessPackageResourceRoleScope.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-entitlement-catalog-reader]

HTTP request

GET /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/accessPackageResourceRoles?$filter=(originSystem+eq+%27{originSystemType}%27+and+accessPackageResource/id+eq+%27{resourceId}%27)&$expand=accessPackageResource

Optional query parameters

This method uses OData query parameters to construct the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of accessPackageResourceRole objects in the response body.

Examples

Example 1: Retrieving the roles of a resource for a group

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/15d889df-3eb8-4e9b-bfb4-b1908849aec4/accessPackageResourceRoles?$filter=(originSystem+eq+%27AadGroup%27+and+accessPackageResource/id+eq+%27a35bef72-a8aa-4ca3-af30-f6b2ece7208f%27)&$expand=accessPackageResource

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "id-value",
      "displayName": "Member",
      "description": "description-value",
      "originId": "originId-value",
      "originSystem": "originSystem-value"
    }
  ]
}

Example 2: Retrieve the roles of a resource for a SharePoint site

The following example shows how to retrieve the roles of a resource, to obtain the originId of each role. This would be used after a SharePoint site has been added as a resource to the catalog, as the originId of a SharePoint site role, the sequence number of the role in the site, is needed to add the role to an access package.

Request

The following is an example of the request, to retrieve the roles of a particular resource 53c71803-a0a8-4777-aecc-075de8ee3991 which has an originSystem of SharePointOnline and is located in catalog beedadfe-01d5-4025-910b-84abb9369997.

HTTP

GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/beedadfe-01d5-4025-910b-84abb9369997/accessPackageResourceRoles?$filter=(originSystem+eq+%27SharePointOnline%27+and+accessPackageResource/id+eq+%2753c71803-a0a8-4777-aecc-075de8ee3991%27)&$select=displayName,originId

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response. The displayName is the same as shown in the SharePoint view of a site, and the originId is the underlying identifier established by SharePoint for the role.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
        "displayName": "Contributors",
        "originId": "4"
    },
    {
        "displayName": "Creators",
        "originId": "3"
    },
    {
        "displayName": "Viewers",
        "originId": "5"
    }
  ]
}

Example 3: Retrieving the roles of a resource for a PIM-managed group

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/15d889df-3eb8-4e9b-bfb4-b1908849aec4/accessPackageResourceRoles?$filter=(originSystem+eq+%27AadGroup%27+and+accessPackageResource/id+eq+%27a35bef72-a8aa-4ca3-af30-f6b2ece7208f%27)&$expand=accessPackageResource

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "4f880547-ad41-4a2f-a1a7-99395c247e5a",
      "displayName": "Eligible Member",
      "description": "Eligible Member",
      "originId": "27a35bef72-a8aa-4ca3-af30-f6b2ece7208f",
      "originSystem": "AadGroup"
    },
    {
      "id": "f0934696-3aba-429d-b69b-c01748aa9323",
      "displayName": "Eligible Owner",
      "description": "Eligible Owner",
      "originId": "27a35bef72-a8aa-4ca3-af30-f6b2ece7208f",
      "originSystem": "AadGroup"
    },
    {
      "id": "4e2cc45f-a3f0-4f0a-b33b-d30e04497315",
      "displayName": "Member",
      "description": "Member",
      "originId": "27a35bef72-a8aa-4ca3-af30-f6b2ece7208f",
      "originSystem": "AadGroup"
    },
    {
      "id": "bd939e12-cf35-4347-aed9-80b87dc10aac",
      "displayName": " Owner",
      "description": "Owner",
      "originId": "27a35bef72-a8aa-4ca3-af30-f6b2ece7208f",
      "originSystem": "AadGroup"
    }
  ]
}