Providers
Start provider authorization
POST /v1/connections · SDK beginProviderAuthorization · CLI deployments connection authorize
POST
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512application/json- body
providerApplicationId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$providerKey*stringMatch
^[a-z0-9](?:[a-z0-9._-]{0,126}[a-z0-9])?$requestedResource?stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
1 <= length <= 2048requestedScopes?array<>returnTo?stringAbsolute https URL the OAuth callback sends the browser to. Its origin must exactly match an entry of the deployment's PLATFORM_OAUTH_RETURN_ORIGINS allowlist, without userinfo or a fragment; otherwise the request fails with 422 invalid_return_to. The callback answers 303 to this URL with connection_id and provider query parameters on success, or error=access_denied (the user declined) or error=authorization_failed on failure; existing query parameters are kept. Omit it to have the callback render a static result page instead.
BeginProviderAuthorizationResponse
application/json- response
authorizationUrl*stringexpiresAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecurl -X POST "https://example.com/v1/connections" \ -H "x-deployments-environment: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "providerKey": "string" }'{ "authorizationUrl": "string", "expiresAt": "2019-08-24T14:15:22Z"}