Start website sign-in for an IMAP OAuth credential
Creates a short-lived, single-use authorization state bound to this user, organization, credential, and confirmed IMAP hostname and OAuth endpoints. The user must confirm the exact authorization endpoint and token endpoint before the authorization code can be sent there. Follow the returned provider URL. Sign-in does not create or change an event source; an already active source keeps polling.
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
Vault holding the server-only IMAP OAuth credential.
IMAP OAuth credential to authorize.
Body
Exact OAuth authorization endpoint shown to the signed-in user before consent.
Exact IMAP hostname that the signed-in user confirms may receive the OAuth access token.
Exact OAuth token endpoint shown to the signed-in user; it receives the authorization code and later the refresh token.
Response
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.