v1

latestOpenAPI 3.0.0MIT2026-07-264001,540832.7 KB
Organizations

Update organization settings

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

patch/api/v1/org/settings

Request body

oidcLinkingEnabledboolean nullable

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).

oidcToEmailLinkingEnabledboolean nullable

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).

supportImpersonationEnabledboolean nullable

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.

semanticLayerPgwireEnabledboolean nullable

Per-org enablement of the semantic-layer Postgres wire integration (surfaced on the project settings page). Like impersonation this has no instance/env default — it's opt-in only, so null (or no stored row) resolves to false.

scheduledDeliveryExpirationSecondsnumber double nullable

Base lifetime (seconds) of this org's scheduled-delivery download links — the default every channel inherits. Overrides the instance-wide PERSISTENT_DOWNLOAD_URL_EXPIRATION_SECONDS env; null inherits it. This field is always resolved to an effective number in API responses (it falls back to the env default), so the frontend can display it directly. A value over {@link S3_PRESIGNED_URL_MAX_EXPIRATION_SECONDS} transparently switches that delivery to the persistent-download-URL system (the only way a link can outlive AWS's 7-day presigned ceiling).

scheduledDeliveryExpirationSecondsEmailnumber double nullable

Per-channel override (seconds) of {@link scheduledDeliveryExpirationSeconds } for email deliveries; null inherits the base. Unlike the base, this is surfaced raw (not resolved) so the UI can distinguish "inherit" from an explicit value. Overrides PERSISTENT_DOWNLOAD_URL_EXPIRATION_SECONDS_EMAIL.

scheduledDeliveryExpirationSecondsSlacknumber double nullable

Per-channel override (seconds) for Slack deliveries; null inherits the base. Overrides PERSISTENT_DOWNLOAD_URL_EXPIRATION_SECONDS_SLACK.

scheduledDeliveryExpirationSecondsMsTeamsnumber double nullable

Per-channel override (seconds) for Microsoft Teams deliveries; null inherits the base. Overrides PERSISTENT_DOWNLOAD_URL_EXPIRATION_SECONDS_MSTEAMS.

scheduledDeliveryExpirationSecondsGoogleChatnumber double nullable

Per-channel override (seconds) for Google Chat deliveries; null inherits the base. Google Chat has no instance env var, so this is an org-only override (it still falls back to the base / env base).

queryLimitnumber double nullable

Max number of rows a query may return for this org. Inherits and is capped by the instance-wide LIGHTDASH_QUERY_MAX_LIMIT (the ceiling); null inherits it. Always resolved to an effective number in API responses so the frontend can display it directly.

csvCellsLimitnumber double nullable

Max number of cells (rows × columns) a CSV/Excel export may contain for this org. Inherits LIGHTDASH_CSV_CELLS_LIMIT and is capped by LIGHTDASH_CSV_MAX_LIMIT (the ceiling); null inherits the default. Always resolved to an effective number in API responses.

corsAllowedDomainsstring[] nullable

Exact origins, wildcard subdomain origins, and regex patterns this org contributes to the instance CORS allow-list. Regex entries use /.../ syntax.

Response

Ok

status'ok' required