Connect provider
Acquires the org's credential for one provider.
POST /v1/provider/{provider}/connect
| Address | https://api.hanzo.ai/v1/provider/{provider}/connect |
| Method | POST |
| Operation | post_provider_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 | provider.connectOut | ok |
default | problem-details | refused |
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 provider connect <provider>import { Configuration, ProviderApi } from 'hanzoai';
const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postProviderByProviderConnect({ provider: 'provider', accountId: "<accountId>", provider: "<provider>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).post_provider_by_provider_connect(provider='provider', account_id="<accountId>", provider="<provider>")cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ProviderAPI.PostProviderByProviderConnect(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, provider_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = provider_api::post_provider_by_provider_connect(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new ProviderApi(client).postProviderByProviderConnect();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/provider/<provider>/connect \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "<accountId>",
"provider": "<provider>"
}'MCP declares no tool for provider — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?