Create credential
Is the direct intake path: a customer-held token/setup-token (Verify) or an externally obtained OAuth bundle from the CLI's local PKCE (Adopt).
POST /v1/connection/{provider}/credential
| Address | https://api.hanzo.ai/v1/connection/{provider}/credential |
| Method | POST |
| Operation | post_connection_by_provider_credential |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Is the direct intake path: a customer-held token/setup-token (Verify) or an externally obtained OAuth bundle from the CLI's local PKCE (Adopt). ALWAYS verify-before-store: a bad credential is refused and NOTHING is persisted (connectByCredential's fail-closed order).
Request
9 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes | Provider is the user-scoped provider's registry id, from the path. |
accountId | body | string | — | AccountID scopes the credential where the provider's Verify needs one. |
label | body | string | — | Label names this connection; empty means "default". |
oauth | body | provider.oauthBundleIn | — | |
oauth.access | body | string | — | Access is the access token. |
oauth.account | body | string | — | Account is the account label the flow reported; sanitized on ingest. |
oauth.refresh | body | string | — | Refresh is the refresh token. |
provider | body | string | — | Provider is the user-scoped provider's registry id, from the path. |
token | body | string | — | Token is the customer-held credential for the Verify path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | provider.credentialOut | ok |
default | problem-details | refused |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
connected | body | boolean | — | Connected is always true — a failed verification is a 400 and stores nothing. |
connector | body | provider.connectionView | — | |
connector.account | body | string | — | Account is the human label of the connected third-party account (the Slack team name, the GitHub org login). |
connector.connectedAt | body | string | — | ConnectedAt is when the connection was last (re)established, RFC 3339 UTC. |
connector.expiresAt | body | string | — | ExpiresAt is when the access token expires, RFC 3339 UTC; empty for a credential that does not expire. |
connector.externalId | body | string | — | ExternalID is the provider's own id for the account (Slack team.id, GitHub installation_id) — the value inbound webhooks are mapped back to this org by. |
connector.id | body | string | — | ID is provider + ":" + label, the address every connection route takes. |
connector.label | body | string | — | Label is the caller's own name for this connection ("default", "work"). |
connector.provider | body | string | — | Provider is the connected provider's registry id. |
connector.scopes | body | string[] | — | Scopes are the permissions the provider granted. |
Failure carries the platform error shape — see Errors.
Examples
hanzo connection credential <provider>import { Configuration, ProviderApi } from 'hanzoai';
const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postConnectionByProviderCredential({ provider: 'provider', accountId: "<accountId>", label: "<label>" });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_connection_by_provider_credential(provider='provider', account_id="<accountId>", label="<label>")cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ProviderAPI.PostConnectionByProviderCredential(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_connection_by_provider_credential(&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).postConnectionByProviderCredential();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were 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/connection/<provider>/credential \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "<accountId>",
"label": "<label>"
}'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?