Skip to main content
POST
Start website sign-in for an IMAP OAuth credential

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

vaultId
string<uuid>
required

Vault holding the server-only IMAP OAuth credential.

credentialId
string<uuid>
required

IMAP OAuth credential to authorize.

Body

application/json
confirmedAuthorizationEndpoint
string
required

Exact OAuth authorization endpoint shown to the signed-in user before consent.

confirmedImapHost
string
required

Exact IMAP hostname that the signed-in user confirms may receive the OAuth access token.

confirmedTokenEndpoint
string
required

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.

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.