Edit

Share via

Update agentCardManifest

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.

Update the properties of an agentCardManifest object.

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) AgentCardManifest.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application AgentCardManifest.ReadWrite.All AgentCardManifest.ReadWrite.ManagedBy

Important

When using delegated permissions, the authenticated user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Agent Registry Administrator is the least privileged role supported for this operation.

HTTP request

PATCH /agentRegistry/agentCardManifests/{agentCardManifestId}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
displayName String Display name of the agent. Optional.
description String Description of the agent's purpose. Optional.
iconUrl String URL to agent's icon image. Optional.
protocolVersion String Protocol version supported by the agent. Optional.
version String Version of the agent implementation. Optional.
documentationUrl String URL to agent's documentation. Optional.
defaultInputModes String collection Default input modes supported. Optional.
defaultOutputModes String collection Default output modes supported. Optional.
provider agentProvider Information about the organization providing the agent. Optional.
securitySchemes securitySchemes Dictionary of security scheme definitions keyed by scheme name. Optional.
security securityRequirement collection Security requirements - array of security scheme references. Optional.
capabilities agentCapabilities Specific capabilities supported by the agent. Optional.
skills agentSkill collection Skills/capabilities that the agent can perform. Optional.
supportsAuthenticatedExtendedCard Boolean Whether agent supports authenticated extended card retrieval. Optional.
ownerIds String collection List of owner identifiers for the agent card manifest, can be users or service principals. Optional.
managedBy String Application identifier managing this manifest. Optional.
originatingStore String Name of the store/system where agent originated. Optional.

Response

If successful, this method returns a 200 OK response code and an updated agentCardManifest object in the response body.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/agentRegistry/agentCardManifests/{agentCardManifestId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentCardManifest",
  "ownerIds": [
    "String"
  ],
  "managedBy": "String",
  "originatingStore": "String",
  "createdBy": "String",
  "protocolVersion": "String",
  "displayName": "String",
  "description": "String",
  "iconUrl": "String",
  "provider": {
    "@odata.type": "microsoft.graph.agentProvider"
  },
  "version": "String",
  "documentationUrl": "String",
  "capabilities": {
    "@odata.type": "microsoft.graph.agentCapabilities"
  },
  "securitySchemes": {
    "@odata.type": "microsoft.graph.securitySchemes"
  },
  "security": [
    {
      "@odata.type": "microsoft.graph.securityRequirement"
    }
  ],
  "defaultInputModes": [
    "String"
  ],
  "defaultOutputModes": [
    "String"
  ],
  "skills": [
    {
      "@odata.type": "microsoft.graph.agentSkill"
    }
  ],
  "supportsAuthenticatedExtendedCard": "Boolean"
}

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

{
  "@odata.type": "#microsoft.graph.agentCardManifest",
  "id": "5d1d9ba4-36ed-2e0c-c182-9da69c5e398d",
  "ownerIds": [
    "String"
  ],
  "managedBy": "String",
  "originatingStore": "String",
  "createdBy": "String",
  "createdDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "protocolVersion": "String",
  "displayName": "String",
  "description": "String",
  "iconUrl": "String",
  "provider": {
    "@odata.type": "microsoft.graph.agentProvider"
  },
  "version": "String",
  "documentationUrl": "String",
  "capabilities": {
    "@odata.type": "microsoft.graph.agentCapabilities"
  },
  "securitySchemes": {
    "@odata.type": "microsoft.graph.securitySchemes"
  },
  "security": [
    {
      "@odata.type": "microsoft.graph.securityRequirement"
    }
  ],
  "defaultInputModes": [
    "String"
  ],
  "defaultOutputModes": [
    "String"
  ],
  "skills": [
    {
      "@odata.type": "microsoft.graph.agentSkill"
    }
  ],
  "supportsAuthenticatedExtendedCard": "Boolean"
}
  • Last updated on