Hanzo
OpenapiIntegrations

Begins a device sign-in and returns the code to show the user plus how to poll…

Begins a device sign-in and returns the code to show the user plus how to poll for completion.

POST /v1/integrations/connectors/{provider}/device

Addresshttps://api.hanzo.ai/v1/integrations/connectors/{provider}/device
MethodPOST
Operationpost_integrations_connectors_by_provider_device
AuthAuthorization: Bearer $HANZO_API_KEY

Begins a device sign-in and returns the code to show the user plus how to poll for completion. KMS readiness is checked NOW rather than dead-ending the user at poll-done (connect() parity), and the per-provider connector cap is checked before the provider is called. The provider's device code is persisted only in the encrypted grants table and is NEVER returned.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
providerpathstringyesProvider is the user-scoped provider's registry id, from the path.
labelbodystringLabel names this connection so one user can hold several per provider ("work", "personal").
providerbodystringProvider is the user-scoped provider's registry id, from the path.

Response

StatusBodyMeaning
200deviceStartOutok

200 body — 5 fields.

FieldInTypeAlwaysDescription
expiresAtbodystringExpiresAt is when the flow dies, RFC 3339 UTC.
flowbodystringFlow is the id to poll with.
intervalbodyintegerInterval is the seconds to wait between polls.
userCodebodystringUserCode is the short code the user types at VerifyURL.
verifyUrlbodystringVerifyURL is the page the user opens to enter UserCode.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Integrations API · All Hanzo APIs · Interactive reference

How is this guide?

On this page