Connectors

Set or rotate this org’s OAuth app for a connector

Replaces the stored application wholesale, with one exception the setup form depends on: omitting client_secret keeps the secret already stored, so correcting a typo in the client id cannot destroy a working secret. Send both to rotate. Scope overrides (scope, optional_scope, user_scope) are optional; omit them to keep the connector’s catalog scopes, or send arrays to replace them. Endpoint fields (token host, other authorize params) are not accepted here by design. Returns the same shape as the read, so the secret does not come back. Requires connector:manage.

put/connector/{slug}/oauth-app

Request

  • Base URL: https://api.elaichi.ai
  • URL: https://api.elaichi.ai/connector/{slug}/oauth-app
  • Auth: HTTP bearer

Path parameters

slugstring required

Connector slug.

Headers

X-Organization-Idstring

Target organization (org_…). Required for cookie/session auth on org-scoped routes; optional for API tokens, which carry their organization, and rejected when it names a different one.

Request body

client_idstring required
client_secretstring

Omit to keep the stored secret. Never returned by any endpoint.

scopestring[]

Omit to keep the catalog scopes; an array overrides them wholesale.

optional_scopestring[]
user_scopestring

Authorize-URL scopes (params.user_scope), separated by spaces or commas and stored space-separated. Only where supports_user_scope is true; omit to clear.

Response

OK

oauth_app_mode'platform_default' | 'byoa'

Which application connects on this connector use.

client_idstring nullable
has_client_secretboolean

Whether a secret is stored. The secret itself is never returned.

scopestring[] nullable

Scope overrides this org stored, or null when it kept the catalog scopes.

optional_scopestring[] nullable
user_scopestring nullable

Space-separated authorize-URL scopes (params.user_scope), or null. Null also when one is stored but held back, see user_scope_masked.

user_scope_maskedboolean

True when a user_scope is stored encrypted by an older write and cannot be read or changed here. A PUT that sets user_scope then answers 409.

supports_user_scopeboolean

Whether this connector’s provider takes user token scopes (Slack does). Where false, a user_scope that differs from the stored one is refused with 400.

updated_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.