Skip to main content
POST
Start or recover provider sign-in

Authorizations

Authorization
string
header
required

A workspace-bound human user OAuth grant with org:write scope. The user must be an organization owner/admin. API keys and browser sessions are not accepted.

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

providerId
string
required

The provider identifier (e.g. openai, anthropic, google, deepseek), returned as provider_id by listProviderCatalog.

Body

application/json
idempotency_key
string<uuid>
required

Persist this UUID before sending. The same namespace/workspace/user/key always identifies the same intent, across OAuth clients. Metadata is retained until membership erasure. Use a NEW key only for an explicitly new sign-in.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
method
enum<string>
required

Sign-in flow to start: choose from the provider's oauth_login.methods in listProviderCatalog. Reuse the same method when retrying this key.

Available options:
interactive,
browser,
device_code
account_key
string

Existing provider account key to reconnect; retain the account_key from that account or its previous login. Omit for a new provider-identified Codex account or the provider's single default connection. Reuse the same value when retrying this key.

Required string length: 1 - 512

Response

New or recovered current sign-in, including retained terminal results.

login
object
required

The sign-in's current state. Never contains provider tokens.