Lightdash Organizations API
Each user is a member of a single organization. These routes allow users to manage their organization. Most actions are only available to admin users.
Lightdash Organizations API is one of 50 APIs that Lightdash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 8 JSON Schema definitions.
Tagged areas include Organization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.
This API exposes 55 operations across 31 paths, and defines 235 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.
Requests are made against a single base URL, /.
55 operations
31 paths
235 schemas
12 DELETE20 GET8 PATCH9 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Lightdash Organizations API declares
2 security schemes
for authenticating requests.
An API key is passed in the cookie as connect.sid (session_cookie).
An API key is passed in the header as Authorization (api_key).
api_key— Value should be 'ApiKey '
Paths & Operations 55
Across 31 paths, the API surfaces 55 operations — 12 DELETE, 20 GET, 8 PATCH, 9 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Organizations 55
Each user is a member of a single organization. These routes allow users to manage their organization. Most actions are only available to admin users.
GET
/api/v1/org/sso/azuread
Get Azure AD SSO configuration
PUT
/api/v1/org/sso/azuread
Upsert Azure AD SSO configuration
DELETE
/api/v1/org/sso/azuread
Delete Azure AD SSO configuration
GET
/api/v1/org/sso/okta
Get Okta SSO configuration
PUT
/api/v1/org/sso/okta
Upsert Okta SSO configuration
DELETE
/api/v1/org/sso/okta
Delete Okta SSO configuration
GET
/api/v1/org/sso/oidc
Get generic OIDC SSO configuration
PUT
/api/v1/org/sso/oidc
Upsert generic OIDC SSO configuration
DELETE
/api/v1/org/sso/oidc
Delete generic OIDC SSO configuration
GET
/api/v1/org/sso/oneLogin
Get OneLogin SSO configuration
PUT
/api/v1/org/sso/oneLogin
Upsert OneLogin SSO configuration
DELETE
/api/v1/org/sso/oneLogin
Delete OneLogin SSO configuration
GET
/api/v1/org/sso/google
Get Google SSO configuration
PUT
/api/v1/org/sso/google
Upsert Google SSO configuration
DELETE
/api/v1/org/sso/google
Delete Google SSO configuration
GET
/api/v1/org/domains
List verified domains
POST
/api/v1/org/domains/verify
Request domain verification
POST
/api/v1/org/domains/confirm
Confirm domain verification
DELETE
/api/v1/org/domains/{domain}
Delete verified domain
GET
/api/v1/org/settings
Get organization settings
PATCH
/api/v1/org/settings
Update organization settings
GET
/api/v1/org/designs
List organization designs
POST
/api/v1/org/designs
Create organization design
GET
/api/v1/org/designs/{designUuid}
Get organization design
PATCH
/api/v1/org/designs/{designUuid}
Update organization design
DELETE
/api/v1/org/designs/{designUuid}
Delete organization design
DELETE
/api/v1/org/designs/default
Clear default organization design
POST
/api/v1/org/designs/{designUuid}/default
Set default organization design
POST
/api/v1/org/designs/{designUuid}/files
Upload file to organization design
DELETE
/api/v1/org/designs/{designUuid}/files/{fileUuid}
Delete file from organization design
GET
/api/v1/org/designs/{designUuid}/files/{fileUuid}
Download file from organization design
GET
/api/v1/org
Get current organization
PUT
/api/v1/org
Create organization
PATCH
/api/v1/org
Update current organization
DELETE
/api/v1/org/{organizationUuid}
Delete organization
GET
/api/v1/org/projects
List organization projects
POST
/api/v1/org/projects
Create project
GET
/api/v1/org/users
List organization members
GET
/api/v1/org/users/{userUuid}deprecated
Get organization member by UUID
PATCH
/api/v1/org/users/{userUuid}deprecated
Update organization member
GET
/api/v1/org/users/email/{email}deprecated
Get organization member by email
DELETE
/api/v1/org/user/{userUuid}
Delete organization member
GET
/api/v1/org/user/{userUuid}/schedulers-summary
Get user schedulers
PATCH
/api/v1/org/user/{userUuid}/reassign-schedulers
Reassign schedulers
GET
/api/v1/org/allowedEmailDomains
List allowed email domains
PATCH
/api/v1/org/allowedEmailDomains
Update allowed email domains
POST
/api/v1/org/groups
Create group
GET
/api/v1/org/groups
List organization groups
POST
/api/v1/org/color-palettes
Create color palette
GET
/api/v1/org/color-palettes
List color palettes
PATCH
/api/v1/org/color-palettes/{colorPaletteUuid}
Update color palette
DELETE
/api/v1/org/color-palettes/{colorPaletteUuid}
Delete color palette
POST
/api/v1/org/color-palettes/{colorPaletteUuid}/active
Set active color palette
GET
/api/v1/org/impersonation
Get impersonation settings
PATCH
/api/v1/org/impersonation
Update impersonation settings
Schemas 235
The contract defines 235 schemas that model the data the API accepts and returns. The most detailed are CreateSnowflakeCredentials (25 properties), Pick_CreatePostgresCredentials.Exclude_keyofCreatePostgresCredentials.SensitiveCredentialsFieldNames__ (22 properties), Project (21 properties), Pick_CreateSnowflakeCredentials.Exclude_keyofCreateSnowflakeCredentials.SensitiveCredentialsFieldNames__ (19 properties). Each schema is shown below with its type and property counts.
ReassignUserSchedulersRequest
object
1 property
1 required
ApiSuccess_ImpersonationOrganizationSettings_
object
2 properties
2 required
OrganizationMemberRole
string
UpsertOktaSsoConfig
DomainVerificationStatus
Verification status of a single domain. Mirrors {@link EmailStatusExpiring}: otp is present only while a pending one-time passcode challenge exists.
DucklakeDataPathGcs
CreateDucklakeDataPath
DbtProjectType.GITHUB
string
DbtNoneProjectConfig
object
5 properties
1 required
TrinoCredentials
Pick_CreateDucklakeDataPathS3.Exclude_keyofCreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey__
object
From T, pick a set of properties whose keys are in the union K
6 properties
2 required
DucklakeCatalogSqlite
ApiOrganizationDesignResponse
DuckdbDucklakeCredentials
Omit_CreateDatabricksCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DucklakeCatalogType.POSTGRES
string
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties
2 required
Omit_CreateDucklakeDataPathAzure.connectionString-or-accountKey_
Construct a type with the properties of T except for those in type K.
DbtLocalProjectConfig
object
6 properties
1 required
WarehouseTypes.BIGQUERY
string
GoogleSsoConfigSummary
UpdateOrganizationSettings
Pick_Group.name_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
OrganizationSsoMethodFlags
object
Per-row flags shared by every SSO method configured at the org level. Stored as plain columns alongside the encrypted provider-specific config.
4 properties
4 required
DucklakeDataPathType.AZURE
string
WarehouseTypes.REDSHIFT
string
ApiUpsertGenericOidcSsoConfigResponse
object
2 properties
2 required
ApiOrganizationSettingsResponse
object
2 properties
2 required
DbtCloudIDEProjectConfig
object
5 properties
3 required
DucklakeDataPathAzure
DbtProjectType.BITBUCKET
string
SnowflakeAuthenticationType
string
Organization
object
Details of a user's Organization
8 properties
2 required
Omit_CreateDucklakeCatalogPostgres.user-or-password_
Construct a type with the properties of T except for those in type K.
ApiCreateProjectResults
object
3 properties
2 required
ProjectMemberRole.VIEWER
string
ApiOneLoginSsoConfigResponse
object
2 properties
2 required
CreateProjectOptionalCredentials
BigqueryAuthenticationType
string
DucklakeDataPathS3
ApiVerifiedDomainsResponse
object
2 properties
2 required
OrganizationSettings
object
Per-organization settings migrated from instance-wide env vars. Surfaced in the Pro admin panel and stored in the organizationsettings table. Starts with the O…
11 properties
11 required
ApiUserSchedulersSummaryResponse
CreateDuckdbCredentials
GenericOidcSsoConfigSummary
Pick_CreateClickhouseCredentials.Exclude_keyofCreateClickhouseCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
9 properties
4 required
DbtProjectType.MANIFEST
string
AllowedEmailDomainProjectsRole
WarehouseTypes.ATHENA
string
DucklakeCatalogType.SQLITE
string
RedshiftCredentials
Omit_CreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
SslConfiguration
object
7 properties
CreateDatabricksCredentials
object
15 properties
4 required
UpdateOrganization
OrganizationProject
object
Summary of a project under an organization
9 properties
8 required
ConfirmDomainVerification
object
2 properties
2 required
DucklakeDataPathType.GCS
string
Partial_OrganizationSettings_
object
Make all properties in T optional
11 properties
AthenaCredentials
DbtAzureDevOpsProjectConfig
object
10 properties
7 required
ClickhouseCredentials
ApiReassignUserSchedulersResponse
CreateOrganization
ApiGroupListResponse
object
2 properties
2 required
OneLoginSsoConfigSummary
ApiSuccess__reassignedCount-number__
object
2 properties
2 required
Omit_CreateRedshiftCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DbtGithubProjectConfig
object
11 properties
5 required
DucklakeCatalogDuckdb
Group
object
7 properties
7 required
ApiDomainVerificationStatusResponse
object
2 properties
2 required
ApiUpsertOneLoginSsoConfigResponse
object
2 properties
2 required
CreateDucklakeDataPathAzure
object
5 properties
2 required
Omit_CreateSnowflakeCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DbtProjectConfig
RequestDomainVerification
object
Request to verify a domain. challengeEmail must be an address at domain; a one-time passcode is sent there and confirmed via {@link ConfirmDomainVerification}.
2 properties
2 required
KnexPaginatedData_Group-Array-or-GroupWithMembers-Array_
object
2 properties
1 required
WarehouseTypes.DATABRICKS
string
EmailOneTimePassword
object
2 properties
2 required
Pick_CreateDuckdbMotherduckCredentials.Exclude_keyofCreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
8 properties
4 required
CreateColorPalette
object
3 properties
2 required
Omit_AllowedEmailDomains.organizationUuid_
Construct a type with the properties of T except for those in type K.
OrganizationColorPalette
object
6 properties
6 required
Omit_CreateBigqueryCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
AthenaAuthenticationType
string
Pick_GroupMember.userUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
Pick_AzureAdSsoConfig.oauth2ClientId-or-oauth2TenantId_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
DbtVersionOptionLatest
string
Omit_CreateDuckdbDucklakeCredentials.catalog-or-dataPath_
Construct a type with the properties of T except for those in type K.
Omit_CreateClickhouseCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
Omit_CreateAthenaCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
CreateAthenaCredentials
object
17 properties
5 required
OktaSsoConfigSummary
CreateTrinoCredentials
object
12 properties
8 required
DatabricksAuthenticationType
string
AllowedEmailDomains
object
4 properties
4 required
ApiOrganizationDesignsResponse
CreateDucklakeCatalogSqlite
object
2 properties
2 required
GroupWithMembers
Details for a group including a list of the group's members.
CreateWarehouseCredentials
AzureAdSsoConfigSummary
CreateDucklakeCatalogPostgres
object
6 properties
6 required
Pick_CreateDucklakeDataPathAzure.Exclude_keyofCreateDucklakeDataPathAzure.connectionString-or-accountKey__
object
From T, pick a set of properties whose keys are in the union K
3 properties
2 required
OrganizationMemberRole.MEMBER
string
DbtProjectType.GITLAB
string
Pick_CreateDuckdbDucklakeCredentials.Exclude_keyofCreateDuckdbDucklakeCredentials.catalog-or-dataPath__
object
From T, pick a set of properties whose keys are in the union K
8 properties
3 required
ApiOrganizationDesign
object
10 properties
10 required
DucklakeDataPathLocal
ApiOktaSsoConfigResponse
object
2 properties
2 required
CreateSnowflakeCredentials
object
25 properties
6 required
DbtGitlabProjectConfig
object
9 properties
5 required
ProjectMemberRole.EDITOR
string
ApiSuccess_ApiOrganizationDesignFile_
object
2 properties
2 required
OrganizationMemberRole.VIEWER
string
DbtProjectType.DBT_CLOUD_IDE
string
WarehouseTypes.TRINO
string
ApiColorPaletteResponse
object
2 properties
2 required
Pick_CreateSnowflakeCredentials.Exclude_keyofCreateSnowflakeCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
19 properties
5 required
DbtVersionOption
SupportedDbtVersions
string
UpsertOneLoginSsoConfig
ApiGoogleSsoConfigResponse
object
2 properties
2 required
CreateDucklakeCatalogDuckdb
object
2 properties
2 required
AnyType
This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are onl…
ApiOrganizationProjects
object
List of projects in the current organization
2 properties
2 required
CreateDucklakeDataPathS3
object
8 properties
2 required
ApiSuccessEmpty
object
2 properties
1 required
Pick_CreateBigqueryCredentials.Exclude_keyofCreateBigqueryCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
15 properties
3 required
ApiOrganizationMemberProfile
object
2 properties
2 required
CreateGroup
UpdateOrganizationDesignRequest
object
3 properties
OrganizationMemberRole.EDITOR
string
ApiSuccess_ApiOrganizationDesign_
object
2 properties
2 required
ApiSuccess_UserSchedulersSummary_
object
2 properties
2 required
ApiUpsertAzureAdSsoConfigResponse
object
2 properties
2 required
Omit_CreateTrinoCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DucklakeDataPathType.S3
string
CreateDucklakeCatalog
DbtProjectType.AZURE_DEVOPS
string
ApiOrganization
object
2 properties
2 required
Pick_CreateProject.Exclude_keyofCreateProject.warehouseConnection__
object
From T, pick a set of properties whose keys are in the union K
12 properties
4 required
CreateOrganizationDesignRequest
object
2 properties
1 required
DuckdbMotherduckCredentials
Pick_CreateDucklakeDataPathGcs.Exclude_keyofCreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret__
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
Partial_Omit_Organization.organizationUuid-or-needsProject__
object
Make all properties in T optional
6 properties
DbtProjectEnvironmentVariable
object
2 properties
2 required
KnexPaginatedData_OrganizationMemberProfile-Array_
object
2 properties
1 required
DbtProjectType.NONE
string
Omit_CreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey_
Construct a type with the properties of T except for those in type K.
DucklakeCatalog
CreatePostgresCredentials
ApiOrganizationDesignFile
object
6 properties
6 required
UpdateImpersonationOrganizationSettings
object
1 property
1 required
ApiImpersonationOrganizationSettingsResponse
WarehouseTypes
string
Pick_CreateTrinoCredentials.Exclude_keyofCreateTrinoCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
10 properties
6 required
Pick_CreateRedshiftCredentials.Exclude_keyofCreateRedshiftCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
18 properties
5 required
UpsertGenericOidcSsoConfig
VerifiedDomain
object
A domain an organization has proven it owns (via a one-time passcode sent to an address at the domain). Verified domains are globally unique — the first organi…
4 properties
4 required
OrganizationMemberProfile
object
Profile for a user's membership in an organization
12 properties
9 required
DucklakeDataPathType.LOCAL
string
ApiCreatedColorPaletteResponse
object
2 properties
2 required
DucklakeCatalogType.DUCKDB
string
OrganizationMemberProfileUpdate
object
1 property
1 required
WarehouseTypes.SNOWFLAKE
string
CreateDuckdbDucklakeCredentials
object
10 properties
5 required
DucklakeCatalogPostgres
CreateBigqueryCredentials
object
16 properties
4 required
Omit_CreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret_
Construct a type with the properties of T except for those in type K.
ProjectType
string
DuckdbConnectionType.DUCKLAKE
string
ApiSuccess_ApiCreateProjectResults_
object
2 properties
2 required
DuckdbCredentials
ApiColorPalettesResponse
object
2 properties
2 required
CreateRedshiftCredentials
Omit_CreatePostgresCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
ApiOrganizationDesignFileResponse
GroupMember
object
A summary for a Lightdash user within a group
4 properties
4 required
OrganizationMemberRole.INTERACTIVE_VIEWER
string
WarehouseTypes.POSTGRES
string
DbtManifestProjectConfig
object
3 properties
3 required
CreateClickhouseCredentials
object
11 properties
6 required
UpsertAzureAdSsoConfig
Pick_CreateDatabricksCredentials.Exclude_keyofCreateDatabricksCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
10 properties
4 required
Pick_OneLoginSsoConfig.oauth2Issuer-or-oauth2ClientId_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
ApiAzureAdSsoConfigResponse
object
2 properties
2 required
WarehouseTypes.CLICKHOUSE
string
ApiGenericOidcSsoConfigResponse
object
2 properties
2 required
AllowedEmailDomainsRole
DbtProjectType.DBT
string
Pick_CreatePostgresCredentials.Exclude_keyofCreatePostgresCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
22 properties
5 required
Project
object
21 properties
16 required
KnexPaginateArgs
object
2 properties
2 required
WarehouseCredentials
CreateDuckdbMotherduckCredentials
object
9 properties
5 required
Pick_AllowedEmailDomains.Exclude_keyofAllowedEmailDomains.organizationUuid__
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
ApiSuccess_ApiOrganizationDesign-Array_
object
2 properties
2 required
ApiUpsertGoogleSsoConfigResponse
object
2 properties
2 required
DuckdbConnectionType.MOTHERDUCK
string
PostgresCredentials
Pick_OktaSsoConfig.oauth2Issuer-or-oktaDomain-or-oauth2ClientId-or-authorizationServerId-or-extraScopes_
object
From T, pick a set of properties whose keys are in the union K
5 properties
5 required
Pick_CreateDucklakeCatalogPostgres.Exclude_keyofCreateDucklakeCatalogPostgres.user-or-password__
object
From T, pick a set of properties whose keys are in the union K
4 properties
4 required
SnowflakeCredentials
WarehouseTypes.DUCKDB
string
Omit_CreateProject.warehouseConnection_
Construct a type with the properties of T except for those in type K.
UpdateAllowedEmailDomains
ApiOrganizationMemberProfiles
object
2 properties
2 required
UUID
string
Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)
UpsertGoogleSsoConfig
Pick_GenericOidcSsoConfig.clientId-or-metadataDocumentEndpoint-or-scopes_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
Pick_EmailStatusExpiring.otp_
object
From T, pick a set of properties whose keys are in the union K
1 property
UserSchedulersSummary
object
3 properties
3 required
Record_string.string_
object
Construct a type with a set of properties K of type T
BigqueryCredentials
ApiOrganizationAllowedEmailDomains
object
2 properties
2 required
CreateProjectTableConfiguration
string
ProjectDefaults
object
Project-wide default settings that can be overridden at explore or field level
1 property
DatabricksCredentials
CreateDucklakeDataPathGcs
object
4 properties
2 required
Pick_Organization.name_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
DucklakeDataPath
Partial_OrganizationSsoMethodFlags_
object
Make all properties in T optional
4 properties
WeekDay
number
ApiCreateGroupResponse
object
2 properties
2 required
ApiUpsertOktaSsoConfigResponse
object
2 properties
2 required
OrganizationDesignFileKind
string
Pick_CreateAthenaCredentials.Exclude_keyofCreateAthenaCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
15 properties
5 required
ImpersonationOrganizationSettings
object
2 properties
2 required
UpdateColorPalette
object
4 properties
1 required
SshTunnelConfiguration
object
6 properties
ProjectMemberRole.INTERACTIVE_VIEWER
string
CreateDucklakeDataPathLocal
object
2 properties
2 required
DbtBitBucketProjectConfig
object
10 properties
6 required
OrganizationColorPaletteWithIsActive
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Lightdash 12
Other APIs Lightdash publishes across the network.
Lightdash AiAgents API
Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets API
Lightdash Charts API
Lightdash Comments API
Lightdash Content API
Lightdash Custom Roles API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exploring API
Lightdash Exports API
#Organization
Where this information came from
This is an independent, third-party profile of Lightdash Organizations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.