Skip to main content
PUT
Set a provider app

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

provider
string
required

The provider whose app to configure.

Body

application/json
clientId
string
required

The provider's OAuth client id. Public; readable back.

clientSecret
string

The provider's OAuth client secret. WRITE-ONLY. Required when creating; omit or send an empty string when rotating to keep the stored one.

scope
enum<string>

Org-wide, or for one Client. Defaults to org.

Available options:
org,
client
scopeClientId
string

Required when scope is client.

Response

Success — an app was already configured, so this rotated it.

data
object
required