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.

Operations 55

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} Get organization member by UUID #
PATCH /api/v1/org/users/{userUuid} Update organization member #
GET /api/v1/org/users/email/{email} 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 #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/lightdash-organizations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightdash-organizations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Lightdash AiAgents Organizations API
  version: 0.3156.1
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens

    '
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:
- name: Organizations
  description: 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.
paths:
  /api/v1/org/sso/azuread:
    get:
      operationId: GetAzureAdSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiAzureAdSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Returns the current organization''s Azure AD SSO configuration (sensitive

        fields are not included).'
      summary: Get Azure AD SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
    put:
      operationId: UpsertAzureAdSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUpsertAzureAdSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Creates or updates the current organization''s Azure AD SSO configuration.

        Omit `oauth2ClientSecret` to preserve the previously stored secret on

        updates.'
      summary: Upsert Azure AD SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertAzureAdSsoConfig'
    delete:
      operationId: DeleteAzureAdSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Removes the current organization's Azure AD SSO configuration.
      summary: Delete Azure AD SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
  /api/v1/org/sso/okta:
    get:
      operationId: GetOktaSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOktaSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Returns the current organization''s Okta SSO configuration (sensitive

        fields are not included).'
      summary: Get Okta SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
    put:
      operationId: UpsertOktaSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUpsertOktaSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Creates or updates the current organization''s Okta SSO configuration.

        Omit `oauth2ClientSecret` to preserve the previously stored secret on

        updates.'
      summary: Upsert Okta SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertOktaSsoConfig'
    delete:
      operationId: DeleteOktaSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Removes the current organization's Okta SSO configuration.
      summary: Delete Okta SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
  /api/v1/org/sso/oidc:
    get:
      operationId: GetGenericOidcSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGenericOidcSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Returns the current organization''s generic OIDC SSO configuration

        (sensitive fields are not included).'
      summary: Get generic OIDC SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
    put:
      operationId: UpsertGenericOidcSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUpsertGenericOidcSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Creates or updates the current organization''s generic OIDC SSO

        configuration. Omit `clientSecret` to preserve the previously stored

        secret on updates.'
      summary: Upsert generic OIDC SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertGenericOidcSsoConfig'
    delete:
      operationId: DeleteGenericOidcSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Removes the current organization's generic OIDC SSO configuration.
      summary: Delete generic OIDC SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
  /api/v1/org/sso/oneLogin:
    get:
      operationId: GetOneLoginSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOneLoginSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Returns the current organization''s OneLogin SSO configuration (sensitive

        fields are not included).'
      summary: Get OneLogin SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
    put:
      operationId: UpsertOneLoginSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUpsertOneLoginSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Creates or updates the current organization''s OneLogin SSO

        configuration. Omit `oauth2ClientSecret` to preserve the previously

        stored secret on updates.'
      summary: Upsert OneLogin SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertOneLoginSsoConfig'
    delete:
      operationId: DeleteOneLoginSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Removes the current organization's OneLogin SSO configuration.
      summary: Delete OneLogin SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
  /api/v1/org/sso/google:
    get:
      operationId: GetGoogleSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGoogleSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Returns the current organization''s Google SSO policy. Google is enabled

        by default using the shared instance OAuth app; a configuration only

        exists when the org has set an explicit policy (e.g. disabled Google).

        `null` means no explicit policy — Google follows the instance default.'
      summary: Get Google SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
    put:
      operationId: UpsertGoogleSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUpsertGoogleSsoConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Creates or updates the current organization''s Google SSO policy. Google

        has no per-org credentials — only the `enabled` / domain / password

        flags are stored.'
      summary: Upsert Google SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertGoogleSsoConfig'
    delete:
      operationId: DeleteGoogleSsoConfig
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Removes the current organization''s Google SSO policy, reverting to the

        instance default (Google enabled).'
      summary: Delete Google SSO configuration
      tags:
      - Organizations
      security: []
      parameters: []
  /api/v1/org/domains:
    get:
      operationId: ListVerifiedDomains
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiVerifiedDomainsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Lists the domains the current organization has verified ownership of.
      summary: List verified domains
      tags:
      - Organizations
      security: []
      parameters: []
  /api/v1/org/domains/verify:
    post:
      operationId: RequestDomainVerification
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiDomainVerificationStatusResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Sends a one-time passcode to an address at the domain to begin verifying

        ownership. The domain must not be a public email provider and must not

        already be verified by another organization.'
      summary: Request domain verification
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestDomainVerification'
  /api/v1/org/domains/confirm:
    post:
      operationId: ConfirmDomainVerification
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiDomainVerificationStatusResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Confirms a domain verification passcode. On success the domain is marked

        verified for the organization.'
      summary: Confirm domain verification
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmDomainVerification'
  /api/v1/org/domains/{domain}:
    delete:
      operationId: DeleteVerifiedDomain
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Removes a verified domain and strips it from any SSO provider that routed

        to it.'
      summary: Delete verified domain
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: domain
        required: true
        schema:
          type: string
  /api/v1/org/settings:
    get:
      operationId: GetOrganizationSettings
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationSettingsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Returns the current organization''s settings. Defaults are returned when

        no settings have been saved.'
      summary: Get organization settings
      tags:
      - Organizations
      security: []
      parameters: []
    patch:
      operationId: UpdateOrganizationSettings
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationSettingsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Updates the current organization''s settings. Only the provided fields

        are changed.'
      summary: Update organization settings
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationSettings'
  /api/v1/org/designs:
    get:
      operationId: ListOrganizationDesigns
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationDesignsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: List all organization design assets.
      summary: List organization designs
      tags:
      - Organizations
      security: []
      parameters: []
    post:
      operationId: CreateOrganizationDesign
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationDesignResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Create a new organization design. Starts empty — upload files separately.
      summary: Create organization design
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationDesignRequest'
  /api/v1/org/designs/{designUuid}:
    get:
      operationId: GetOrganizationDesign
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationDesignResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get a single organization design with its files.
      summary: Get organization design
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: designUuid
        required: true
        schema:
          type: string
    patch:
      operationId: UpdateOrganizationDesign
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationDesignResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Update an organization design's name or description.
      summary: Update organization design
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: designUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationDesignRequest'
    delete:
      operationId: DeleteOrganizationDesign
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Delete an organization design and all its files (cascades S3).
      summary: Delete organization design
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: designUuid
        required: true
        schema:
          type: string
  /api/v1/org/designs/default:
    delete:
      operationId: ClearDefaultOrganizationDesign
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Clear whichever design is currently the organization default. Idempotent

        — succeeds when no default is set.


        NOTE: This literal `/default` route MUST stay registered before

        `Delete(''/{designUuid}'')` below so Express routes a request to

        `DELETE /api/v1/org/designs/default` here rather than treating

        "default" as a `designUuid` path param.'
      summary: Clear default organization design
      tags:
      - Organizations
      security: []
      parameters: []
  /api/v1/org/designs/{designUuid}/default:
    post:
      operationId: SetDefaultOrganizationDesign
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationDesignResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Mark this design as the organization's default. Clears any previous default.
      summary: Set default organization design
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: designUuid
        required: true
        schema:
          type: string
  /api/v1/org/designs/{designUuid}/files:
    post:
      operationId: UploadOrganizationDesignFile
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationDesignFileResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Upload a file into a design. Send raw bytes as the body with the

        appropriate Content-Type and Content-Length headers. Pass `kind`

        and `filename` as query parameters. Mirrors the data-app image

        upload pattern — no multipart wrapping required.'
      summary: Upload file to organization design
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: designUuid
        required: true
        schema:
          type: string
      - in: query
        name: kind
        required: true
        schema:
          type: string
      - in: query
        name: filename
        required: true
        schema:
          type: string
  /api/v1/org/designs/{designUuid}/files/{fileUuid}:
    delete:
      operationId: DeleteOrganizationDesignFile
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Delete a single file from an organization design.
      summary: Delete file from organization design
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: designUuid
        required: true
        schema:
          type: string
      - in: path
        name: fileUuid
        required: true
        schema:
          type: string
    get:
      operationId: DownloadOrganizationDesignFile
      responses:
        '200':
          description: Success
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Download a single file from an organization design. Streams the

        S3 object body back with the stored Content-Type and a sensible

        Content-Disposition.'
      summary: Download file from organization design
      tags:
      - Organizations
      security: []
      parameters:
      - in: path
        name: designUuid
        required: true
        schema:
          type: string
      - in: path
        name: fileUuid
        required: true
        schema:
          type: string
  /api/v1/org:
    get:
      operationId: GetMyOrganization
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganization'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get the current user's organization
      summary: Get current organization
      tags:
      - Organizations
      security: []
      parameters: []
    put:
      operationId: CreateOrganization
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: 'Creates a new organization, the current user becomes the Admin of the new organization.

        This is only available to users that are not already in an organization.'
      summary: Create organization
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        description: the new organization settings
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganization'
              description: the new organization settings
    patch:
      operationId: UpdateMyOrganization
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Update the current user's organization
      summary: Update current organization
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        description: the new organization settings
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganization'
              description: the new organization settings
  /api/v1/org/{organizationUuid}:
    delete:
      operationId: DeleteMyOrganization
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Deletes an organization and all users inside that organization
      summary: Delete organization
      tags:
      - Organizations
      security: []
      parameters:
      - description: the uuid of the organization to delete
        in: path
        name: organizationUuid
        required: true
        schema:
          type: string
  /api/v1/org/projects:
    get:
      operationId: ListOrganizationProjects
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationProjects'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Gets all projects of the current user's organization
      summary: List organization projects
      tags:
      - Organizations
      security: []
      parameters: []
    post:
      operationId: CreateProject
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccess_ApiCreateProjectResults_'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Create a new project in the organization
      summary: Create project
      tags:
      - Organizations
      security: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProjectOptionalCredentials'
  /api/v1/org/users:
    get:
      operationId: ListOrganizationMembers
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationMemberProfiles'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Gets all the members of the current user's organization
      summary: List organization members
      tags:
      - Organizations
      security: []
      parameters:
      - in: query
        name: includeGroups
        required: false
        schema:
          format: double
          type: number
      - in: query
        name: pageSize
        required: false
        schema:
          format: double
          type: number
      - in: query
        name: page
        required: false
        schema:
          format: double
          type: number
      - in: query
        name: searchQuery
        required: false
        schema:
          type: string
      - description: filter users who can view this project
        in: query
        name: projectUuid
        required: false
        schema:
          type: string
      - in: query
        name: googleOidcOnly
        required: false
        schema:
          type: boolean
  /api/v1/org/users/{userUuid}:
    get:
      operationId: GetOrganizationMemberByUuid
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOrganizationMemberProfile'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Get the member profile for a user in the current user's organization by uuid
      summary: Get organization member by UUID
      tags:
      - Organizations
      deprecated: true
      security: []
      parameters:
      - description: the uuid of the user
        in: path
        name: userUuid
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
    p

# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-organizations-api-openapi.yml