Update organization settings

Updates the current organization’s settings. Only the provided fields are changed.

PATCH /api/v1/org/settings

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "supportImpersonationEnabled": true,
    "oidcToEmailLinkingEnabled": true,
    "oidcLinkingEnabled": true
  }
}

Body

application/json

Make all properties in T optional

oidcLinkingEnabled · boolean | null

Auto-link a new OIDC identity to an existing user who already has a different OIDC identity with the same email (overrides AUTH_ENABLE_OIDC_LINKING; null inherits it).

oidcToEmailLinkingEnabled · boolean | null

Auto-link an OIDC identity to an existing user matched by verified primary email, regardless of how they signed up (overrides AUTH_ENABLE_OIDC_TO_EMAIL_LINKING; null inherits it).

supportImpersonationEnabled · boolean | null

Per-org consent for the Lightdash support team to impersonate users in the org while helping with a support request. Unlike the OIDC toggles this has no instance/env default — it's opt-in only, so null (or no stored row) resolves to false.

Response

200

application/json

Ok

results · object · required

Per-organization settings migrated from instance-wide env vars. Surfaced in the Pro admin panel and stored in the organization_settings table. Starts with the OIDC account-linking toggles; designed to grow as more settings move org-level.

Each value is tri-state: null means "not set — inherit the instance/env default", while an explicit true/false overrides the env. The fallback to the env default is resolved in the auth layer, not here.

Show child attributes

status · enum<string> · required

Available options: ok