Skip to main content
POST
Begin authorizing a third-party account connection

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

provider
string
required

Integration provider id returned by managedAgentsListIntegrationProvidersV2.

Minimum string length: 1

Body

application/json
connectionId
string<uuid>

Existing connection to reauthorize in place, keeping its id and the vault grants that reference it. Omit to create a new connection. It must belong to the caller organization and use this provider; it is bound server-side to the returned state, never taken from the provider callback.

option
string

Short opaque provider continuation option, or the permission preset for a provider whose catalog reports presetFixedAtAuthorization. Omit for a provider needing neither.

Maximum string length: 30

Response

OK

state
string
required

Single-use CSRF nonce identifying this install attempt, not a lifecycle status. The provider must echo it in the callback; completion consumes the server-held record that binds it to the provider, organization, and user.

url
string
required

Absolute provider-hosted authorization page to redirect the user to. Carries the state nonce as a query parameter; send the user here rather than fetching it server-side.