Organizations

Configure Organization Embeddable Auth

Create or update the Embeddable Auth (OAuth provider) configuration at the organization level.

put/v1/management/organizations/{org_id}/authkit

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/management/organizations/{org_id}/authkit
  • Auth: API key in header X-One-Secret

Path parameters

org_idstring uuid required

Organization ID

Request body

activeboolean required

Whether this OAuth configuration is enabled. When false the platform is hidden from the Embeddable Auth picker for end users in this scope and environment, even if credentials are present.

clientIdstring
clientSecretstring
connectionDefinitionIdstring required

Prefixed ID with 'conn_def' prefix (e.g., 'conn_def_1C'), also accepts raw integer

environment'test' | 'live' required
guidestring nullable

Optional URL shown behind the "View connection guide" link in the Embeddable Auth component for this platform. Typically a page in your docs explaining how end users should obtain whatever the platform requires (account, workspace, etc.) before connecting. Must be an absolute http:// or https:// URL; other schemes (javascript:, data:, file:, …) are rejected to prevent stored-XSS / phishing on dashboards and the AuthKit widget that render this value as a clickable link.

scopesstring nullable

Space-separated list of OAuth scopes to request from the platform (RFC 6749 §3.3 format, e.g. "read:user offline_access"). Applied to both the authorization-URL scope parameter and the client-credentials token exchange. Leave unset to use the platform's default scope set.

useDefaultOauthCredsboolean nullable

When true, use Pica's managed OAuth app for this platform instead of supplying your own clientId and clientSecret.

Response

Embeddable Auth row created or updated

activatedAtstring date-time nullable
activeboolean required
clientIdDisplaystring nullable
clientSecretDisplaystring nullable
connectionDefIdstring required

Prefixed ID with 'conn_def' prefix (e.g., 'conn_def_1C'), also accepts raw integer

createdAtstring date-time required
environment'test' | 'live' required
guidestring nullable
idstring required

Prefixed ID with 'conn_plf' prefix (e.g., 'conn_plf_1C'), also accepts raw integer

imagestring required
scopesstring nullable
secretIdstring uuid nullable
tagsstring[] required
titlestring required
typestring required
useDefaultOauthCredsboolean required

Changes

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