integrations

Start RFC 8628 OAuth device authorization for an integration.

Start RFC 8628 OAuth device authorization for an integration. Returns a user_code and verification URI for the signed-in user to approve at the provider. The provider device_code and any client secret stay server-side and never appear in the output. Poll with integrationDeviceConnectPoll until approved or failed. Prefer /connect/oauth?flow=device for interactive browser flows; use this capability when an agent must drive device connect without a browser redirect.

Org permission: integration:write.

post/v1/integrations/device/start

Request

  • Base URL: https://api.kody.codes
  • URL: https://api.kody.codes/v1/integrations/device/start
  • Auth: HTTP bearer

Request body

providerstring required

Connection / provider name to create or reconnect via device authorization.

platformAppSlugstring

Optional platform (built-in) app slug. When set, endpoints and client id come from the app row.

tokenUrlstring uri
deviceAuthorizationUrlstring uri
authorizeUrlstring uri
apiBaseUrlstring uri nullable
clientIdstring
clientSecretstring

Optional client secret for confidential device clients. Never returned in outputs.

scopesstring[]
scopeSeparatorstring nullable
extraAuthorizeParamsobject
allowedHostsstring[]
tokenExchangeStyle'form' | 'basic-json' | 'basic-form'
usePkceboolean nullable

Response

Success.

oktrue required
sessionIdstring required

Opaque session id for integrationDeviceConnectPoll.

userCodestring required

Code the user enters at the provider.

verificationUristring uri required
verificationUriCompletestring uri nullable required
expiresIninteger required
intervalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.