Connectors

Create connection

Changed on

Create a pending provider connection and return a one-time connect_url for the hosted OAuth flow. The user completes provider consent at connect_url and is redirected to return_url with ?connection_id=.

post/connectors/v1/connections

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/connectors/v1/connections
  • Auth
    HTTP bearer

Headers

x-case-connector-subjectstring

Trusted server-to-server application-user assertion. Derive it from the authenticated application session, never browser input. Omit only for the legacy organization-scoped namespace.

Request body

provider'box' | 'clio' | 'dropbox' | 'gdrive' | 'microsoft' | 'smokeball' required
return_urlstring required

HTTPS URL the user is sent back to after consent.

scope_tier'box.readwrite' | 'box.readwrite.webhooks' | 'clio.us' | 'dropbox.readwrite' | 'drive' | 'microsoft.account.read' | 'microsoft.read' | 'microsoft.personal.read' | 'microsoft.write' | 'microsoft.personal.write' | 'smokeball.us' | 'smokeball.us.staging' | 'smokeball.us.staging.write' | 'smokeball.us.write'

Provider-specific OAuth permission tier. Omit to use the provider's default. Use microsoft.account.read to let Microsoft choose a personal or work/school account. Existing explicit microsoft.read and microsoft.personal.read tiers remain supported. Microsoft write tiers require the separate write switch and explicit authorization for bounded exports and paired sync.

Response

Pending connection created

connection_idstring
connect_urlstring
expires_atstring

Changes