Start a device-authorization connector login (returns user code + verification URL)
Requires the connectors:create permission.
Device flow for providers that support it: codex (OpenAI) and github (a repo-scoped token for Deploy-from-Git private clones). The github provider requires a configured GitHub OAuth-app client_id (INTERLAKEN_GITHUB_CLIENT_ID); when unset the login returns a clear "GitHub deploys not configured" error. Pass connector_id to reconnect an existing connector in place: when the login completes its credential is replaced under the same id, name and default flag, so application sources and sessions that reference it keep working. A GitHub App's expiring user token is stored with its refresh token and rotated automatically (needs github.client_secret).
An access token from this zone's POST /oauth/token, or a session token from POST /api/v1/auth/login. Send it as Authorization: Bearer <token>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/connectors/device/start" \ -H "Content-Type: application/json" \ -d '{ "provider": "string" }'{ "interval": 0, "poll_id": "string", "user_code": "string", "verification_url": "string"}