Skip to main content
POST
Start an owner consent handoff

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
provider
any
required
project_id
string
required if environment_id is set
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment_id
string
required if project_id is set
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Connection result.

request_id
string
required
Pattern: ^[a-f0-9]{64}$
url
string<uri>
required
expires_at
string<date-time>
required