Skip to content

agentinstance-list-collections.md

Latest commit

 

History

History
132 lines (99 loc) · 4.53 KB

agentinstance-list-collections.md

File metadata and controls

132 lines (99 loc) · 4.53 KB
title List collections
description List the collections that the agent instance is a member of.
author jasondou
ms.date 11/06/2025
ms.localizationpriority medium
ms.subservice entra-id
doc_type apiPageType

List collections

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

List the collections that the agent instance is a member of.

[!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-agentregistry-apis]

HTTP request

GET /agentRegistry/agentInstances/{agentInstanceId}/collections

Optional query parameters

This method supports the $filter, $select, and $expand OData query parameters to help customize 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 agentCollection objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/agentRegistry/agentInstances/{agentInstanceId}/collections

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]

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": "Security Copilot Platform Workspace: 001",
      "ownerIds": [
        "daf58b0e-44e1-433c-b6b0-ca70cae320b8",
        "b9108c41-d2d2-4e78-b073-92f57b752bd0"
      ],
      "managedBy": "719cc904-9700-4e08-9941-fd826cc84c60",
      "originatingStore": "Microsoft Security Copilot",
      "createdBy": "d47bffae-411a-4de9-8548-05e79bc01f0d",
      "displayName": "Conditional Access Agents",
      "description": "Agents to manage your organization's conditional access policy",
      "createdDateTime": "2025-01-01T00:00:00.1234567Z",
      "lastModifiedDateTime": "2025-01-01T00:00:00.1234567Z"
    }
  ]
}