Manage A2A for a realm

Manages a realm’s A2A access, by action: get the settings, update them (turn A2A on or off, choose the agent mesh provider and its settings), or mesh_connect, mesh_disconnect, mesh_refresh the realm’s mesh connection. The A2A token itself is minted with Generate a token (type: a2a).

Requires a realm admin with the realms.update permission on the realm that owns the realm given by realm_id.

POST /v1/realms/a2a

cURL

get

curl --request POST \ --url https://{host}/v1/realms/a2a \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b", "action": "get" } '

200

{
  "ok": true,
  "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
  "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
  "a2a_enabled": true,
  "has_bearer": true,
  "bearer_prefix": "cliq_a2a_4f9",
  "mesh_provider_mode": "inherit",
  "active_provider_id": null,
  "effective_provider_id": null,
  "providers": {},
  "mesh_status": null,
  "card_url": "https://api.cliqhub.io/a2a/o/acme/r/production/.well-known/agent-card.json",
  "send_url": "https://api.cliqhub.io/a2a/o/acme/r/production/send",
  "created_at": 1759000000000,
  "updated_at": 1759100000000
}

Authorizations

Authorization · string · header · required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

realm_id · string · required

The realm.

Minimum string length: 1

action · enum<string> · required

get, update, mesh_connect, mesh_disconnect or mesh_refresh.

Available options: get, update, mesh_connect, mesh_disconnect, mesh_refresh

a2a_enabled · boolean

update: let outside agents send tasks to the realm.

mesh_provider_mode · enum<string>

update: inherit the organization's provider, override with the realm's own, or none.

Available options: inherit, override, none

active_provider_id · string | null

update: the provider to use with override.

provider_id · string

update: a provider whose settings to change (with provider_settings).

provider_settings · object

update: settings for provider_id.

Response

200

application/json

Success.

ok · enum<boolean> · required

Always true on success.

Available options: true