# Agent Cards > Agent Cards - Use the endpoints described below to discover agents registered within platform and > manage agent cards. This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context. Companion generated at `2026-05-21T05:20:22.430191+00:00` (UTC). ## Primary page - [Agent Cards](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md): Full documentation for this topic (Markdown sidecar). ## Sections on this page - [List registered agent cards](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#list-registered-agent-cards): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#agentcards_list-parameters): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#enumerated-values): In-page section heading. - [Example responses](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#example-responses): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#responses): In-page section heading. - [Delete the agent card by deployment ID](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#delete-the-agent-card-by-deployment-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#deploymentsagentcard_deletemany-parameters): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#responses_1): In-page section heading. - [Retrieve the agent card by deployment ID](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#retrieve-the-agent-card-by-deployment-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#deploymentsagentcard_list-parameters): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#responses_2): In-page section heading. - [Create or replace the agent card by deployment ID](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#create-or-replace-the-agent-card-by-deployment-id): In-page section heading. - [Parameters](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#deploymentsagentcard_putmany-parameters): In-page section heading. - [Responses](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#responses_3): In-page section heading. - [APIKeySecurityScheme](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_APIKeySecurityScheme): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#enumerated-values_1): In-page section heading. - [AgentCapabilities](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentCapabilities): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_1): In-page section heading. - [AgentCard](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentCard): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_2): In-page section heading. - [AgentCardListResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentCardListResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_3): In-page section heading. - [AgentCardResponse](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentCardResponse): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_4): In-page section heading. - [AgentCardSignature](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentCardSignature): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_5): In-page section heading. - [AgentExtension](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentExtension): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_6): In-page section heading. - [AgentInterface](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentInterface): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_7): In-page section heading. - [AgentProvider](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentProvider): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_8): In-page section heading. - [AgentSkill](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AgentSkill): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_9): In-page section heading. - [AllowExtra](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AllowExtra): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_10): In-page section heading. - [AuthorizationCodeOAuthFlow](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_AuthorizationCodeOAuthFlow): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_11): In-page section heading. - [ClientCredentialsOAuthFlow](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_ClientCredentialsOAuthFlow): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_12): In-page section heading. - [HTTPAuthSecurityScheme](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_HTTPAuthSecurityScheme): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_13): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#enumerated-values_2): In-page section heading. - [ImplicitOAuthFlow](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_ImplicitOAuthFlow): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_14): In-page section heading. - [MutualTLSSecurityScheme](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_MutualTLSSecurityScheme): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_15): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#enumerated-values_3): In-page section heading. - [OAuth2SecurityScheme](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_OAuth2SecurityScheme): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_16): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#enumerated-values_4): In-page section heading. - [OAuthFlows](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_OAuthFlows): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_17): In-page section heading. - [OpenIdConnectSecurityScheme](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_OpenIdConnectSecurityScheme): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_18): In-page section heading. - [Enumerated Values](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#enumerated-values_5): In-page section heading. - [PasswordOAuthFlow](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#tocS_PasswordOAuthFlow): In-page section heading. - [Properties](https://docs.datarobot.com/en/docs/api/reference/public-api/agent_cards.html.md#properties_19): In-page section heading. ## Related documentation - [Developer documentation](https://docs.datarobot.com/en/docs/api/index.html.md): Linked from this page. - [API reference](https://docs.datarobot.com/en/docs/api/reference/index.html.md): Linked from this page. ## Documentation content Use the endpoints described below to discover agents registered within platform and manage agent cards. ## List registered agent cards Operation path: `GET /api/v2/agentCards/` Authentication requirements: `BearerAuth` Retrieve the list of agent cards within tenant. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | offset | query | integer | true | The number of agent cards to skip. Defaults to 0. | | limit | query | integer | true | The number of agent cards (greater than zero, max 100) to return. Defaults to 25. | | orderBy | query | string | false | The order to sort the agent cards. Defaults to order by creation time in ascending order. | | deploymentIds | query | array[string] | false | Filter registered agents on deployment IDs. | | externalIds | query | string | false | Filter registered agents on external IDs. | ### Enumerated Values | Parameter | Value | | --- | --- | | orderBy | [deploymentId, -deploymentId, externalId, -externalId, createdAt, -createdAt, updatedAt, -updatedAt] | ### Example responses > 200 Response ``` { "properties": { "count": { "description": "The number of items returned on this page.", "type": "integer" }, "data": { "description": "The list of formatted agent cards.", "items": { "properties": { "agentCard": { "description": "Plain agent card data.", "properties": { "additionalInterfaces": { "description": "Additional transport interfaces beyond the primary URL.", "items": { "properties": { "transport": { "description": "The transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON).", "type": "string" }, "url": { "description": "The URL for this transport interface.", "type": "string" } }, "required": [ "transport", "url" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "capabilities": { "description": "Optional capabilities supported by the agent.", "properties": { "extensions": { "description": "Protocol extensions supported by the agent.", "items": { "properties": { "description": { "description": "A human-readable description of the extension.", "type": [ "string", "null" ] }, "params": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "required": { "description": "Whether this extension is required by the agent.", "type": [ "boolean", "null" ] }, "uri": { "description": "The URI identifying the extension.", "type": "string" } }, "required": [ "uri" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "pushNotifications": { "description": "Whether the agent supports push notifications.", "type": [ "boolean", "null" ] }, "stateTransitionHistory": { "description": "Whether the agent supports state transition history.", "type": [ "boolean", "null" ] }, "streaming": { "description": "Whether the agent supports streaming responses.", "type": [ "boolean", "null" ] } }, "type": "object", "x-versionadded": "v2.46" }, "defaultInputModes": { "description": "Default MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "defaultOutputModes": { "description": "Default MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "description": { "description": "A human-readable description of the agent.", "type": "string" }, "documentationUrl": { "description": "URL to the agent's documentation.", "type": [ "string", "null" ] }, "iconUrl": { "description": "URL to an icon representing the agent.", "type": [ "string", "null" ] }, "name": { "description": "The display name of the agent.", "type": "string" }, "preferredTransport": { "default": "JSONRPC", "description": "Preferred transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON). Defaults to 'JSONRPC'.", "type": [ "string", "null" ] }, "protocolVersion": { "default": "0.3.0", "description": "The A2A protocol version. Defaults to '0.3.0'.", "type": [ "string", "null" ] }, "provider": { "description": "The service provider of the agent.", "properties": { "organization": { "description": "The organization name of the agent provider.", "type": "string" }, "url": { "description": "The URL of the agent provider.", "type": "string" } }, "required": [ "organization", "url" ], "type": "object", "x-versionadded": "v2.46" }, "security": { "description": "Global security requirements. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "securitySchemes": { "additionalProperties": { "oneOf": [ { "properties": { "description": { "description": "A description of the API key security scheme.", "type": [ "string", "null" ] }, "in": { "description": "The location of the API key.", "enum": [ "cookie", "header", "query" ], "type": "string" }, "name": { "description": "The name of the API key parameter.", "type": "string" }, "type": { "default": "apiKey", "description": "The security scheme type; must be 'apiKey'.", "enum": [ "apiKey" ], "type": "string" } }, "required": [ "in", "name" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "bearerFormat": { "description": "A hint to the client about the bearer token format (e.g. 'JWT').", "type": [ "string", "null" ] }, "description": { "description": "A description of the HTTP auth security scheme.", "type": [ "string", "null" ] }, "scheme": { "description": "The HTTP authentication scheme (e.g. 'bearer', 'basic').", "type": "string" }, "type": { "default": "http", "description": "The security scheme type; must be 'http'.", "enum": [ "http" ], "type": "string" } }, "required": [ "scheme" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OAuth 2.0 security scheme.", "type": [ "string", "null" ] }, "flows": { "description": "The supported OAuth 2.0 flows.", "properties": { "authorizationCode": { "description": "Configuration for the OAuth 2.0 Authorization Code flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the authorization code flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for exchanging the authorization code.", "type": "string" } }, "required": [ "authorizationUrl", "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "clientCredentials": { "description": "Configuration for the OAuth 2.0 Client Credentials flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the client credentials flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "implicit": { "description": "Configuration for the OAuth 2.0 Implicit flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the implicit flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" } }, "required": [ "authorizationUrl", "scopes" ], "type": "object", "x-versionadded": "v2.46" }, "password": { "description": "Configuration for the OAuth 2.0 Resource Owner Password flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the password flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } }, "type": "object", "x-versionadded": "v2.46" }, "oauth2MetadataUrl": { "description": "URL of the OAuth 2.0 server metadata document.", "type": [ "string", "null" ] }, "type": { "default": "oauth2", "description": "The security scheme type; must be 'oauth2'.", "enum": [ "oauth2" ], "type": "string" } }, "required": [ "flows" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OpenID Connect security scheme.", "type": [ "string", "null" ] }, "openIdConnectUrl": { "description": "The OpenID Connect discovery document URL.", "type": "string" }, "type": { "default": "openIdConnect", "description": "The security scheme type; must be 'openIdConnect'.", "enum": [ "openIdConnect" ], "type": "string" } }, "required": [ "openIdConnectUrl" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the mTLS security scheme.", "type": [ "string", "null" ] }, "type": { "default": "mutualTLS", "description": "The security scheme type; must be 'mutualTLS'.", "enum": [ "mutualTLS" ], "type": "string" } }, "type": "object", "x-versionadded": "v2.46" } ] }, "description": "Map of security scheme names to their definitions.", "type": "object" }, "signatures": { "description": "JWS signatures over this agent card.", "items": { "properties": { "header": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "protected": { "description": "The base64url-encoded JWS protected header.", "type": "string" }, "signature": { "description": "The base64url-encoded JWS signature value.", "type": "string" } }, "required": [ "protected", "signature" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "skills": { "description": "The list of skills this agent can perform.", "items": { "properties": { "description": { "description": "A human-readable description of the skill.", "type": "string" }, "examples": { "description": "Example prompts or inputs for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "id": { "description": "Unique identifier for the skill.", "type": "string" }, "inputModes": { "description": "MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "name": { "description": "The display name of the skill.", "type": "string" }, "outputModes": { "description": "MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "security": { "description": "Security requirements for the skill. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "tags": { "description": "Categorization tags for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "description", "id", "name", "tags" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "supportsAuthenticatedExtendedCard": { "description": "Whether the agent exposes an authenticated extended card.", "type": [ "boolean", "null" ] }, "url": { "description": "The primary endpoint URL for the agent.", "type": "string" }, "version": { "description": "The version of the agent (e.g. '1.0.0').", "type": "string" } }, "required": [ "capabilities", "defaultInputModes", "defaultOutputModes", "description", "name", "skills", "url", "version" ], "type": "object", "x-versionadded": "v2.46" }, "createdAt": { "description": "The date and time of when agent has been deployed and it's agent card registered, in ISO 8601 format", "format": "date-time", "type": "string" }, "deploymentId": { "description": "The ID of the agent deployment.", "type": "string" }, "externalId": { "description": "External ID of the agent.", "type": [ "string", "null" ] }, "id": { "description": "The ID of the agent card.", "type": "string" }, "tenantId": { "description": "The id of the tenant agent card is registered in.", "maxLength": 36, "minLength": 32, "type": [ "string", "null" ] }, "updatedAt": { "description": "The date and time of when agent card has been last updated.", "format": "date-time", "type": "string" } }, "required": [ "agentCard", "createdAt", "deploymentId", "id", "updatedAt" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "next": { "description": "The URL of the next page (if null, there is no next page).", "format": "uri", "type": [ "string", "null" ] }, "previous": { "description": "The URL of the previous page (if null, there is no previous page).", "format": "uri", "type": [ "string", "null" ] }, "totalCount": { "description": "The total number of items across all pages.", "type": "integer" } }, "required": [ "data", "next", "previous", "totalCount" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | The list of agent cards registered within tenant. | AgentCardListResponse | ## Delete the agent card by deployment ID Operation path: `DELETE /api/v2/deployments/{deploymentId}/agentCard/` Authentication requirements: `BearerAuth` Delete the agent card associated with an external agent deployment. This operation is idempotent - returns 204 even if no agent card exists. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | deploymentId | path | string | true | The ID of the deployment. | ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 204 | No Content | none | None | | 404 | Not Found | Deployment not found. | None | | 405 | Method Not Allowed | Agent card deletion is only allowed for external deployments. | None | ## Retrieve the agent card by deployment ID Operation path: `GET /api/v2/deployments/{deploymentId}/agentCard/` Authentication requirements: `BearerAuth` Retrieve the agent card associated with an agent deployment. The agent card is returned by this route as it was returned by the agent during deployment creation or as it was uploaded to DataRobot. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | deploymentId | path | string | true | The ID of the deployment. | ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | The agent card for the deployment. | None | | 404 | Not Found | No agent card found for this deployment. | None | ## Create or replace the agent card by deployment ID Operation path: `PUT /api/v2/deployments/{deploymentId}/agentCard/` Authentication requirements: `BearerAuth` Upload the agent card for an agent deployment. The request body must be the agent card document as a JSON object. If an agent card already exists for this deployment it will be replaced. This operation is only supported for external deployments. For DataRobot hosted deployments, the agent card document is pulled automatically from the deployment. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | deploymentId | path | string | true | The ID of the deployment. | ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | OK | The stored agent card for the deployment. | None | | 413 | Payload Too Large | The agent card exceeds the maximum allowed size. | None | | 422 | Unprocessable Entity | Agent card upload is only supported for external deployments. | None | # Schemas ## APIKeySecurityScheme ``` { "properties": { "description": { "description": "A description of the API key security scheme.", "type": [ "string", "null" ] }, "in": { "description": "The location of the API key.", "enum": [ "cookie", "header", "query" ], "type": "string" }, "name": { "description": "The name of the API key parameter.", "type": "string" }, "type": { "default": "apiKey", "description": "The security scheme type; must be 'apiKey'.", "enum": [ "apiKey" ], "type": "string" } }, "required": [ "in", "name" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string,null | false | | A description of the API key security scheme. | | in | string | true | | The location of the API key. | | name | string | true | | The name of the API key parameter. | | type | string | false | | The security scheme type; must be 'apiKey'. | ### Enumerated Values | Property | Value | | --- | --- | | in | [cookie, header, query] | | type | apiKey | ## AgentCapabilities ``` { "description": "Optional capabilities supported by the agent.", "properties": { "extensions": { "description": "Protocol extensions supported by the agent.", "items": { "properties": { "description": { "description": "A human-readable description of the extension.", "type": [ "string", "null" ] }, "params": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "required": { "description": "Whether this extension is required by the agent.", "type": [ "boolean", "null" ] }, "uri": { "description": "The URI identifying the extension.", "type": "string" } }, "required": [ "uri" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "pushNotifications": { "description": "Whether the agent supports push notifications.", "type": [ "boolean", "null" ] }, "stateTransitionHistory": { "description": "Whether the agent supports state transition history.", "type": [ "boolean", "null" ] }, "streaming": { "description": "Whether the agent supports streaming responses.", "type": [ "boolean", "null" ] } }, "type": "object", "x-versionadded": "v2.46" } ``` Optional capabilities supported by the agent. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | extensions | [AgentExtension] | false | maxItems: 100 | Protocol extensions supported by the agent. | | pushNotifications | boolean,null | false | | Whether the agent supports push notifications. | | stateTransitionHistory | boolean,null | false | | Whether the agent supports state transition history. | | streaming | boolean,null | false | | Whether the agent supports streaming responses. | ## AgentCard ``` { "description": "Plain agent card data.", "properties": { "additionalInterfaces": { "description": "Additional transport interfaces beyond the primary URL.", "items": { "properties": { "transport": { "description": "The transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON).", "type": "string" }, "url": { "description": "The URL for this transport interface.", "type": "string" } }, "required": [ "transport", "url" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "capabilities": { "description": "Optional capabilities supported by the agent.", "properties": { "extensions": { "description": "Protocol extensions supported by the agent.", "items": { "properties": { "description": { "description": "A human-readable description of the extension.", "type": [ "string", "null" ] }, "params": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "required": { "description": "Whether this extension is required by the agent.", "type": [ "boolean", "null" ] }, "uri": { "description": "The URI identifying the extension.", "type": "string" } }, "required": [ "uri" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "pushNotifications": { "description": "Whether the agent supports push notifications.", "type": [ "boolean", "null" ] }, "stateTransitionHistory": { "description": "Whether the agent supports state transition history.", "type": [ "boolean", "null" ] }, "streaming": { "description": "Whether the agent supports streaming responses.", "type": [ "boolean", "null" ] } }, "type": "object", "x-versionadded": "v2.46" }, "defaultInputModes": { "description": "Default MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "defaultOutputModes": { "description": "Default MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "description": { "description": "A human-readable description of the agent.", "type": "string" }, "documentationUrl": { "description": "URL to the agent's documentation.", "type": [ "string", "null" ] }, "iconUrl": { "description": "URL to an icon representing the agent.", "type": [ "string", "null" ] }, "name": { "description": "The display name of the agent.", "type": "string" }, "preferredTransport": { "default": "JSONRPC", "description": "Preferred transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON). Defaults to 'JSONRPC'.", "type": [ "string", "null" ] }, "protocolVersion": { "default": "0.3.0", "description": "The A2A protocol version. Defaults to '0.3.0'.", "type": [ "string", "null" ] }, "provider": { "description": "The service provider of the agent.", "properties": { "organization": { "description": "The organization name of the agent provider.", "type": "string" }, "url": { "description": "The URL of the agent provider.", "type": "string" } }, "required": [ "organization", "url" ], "type": "object", "x-versionadded": "v2.46" }, "security": { "description": "Global security requirements. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "securitySchemes": { "additionalProperties": { "oneOf": [ { "properties": { "description": { "description": "A description of the API key security scheme.", "type": [ "string", "null" ] }, "in": { "description": "The location of the API key.", "enum": [ "cookie", "header", "query" ], "type": "string" }, "name": { "description": "The name of the API key parameter.", "type": "string" }, "type": { "default": "apiKey", "description": "The security scheme type; must be 'apiKey'.", "enum": [ "apiKey" ], "type": "string" } }, "required": [ "in", "name" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "bearerFormat": { "description": "A hint to the client about the bearer token format (e.g. 'JWT').", "type": [ "string", "null" ] }, "description": { "description": "A description of the HTTP auth security scheme.", "type": [ "string", "null" ] }, "scheme": { "description": "The HTTP authentication scheme (e.g. 'bearer', 'basic').", "type": "string" }, "type": { "default": "http", "description": "The security scheme type; must be 'http'.", "enum": [ "http" ], "type": "string" } }, "required": [ "scheme" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OAuth 2.0 security scheme.", "type": [ "string", "null" ] }, "flows": { "description": "The supported OAuth 2.0 flows.", "properties": { "authorizationCode": { "description": "Configuration for the OAuth 2.0 Authorization Code flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the authorization code flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for exchanging the authorization code.", "type": "string" } }, "required": [ "authorizationUrl", "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "clientCredentials": { "description": "Configuration for the OAuth 2.0 Client Credentials flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the client credentials flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "implicit": { "description": "Configuration for the OAuth 2.0 Implicit flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the implicit flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" } }, "required": [ "authorizationUrl", "scopes" ], "type": "object", "x-versionadded": "v2.46" }, "password": { "description": "Configuration for the OAuth 2.0 Resource Owner Password flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the password flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } }, "type": "object", "x-versionadded": "v2.46" }, "oauth2MetadataUrl": { "description": "URL of the OAuth 2.0 server metadata document.", "type": [ "string", "null" ] }, "type": { "default": "oauth2", "description": "The security scheme type; must be 'oauth2'.", "enum": [ "oauth2" ], "type": "string" } }, "required": [ "flows" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OpenID Connect security scheme.", "type": [ "string", "null" ] }, "openIdConnectUrl": { "description": "The OpenID Connect discovery document URL.", "type": "string" }, "type": { "default": "openIdConnect", "description": "The security scheme type; must be 'openIdConnect'.", "enum": [ "openIdConnect" ], "type": "string" } }, "required": [ "openIdConnectUrl" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the mTLS security scheme.", "type": [ "string", "null" ] }, "type": { "default": "mutualTLS", "description": "The security scheme type; must be 'mutualTLS'.", "enum": [ "mutualTLS" ], "type": "string" } }, "type": "object", "x-versionadded": "v2.46" } ] }, "description": "Map of security scheme names to their definitions.", "type": "object" }, "signatures": { "description": "JWS signatures over this agent card.", "items": { "properties": { "header": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "protected": { "description": "The base64url-encoded JWS protected header.", "type": "string" }, "signature": { "description": "The base64url-encoded JWS signature value.", "type": "string" } }, "required": [ "protected", "signature" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "skills": { "description": "The list of skills this agent can perform.", "items": { "properties": { "description": { "description": "A human-readable description of the skill.", "type": "string" }, "examples": { "description": "Example prompts or inputs for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "id": { "description": "Unique identifier for the skill.", "type": "string" }, "inputModes": { "description": "MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "name": { "description": "The display name of the skill.", "type": "string" }, "outputModes": { "description": "MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "security": { "description": "Security requirements for the skill. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "tags": { "description": "Categorization tags for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "description", "id", "name", "tags" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "supportsAuthenticatedExtendedCard": { "description": "Whether the agent exposes an authenticated extended card.", "type": [ "boolean", "null" ] }, "url": { "description": "The primary endpoint URL for the agent.", "type": "string" }, "version": { "description": "The version of the agent (e.g. '1.0.0').", "type": "string" } }, "required": [ "capabilities", "defaultInputModes", "defaultOutputModes", "description", "name", "skills", "url", "version" ], "type": "object", "x-versionadded": "v2.46" } ``` Plain agent card data. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | additionalInterfaces | [AgentInterface] | false | maxItems: 100 | Additional transport interfaces beyond the primary URL. | | capabilities | AgentCapabilities | true | | Optional capabilities supported by the agent. | | defaultInputModes | [string] | true | maxItems: 100 | Default MIME types or modes accepted as input. | | defaultOutputModes | [string] | true | maxItems: 100 | Default MIME types or modes produced as output. | | description | string | true | | A human-readable description of the agent. | | documentationUrl | string,null | false | | URL to the agent's documentation. | | iconUrl | string,null | false | | URL to an icon representing the agent. | | name | string | true | | The display name of the agent. | | preferredTransport | string,null | false | | Preferred transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON). Defaults to 'JSONRPC'. | | protocolVersion | string,null | false | | The A2A protocol version. Defaults to '0.3.0'. | | provider | AgentProvider | false | | The service provider of the agent. | | security | [AllowExtra] | false | maxItems: 100 | Global security requirements. Each entry maps a scheme name to required scopes. | | securitySchemes | object | false | | Map of security scheme names to their definitions. | | » additionalProperties | any | false | | none | oneOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »» anonymous | APIKeySecurityScheme | false | | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »» anonymous | HTTPAuthSecurityScheme | false | | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »» anonymous | OAuth2SecurityScheme | false | | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »» anonymous | OpenIdConnectSecurityScheme | false | | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | »» anonymous | MutualTLSSecurityScheme | false | | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | signatures | [AgentCardSignature] | false | maxItems: 100 | JWS signatures over this agent card. | | skills | [AgentSkill] | true | maxItems: 100 | The list of skills this agent can perform. | | supportsAuthenticatedExtendedCard | boolean,null | false | | Whether the agent exposes an authenticated extended card. | | url | string | true | | The primary endpoint URL for the agent. | | version | string | true | | The version of the agent (e.g. '1.0.0'). | ## AgentCardListResponse ``` { "properties": { "count": { "description": "The number of items returned on this page.", "type": "integer" }, "data": { "description": "The list of formatted agent cards.", "items": { "properties": { "agentCard": { "description": "Plain agent card data.", "properties": { "additionalInterfaces": { "description": "Additional transport interfaces beyond the primary URL.", "items": { "properties": { "transport": { "description": "The transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON).", "type": "string" }, "url": { "description": "The URL for this transport interface.", "type": "string" } }, "required": [ "transport", "url" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "capabilities": { "description": "Optional capabilities supported by the agent.", "properties": { "extensions": { "description": "Protocol extensions supported by the agent.", "items": { "properties": { "description": { "description": "A human-readable description of the extension.", "type": [ "string", "null" ] }, "params": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "required": { "description": "Whether this extension is required by the agent.", "type": [ "boolean", "null" ] }, "uri": { "description": "The URI identifying the extension.", "type": "string" } }, "required": [ "uri" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "pushNotifications": { "description": "Whether the agent supports push notifications.", "type": [ "boolean", "null" ] }, "stateTransitionHistory": { "description": "Whether the agent supports state transition history.", "type": [ "boolean", "null" ] }, "streaming": { "description": "Whether the agent supports streaming responses.", "type": [ "boolean", "null" ] } }, "type": "object", "x-versionadded": "v2.46" }, "defaultInputModes": { "description": "Default MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "defaultOutputModes": { "description": "Default MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "description": { "description": "A human-readable description of the agent.", "type": "string" }, "documentationUrl": { "description": "URL to the agent's documentation.", "type": [ "string", "null" ] }, "iconUrl": { "description": "URL to an icon representing the agent.", "type": [ "string", "null" ] }, "name": { "description": "The display name of the agent.", "type": "string" }, "preferredTransport": { "default": "JSONRPC", "description": "Preferred transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON). Defaults to 'JSONRPC'.", "type": [ "string", "null" ] }, "protocolVersion": { "default": "0.3.0", "description": "The A2A protocol version. Defaults to '0.3.0'.", "type": [ "string", "null" ] }, "provider": { "description": "The service provider of the agent.", "properties": { "organization": { "description": "The organization name of the agent provider.", "type": "string" }, "url": { "description": "The URL of the agent provider.", "type": "string" } }, "required": [ "organization", "url" ], "type": "object", "x-versionadded": "v2.46" }, "security": { "description": "Global security requirements. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "securitySchemes": { "additionalProperties": { "oneOf": [ { "properties": { "description": { "description": "A description of the API key security scheme.", "type": [ "string", "null" ] }, "in": { "description": "The location of the API key.", "enum": [ "cookie", "header", "query" ], "type": "string" }, "name": { "description": "The name of the API key parameter.", "type": "string" }, "type": { "default": "apiKey", "description": "The security scheme type; must be 'apiKey'.", "enum": [ "apiKey" ], "type": "string" } }, "required": [ "in", "name" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "bearerFormat": { "description": "A hint to the client about the bearer token format (e.g. 'JWT').", "type": [ "string", "null" ] }, "description": { "description": "A description of the HTTP auth security scheme.", "type": [ "string", "null" ] }, "scheme": { "description": "The HTTP authentication scheme (e.g. 'bearer', 'basic').", "type": "string" }, "type": { "default": "http", "description": "The security scheme type; must be 'http'.", "enum": [ "http" ], "type": "string" } }, "required": [ "scheme" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OAuth 2.0 security scheme.", "type": [ "string", "null" ] }, "flows": { "description": "The supported OAuth 2.0 flows.", "properties": { "authorizationCode": { "description": "Configuration for the OAuth 2.0 Authorization Code flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the authorization code flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for exchanging the authorization code.", "type": "string" } }, "required": [ "authorizationUrl", "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "clientCredentials": { "description": "Configuration for the OAuth 2.0 Client Credentials flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the client credentials flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "implicit": { "description": "Configuration for the OAuth 2.0 Implicit flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the implicit flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" } }, "required": [ "authorizationUrl", "scopes" ], "type": "object", "x-versionadded": "v2.46" }, "password": { "description": "Configuration for the OAuth 2.0 Resource Owner Password flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the password flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } }, "type": "object", "x-versionadded": "v2.46" }, "oauth2MetadataUrl": { "description": "URL of the OAuth 2.0 server metadata document.", "type": [ "string", "null" ] }, "type": { "default": "oauth2", "description": "The security scheme type; must be 'oauth2'.", "enum": [ "oauth2" ], "type": "string" } }, "required": [ "flows" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OpenID Connect security scheme.", "type": [ "string", "null" ] }, "openIdConnectUrl": { "description": "The OpenID Connect discovery document URL.", "type": "string" }, "type": { "default": "openIdConnect", "description": "The security scheme type; must be 'openIdConnect'.", "enum": [ "openIdConnect" ], "type": "string" } }, "required": [ "openIdConnectUrl" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the mTLS security scheme.", "type": [ "string", "null" ] }, "type": { "default": "mutualTLS", "description": "The security scheme type; must be 'mutualTLS'.", "enum": [ "mutualTLS" ], "type": "string" } }, "type": "object", "x-versionadded": "v2.46" } ] }, "description": "Map of security scheme names to their definitions.", "type": "object" }, "signatures": { "description": "JWS signatures over this agent card.", "items": { "properties": { "header": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "protected": { "description": "The base64url-encoded JWS protected header.", "type": "string" }, "signature": { "description": "The base64url-encoded JWS signature value.", "type": "string" } }, "required": [ "protected", "signature" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "skills": { "description": "The list of skills this agent can perform.", "items": { "properties": { "description": { "description": "A human-readable description of the skill.", "type": "string" }, "examples": { "description": "Example prompts or inputs for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "id": { "description": "Unique identifier for the skill.", "type": "string" }, "inputModes": { "description": "MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "name": { "description": "The display name of the skill.", "type": "string" }, "outputModes": { "description": "MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "security": { "description": "Security requirements for the skill. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "tags": { "description": "Categorization tags for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "description", "id", "name", "tags" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "supportsAuthenticatedExtendedCard": { "description": "Whether the agent exposes an authenticated extended card.", "type": [ "boolean", "null" ] }, "url": { "description": "The primary endpoint URL for the agent.", "type": "string" }, "version": { "description": "The version of the agent (e.g. '1.0.0').", "type": "string" } }, "required": [ "capabilities", "defaultInputModes", "defaultOutputModes", "description", "name", "skills", "url", "version" ], "type": "object", "x-versionadded": "v2.46" }, "createdAt": { "description": "The date and time of when agent has been deployed and it's agent card registered, in ISO 8601 format", "format": "date-time", "type": "string" }, "deploymentId": { "description": "The ID of the agent deployment.", "type": "string" }, "externalId": { "description": "External ID of the agent.", "type": [ "string", "null" ] }, "id": { "description": "The ID of the agent card.", "type": "string" }, "tenantId": { "description": "The id of the tenant agent card is registered in.", "maxLength": 36, "minLength": 32, "type": [ "string", "null" ] }, "updatedAt": { "description": "The date and time of when agent card has been last updated.", "format": "date-time", "type": "string" } }, "required": [ "agentCard", "createdAt", "deploymentId", "id", "updatedAt" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "next": { "description": "The URL of the next page (if null, there is no next page).", "format": "uri", "type": [ "string", "null" ] }, "previous": { "description": "The URL of the previous page (if null, there is no previous page).", "format": "uri", "type": [ "string", "null" ] }, "totalCount": { "description": "The total number of items across all pages.", "type": "integer" } }, "required": [ "data", "next", "previous", "totalCount" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | count | integer | false | | The number of items returned on this page. | | data | [AgentCardResponse] | true | maxItems: 100 | The list of formatted agent cards. | | next | string,null(uri) | true | | The URL of the next page (if null, there is no next page). | | previous | string,null(uri) | true | | The URL of the previous page (if null, there is no previous page). | | totalCount | integer | true | | The total number of items across all pages. | ## AgentCardResponse ``` { "properties": { "agentCard": { "description": "Plain agent card data.", "properties": { "additionalInterfaces": { "description": "Additional transport interfaces beyond the primary URL.", "items": { "properties": { "transport": { "description": "The transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON).", "type": "string" }, "url": { "description": "The URL for this transport interface.", "type": "string" } }, "required": [ "transport", "url" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "capabilities": { "description": "Optional capabilities supported by the agent.", "properties": { "extensions": { "description": "Protocol extensions supported by the agent.", "items": { "properties": { "description": { "description": "A human-readable description of the extension.", "type": [ "string", "null" ] }, "params": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "required": { "description": "Whether this extension is required by the agent.", "type": [ "boolean", "null" ] }, "uri": { "description": "The URI identifying the extension.", "type": "string" } }, "required": [ "uri" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "pushNotifications": { "description": "Whether the agent supports push notifications.", "type": [ "boolean", "null" ] }, "stateTransitionHistory": { "description": "Whether the agent supports state transition history.", "type": [ "boolean", "null" ] }, "streaming": { "description": "Whether the agent supports streaming responses.", "type": [ "boolean", "null" ] } }, "type": "object", "x-versionadded": "v2.46" }, "defaultInputModes": { "description": "Default MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "defaultOutputModes": { "description": "Default MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "description": { "description": "A human-readable description of the agent.", "type": "string" }, "documentationUrl": { "description": "URL to the agent's documentation.", "type": [ "string", "null" ] }, "iconUrl": { "description": "URL to an icon representing the agent.", "type": [ "string", "null" ] }, "name": { "description": "The display name of the agent.", "type": "string" }, "preferredTransport": { "default": "JSONRPC", "description": "Preferred transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON). Defaults to 'JSONRPC'.", "type": [ "string", "null" ] }, "protocolVersion": { "default": "0.3.0", "description": "The A2A protocol version. Defaults to '0.3.0'.", "type": [ "string", "null" ] }, "provider": { "description": "The service provider of the agent.", "properties": { "organization": { "description": "The organization name of the agent provider.", "type": "string" }, "url": { "description": "The URL of the agent provider.", "type": "string" } }, "required": [ "organization", "url" ], "type": "object", "x-versionadded": "v2.46" }, "security": { "description": "Global security requirements. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "securitySchemes": { "additionalProperties": { "oneOf": [ { "properties": { "description": { "description": "A description of the API key security scheme.", "type": [ "string", "null" ] }, "in": { "description": "The location of the API key.", "enum": [ "cookie", "header", "query" ], "type": "string" }, "name": { "description": "The name of the API key parameter.", "type": "string" }, "type": { "default": "apiKey", "description": "The security scheme type; must be 'apiKey'.", "enum": [ "apiKey" ], "type": "string" } }, "required": [ "in", "name" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "bearerFormat": { "description": "A hint to the client about the bearer token format (e.g. 'JWT').", "type": [ "string", "null" ] }, "description": { "description": "A description of the HTTP auth security scheme.", "type": [ "string", "null" ] }, "scheme": { "description": "The HTTP authentication scheme (e.g. 'bearer', 'basic').", "type": "string" }, "type": { "default": "http", "description": "The security scheme type; must be 'http'.", "enum": [ "http" ], "type": "string" } }, "required": [ "scheme" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OAuth 2.0 security scheme.", "type": [ "string", "null" ] }, "flows": { "description": "The supported OAuth 2.0 flows.", "properties": { "authorizationCode": { "description": "Configuration for the OAuth 2.0 Authorization Code flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the authorization code flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for exchanging the authorization code.", "type": "string" } }, "required": [ "authorizationUrl", "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "clientCredentials": { "description": "Configuration for the OAuth 2.0 Client Credentials flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the client credentials flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "implicit": { "description": "Configuration for the OAuth 2.0 Implicit flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the implicit flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" } }, "required": [ "authorizationUrl", "scopes" ], "type": "object", "x-versionadded": "v2.46" }, "password": { "description": "Configuration for the OAuth 2.0 Resource Owner Password flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the password flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } }, "type": "object", "x-versionadded": "v2.46" }, "oauth2MetadataUrl": { "description": "URL of the OAuth 2.0 server metadata document.", "type": [ "string", "null" ] }, "type": { "default": "oauth2", "description": "The security scheme type; must be 'oauth2'.", "enum": [ "oauth2" ], "type": "string" } }, "required": [ "flows" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the OpenID Connect security scheme.", "type": [ "string", "null" ] }, "openIdConnectUrl": { "description": "The OpenID Connect discovery document URL.", "type": "string" }, "type": { "default": "openIdConnect", "description": "The security scheme type; must be 'openIdConnect'.", "enum": [ "openIdConnect" ], "type": "string" } }, "required": [ "openIdConnectUrl" ], "type": "object", "x-versionadded": "v2.46" }, { "properties": { "description": { "description": "A description of the mTLS security scheme.", "type": [ "string", "null" ] }, "type": { "default": "mutualTLS", "description": "The security scheme type; must be 'mutualTLS'.", "enum": [ "mutualTLS" ], "type": "string" } }, "type": "object", "x-versionadded": "v2.46" } ] }, "description": "Map of security scheme names to their definitions.", "type": "object" }, "signatures": { "description": "JWS signatures over this agent card.", "items": { "properties": { "header": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "protected": { "description": "The base64url-encoded JWS protected header.", "type": "string" }, "signature": { "description": "The base64url-encoded JWS signature value.", "type": "string" } }, "required": [ "protected", "signature" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "skills": { "description": "The list of skills this agent can perform.", "items": { "properties": { "description": { "description": "A human-readable description of the skill.", "type": "string" }, "examples": { "description": "Example prompts or inputs for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "id": { "description": "Unique identifier for the skill.", "type": "string" }, "inputModes": { "description": "MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "name": { "description": "The display name of the skill.", "type": "string" }, "outputModes": { "description": "MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "security": { "description": "Security requirements for the skill. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "tags": { "description": "Categorization tags for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "description", "id", "name", "tags" ], "type": "object", "x-versionadded": "v2.46" }, "maxItems": 100, "type": "array" }, "supportsAuthenticatedExtendedCard": { "description": "Whether the agent exposes an authenticated extended card.", "type": [ "boolean", "null" ] }, "url": { "description": "The primary endpoint URL for the agent.", "type": "string" }, "version": { "description": "The version of the agent (e.g. '1.0.0').", "type": "string" } }, "required": [ "capabilities", "defaultInputModes", "defaultOutputModes", "description", "name", "skills", "url", "version" ], "type": "object", "x-versionadded": "v2.46" }, "createdAt": { "description": "The date and time of when agent has been deployed and it's agent card registered, in ISO 8601 format", "format": "date-time", "type": "string" }, "deploymentId": { "description": "The ID of the agent deployment.", "type": "string" }, "externalId": { "description": "External ID of the agent.", "type": [ "string", "null" ] }, "id": { "description": "The ID of the agent card.", "type": "string" }, "tenantId": { "description": "The id of the tenant agent card is registered in.", "maxLength": 36, "minLength": 32, "type": [ "string", "null" ] }, "updatedAt": { "description": "The date and time of when agent card has been last updated.", "format": "date-time", "type": "string" } }, "required": [ "agentCard", "createdAt", "deploymentId", "id", "updatedAt" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | agentCard | AgentCard | true | | Plain agent card data. | | createdAt | string(date-time) | true | | The date and time of when agent has been deployed and it's agent card registered, in ISO 8601 format | | deploymentId | string | true | | The ID of the agent deployment. | | externalId | string,null | false | | External ID of the agent. | | id | string | true | | The ID of the agent card. | | tenantId | string,null | false | maxLength: 36minLength: 32minLength: 32 | The id of the tenant agent card is registered in. | | updatedAt | string(date-time) | true | | The date and time of when agent card has been last updated. | ## AgentCardSignature ``` { "properties": { "header": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "protected": { "description": "The base64url-encoded JWS protected header.", "type": "string" }, "signature": { "description": "The base64url-encoded JWS signature value.", "type": "string" } }, "required": [ "protected", "signature" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | header | AllowExtra | false | | The parameters submitted by the user to the failed job. | | protected | string | true | | The base64url-encoded JWS protected header. | | signature | string | true | | The base64url-encoded JWS signature value. | ## AgentExtension ``` { "properties": { "description": { "description": "A human-readable description of the extension.", "type": [ "string", "null" ] }, "params": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "required": { "description": "Whether this extension is required by the agent.", "type": [ "boolean", "null" ] }, "uri": { "description": "The URI identifying the extension.", "type": "string" } }, "required": [ "uri" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string,null | false | | A human-readable description of the extension. | | params | AllowExtra | false | | The parameters submitted by the user to the failed job. | | required | boolean,null | false | | Whether this extension is required by the agent. | | uri | string | true | | The URI identifying the extension. | ## AgentInterface ``` { "properties": { "transport": { "description": "The transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON).", "type": "string" }, "url": { "description": "The URL for this transport interface.", "type": "string" } }, "required": [ "transport", "url" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | transport | string | true | | The transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON). | | url | string | true | | The URL for this transport interface. | ## AgentProvider ``` { "description": "The service provider of the agent.", "properties": { "organization": { "description": "The organization name of the agent provider.", "type": "string" }, "url": { "description": "The URL of the agent provider.", "type": "string" } }, "required": [ "organization", "url" ], "type": "object", "x-versionadded": "v2.46" } ``` The service provider of the agent. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | organization | string | true | | The organization name of the agent provider. | | url | string | true | | The URL of the agent provider. | ## AgentSkill ``` { "properties": { "description": { "description": "A human-readable description of the skill.", "type": "string" }, "examples": { "description": "Example prompts or inputs for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "id": { "description": "Unique identifier for the skill.", "type": "string" }, "inputModes": { "description": "MIME types or modes accepted as input.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "name": { "description": "The display name of the skill.", "type": "string" }, "outputModes": { "description": "MIME types or modes produced as output.", "items": { "type": "string" }, "maxItems": 100, "type": "array" }, "security": { "description": "Security requirements for the skill. Each entry maps a scheme name to required scopes.", "items": { "description": "The parameters submitted by the user to the failed job.", "type": "object" }, "maxItems": 100, "type": "array" }, "tags": { "description": "Categorization tags for the skill.", "items": { "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "description", "id", "name", "tags" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string | true | | A human-readable description of the skill. | | examples | [string] | false | maxItems: 100 | Example prompts or inputs for the skill. | | id | string | true | | Unique identifier for the skill. | | inputModes | [string] | false | maxItems: 100 | MIME types or modes accepted as input. | | name | string | true | | The display name of the skill. | | outputModes | [string] | false | maxItems: 100 | MIME types or modes produced as output. | | security | [AllowExtra] | false | maxItems: 100 | Security requirements for the skill. Each entry maps a scheme name to required scopes. | | tags | [string] | true | maxItems: 100 | Categorization tags for the skill. | ## AllowExtra ``` { "description": "The parameters submitted by the user to the failed job.", "type": "object" } ``` The parameters submitted by the user to the failed job. ### Properties None ## AuthorizationCodeOAuthFlow ``` { "description": "Configuration for the OAuth 2.0 Authorization Code flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the authorization code flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for exchanging the authorization code.", "type": "string" } }, "required": [ "authorizationUrl", "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } ``` Configuration for the OAuth 2.0 Authorization Code flow. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | authorizationUrl | string | true | | The authorization URL for the authorization code flow. | | refreshUrl | string,null | false | | The URL for refreshing tokens. | | scopes | object | true | | Available scopes mapping scope name to description. | | » additionalProperties | string | false | | none | | tokenUrl | string | true | | The token URL for exchanging the authorization code. | ## ClientCredentialsOAuthFlow ``` { "description": "Configuration for the OAuth 2.0 Client Credentials flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the client credentials flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } ``` Configuration for the OAuth 2.0 Client Credentials flow. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | refreshUrl | string,null | false | | The URL for refreshing tokens. | | scopes | object | true | | Available scopes mapping scope name to description. | | » additionalProperties | string | false | | none | | tokenUrl | string | true | | The token URL for the client credentials flow. | ## HTTPAuthSecurityScheme ``` { "properties": { "bearerFormat": { "description": "A hint to the client about the bearer token format (e.g. 'JWT').", "type": [ "string", "null" ] }, "description": { "description": "A description of the HTTP auth security scheme.", "type": [ "string", "null" ] }, "scheme": { "description": "The HTTP authentication scheme (e.g. 'bearer', 'basic').", "type": "string" }, "type": { "default": "http", "description": "The security scheme type; must be 'http'.", "enum": [ "http" ], "type": "string" } }, "required": [ "scheme" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | bearerFormat | string,null | false | | A hint to the client about the bearer token format (e.g. 'JWT'). | | description | string,null | false | | A description of the HTTP auth security scheme. | | scheme | string | true | | The HTTP authentication scheme (e.g. 'bearer', 'basic'). | | type | string | false | | The security scheme type; must be 'http'. | ### Enumerated Values | Property | Value | | --- | --- | | type | http | ## ImplicitOAuthFlow ``` { "description": "Configuration for the OAuth 2.0 Implicit flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the implicit flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" } }, "required": [ "authorizationUrl", "scopes" ], "type": "object", "x-versionadded": "v2.46" } ``` Configuration for the OAuth 2.0 Implicit flow. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | authorizationUrl | string | true | | The authorization URL for the implicit flow. | | refreshUrl | string,null | false | | The URL for refreshing tokens. | | scopes | object | true | | Available scopes mapping scope name to description. | | » additionalProperties | string | false | | none | ## MutualTLSSecurityScheme ``` { "properties": { "description": { "description": "A description of the mTLS security scheme.", "type": [ "string", "null" ] }, "type": { "default": "mutualTLS", "description": "The security scheme type; must be 'mutualTLS'.", "enum": [ "mutualTLS" ], "type": "string" } }, "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string,null | false | | A description of the mTLS security scheme. | | type | string | false | | The security scheme type; must be 'mutualTLS'. | ### Enumerated Values | Property | Value | | --- | --- | | type | mutualTLS | ## OAuth2SecurityScheme ``` { "properties": { "description": { "description": "A description of the OAuth 2.0 security scheme.", "type": [ "string", "null" ] }, "flows": { "description": "The supported OAuth 2.0 flows.", "properties": { "authorizationCode": { "description": "Configuration for the OAuth 2.0 Authorization Code flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the authorization code flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for exchanging the authorization code.", "type": "string" } }, "required": [ "authorizationUrl", "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "clientCredentials": { "description": "Configuration for the OAuth 2.0 Client Credentials flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the client credentials flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "implicit": { "description": "Configuration for the OAuth 2.0 Implicit flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the implicit flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" } }, "required": [ "authorizationUrl", "scopes" ], "type": "object", "x-versionadded": "v2.46" }, "password": { "description": "Configuration for the OAuth 2.0 Resource Owner Password flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the password flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } }, "type": "object", "x-versionadded": "v2.46" }, "oauth2MetadataUrl": { "description": "URL of the OAuth 2.0 server metadata document.", "type": [ "string", "null" ] }, "type": { "default": "oauth2", "description": "The security scheme type; must be 'oauth2'.", "enum": [ "oauth2" ], "type": "string" } }, "required": [ "flows" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string,null | false | | A description of the OAuth 2.0 security scheme. | | flows | OAuthFlows | true | | The supported OAuth 2.0 flows. | | oauth2MetadataUrl | string,null | false | | URL of the OAuth 2.0 server metadata document. | | type | string | false | | The security scheme type; must be 'oauth2'. | ### Enumerated Values | Property | Value | | --- | --- | | type | oauth2 | ## OAuthFlows ``` { "description": "The supported OAuth 2.0 flows.", "properties": { "authorizationCode": { "description": "Configuration for the OAuth 2.0 Authorization Code flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the authorization code flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for exchanging the authorization code.", "type": "string" } }, "required": [ "authorizationUrl", "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "clientCredentials": { "description": "Configuration for the OAuth 2.0 Client Credentials flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the client credentials flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" }, "implicit": { "description": "Configuration for the OAuth 2.0 Implicit flow.", "properties": { "authorizationUrl": { "description": "The authorization URL for the implicit flow.", "type": "string" }, "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" } }, "required": [ "authorizationUrl", "scopes" ], "type": "object", "x-versionadded": "v2.46" }, "password": { "description": "Configuration for the OAuth 2.0 Resource Owner Password flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the password flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } }, "type": "object", "x-versionadded": "v2.46" } ``` The supported OAuth 2.0 flows. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | authorizationCode | AuthorizationCodeOAuthFlow | false | | Configuration for the OAuth 2.0 Authorization Code flow. | | clientCredentials | ClientCredentialsOAuthFlow | false | | Configuration for the OAuth 2.0 Client Credentials flow. | | implicit | ImplicitOAuthFlow | false | | Configuration for the OAuth 2.0 Implicit flow. | | password | PasswordOAuthFlow | false | | Configuration for the OAuth 2.0 Resource Owner Password flow. | ## OpenIdConnectSecurityScheme ``` { "properties": { "description": { "description": "A description of the OpenID Connect security scheme.", "type": [ "string", "null" ] }, "openIdConnectUrl": { "description": "The OpenID Connect discovery document URL.", "type": "string" }, "type": { "default": "openIdConnect", "description": "The security scheme type; must be 'openIdConnect'.", "enum": [ "openIdConnect" ], "type": "string" } }, "required": [ "openIdConnectUrl" ], "type": "object", "x-versionadded": "v2.46" } ``` ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string,null | false | | A description of the OpenID Connect security scheme. | | openIdConnectUrl | string | true | | The OpenID Connect discovery document URL. | | type | string | false | | The security scheme type; must be 'openIdConnect'. | ### Enumerated Values | Property | Value | | --- | --- | | type | openIdConnect | ## PasswordOAuthFlow ``` { "description": "Configuration for the OAuth 2.0 Resource Owner Password flow.", "properties": { "refreshUrl": { "description": "The URL for refreshing tokens.", "type": [ "string", "null" ] }, "scopes": { "additionalProperties": { "type": "string" }, "description": "Available scopes mapping scope name to description.", "type": "object" }, "tokenUrl": { "description": "The token URL for the password flow.", "type": "string" } }, "required": [ "scopes", "tokenUrl" ], "type": "object", "x-versionadded": "v2.46" } ``` Configuration for the OAuth 2.0 Resource Owner Password flow. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | refreshUrl | string,null | false | | The URL for refreshing tokens. | | scopes | object | true | | Available scopes mapping scope name to description. | | » additionalProperties | string | false | | none | | tokenUrl | string | true | | The token URL for the password flow. |