Acquires the org's credential for one provider.
Acquires the org's credential for one provider.
POST /v1/integrations/{provider}/connect
| Address | https://api.hanzo.ai/v1/integrations/{provider}/connect |
| Method | POST |
| Operation | post_integrations_by_provider_connect |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Acquires the org's credential for one provider. It has TWO paths and the REQUEST picks which: a "token" key in the body seals that credential directly (verify-before-store), and its absence begins the 3-legged OAuth flow — minting a single-use nonce plus an HMAC-signed state that binds this org to this provider, and answering with the provider's authorize URL for the caller to redirect to.
Fail-closed order, unchanged: no principal → 403; unknown provider → 404; an AdminOnly connector without the caller's own-org admin bit → 403; not configured → 503; KMS not ready → 503 (the flow WILL need to seal a token, so refuse now rather than dead-end at the callback).
Request
4 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes | Provider is the connector's registry id, from the :provider path segment. |
accountId | body | string | — | AccountID is the provider account the credential should be scoped to, for the providers whose Verify needs one (Cloudflare). |
provider | body | string | — | Provider is the connector's registry id, from the :provider path segment. |
token | body | string | — | Token is the customer's provider credential. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | connectOut | ok |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
account | body | string | — | Account is the account label the provider reported for the credential. |
authorizeUrl | body | string | — | AuthorizeURL is the provider consent URL to send the user to. |
connected | body | boolean | — | Connected is true on the apikey path once the credential verified and sealed. |
externalId | body | string | — | ExternalID is the provider's account id for the credential. |
provider | body | string | — | Provider is the connector's registry id. |
scopes | body | string[] | — | Scopes are the permissions the credential carries. |
Failure carries the platform error shape — see Errors.
Examples
hanzo integrations connect <provider>import { Configuration, IntegrationsApi } from 'hanzoai';
const api = new IntegrationsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postIntegrationsByProviderConnect({ provider: 'provider', accountId: "<accountId>", provider: "<provider>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IntegrationsApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IntegrationsApi(client).post_integrations_by_provider_connect(provider='provider', account_id="<accountId>", provider="<provider>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IntegrationsAPI.PostIntegrationsByProviderConnect(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, integrations_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = integrations_api::post_integrations_by_provider_connect(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IntegrationsApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new IntegrationsApi(client).postIntegrationsByProviderConnect();curl -X POST https://api.hanzo.ai/v1/integrations/<provider>/connect \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "<accountId>",
"provider": "<provider>"
}'The door reaches integrations through the integrations tool, which names its 45 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_connectors"
}
}
}'How is this guide?