Begin authorizing a third-party account connection
Begins authorizing a third-party account connection and returns the provider URL to send the operator to, together with a single-use, short-lived state nonce. A caller may also continue one of the opaque provider options returned by managedAgentsCompleteIntegrationInstall. Nothing is connected until completion succeeds. Do not automatically retry an ambiguous transport failure; begin a new install and use its returned state.
Authorizations
A Recursion API key, created in the console under API keys.
Headers
Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.
1Organization 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.
1Path Parameters
Integration provider id returned by managedAgentsListIntegrationProviders.
1Body
Optional input for starting or continuing an integration authorization. It may select a provider-defined continuation or an existing connection to re-authorize; organization identity always comes from the authenticated caller.
Existing connection to re-authorize in place, keeping its id and therefore the vault grants that reference it. Omit to create a new connection. The connection must belong to the caller's organization and use this provider; it is recorded server-side against the returned state, never read back from the provider callback.
Short opaque provider option: either a continuation value returned by a prior completion, or -- for a provider whose catalog entry reports preset_fixed_at_authorization -- the permission preset to authorize (see ProviderInfo.permissions). Omit for a provider needing neither.
30Response
Where to send a user to authorize an integration, plus the one-time state nonce that ties the provider's callback back to this attempt. Returned when an authorization flow is started.
Where to send a user to authorize an integration, plus the one-time state nonce that ties the provider's callback back to this attempt. Returned when an authorization flow is started.
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.
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.