Lightdash My Account 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 My Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.
This API exposes
18 operations
across 14 paths,
and defines 83 schemas.
It is described by OpenAPI 3.0.0, at version 0.3156.1.
Requests are made against a single base URL, /.
The identity and technical contract details declared by the specification.
Pick_CreateAthenaCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
OrganizationMemberRole
string
SessionAuth
object
2 properties
2 required
LoginOptions
object
3 properties
1 required
Pick_CreateDuckdbCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
Pick_CreateBigqueryCredentials.type-or-keyfileContents-or-authenticationType_
object
From T, pick a set of properties whose keys are in the union K
3 properties
2 required
Partial_Pick_CreateDatabricksCredentials.database-or-serverHostName-or-httpPath-or-oauthClientId__
object
Make all properties in T optional
4 properties
EmailStatus
object
3 properties
2 required
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties
2 required
OauthAuth
object
7 properties
5 required
Pick_Account.Exclude_keyofAccount.user-or-keyofAccountHelpers__
object
From T, pick a set of properties whose keys are in the union K
3 properties
2 required
WarehouseTypes.BIGQUERY
string
Omit_Account-at-user.ability-or-abilityRules_
Construct a type with the properties of T except for those in type K.
PersonalAccessToken
object
6 properties
6 required
Pick_CreateRedshiftCredentials-or-CreatePostgresCredentials-or-CreateSnowflakeCredentials-or-CreateTrinoCredentials-or-CreateClickhouseCredentials.type-or-user_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
CreateEmbedJwt
object
7 properties
1 required
WarehouseTypes.REDSHIFT
string
Pick_PersonalAccessToken.expiresAt-or-description_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
SnowflakeAuthenticationType
string
BigqueryAuthenticationType
string
Pick_CreateDatabricksCredentials.type-or-personalAccessToken-or-authenticationType-or-refreshToken_
object
From T, pick a set of properties whose keys are in the union K
4 properties
1 required
ActivateUser
object
3 properties
3 required
CreatePersonalAccessToken
UserWarehouseCredentialsProject
object
3 properties
3 required
WarehouseTypes.ATHENA
string
ImpersonationInfo
object
3 properties
3 required
CommonChartEmbedJwtContent
object
9 properties
1 required
EmbedJwtContentDashboardUuid
Pick_CreateClickhouseCredentials.type-or-user-or-password_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
CreateUserArgs
object
4 properties
4 required
UpsertUserWarehouseCredentials
object
2 properties
2 required
Pick_CreatePostgresCredentials.type-or-user-or-password_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
Pick_Account-at-user.Exclude_keyofAccount-at-user.ability-or-abilityRules__
object
From T, pick a set of properties whose keys are in the union K
4 properties
3 required
ApiGetAccountResponse
object
2 properties
2 required
WarehouseTypes.DATABRICKS
string
EmailOneTimePassword
object
2 properties
2 required
UserWarehouseCredentials
object
7 properties
7 required
DatabricksAuthenticationType
string
JwtAuth
object
3 properties
3 required
EmailOneTimePasswordExpiring
LightdashUser
object
18 properties
11 required
ApiGetAuthenticatedUserResponse
object
Shows the authenticated user
2 properties
2 required
ActivateUserWithInviteCode
EmailStatusExpiring
Verification status of an email address
Pick_CreateTrinoCredentials.type-or-user-or-password_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
ApiUserAllowedOrganizationsResponse
object
2 properties
2 required
PersonalAccessTokenAuth
object
2 properties
2 required
UserAllowedOrganization
object
3 properties
3 required
WarehouseTypes.TRINO
string
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…
ApiSuccessEmpty
object
2 properties
1 required
EmbedJwtContentDashboardSlug
Pick_CreateDatabricksCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
Pick_CreateRedshiftCredentials.type-or-user-or-password_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
Pick_CreateBigqueryCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
FilterInteractivityValues
string
url.URL
string
The URL interface represents an object providing static methods used for creating object URLs. [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL)…
WarehouseTypes.SNOWFLAKE
string
AccountRequestContext
object
Per-request metadata captured by the auth middleware. Used by the audit log to record the IP, user agent and request id alongside permission checks.
3 properties
ApiRegisterUserResponse
object
2 properties
2 required
ApiEmailStatusResponse
object
Shows the current verification status of an email address
2 properties
2 required
WarehouseTypes.POSTGRES
string
Pick_CreateDuckdbMotherduckCredentials.type-or-token_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
Omit_Account.user-or-keyofAccountHelpers_
Construct a type with the properties of T except for those in type K.
OpenIdIdentityIssuerType
string
WarehouseTypes.CLICKHOUSE
string
ApiGetLoginOptionsResponse
object
2 properties
2 required
Pick_CreateAthenaCredentials.type-or-accessKeyId-or-secretAccessKey_
object
From T, pick a set of properties whose keys are in the union K
3 properties
1 required
EmbedWriteActions
object
3 properties
1 required
CommonEmbedJwtContent
object
13 properties
1 required
WarehouseTypes.DUCKDB
string
Record_string.string_
object
Construct a type with a set of properties K of type T
PersonalAccessTokenWithToken
Pick_CreateSnowflakeCredentials.type-or-user-or-password-or-authenticationType-or-refreshToken_
object
From T, pick a set of properties whose keys are in the union K
5 properties
2 required
Partial_Pick_Organization.name-or-createdAt-or-organizationUuid__
object
Make all properties in T optional
3 properties
ServiceAccountAuth
object
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Lightdash publishes across the network.
