Skip to main content
PUT
Set your OAuth client

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

app
string
required

The catalog app to bring your own OAuth client for. It must offer an OAuth sign-in; an app that only takes a key is a 400.

Body

application/json
clientId
string
required

Your OAuth client's id at the provider.

clientSecret
string
required

Your OAuth client's secret. WRITE-ONLY, every time: it goes to Composio and is held nowhere on Ergoly's side, so there is no stored one to keep and both fields are required on a rotation too.

Response

Success — a client was already configured for this app, so this rotated it.

data
object
required