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": {
    "scheduledDeliveryExpirationSecondsGoogleChat": 123,
    "scheduledDeliveryExpirationSecondsMsTeams": 123,
    "scheduledDeliveryExpirationSecondsSlack": 123,
    "scheduledDeliveryExpirationSecondsEmail": 123,
    "scheduledDeliveryExpirationSeconds": 123,
    "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.

scheduledDeliveryExpirationSeconds · number<double> | null

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

scheduledDeliveryExpirationSecondsEmail · number<double> | null

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.

scheduledDeliveryExpirationSecondsSlack · number<double> | null

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

scheduledDeliveryExpirationSecondsMsTeams · number<double> | null

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

scheduledDeliveryExpirationSecondsGoogleChat · number<double> | null

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

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