API Reference

Set customer OAuth app credentials (BYOA)

PUT /api/connectors/{id}/oauth-app

Upserts the Saffron installed integration in byoa mode with the given client id/secret. Only valid when catalog client.id is dummy.

Operation IDputConnectorOAuthApp

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject

2 properties

client_idstringrequired

client_secretstring

Success response body

200Updated status (same shape as GET)

Updated status (same shape as GET)

No response content schema is documented.

Error responses

400Validation or Saffron error

Validation or Saffron error

No response content schema is documented.

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/connectors/YOUR_ID/oauth-app' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "client_id": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/connectors/YOUR_ID/oauth-app", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);