Skip to main content
POST
Complete 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

Body

application/json
code
string
required

Provider authorization code returned to the RMA website.

state
string
required

Short-lived, single-use state returned by startIMAPOAuthAuthorization.

Response

OK

connected
boolean
required

True after the provider granted reusable IMAP access and the encrypted token bundle was saved.