Skip to content

agentcollection-get.md

Latest commit

 

History

History
133 lines (99 loc) · 4.65 KB

agentcollection-get.md

File metadata and controls

133 lines (99 loc) · 4.65 KB
title Get agentCollection
description Read the properties and relationships of agentCollection object.
author jasondou
ms.date 11/06/2025
ms.localizationpriority medium
ms.subservice entra-id
doc_type apiPageType

Get agentCollection

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Read the properties and relationships of agentCollection object.

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

Important

In addition to the permissions listed in the preceding table, the following lesser-privileged permissions scoped to the special collections are supported for this API:

  • AgentCollection.Read.Global and AgentCollection.ReadWrite.Global for the Global collection
  • AgentCollection.Read.Quarantined and AgentCollection.ReadWrite.Quarantined for the Quarantined collection

[!INCLUDE rbac-agentregistry-apis]

HTTP request

GET /agentRegistry/agentCollections/{agentCollectionId}

Optional query parameters

This method supports the $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 an agentCollection object in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/agentRegistry/agentCollections/{agentCollectionId}

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

{
  "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"
}