편집

다음을 통해 공유


Get Copilot package details

Important

APIs under the /beta version are subject to change. Use of these APIs in production applications is not supported.

Retrieves detailed information for a specific agent or app by ID.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) CopilotPackages.Read.All CopilotPackages.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application CopilotPackages.Read.All CopilotPackages.ReadWrite.All

HTTP request

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages/{id}

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 copilotPackageDetail object in the response body.

Example

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages/abc

Response

The following example shows the response.

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

{
  "longDescription": "This is a detailed description for package abc. It provides comprehensive information about the package functionality, features, and usage scenarios.",
  "version": "1.2.3",
  "categories": [
    "Development",
    "Productivity",
    "Tools"
  ],
  "type": "custom",
  "manifestVersion": "2.0",
  "id": "abc",
  "shortDescription": "Short description for package abc",
  "isBlocked": false,
  "supportedHosts": [
    "Teams",
    "Outlook",
    "SharePoint"
  ],
  "lastModifiedDateTime": "2025-10-06T00:07:20.1467852Z",
  "availableTo": "all",
  "deployedTo": "all",
  "allowedUsersAndGroups": [
    {
      "resourceId": "user-123",
      "resourceType": "user"
    },
    {
      "resourceId": "group-456",
      "resourceType": "group"
    }
  ],
  "elementDetails": [
    {
      "elementType": "Bot",
      "elements": [
        {
          "id": "bot-001",
          "definition": "{\\n\\\"botId\\\":\\\"303e399a-cecc-4511-ad38-82970baa288b\\\",\\n\\\"scopes\\\":[\\n\\\"personal\\\"\\n],\\n\\\"isNotificationOnly\\\":true,\\n\\\"supportsCalling\\\":false,\\n\\\"supportsVideo\\\":false,\\n\\\"supportsFiles\\\":false\\n}"
        },
        {
          "id": "bot-002",
          "definition": "{\\n\\\"botId\\\":\\\"203e399a-cecc-4511-ad38-82970baa288b\\\",\\n\\\"scopes\\\":[\\n\\\"personal\\\"\\n],\\n\\\"isNotificationOnly\\\":true,\\n\\\"supportsCalling\\\":false,\\n\\\"supportsVideo\\\":false,\\n\\\"supportsFiles\\\":false\\n}"
        }
      ]
    },
    {
      "elementType": "DeclarativeCopilots",
      "elements": [
        {
          "id": "dcp-001",
          "definition": "dcp1 json definition as string"
        },
        {
          "id": "dcp-002",
          "definition": "dcp2 json definition as string"
        }
      ]
    }
  ]
}