Connection
A Connection (1.60.0): an Organization's authorized link to an external system through a Connector or an MCP server, with its status, scopes, environments and attestation; never its secrets.
An object with 27 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
allowed_environments | array of Environment | yes | The environments whose runs may use it; live only by default. A test run against a Connection that does not allow test executes the Connector's mock (integrations.md section 3). |
auth_strategy | ConnectionAuthStrategy | yes | |
authorized_at | Timestamp or null | yes | |
base_url | ConnectionBaseUrl or null | yes | |
connector_id | ConnectorId or null | yes | The Connector; null for an MCP server. |
connector_major | integer or null | yes | The major version of the Connector's manifest the Connection pins; null for an MCP server. |
created_at | Timestamp | yes | |
enabled_tools | array of ConnectorToolName | yes | The Connector's tools the Organization allows, which set the scopes requested (integrations.md section 10); empty for an MCP server, whose registration's allowed_tools govern. |
external_account | string or null | yes | The external account authorized (a tenant id, an instance URL); null before. |
granted_scopes | array of VendorScope | yes | The scopes the vendor granted at the last authorization; empty before. |
id | ConnectionId | yes | |
mcp_server_id | McpServerId or null | yes | The MCP server registration whose credential the Connection holds; null for a Connector. |
name | ConnectionName | yes | |
object | "connection" | yes | |
organization_id | OrganizationId | yes | |
origin | ConnectionOrigin | yes | |
phi_attestation | ConnectionPhiAttestation or null | yes | The PHI attestation, or null; only an attested Connection may receive PHI. |
requested_scopes | array of VendorScope | yes | The union of the scopes of enabled_tools; nothing more is requested. |
revision | integer | yes | Counts writes to the Connection; returned as the ETag and required in If-Match. |
revoked_at | Timestamp or null | yes | |
sandbox | boolean | yes | True for a vendor sandbox, which may allow test; a test Call never books a real appointment. |
secret_hint | string or null | yes | The last characters of the stored key or token, or null; never the secret. |
secret_version | integer | yes | Counts the secrets stored; 0 before the first. A refresh write-back compares and sets it. |
sender | ConnectionSender or null | yes | The sender of a messaging Connection; null otherwise. |
status | ConnectionStatus | yes | |
status_reason | ConnectionStatusReason or null | yes | Null while active. |
updated_at | Timestamp | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.