openapi: 3.0.3
info:
  title: dbt Cloud API v3
  version: 3.0.0
  description: |
    # How to use this API

    The dbt Cloud API v3 contains endpoints for programmatic administration of your dbt Cloud account.
    With it, you can replicate resources across projects, accounts, and environments, or standardize project
    creation for business teams. For endpoints related to jobs and runs, refer to the
    [Discovery API](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-api) or [dbt Cloud API v2](https://docs.getdbt.com/dbt-cloud/api-v2#/).

    The API docs are generated from an openapi spec defined in the
    [dbt-cloud-openapi-spec](https://github.com/dbt-labs/dbt-cloud-openapi-spec/blob/master/openapi-v3.yaml)
    repository. If you find issues in these docs or have questions about using the dbt Cloud
    API, please open an issue in the dbt-cloud-openapi-spec repo or contact support@getdbt.com.

    ## Authentication

    To authenticate an application with the dbt Cloud API, navigate to the
    Account Settings page and go to Personal Tokens from the left sidebar. Create one if you don't have one already.
    If you cannot access this page, confirm that your dbt Cloud account has access to the API,
    and that you are using the hosted version of dbt Cloud. If dbt Cloud is running inside of a VPC
    in an Enterprise account, contact your account manager for help finding your account-scoped Personal Access Token.

    Once you've found your Personal Access Token (PAT) for your account, use it in the Authorization header of requests to the dbt Cloud API.
    Be sure to include the `Token` prefix in the Authorization header, or the request will fail with a
    "401 Unauthorized" error.

    *Note: `Bearer` can be used in place of `Token` in the Authorization header. Both syntaxes are equivalent.*

    **Headers**
    ```
    Accept: application/json
    Authorization: Token <your token>
    ```

    ## Pagination

    All top-level API resources support bulk fetches using the "list" or `GET` API methods. These API methods accept `limit` and `offset` query parameters that you can use together to paginate results and return a subset of those results.

    * Offset: Specifies how many records to skip. Can be an integer 0 and higher.
    * Limit: Specifies the maximum records you want to retrieve in a single request. Can be an integer up to 100. This limit makes responses easier to handle for servers and people.

    Endpoints that support pagination include some useful extra information about the pagination state. For example:

    ```json
    {
      data: [...],
      extra: {
        // How the results were filtered
        filters: {...},
        // The order of the results
        order_by: "id",
        // The pagination state
        pagination: {
          // The number of records returned in this response
          count: 5,
          // The total number of available records
          total_count: 10,
        }

      }
    }
    ````

    ## Example request

    The following example uses the list projects endpoint to list the projects that your token is authorized to access.
    This request skips the first 10 projects and lists the next 10 projects.
    Be sure to replace `<YOUR_TOKEN>` in the Authorization header with your actual API token and `<YOUR_ACCOUNT_ID>` with your actual account ID.

    ```bash
    curl --request GET \
      --url 'https://cloud.getdbt.com/api/v3/accounts/<YOUR_ACCOUNT_ID>/projects/?limit=10&offset=5' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Token <YOUR_TOKEN>'
    ```
  termsOfService: https://www.getdbt.com/terms-of-service
  contact:
    email: support@getdbt.com
paths:
  /api/v3/accounts/:
    get:
      operationId: List Accounts
      description: List the Accounts that your API Token is authorized to access.
      parameters:
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Accounts
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountListEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/assign-groups/:
    post:
      operationId: Assign User to Groups
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignGroupsRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AssignGroupsRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AssignGroupsRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/audit-logs/:
    get:
      operationId: List Recent Audit Log Events
      description: |-
        Fetch paginated audit log events.

        Note: This API is only available to enterprise customers.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Audit Logs
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAuditLogListEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/audit-logs/download/:
    get:
      operationId: Get Recent Audit Log Events CSV
      description: |-
        Generate audit log CSV

        Note: This API is only available to enterprise customers.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Audit Logs
      security:
      - BearerAuthentication: []
      responses:
        '200':
          description: A CSV file
  /api/v3/accounts/{account_id}/audit-logs/export/:
    get:
      operationId: Get Bulk Audit Log Export Status
      description: |-
        Check the status of a bulk export request.

        Note: This API is only available to enterprise customers.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Audit Logs
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogBulkExportStatusResponseEnveloped'
          description: ''
    post:
      operationId: Submit Bulk Audit Log Export Request
      description: |-
        Submit a bulk export request.

        Note: This API is only available to enterprise customers.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - Audit Logs
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogStartBulkExportResponseEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/audit-logs/export/{job_identifier}/download/:
    get:
      operationId: Download Bulk Audit Log Export
      description: |-
        Download a bulk export of audit log events.

        Note: This API is only available to enterprise customers.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: job_identifier
        schema:
          type: string
        required: true
      tags:
      - Audit Logs
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogBulkExportDownloadResponseEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/connections/:
    get:
      operationId: List Account Connections
      description: List all Account Connections.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: adapter_version
        schema:
          type: string
          enum:
          - apache_spark_v0
          - athena_v0
          - bigquery_v0
          - bigquery_v1
          - clickhouse_v0
          - databricks_spark_v0
          - databricks_v0
          - fabric_v0
          - postgres_v0
          - redshift_v0
          - salesforce_v0
          - snowflake_v0
          - synapse_v0
          - teradata_v0
          - trino_v0
        description: The adapter to fetch the connections for. Please note that Clickhouse
          is in private beta; to request access, contact your account representative.
      - in: query
        name: has_analytics_credentials
        schema:
          type: boolean
        description: Connections with analytics credentials
      - in: query
        name: has_catalog_ingestion_enabled
        schema:
          type: boolean
        description: Connections with catalog ingestion enabled
      - in: query
        name: has_cost_insights_enabled
        schema:
          type: boolean
        description: Connections with cost insights enabled
      - in: query
        name: has_cost_management_enabled
        schema:
          type: boolean
        description: Connections with cost management enabled
      - in: query
        name: has_platform_metadata_credentials
        schema:
          type: boolean
        description: Connections with platform metadata credentials
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: name__icontains
        schema:
          type: string
        description: Connection's name, case-insensitive
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      - in: query
        name: private_endpoint_id
        schema:
          type: string
        description: Filter by private endpoint ID
      - in: query
        name: requires_platform_metadata_credentials
        schema:
          type: boolean
        description: Filter connections by Platform Metadata Credentials status with
          warehouse account deduplication. True=connections that need Platform Metadata
          Credentials, False=connections that have direct Platform Metadata Credentials
          only. Returns one connection per unique warehouse account (the one with
          most environments).
      tags:
      - Connections
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountConnectionListResponse'
          description: ''
    post:
      operationId: Create Account Connection
      description: Create a new Account Connection.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      tags:
      - Connections
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountConnectionCreateBodyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AccountConnectionCreateBodyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AccountConnectionCreateBodyRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountConnectionDetailResponse'
          description: ''
  /api/v3/accounts/{account_id}/connections/{id}/:
    get:
      operationId: Retrieve Account Connection
      description: Retrieve details of a specific Account Connection.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Connections
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountConnectionDetailResponse'
          description: ''
    patch:
      operationId: Update Account Connection
      description: Update an existing Account Connection.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - Connections
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountConnectionUpdateBodyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AccountConnectionUpdateBodyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AccountConnectionUpdateBodyRequest'
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountConnectionDetailResponse'
          description: ''
    delete:
      operationId: Delete Account Connection Delete
      description: Delete an existing Account Connection Delete.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - Connections
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/environments/{environment_id}/sao-cache/:
    delete:
      operationId: Delete Environment SAO Cache
      description: Clear the environment SAO (State Aware Orchestration) cache in
        Redis for the given environment
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: environment_id
        schema:
          type: integer
        required: true
      tags:
      - Environments
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/favorite-assets/:
    get:
      operationId: List Favorite Asset Responses
      description: List all Favorite Asset Responses.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: environment_id
        schema:
          type: integer
        description: The environment ID the favorited asset is associated with. Can
          be null for data warehouse assets.
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      - in: query
        name: project_id
        schema:
          type: integer
        description: The project ID the favorited asset is associated with
      - in: query
        name: user_id
        schema:
          type: integer
        description: The user ID the favorited asset is associated with
      tags:
      - Favorite Assets
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailFavoriteAssetResponse'
          description: ''
  /api/v3/accounts/{account_id}/group-permissions/{group_id}/:
    post:
      operationId: Assign Group Permissions
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: group_id
        schema:
          type: integer
        required: true
      tags:
      - Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupPermissionListRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GroupPermissionListRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GroupPermissionListRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupPermissionListEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/groups/:
    get:
      operationId: List Groups
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: group_permissions.'
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: query
        name: pk__in
        schema:
          type: array
          items:
            type: integer
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      tags:
      - Groups
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListEnveloped'
          description: ''
    post:
      operationId: Create Group
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GroupRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/groups/{id}/:
    get:
      operationId: Retrieve Group
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: group_permissions.'
      tags:
      - Groups
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEnveloped'
          description: ''
    post:
      operationId: Update Group
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GroupRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/invites/:
    post:
      operationId: Send user invites
      description: Send email invites to users who you wish to add to this account
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - Invites
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteUsersRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/InviteUsersRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/InviteUsersRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteUsersResponseEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/ip-restrictions/:
    get:
      operationId: List IP Restrictions
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - IP Restriction Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPRestrictionRuleListEnveloped'
          description: ''
    post:
      operationId: Save IP Restriction
      description: |-
        Save net-new ip restriction rule

        Note: As long as at least one cidr was successfully saved a 2XX will be returned.
        Check the `extra` key within the response for a list of cidrs that failed to save.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - IP Restriction Endpoints
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPRestrictionRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/IPRestrictionRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/IPRestrictionRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPRestrictionRuleEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/ip-restrictions-set/:
    post:
      operationId: Enable IP Restrictions
      description: Toggle the enablement of the IP restriction feature.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - IP Restriction Endpoints
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPRestrictionSetRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/IPRestrictionSetRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/IPRestrictionSetRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPRestrictionRuleSetEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/ip-restrictions-set/{id}/validate/:
    get:
      operationId: Validate Client IP Against IP Restrictions
      description: |-
        This endpoint returns whether the client ip is acceptable based on the
        configured ip restriction rules associated to the rule set.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - IP Restriction Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPRestrictionSetValidate'
          description: ''
  /api/v3/accounts/{account_id}/ip-restrictions-set/{id}/validate/{rule_id}:
    get:
      operationId: Validate Client IP Against IP Restrictions Excluding Specified
        IP Rule
      description: |-
        This endpoint returns whether the client ip is acceptable based on the
        configured ip restriction rules associated to the rule set - excluding the ip rule id
        passed into the url
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: rule_id
        schema:
          type: integer
        required: true
      tags:
      - IP Restriction Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPRestrictionSetValidate'
          description: ''
  /api/v3/accounts/{account_id}/ip-restrictions/{id}:
    get:
      operationId: Retrieve IP Restriction
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - IP Restriction Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPRestrictionRuleEnveloped'
          description: ''
    put:
      operationId: Update IP Restriction
      description: |-
        Update an existing ip restriction rule

        Note: As long as at least one cidr was successfully saved a 2XX will be returned.
        Check the `extra` key within the response for a list of cidrs that failed to save.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - IP Restriction Endpoints
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIPRestrictionRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateIPRestrictionRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateIPRestrictionRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPRestrictionRule'
          description: ''
    delete:
      operationId: Delete IP Restriction
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - IP Restriction Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/license-maps/:
    get:
      operationId: List License Maps
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      tags:
      - License Maps
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseMapListEnveloped'
          description: ''
    post:
      operationId: Create License Map
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - License Maps
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LicenseMapRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LicenseMapRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LicenseMapRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseMapEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/license-maps/{id}/:
    get:
      operationId: Retrieve License Map
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - License Maps
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseMapEnveloped'
          description: ''
    post:
      operationId: Update License Map
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - License Maps
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LicenseMapRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LicenseMapRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LicenseMapRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseMapEnveloped'
          description: ''
    delete:
      operationId: Destroy License Map
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - License Maps
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/oauth-configurations/:
    get:
      operationId: List OAuthConfigurations
      description: List OAuthConfigurations
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: client_id
        schema:
          type: string
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      - in: query
        name: type
        schema:
          type: string
      tags:
      - OAuth Configurations
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthConfigurationListEnveloped'
          description: ''
    post:
      operationId: Create OAuthConfiguration
      description: Create a new OAuthConfiguration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - OAuth Configurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthConfigurationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OAuthConfigurationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OAuthConfigurationRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthConfigurationEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/oauth-configurations/{id}/:
    get:
      operationId: Retrieve OAuth Configuration
      description: Retrieve an OAuth Configuration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - OAuth Configurations
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthConfigurationEnveloped'
          description: ''
    post:
      operationId: Update OAuth Configuration
      description: Update an OAuthConfiguration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - OAuth Configurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthConfigurationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OAuthConfigurationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OAuthConfigurationRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthConfigurationEnveloped'
          description: ''
    delete:
      operationId: Destroy OAuth Configuration
      description: Delete an OAuth Configuration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - OAuth Configurations
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/private-endpoints/:
    get:
      operationId: List Private Endpoints
      description: List all Private Endpoints.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of Private Endpoints to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of Private Endpoints to skip before starting to collect
          the result set.
      - in: query
        name: search
        schema:
          type: string
        description: Search term to filter endpoints by name or private_link_endpoint.
      - in: query
        name: type
        schema:
          type: string
        description: The type of the Private Endpoint to filter by.
      tags:
      - Private Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointListResponse'
          description: ''
    post:
      operationId: Create Private Endpoint
      description: Create a new Private Endpoints List Alias View.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      tags:
      - Private Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          description: No response body
  /api/v3/accounts/{account_id}/private-endpoints/{pl_endpoint_ksuid}/:
    get:
      operationId: Retrieve Private Endpoint
      description: Retrieve details of a specific Private Endpoint.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: pl_endpoint_ksuid
        schema:
          type: string
        required: true
      tags:
      - Private Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateEndpointDetailResponse'
          description: ''
    patch:
      operationId: Update Private Endpoint
      description: '-'
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: pl_endpoint_ksuid
        schema:
          type: string
        required: true
      tags:
      - Private Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          description: No response body
    delete:
      operationId: Delete Private Endpoint
      description: '-'
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: pl_endpoint_ksuid
        schema:
          type: string
        required: true
      tags:
      - Private Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/:
    get:
      operationId: List Projects
      description: List Projects
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: repository, connection, group_permissions, docs_job, freshness_job.'
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: query
        name: pk__gt
        schema:
          type: integer
      - in: query
        name: pk__in
        schema:
          type: array
          items:
            type: integer
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      tags:
      - Projects
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectListEnveloped'
          description: ''
    post:
      operationId: Create Project
      description: Create a new Project
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - Projects
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ProjectRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProjectRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{id}/:
    get:
      operationId: Retrieve Project
      description: Retrieve a Project
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: repository, connection, group_permissions, docs_job, freshness_job.'
      tags:
      - Projects
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEnveloped'
          description: ''
    post:
      operationId: Update Project
      description: Update a Project
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - Projects
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ProjectRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProjectRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEnveloped'
          description: ''
    delete:
      operationId: Destroy Project
      description: Delete Project
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - Projects
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/adapters/:
    post:
      operationId: Create Adapter
      description: Create a new adapter for a project. The ID from this adapter can
        be used to create Connections or Credentials when necessary.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Adapters
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DbtAdapterRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DbtAdapterRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DbtAdapterRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbtAdapterEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/adapters/{id}/:
    get:
      operationId: Retrieve Adapter
      description: Get an adapter by ID.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Adapters
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbtAdapterEnveloped'
          description: ''
    post:
      operationId: Update Adapter
      description: Update an adapter.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Adapters
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DbtAdapterRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DbtAdapterRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DbtAdapterRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbtAdapterEnveloped'
          description: ''
    delete:
      operationId: Destroy Adapter
      description: Delete an adapter.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Adapters
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/connections/:
    get:
      operationId: List Connections
      description: List Connections
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: adapter_version
        schema:
          type: string
          enum:
          - apache_spark_v0
          - databricks_spark_v0
          - databricks_v0
          - trino_v0
          - snowflake_v0
          - bigquery_v0
          - bigquery_v1
          - postgres_v0
          - redshift_v0
          - salesforce_v0
          - synapse_v0
          - fabric_v0
          - athena_v0
          - teradata_v0
          - clickhouse_v0
      - in: query
        name: has_catalog_ingestion_enabled
        schema:
          type: boolean
      - in: query
        name: has_cost_insights_enabled
        schema:
          type: boolean
      - in: query
        name: has_cost_management_enabled
        schema:
          type: boolean
      - in: query
        name: has_platform_metadata_credentials
        schema:
          type: boolean
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      tags:
      - Connections
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseConnectionV3ListEnveloped'
          description: ''
    post:
      operationId: Create Connection
      description: Create a new Connection
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Connections
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseConnectionV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BaseConnectionV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BaseConnectionV3Request'
        required: true
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseConnectionV3Enveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/connections/{id}/:
    get:
      operationId: Retrieve Connection
      description: Retrieve a Connection
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Connections
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseConnectionV3Enveloped'
          description: ''
    post:
      operationId: Update Connection
      description: Update a Connection
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Connections
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseConnectionV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BaseConnectionV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BaseConnectionV3Request'
        required: true
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseConnectionV3Enveloped'
          description: ''
    delete:
      operationId: Destroy Connection
      description: Delete a Connection
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Connections
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/credentials/:
    get:
      operationId: List Credentials
      description: List the credentials for a given project.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Credentials
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsResponseListEnveloped'
          description: ''
    post:
      operationId: Create Credentials
      description: Create a new set of credentials to associate with a user or environment.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsResponseEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/credentials/{id}/:
    get:
      operationId: Get Credentials
      description: Fetch a specific set of credentials.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Credentials
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsResponseEnveloped'
          description: ''
    post:
      operationId: Update Credentials
      description: Update a set of credentials.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsResponseEnveloped'
          description: ''
    patch:
      operationId: Partial Update Credentials
      description: Partially update a set of credentials.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CredentialsRequestRequest'
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsResponseEnveloped'
          description: ''
    delete:
      operationId: Delete Credentials
      description: Delete a set of credentials.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Credentials
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/:
    post:
      operationId: Create Projects Environment Variable
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/{id}/:
    post:
      operationId: Update Projects Environment Variable
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEnvironmentVariableEnveloped'
          description: ''
    delete:
      operationId: Destroy Projects Environment Variable
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/bulk/:
    post:
      operationId: Create Projects Environment Variables Bulk
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponseListEnveloped'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponseFailListEnveloped'
          description: ''
    put:
      operationId: Update Projects Environment Variables Bulk
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - env_vars
              properties:
                env_vars:
                  type: object
                  description: Environment variable update payload. 'name' is the
                    current variable name (required). 'new_name' is the rename target
                    (optional). All other keys are either existing environment variable
                    IDs (numeric strings) whose values should be updated, or environment
                    names whose values should be created. Set a value to empty string
                    or null to delete that variable override.
                  required:
                  - name
                  properties:
                    name:
                      type: string
                      description: Current name of the environment variable.
                    new_name:
                      type: string
                      description: New name for the environment variable. Requires
                        'name' to also be set.
                  additionalProperties:
                    type: string
                    nullable: true
                    description: Value keyed by either an existing env var ID (to
                      update) or an environment name (to create a new override).
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPutSuccessResponseEnveloped'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPutErrorResponseEnveloped'
          description: ''
    delete:
      operationId: Destroy Projects Environment Variables Bulk
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/environment/:
    get:
      operationId: Retrieve Projects Environment Variables Environment
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvVarEnvironmentResponse'
              examples:
                EnvironmentVariablesByEnvironment:
                  value:
                    data:
                      environments:
                      - project
                      - production
                      - staging
                      - dev
                      variables:
                        DBT_ENV_SECRET_1:
                          project:
                            id: 1
                            value: '**********'
                          production:
                            id: 2
                            value: '**********'
                        DBT_ENV_CUSTOM_2:
                          project:
                            id: 3
                            value: project_default
                          staging:
                            id: 4
                            value: staging_value
                          dev:
                            id: 5
                            value: dev_value
                    status:
                      code: 200
                      is_success: true
                      user_message: Success!
                      developer_message: ''
                    extra: {}
                  summary: Environment variables by environment
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/job/:
    get:
      operationId: Retrieve Projects Environment Variables Job
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: job_definition_id
        schema:
          type: integer
        description: The ID of the job definition to retrieve environment variables
          for
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environment Variables
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvVarJobResponse'
              examples:
                JobEnvironmentVariables:
                  value:
                    data:
                      DBT_ENV_SECRET_1:
                        project:
                          id: 1
                          value: '**********'
                      DBT_ENV_CUSTOM_2:
                        project:
                          id: 2
                          value: project_default
                        environment:
                          id: 3
                          value: dev_override
                        job:
                          id: 4
                          value: job_override
                    status:
                      code: 200
                      is_success: true
                      user_message: Success!
                      developer_message: ''
                    extra: {}
                  summary: Job environment variables
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/environment-variables/user/:
    get:
      operationId: Retrieve Projects Environment Variables User
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      - in: query
        name: user_id
        schema:
          type: integer
        description: The ID of the user to retrieve environment variables for
        required: true
      tags:
      - Environment Variables
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvVarUserResponse'
              examples:
                UserEnvironmentVariables:
                  value:
                    data:
                      DBT_ENV_SECRET_1:
                        project:
                          id: 1
                          value: '**********'
                      DBT_ENV_CUSTOM_2:
                        project:
                          id: 2
                          value: project_default
                        environment:
                          id: 3
                          value: dev_override
                        user:
                          id: 4
                          value: user_override
                    status:
                      code: 200
                      is_success: true
                      user_message: Success!
                      developer_message: ''
                    extra: {}
                  summary: User environment variables
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/environments/:
    get:
      operationId: List Environments
      description: List Environments
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: credentials_id
        schema:
          type: integer
      - in: query
        name: dbt_version
        schema:
          type: string
      - in: query
        name: dbt_version__in
        schema:
          type: array
          items:
            type: string
      - in: query
        name: deployment_type
        schema:
          type: string
          enum:
          - production
          - staging
      - in: query
        name: deployment_type__in
        schema:
          type: array
          items:
            type: string
            enum:
            - production
            - staging
      - in: query
        name: id__gt
        schema:
          type: integer
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: project, connection, credentials, repository.'
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: query
        name: pk__in
        schema:
          type: array
          items:
            type: integer
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      - in: query
        name: project_id__in
        schema:
          type: array
          items:
            type: integer
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      - in: query
        name: type
        schema:
          type: string
      tags:
      - Environments
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentV3ListEnveloped'
          description: ''
    post:
      operationId: Create Environment
      description: Create a new Environment
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EnvironmentV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EnvironmentV3Request'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentV3Enveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/environments/{id}/:
    get:
      operationId: Retrieve Environment
      description: Retrieve an Environment
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: project, connection, credentials, repository.'
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environments
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentV3Enveloped'
          description: ''
    post:
      operationId: Update Environment
      description: Replace an Environment. This is a full replace operation — all
        fields must be provided. Any omitted fields will be reset to their default
        values (typically null). To avoid unintentionally clearing fields such as
        credentials_id or connection_id, first retrieve the environment with a GET
        request and include all current values in the update payload.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EnvironmentV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EnvironmentV3Request'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentV3Enveloped'
          description: ''
    delete:
      operationId: Destroy Environment
      description: Delete an Environment
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Environments
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/extended-attributes/:
    post:
      operationId: Create Extended Attributes
      description: Create a new Extended Attributes record.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Extended Attributes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtendedAttributesCreateBodyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExtendedAttributesCreateBodyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExtendedAttributesCreateBodyRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedAttributesResponse'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/extended-attributes/{id}/:
    get:
      operationId: Retrieve Extended Attributes
      description: Retrieve an existing Extended Attributes record.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Extended Attributes
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedAttributesResponse'
          description: ''
    patch:
      operationId: Update Extended Attributes
      description: Update an existing Extended Attributes record.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Extended Attributes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtendedAttributesUpdateBodyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExtendedAttributesUpdateBodyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExtendedAttributesUpdateBodyRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedAttributesResponse'
          description: ''
    delete:
      operationId: Destroy Extended Attributes
      description: Delete an existing Extended Attributes record.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Extended Attributes
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/integrations/lineage/:
    get:
      operationId: List Lineage Integrations
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLineageIntegrationResponse'
          description: ''
    post:
      operationId: Create Lineage Integration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostLineageIntegrationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PostLineageIntegrationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PostLineageIntegrationRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailLineageIntegrationResponse'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/integrations/lineage/{id}/:
    get:
      operationId: Get Lineage Integration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailLineageIntegrationResponse'
          description: ''
    patch:
      operationId: Update Lineage Integration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchLineageIntegrationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchLineageIntegrationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchLineageIntegrationRequest'
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailLineageIntegrationResponse'
          description: ''
    delete:
      operationId: Delete Lineage Integration
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/integrations/lineage/{id}/collections/:
    get:
      operationId: List collections from BI tool
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: collection_id
        schema:
          type: string
        description: A subfolder in the collection
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLineageIntegrationCollectionResponse'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/integrations/lineage/{id}/collections/{collection_id}/:
    get:
      operationId: List collections from BI tool_2
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: collection_id
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLineageIntegrationCollectionResponse'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/integrations/lineage/{id}/selections:
    post:
      operationId: Update Lineage Integration Selections
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Lineage Integrations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostLineageIntegrationWatchSelectionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PostLineageIntegrationWatchSelectionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PostLineageIntegrationWatchSelectionRequest'
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLineageIntegrationWatchSelectionResponse'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/managed-repositories/:
    post:
      operationId: Create Managed Repository
      description: Create a new dbt Cloud managed repository.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Repositories
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateManagedRepositoryRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateManagedRepositoryRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateManagedRepositoryRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryV3Enveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/managed-repositories/{repository_id}/download/:
    get:
      operationId: Retrieve Projects Managed Repositories Download
      description: Download a managed repository as a ZIP archive
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      - in: path
        name: repository_id
        schema:
          type: integer
        required: true
      tags:
      - Projects Managed Repositories
      security:
      - BearerAuthentication: []
      responses:
        '200':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/profiles/:
    get:
      operationId: List Profiles
      description: |-
        List profiles.

        Profiles are the set of connection, credentials, and attributes used to connect to a data warehouse. They can be assigned to deployment environments to run jobs.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: connection_id
        schema:
          type: integer
        description: The ID of the connection for the profile
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: key
        schema:
          type: string
        description: Filter profiles whose key contains this value, case-insensitive
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      - in: query
        name: profile_ids
        schema: {}
        description: A list of profile IDs to fetch
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Profiles
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileListResponse'
          description: ''
    post:
      operationId: Create Profile
      description: |-
        Create a new profile.

        Profiles are the set of connection, credentials, and attributes used to connect to a data warehouse. They can be assigned to deployment environments to run jobs.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Profiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileCreateBodyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ProfileCreateBodyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProfileCreateBodyRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileDetailResponse'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/profiles/{id}/:
    get:
      operationId: Retrieve Profile
      description: |-
        Retrieve a specific profile.

        Profiles are the set of connection, credentials, and attributes used to connect to a data warehouse. They can be assigned to deployment environments to run jobs.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Profiles
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileDetailResponse'
          description: ''
    patch:
      operationId: Update Profile
      description: |-
        Update an existing profile.

        Profiles are the set of connection, credentials, and attributes used to connect to a data warehouse. They can be assigned to deployment environments to run jobs.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Profiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileUpdateBodyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ProfileUpdateBodyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProfileUpdateBodyRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileDetailResponse'
          description: ''
    delete:
      operationId: Delete Profile
      description: |-
        Delete an existing profile. The profile must not be assigned to any deployment environments in order to be deleted.

        Profiles are the set of connection, credentials, and attributes used to connect to a data warehouse. They can be assigned to deployment environments to run jobs.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Profiles
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/projects/{project_id}/repositories/:
    get:
      operationId: List Repositories
      description: List repositories for the given project
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: deploy_key.'
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      - in: query
        name: project_id__in
        schema:
          type: array
          items:
            type: integer
      - in: query
        name: remote_url
        schema:
          type: string
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      tags:
      - Repositories
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryV3ListEnveloped'
          description: ''
    post:
      operationId: Create Repository
      description: Create a new repository for the given project
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Repositories
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepositoryV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RepositoryV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RepositoryV3Request'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryV3Enveloped'
          description: ''
  /api/v3/accounts/{account_id}/projects/{project_id}/repositories/{id}/:
    get:
      operationId: Retrieve Repository
      description: Get a repository by ID
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: deploy_key.'
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Repositories
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryV3Enveloped'
          description: ''
    post:
      operationId: Update Repository
      description: Update a repository
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Repositories
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepositoryV3Request'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RepositoryV3Request'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RepositoryV3Request'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryV3Enveloped'
          description: ''
    delete:
      operationId: Destroy Repository
      description: Delete a repository
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: project_id
        schema:
          type: integer
        required: true
      tags:
      - Repositories
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/scim-config/:
    get:
      operationId: Retrieve SCIM configuration
      description: Retrieve the SCIM configuration for the account
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailSCIMConfigResponse'
          description: ''
    post:
      operationId: Create SCIM configuration
      description: Create SCIM configuration for the account
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSCIMConfigurationRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSCIMConfigurationRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateSCIMConfigurationRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailSCIMConfigResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim-config/tokens/:
    get:
      operationId: Retrieve SCIM tokens
      description: Retrieve all SCIM tokens
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSCIMTokenResponse'
          description: ''
    post:
      operationId: Create SCIM token
      description: Create a SCIM token
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSCIMTokenRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSCIMTokenRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateSCIMTokenRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailCreateSCIMTokenResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim-config/tokens/{id}/:
    get:
      operationId: Retrieve SCIM token
      description: Retrieve the specified SCIM token
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailSCIMTokenResponse'
          description: ''
    delete:
      operationId: Delete SCIM token
      description: Delete the specified SCIM token
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/scim/v2/Groups:
    get:
      operationId: List SCIM Groups
      description: List all groups via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ListGroupSCIMResponse'
          description: ''
    post:
      operationId: Create SCIM Group
      description: Create a group via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/CreateOrReplaceGroupSCIMRequestRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrReplaceGroupSCIMRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailGroupSCIMResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim/v2/Groups/{group_id}:
    get:
      operationId: Get SCIM Group
      description: Get a group via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: group_id
        schema:
          type: string
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailGroupSCIMResponse'
          description: ''
    put:
      operationId: Update SCIM Group
      description: Update a group via SCIM using PUT
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: group_id
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/CreateOrReplaceGroupSCIMRequestRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrReplaceGroupSCIMRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailGroupSCIMResponse'
          description: ''
    patch:
      operationId: Patch SCIM Group
      description: Update a group via SCIM using PATCH
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: group_id
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/PatchGroupSCIMRequestRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/PatchGroupSCIMRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailGroupSCIMResponse'
          description: ''
    delete:
      operationId: Delete SCIM Group
      description: Delete a group via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: group_id
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/scim/v2/ResourceTypes:
    get:
      operationId: Get SCIM Resource Types
      description: Get Supported SCIM Resource Types
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailSCIMListResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim/v2/ResourceTypes/{resource_type}:
    get:
      operationId: Get SCIM Resource Type Details
      description: Get Supported SCIM Resource Type Details
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: resource_type
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailSCIMResourceTypeResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim/v2/Schemas:
    get:
      operationId: Get SCIM Schemas
      description: Get Supported SCIM Schemas
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailSCIMListResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim/v2/Schemas/{schema_uri}:
    get:
      operationId: Get SCIM Schema Details
      description: Get Supported SCIM Schema Details
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: schema_uri
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailSCIMResourceTypeResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim/v2/ServiceProviderConfig:
    get:
      operationId: Retrieve Scim V2 Serviceproviderconfig
      description: Get the SCIM Service Provider Config
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          description: No response body
  /api/v3/accounts/{account_id}/scim/v2/Users:
    get:
      operationId: List SCIM Users
      description: List all users via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ListUserSCIMResponse'
          description: ''
    post:
      operationId: Create SCIM User
      description: Create a user via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/CreateUserSCIMRequestRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserSCIMRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailUserSCIMResponse'
          description: ''
  /api/v3/accounts/{account_id}/scim/v2/Users/{user_id}:
    get:
      operationId: Get SCIM User
      description: Get a user via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: user_id
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailUserSCIMResponse'
          description: ''
    put:
      operationId: Replace SCIM User
      description: Replace a user via SCIM using PUT
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/ReplaceUserSCIMRequestRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceUserSCIMRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailUserSCIMResponse'
          description: ''
    patch:
      operationId: Update SCIM User
      description: Update a user attribute(s) via SCIM
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      requestBody:
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/UpdateUserSCIMRequestRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserSCIMRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/DetailUserSCIMResponse'
          description: ''
    delete:
      operationId: Delete SCIM User
      description: Delete a user via SCIM. This endpoint will remove the users license
        from the account.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: string
        required: true
      tags:
      - SCIM Endpoints
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/semantic-layer-credentials/:
    get:
      operationId: List Semantic Layer Credentials
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: order_by
        schema:
          type: string
          default: id
        description: Field to order results by. Prefix with '-' for descending order.
      - in: query
        name: pk
        schema:
          type: integer
      - in: query
        name: project_id
        schema:
          type: integer
      - in: query
        name: state
        schema:
          oneOf:
          - type: integer
          - type: string
            enum:
            - active
            - deleted
            - all
          default: active
        description: "Filters by soft deletion state.\n            <ul>\n        \
          \        <li>\n                    <strong>\"active\"</strong> / <strong>1</strong>:\
          \ Only active resources\n                </li>\n                <li>\n \
          \                   <strong>\"deleted\"</strong> / <strong>2</strong>: Only\
          \ deleted resources\n                </li>\n                <li>\n     \
          \               <strong>\"all\"</strong>: All resources\n              \
          \  </li>\n            </ul>\n            "
      tags:
      - Semantic Layer Credentials
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SemanticLayerCredentialsListEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/service-tokens/:
    get:
      operationId: List Service Tokens
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Service Tokens
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListServiceTokenResponse'
          description: ''
    post:
      operationId: Create Service Token
      description: This endpoint is used to generate a new service token for the account.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      tags:
      - Service Tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateServiceTokenRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateServiceTokenRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateServiceTokenRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailCreateServiceTokenResponse'
          description: ''
  /api/v3/accounts/{account_id}/service-tokens/{id}/:
    get:
      operationId: Retrieve Service Token
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Service Tokens
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailServiceTokenResponse'
          description: ''
    put:
      operationId: Update Service Token
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - Service Tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServiceTokenRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateServiceTokenRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateServiceTokenRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailServiceTokenResponse'
          description: ''
    delete:
      operationId: Destroy Service Token
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - Service Tokens
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/service-tokens/{service_token_id}/permissions/:
    get:
      operationId: Retrieve Service Tokens Permission
      description: List permissions of a given ServiceToken for an account.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: service_token_id
        schema:
          type: integer
        required: true
      tags:
      - Service Tokens
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceTokenPermissionListEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/users/:
    get:
      operationId: List Users
      description: List users for a given account.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserListEnveloped'
          description: ''
  /api/v3/accounts/{account_id}/users/{id}/:
    get:
      operationId: Retrieve User
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailAccountUserResponse'
          description: ''
  /api/v3/accounts/{account_id}/users/{user_id}/account-apikeys/:
    get:
      operationId: List Account Scoped PATs
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceTokenListEnveloped'
          description: ''
    post:
      operationId: Create Account Scoped PAT
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountScopedPATRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AccountScopedPATRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AccountScopedPATRequestRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailCreateAccountScopedPATResponse'
          description: ''
  /api/v3/accounts/{account_id}/users/{user_id}/account-apikeys/{id}/:
    get:
      operationId: Get Account Scoped PAT
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountScopedPATResponseEnveloped'
          description: ''
    post:
      operationId: Rotate Account Scoped PAT
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailCreateAccountScopedPATResponse'
          description: ''
    delete:
      operationId: Delete Account Scoped PAT
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
  /api/v3/accounts/{account_id}/webhooks/event/{event_id}:
    get:
      operationId: Retrieve Webhooks Event
      description: |-
        Get a specific event given an event_id.
        This endpoint is deprecated and should not be called anymore.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: event_id
        schema:
          type: string
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/accounts/{account_id}/webhooks/event/{event_id}/receipts:
    get:
      operationId: List Webhooks Event Receipts
      description: |-
        Get all receipts for a given event id.
        This endpoint is deprecated and should not be called anymore.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: event_id
        schema:
          type: string
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhooksReceiptsResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/accounts/{account_id}/webhooks/receipt/{receipt_id}:
    get:
      operationId: Retrieve Webhooks Receipt
      description: |-
        Get a specific receipt given its id.
        This endpoint is deprecated and should not be called anymore.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: receipt_id
        schema:
          type: string
        required: true
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebhooksReceiptResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/accounts/{account_id}/webhooks/subscription/{subscription_id}:
    get:
      operationId: Retrieve Webhooks Subscription
      description: Get a specific subscription with a subscription id
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: subscription_id
        schema:
          type: string
        required: true
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
    put:
      operationId: Update Webhooks Subscription
      description: Edit a subscription given a subscription id
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: subscription_id
        schema:
          type: string
        required: true
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubscriptionResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
    delete:
      operationId: Destroy Webhooks Subscription
      description: Delete a specific subscription
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: subscription_id
        schema:
          type: string
        required: true
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSubscriptionResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/accounts/{account_id}/webhooks/subscription/{subscription_id}/event/{event_id}/receipt:
    get:
      operationId: List Webhooks Subscription Event Receipt
      description: Get the receipt for a given subscription id and event id.
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: path
        name: event_id
        schema:
          type: string
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: subscription_id
        schema:
          type: string
        required: true
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhooksReceiptsResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/accounts/{account_id}/webhooks/subscription/{subscription_id}/events:
    get:
      operationId: List Webhooks Events
      description: Get all events for a specific subscription
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: subscription_id
        schema:
          type: string
        required: true
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWebhooksEvents'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/accounts/{account_id}/webhooks/subscription/{subscription_id}/test:
    get:
      operationId: Test Webhooks Subscription
      description: Test the client endpoint for a given subscription
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: path
        name: subscription_id
        schema:
          type: string
        required: true
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestSubscriptionResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/accounts/{account_id}/webhooks/subscriptions:
    get:
      operationId: List Webhooks Subscriptions
      description: Given an account id list all webhook subscriptions
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      tags:
      - Webhooks
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWebhooksSubscriptions'
          description: ''
    post:
      operationId: Create Webhooks Subscription
      description: Create a new webhook subscription
      parameters:
      - in: path
        name: account_id
        schema:
          type: integer
        required: true
      - in: query
        name: limit
        schema:
          type: integer
        description: The maximum number of items to return.
      - in: query
        name: offset
        schema:
          type: integer
        description: The number of items to skip before starting to collect the result
          set.
      tags:
      - Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionResponseEnvelope'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: ''
  /api/v3/adapter-schema/:
    get:
      operationId: Retrieve Adapter Schema
      description: "\"\n        Fetch the schema for a given adapter. The schema will\
        \ include details on available fields for connections and credentials.\n\n\
        \        Notes:\n        - salesforce_v0 is currently in beta and not available\
        \ to all users.\n        "
      parameters:
      - in: query
        name: adapter_version
        schema:
          type: string
          enum:
          - apache_spark_v0
          - athena_v0
          - bigquery_v0
          - bigquery_v1
          - clickhouse_v0
          - databricks_spark_v0
          - databricks_v0
          - fabric_v0
          - postgres_v0
          - redshift_v0
          - salesforce_v0
          - snowflake_v0
          - synapse_v0
          - teradata_v0
          - trino_v0
        description: The adapter to fetch the schema for
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: Comma-separated list of related objects to include in the response.
      tags:
      - Adapter Schema
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdapterSchemaResponseEnveloped'
          description: ''
  /api/v3/users/{user_id}/credentials/:
    get:
      operationId: List User Credentials
      description: 'List the development credentials associated with a given user.
        Authentication: Requires a personal access token (PAT) for the user specified
        by `user_id`. The authenticated user must match `user_id`. Service tokens
        are not supported, including Account Admin service tokens. An admin cannot
        use their PAT to manage another user''s credentials.'
      parameters:
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: credentials, project.'
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCredentialsListEnveloped'
          description: ''
    post:
      operationId: Create User Credentials
      description: 'Associate a set of development credentials with a given user.
        Authentication: Requires a personal access token (PAT) for the user specified
        by `user_id`. The authenticated user must match `user_id`. Service tokens
        are not supported, including Account Admin service tokens. An admin cannot
        use their PAT to manage another user''s credentials.'
      parameters:
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCredentialsRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserCredentialsRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserCredentialsRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCredentialsEnveloped'
          description: ''
  /api/v3/users/{user_id}/credentials/{id}/:
    get:
      operationId: Get User Credentials
      description: 'Get a development credentials association for a given user. Authentication:
        Requires a personal access token (PAT) for the user specified by `user_id`.
        The authenticated user must match `user_id`. Service tokens are not supported,
        including Account Admin service tokens. An admin cannot use their PAT to manage
        another user''s credentials.'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: query
        name: include_related
        schema:
          type: string
        description: 'Comma-separated list of related objects to include in the response.
          Available: credentials, project.'
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCredentialsListEnveloped'
          description: ''
    post:
      operationId: Update User Credentials
      description: 'Update which development credentials are associated with a specific
        user. Authentication: Requires a personal access token (PAT) for the user
        specified by `user_id`. The authenticated user must match `user_id`. Service
        tokens are not supported, including Account Admin service tokens. An admin
        cannot use their PAT to manage another user''s credentials.'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCredentialsRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserCredentialsRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserCredentialsRequest'
        required: true
      security:
      - BearerAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCredentialsEnveloped'
          description: ''
    delete:
      operationId: Delete User Credentials
      description: 'Delete a development credentials / user association. Authentication:
        Requires a personal access token (PAT) for the user specified by `user_id`.
        The authenticated user must match `user_id`. Service tokens are not supported,
        including Account Admin service tokens. An admin cannot use their PAT to manage
        another user''s credentials.'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - Users
      security:
      - BearerAuthentication: []
      responses:
        '204':
          description: No response body
components:
  schemas:
    AccountConnectionCreateBodyRequest:
      title: AccountConnectionCreateBody
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        account_id:
          title: Account Id
          description: The account the connection is associated with
          type: integer
        name:
          title: Name
          description: The name of the connection
          type: string
        adapter_version:
          description: Identifies the warehouse and version of its adapter. Please
            note that Clickhouse is in private beta; to request access, contact your
            account representative.
          allOf:
          - $ref: '#/components/schemas/DbtAdapterVersion'
        private_link_endpoint_id:
          title: Private Link Endpoint Id
          type: string
        is_ssh_tunnel_enabled:
          title: Is Ssh Tunnel Enabled
          default: false
          type: boolean
        oauth_configuration_id:
          title: Oauth Configuration Id
          type: integer
        config:
          title: Config
          description: The adapter-specific configuration for the connection
          anyOf:
          - $ref: '#/components/schemas/SnowflakeConnection'
          - $ref: '#/components/schemas/PostgresConnection'
          - $ref: '#/components/schemas/RedshiftConnection'
          - $ref: '#/components/schemas/BigqueryConnection'
          - $ref: '#/components/schemas/BigqueryConnectionV1'
          - $ref: '#/components/schemas/ClickHouseConnection'
          - $ref: '#/components/schemas/DatabricksConnection'
          - $ref: '#/components/schemas/DatabricksSparkConnection'
          - $ref: '#/components/schemas/TrinoConnection'
          - $ref: '#/components/schemas/FabricConnection'
          - $ref: '#/components/schemas/SynapseConnection'
          - $ref: '#/components/schemas/ApacheSparkConnection'
          - $ref: '#/components/schemas/AthenaConnection'
          - $ref: '#/components/schemas/SalesforceConnection'
          - $ref: '#/components/schemas/TeradataConnection'
      required:
      - account_id
      - name
      - adapter_version
      - config
      additionalProperties: false
    AccountConnectionDetail:
      title: AccountConnectionDetail
      type: object
      properties:
        id:
          title: Id
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        account_id:
          title: Account Id
          description: The account the connection is associated with
          type: integer
        name:
          title: Name
          description: The name of the connection
          type: string
        adapter_version:
          description: Identifies the warehouse and version of its adapter
          allOf:
          - $ref: '#/components/schemas/DbtAdapterVersion'
        private_link_endpoint_id:
          title: Private Link Endpoint Id
          type: string
        is_ssh_tunnel_enabled:
          title: Is Ssh Tunnel Enabled
          default: false
          type: boolean
        oauth_redirect_uri:
          title: Oauth Redirect Uri
          description: If OAuth is enabled for this connection, this field is used
            internally by dbt Cloud
          type: string
        oauth_configuration_id:
          title: Oauth Configuration Id
          type: integer
        is_configured_for_native_oauth:
          title: Is Configured For Native Oauth
          type: boolean
        platform_metadata_credentials_id:
          title: Platform Metadata Credentials Id
          type: integer
        analytics_credentials_id:
          title: Analytics Credentials Id
          type: integer
        config:
          title: Config
          description: The adapter-specific configuration for the connection
          anyOf:
          - $ref: '#/components/schemas/SnowflakeConnection'
          - $ref: '#/components/schemas/PostgresConnection'
          - $ref: '#/components/schemas/RedshiftConnection'
          - $ref: '#/components/schemas/BigqueryConnection'
          - $ref: '#/components/schemas/BigqueryConnectionV1'
          - $ref: '#/components/schemas/ClickHouseConnection'
          - $ref: '#/components/schemas/DatabricksConnection'
          - $ref: '#/components/schemas/DatabricksSparkConnection'
          - $ref: '#/components/schemas/TrinoConnection'
          - $ref: '#/components/schemas/FabricConnection'
          - $ref: '#/components/schemas/SynapseConnection'
          - $ref: '#/components/schemas/ApacheSparkConnection'
          - $ref: '#/components/schemas/AthenaConnection'
          - $ref: '#/components/schemas/SalesforceConnection'
          - $ref: '#/components/schemas/TeradataConnection'
      required:
      - id
      - created_at
      - updated_at
      - account_id
      - name
      - adapter_version
      - oauth_redirect_uri
      - config
    AccountConnectionDetailResponse:
      title: AccountConnectionDetailResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/AccountConnectionDetail'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    AccountConnectionList:
      title: AccountConnectionList
      type: object
      properties:
        id:
          title: Id
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        account_id:
          title: Account Id
          description: The account the connection is associated with
          type: integer
        name:
          title: Name
          description: The name of the connection
          type: string
        adapter_version:
          description: Identifies the warehouse and version of its adapter
          allOf:
          - $ref: '#/components/schemas/DbtAdapterVersion'
        private_link_endpoint_id:
          title: Private Link Endpoint Id
          type: string
        is_ssh_tunnel_enabled:
          title: Is Ssh Tunnel Enabled
          default: false
          type: boolean
        oauth_configuration_id:
          title: Oauth Configuration Id
          description: The OAuth Configuration associated with this connection. When
            set,developer credentials leveraging OAuth may be created.
          type: integer
        environment__count:
          title: Environment  Count
          description: The number of environments using this connection
          type: integer
        platform_metadata_credentials_id:
          title: Platform Metadata Credentials Id
          type: integer
        analytics_credentials_id:
          title: Analytics Credentials Id
          type: integer
        config:
          title: Config
          description: This field will always be null in list responses. To retrieve
            connection configuration details, use the Retrieve Account Connection
            endpoint instead.
          anyOf:
          - $ref: '#/components/schemas/SnowflakeConnection'
          - $ref: '#/components/schemas/PostgresConnection'
          - $ref: '#/components/schemas/RedshiftConnection'
          - $ref: '#/components/schemas/BigqueryConnection'
          - $ref: '#/components/schemas/BigqueryConnectionV1'
          - $ref: '#/components/schemas/ClickHouseConnection'
          - $ref: '#/components/schemas/DatabricksConnection'
          - $ref: '#/components/schemas/DatabricksSparkConnection'
          - $ref: '#/components/schemas/TrinoConnection'
          - $ref: '#/components/schemas/FabricConnection'
          - $ref: '#/components/schemas/SynapseConnection'
          - $ref: '#/components/schemas/ApacheSparkConnection'
          - $ref: '#/components/schemas/AthenaConnection'
          - $ref: '#/components/schemas/SalesforceConnection'
          - $ref: '#/components/schemas/TeradataConnection'
      required:
      - id
      - created_at
      - updated_at
      - account_id
      - name
      - adapter_version
      - environment__count
    AccountConnectionListResponse:
      title: AccountConnectionListResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/AccountConnectionList'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    AccountConnectionUpdateBodyRequest:
      title: AccountConnectionUpdateBody
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        account_id:
          title: Account Id
          description: The account the connection is associated with
          type: integer
        name:
          title: Name
          description: The name of the connection
          type: string
        private_link_endpoint_id:
          title: Private Link Endpoint Id
          type: string
        is_ssh_tunnel_enabled:
          title: Is Ssh Tunnel Enabled
          default: false
          type: boolean
        oauth_configuration_id:
          title: Oauth Configuration Id
          type: integer
        config:
          title: Config
          description: The adapter-specific configuration for the connection
          anyOf:
          - $ref: '#/components/schemas/OptionalSnowflakeConnection'
          - $ref: '#/components/schemas/OptionalPostgresConnection'
          - $ref: '#/components/schemas/OptionalRedshiftConnection'
          - $ref: '#/components/schemas/OptionalBigqueryConnection'
          - $ref: '#/components/schemas/OptionalBigqueryConnectionV1'
          - $ref: '#/components/schemas/OptionalClickHouseConnection'
          - $ref: '#/components/schemas/OptionalDatabricksConnection'
          - $ref: '#/components/schemas/OptionalDatabricksSparkConnection'
          - $ref: '#/components/schemas/OptionalTrinoConnection'
          - $ref: '#/components/schemas/OptionalFabricConnection'
          - $ref: '#/components/schemas/OptionalSynapseConnection'
          - $ref: '#/components/schemas/OptionalApacheSparkConnection'
          - $ref: '#/components/schemas/OptionalAthenaConnection'
          - $ref: '#/components/schemas/OptionalSalesforceConnection'
          - $ref: '#/components/schemas/OptionalTeradataConnection'
      additionalProperties: false
    AccountListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AccountResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    AccountResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        name:
          type: string
          description: The name of the account
        plan:
          allOf:
          - $ref: '#/components/schemas/PlanEnum'
          readOnly: true
          description: |-
            The active plan type for the account

            * `cancelled` - CANCELLED
            * `cancelled_2022` - CANCELLED_2022
            * `cancelled_2025` - CANCELLED_2025
            * `developer` - DEVELOPER
            * `developer_2022` - DEVELOPER_2022
            * `enterprise` - ENTERPRISE
            * `enterprise_2025` - ENTERPRISE_2025
            * `enterprise_plus_2025` - ENTERPRISE_PLUS_2025
            * `free` - FREE
            * `starter_2025` - STARTER_2025
            * `team` - TEAM
            * `team_2022` - TEAM_2022
            * `team_annual` - TEAM_ANNUAL
            * `trial` - TRIAL
            * `trial_2022` - TRIAL_2022
            * `trial_2025` - TRIAL_2025
            * `usage_2026` - USAGE_2026
            * `usage_managed_2026` - USAGE_MANAGED_2026
        run_slots:
          type: integer
          readOnly: true
          default: 1
          description: The total number of run slots the account may use
        developer_seats:
          type: integer
          readOnly: true
          default: 0
          description: The total number of developer seats the account may use
        it_seats:
          type: integer
          readOnly: true
          default: 0
          description: The total number of IT seats the account may use
        explorer_seats:
          type: integer
          readOnly: true
          default: 0
          description: The total number of explorer seats the account may use
        analyst_seats:
          type: integer
          readOnly: true
          default: 0
          description: The total number of pre-purchased analyst seats for the account
        read_only_seats:
          type: integer
          readOnly: true
          default: 0
          description: The total number of Read Only seats the account may use
        locked:
          type: boolean
          readOnly: true
          default: false
          description: Whether the account is currently locked
        lock_reason:
          type: string
          readOnly: true
          description: Why the account is locked
        lock_cause:
          allOf:
          - $ref: '#/components/schemas/LockCauseEnum'
          readOnly: true
          description: |-
            Why the account is locked

            * `trial_expired` - TRIAL_EXPIRED
            * `cancelled` - CANCELLED
            * `unpaid` - UNPAID
            * `provisioned_team_annual` - PROVISIONED_TEAM_ANNUAL
            * `other` - OTHER
            * `migrated` - MIGRATED
            * `workshop` - WORKSHOP
        unlocked_at:
          type: string
          format: date-time
          readOnly: true
        pending_cancel:
          type: boolean
          readOnly: true
          default: false
          description: Whether the account is pending cancellation
        billing_email_address:
          type: string
          readOnly: true
          description: The email address to send billing notifications to
        pod_memory_request_mebibytes:
          type: integer
          readOnly: true
          default: 600
          description: The amount of memory (in MiB) to request for run pods
        develop_pod_memory_request_mebibytes:
          type: integer
          readOnly: true
          default: 0
          description: The amount of memory (in MiB) to request for develop pods
        run_duration_limit_seconds:
          type: integer
          readOnly: true
          default: 86400
          description: The maximum duration that a run may is permitted to execute
            for before it is terminated
        queue_limit:
          type: integer
          readOnly: true
          default: 50
          description: The maximum number of runs that may be queued at once
        enterprise_login_slug:
          type: string
          readOnly: true
          description: The enterprise login URL, if available
        business_critical:
          type: boolean
          readOnly: true
          default: false
          description: Whether this account is on a Business Critical plan
        default_license_type:
          allOf:
          - $ref: '#/components/schemas/DefaultLicenseTypeEnum'
          default: developer
          description: |-
            The license type assigned to new users provisioned onto this account when no other license type is determined (e.g. no SSO group mapping, SCIM payload, or existing invite). Writes are ignored unless the account-wide default license flag is enabled for this account.

            * `developer` - DEVELOPER
            * `read_only` - READ_ONLY
            * `analyst` - ANALYST
            * `it` - IT
        starter_repo_url:
          type: string
          readOnly: true
          description: If defined, the URL used to initialize new dbt projects
        git_auth_level:
          type: string
          readOnly: true
        identifier:
          type: string
          readOnly: true
          description: A globally unique (cross-cell) identifier
        trial_end_date:
          type: string
          format: date-time
          readOnly: true
        static_subdomain:
          type: string
          readOnly: true
        vanity_subdomain:
          type: string
          readOnly: true
        run_locked_until:
          type: string
          format: date-time
          readOnly: true
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        docs_job_id:
          type: integer
          format: int64
          description: (Deprecated)
        freshness_job_id:
          type: integer
          format: int64
          description: (Deprecated)
        copilot_locked_until:
          type: string
          format: date-time
          readOnly: true
          description: When copilot will be enabled again for the account
        agent_credit_locked:
          type: boolean
          readOnly: true
          default: false
          description: True when the account's agent-credit balance is depleted and
            dbt-owned-key agent calls should be refused. Cleared on successful top-up.
        account_migration_events:
          type: array
          items: {}
          readOnly: true
          description: (Deprecated)
        groups:
          type: array
          items:
            $ref: '#/components/schemas/Group'
          readOnly: true
          default: []
          description: The user groups in the account
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account_migration_events
      - agent_credit_locked
      - analyst_seats
      - billing_email_address
      - business_critical
      - copilot_locked_until
      - created_at
      - develop_pod_memory_request_mebibytes
      - developer_seats
      - enterprise_login_slug
      - explorer_seats
      - git_auth_level
      - groups
      - id
      - identifier
      - it_seats
      - lock_cause
      - lock_reason
      - locked
      - pending_cancel
      - plan
      - pod_memory_request_mebibytes
      - queue_limit
      - read_only_seats
      - run_duration_limit_seconds
      - run_locked_until
      - run_slots
      - starter_repo_url
      - static_subdomain
      - trial_end_date
      - unlocked_at
      - updated_at
      - vanity_subdomain
    AccountScopedPATRequestRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
      required:
      - name
    AccountScopedPATResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        uid:
          type: string
        name:
          type: string
        token:
          type: string
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        token_string:
          type: string
          readOnly: true
        last_used:
          type: string
          format: date-time
          readOnly: true
        last_identify:
          type: string
          format: date-time
          readOnly: true
        user_id:
          type: integer
          format: int64
        user:
          $ref: '#/components/schemas/User'
        type:
          $ref: '#/components/schemas/Type34eEnum'
        expires_at:
          type: string
          format: date-time
        metadata_only:
          type: boolean
          default: false
        webhooks_only:
          type: boolean
          default: false
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        service_token_permissions:
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenPermission'
          readOnly: true
          default: []
      required:
      - created_at
      - id
      - last_identify
      - last_used
      - service_token_permissions
      - token_string
      - updated_at
    AccountScopedPATResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AccountScopedPATResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    AccountUser:
      title: AccountUser
      type: object
      properties:
        id:
          title: Id
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        email:
          title: Email
          description: The email address of the user
          type: string
        first_name:
          title: First Name
          description: The first name of the user
          type: string
        last_name:
          title: Last Name
          description: The last name of the user
          type: string
        fullname:
          title: Fullname
          description: The full name of the user
          type: string
        email_verified:
          title: Email Verified
          description: Whether the user has verified their email
          type: boolean
        license:
          title: License
          description: The license assigned to the user for the account
          allOf:
          - $ref: '#/components/schemas/AccountUserLicense'
        is_active:
          title: Is Active
          description: A boolean indicating if this user is active
          default: false
          type: boolean
        is_staff:
          title: Is Staff
          default: false
          type: boolean
        scim_managed:
          title: Scim Managed
          description: Whether the user is managed via SCIM
          type: boolean
      required:
      - id
      - created_at
      - updated_at
      - email
      - first_name
      - last_name
      - fullname
      - email_verified
      - license
    AccountUserLicense:
      title: AccountUserLicense
      type: object
      properties:
        id:
          title: Id
          type: integer
        license_type:
          $ref: '#/components/schemas/LicenseType'
      required:
      - id
      - license_type
    Adapter:
      type: object
      properties:
        metadata:
          allOf:
          - $ref: '#/components/schemas/AdapterMetadata'
          description: High level information about the adapter
        connection:
          allOf:
          - $ref: '#/components/schemas/Schema'
          description: The set of connection-level fields for this adapter
        credential:
          allOf:
          - $ref: '#/components/schemas/Schema'
          description: The set of credential-level fields for this adapter
        platform_metadata_credentials:
          allOf:
          - $ref: '#/components/schemas/Schema'
          description: The set of platform metadata credential-level fields for this
            adapter
        analytics_credentials:
          allOf:
          - $ref: '#/components/schemas/Schema'
          description: The set of analytics credentials fields for this adapter
        semantic_layer_credentials:
          allOf:
          - $ref: '#/components/schemas/Schema'
          description: The set of semantic layer credential-level fields for this
            adapter
        cost_insights_config:
          allOf:
          - $ref: '#/components/schemas/Schema'
          description: The set of cost insights configuration fields for this adapter
      required:
      - metadata
    AdapterMetadata:
      type: object
      properties:
        title:
          type: string
          description: Brief human-facing name for the adapter
        docs_link:
          type: string
          description: Link to the dbt core docs for this adapter
        image_link:
          type: string
        private_link:
          allOf:
          - $ref: '#/components/schemas/AdapterPrivateLinkProperties'
          description: Private link properties of the adapter; None means PrivateLink
            is unsupported
      required:
      - docs_link
      - image_link
      - title
    AdapterPrivateLinkProperties:
      type: object
      properties:
        endpoint_type:
          allOf:
          - $ref: '#/components/schemas/ConnectionTypeEnum'
          description: |-
            The type of private link endpoint eligible. Typically ["adapter"]

            * `postgres` - postgres
            * `redshift` - redshift
            * `snowflake` - snowflake
            * `bigquery` - bigquery
            * `adapter` - adapter
        hostname_field:
          type: string
          default: host
          description: The field in the connection schema that contains the hostname
        strip_suffix:
          type: string
          description: Suffix to be stripped from the private link endpoint to obtain
            the hostname for the connection
      required:
      - endpoint_type
      - strip_suffix
    AdapterSchemaResponse:
      type: object
      properties:
        adapter:
          $ref: '#/components/schemas/Adapter'
    AdapterSchemaResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AdapterSchemaResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    AdapterVersionEnum:
      enum:
      - apache_spark_v0
      - databricks_spark_v0
      - databricks_v0
      - trino_v0
      - snowflake_v0
      - bigquery_v0
      - bigquery_v1
      - postgres_v0
      - redshift_v0
      - salesforce_v0
      - synapse_v0
      - fabric_v0
      - athena_v0
      - teradata_v0
      - clickhouse_v0
      type: string
      description: |-
        * `apache_spark_v0` - apache_spark_v0
        * `databricks_spark_v0` - databricks_spark_v0
        * `databricks_v0` - databricks_v0
        * `trino_v0` - trino_v0
        * `snowflake_v0` - snowflake_v0
        * `bigquery_v0` - bigquery_v0
        * `bigquery_v1` - bigquery_v1
        * `postgres_v0` - postgres_v0
        * `redshift_v0` - redshift_v0
        * `salesforce_v0` - salesforce_v0
        * `synapse_v0` - synapse_v0
        * `fabric_v0` - fabric_v0
        * `athena_v0` - athena_v0
        * `teradata_v0` - teradata_v0
        * `clickhouse_v0` - clickhouse_v0
    ApacheSparkConnection:
      title: ApacheSparkConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        cluster:
          title: Cluster
          type: string
        method:
          default: http
          allOf:
          - $ref: '#/components/schemas/ConnectionMethod'
        connect_timeout:
          title: Connect Timeout
          default: 10
          type: integer
        connect_retries:
          title: Connect Retries
          default: 0
          type: integer
        organization:
          title: Organization
          default: ''
          type: string
        user:
          title: User
          default: ''
          type: string
        auth:
          title: Auth
          default: ''
          type: string
        kerberos_service_name:
          title: Kerberos Service Name
          default: ''
          type: string
        port:
          title: Port
          default: 443
          minimum: 1
          maximum: 65535
          type: integer
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - host
      - cluster
    AssignGroupsRequestRequest:
      type: object
      properties:
        desired_group_ids:
          type: array
          items:
            type: integer
        user_id:
          type: integer
      required:
      - desired_group_ids
      - user_id
    AthenaConnection:
      title: AthenaConnection
      type: object
      properties:
        region_name:
          title: Region Name
          type: string
        database:
          title: Database
          type: string
        work_group:
          title: Work Group
          type: string
        spark_work_group:
          title: Spark Work Group
          type: string
        s3_staging_dir:
          title: S3 Staging Dir
          type: string
        s3_data_dir:
          title: S3 Data Dir
          type: string
        s3_data_naming:
          title: S3 Data Naming
          type: string
        s3_tmp_table_dir:
          title: S3 Tmp Table Dir
          type: string
        poll_interval:
          title: Poll Interval
          type: integer
        num_retries:
          title: Num Retries
          type: integer
        num_boto3_retries:
          title: Num Boto3 Retries
          type: integer
        num_iceberg_retries:
          title: Num Iceberg Retries
          type: integer
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - region_name
      - database
      - s3_staging_dir
    AuditLogBulkExportDownloadResponse:
      type: object
      properties:
        download_url:
          type: string
    AuditLogBulkExportDownloadResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditLogBulkExportDownloadResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    AuditLogBulkExportStatusResponse:
      type: object
      properties:
        is_running:
          type: boolean
    AuditLogBulkExportStatusResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditLogBulkExportStatusResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    AuditLogStartBulkExportResponse:
      type: object
      properties:
        job_id:
          type: string
    AuditLogStartBulkExportResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditLogStartBulkExportResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    BaseConnectionV3:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
          description: The account the connection is associated with
        project_id:
          type: integer
          format: int64
          description: The project the connection is associated with
        name:
          type: string
          description: The name of the connection
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        adapter_version:
          $ref: '#/components/schemas/AdapterVersionEnum'
        created_by_id:
          type: integer
          format: int64
        created_by_service_token_id:
          type: integer
          format: int64
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        private_link_endpoint_id:
          type: string
        oauth_configuration_id:
          type: integer
          format: int64
          description: The OAuth Configuration associated with this connection. When
            set,developer credentials leveraging OAuth may be created.
      required:
      - account_id
      - name
      - project_id
      - state
      - type
    BaseConnectionV3Enveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BaseConnectionV3Response'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    BaseConnectionV3ListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BaseConnectionV3Response'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    BaseConnectionV3Request:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
          description: The account the connection is associated with
        project_id:
          type: integer
          format: int64
          description: The project the connection is associated with
        name:
          type: string
          minLength: 1
          description: The name of the connection
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        adapter_version:
          $ref: '#/components/schemas/AdapterVersionEnum'
        created_by_id:
          type: integer
          format: int64
        created_by_service_token_id:
          type: integer
          format: int64
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        private_link_endpoint_id:
          type: string
          minLength: 1
        oauth_configuration_id:
          type: integer
          format: int64
          description: The OAuth Configuration associated with this connection. When
            set,developer credentials leveraging OAuth may be created.
      required:
      - account_id
      - name
      - project_id
      - state
      - type
    BaseConnectionV3Response:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
          description: The account the connection is associated with
        project_id:
          type: integer
          format: int64
          description: The project the connection is associated with
        name:
          type: string
          description: The name of the connection
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        adapter_version:
          $ref: '#/components/schemas/AdapterVersionEnum'
        created_by_id:
          type: integer
          format: int64
        created_by_service_token_id:
          type: integer
          format: int64
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        private_link_endpoint_id:
          type: string
        oauth_redirect_uri:
          type: string
          readOnly: true
          description: If OAuth is enabled for this connection, this field is used
            internally by dbt Cloud
        oauth_configuration_id:
          type: integer
          format: int64
          description: The OAuth Configuration associated with this connection. When
            set,developer credentials leveraging OAuth may be created.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - oauth_redirect_uri
      - updated_at
    BigqueryConnection:
      title: BigqueryConnection
      type: object
      properties:
        project_id:
          title: Project Id
          maxLength: 255
          minLength: 1
          type: string
        timeout_seconds:
          title: Timeout Seconds
          exclusiveMinimum: 0
          maximum: 86400
          type: integer
        private_key_id:
          title: Private Key Id
          maxLength: 255
          minLength: 1
          type: string
        private_key:
          title: Private Key
          write_only: true
          type: string
          writeOnly: true
          format: password
        client_email:
          title: Client Email
          maxLength: 1024
          minLength: 1
          type: string
        client_id:
          title: Client Id
          maxLength: 255
          minLength: 1
          type: string
        auth_uri:
          title: Auth Uri
          type: string
        token_uri:
          title: Token Uri
          type: string
        auth_provider_x509_cert_url:
          title: Auth Provider X509 Cert Url
          type: string
        client_x509_cert_url:
          title: Client X509 Cert Url
          type: string
        priority:
          $ref: '#/components/schemas/schemas__adapters__bigquery__v0__connection_schema__Priority'
        scopes:
          title: Scopes
          type: array
          items:
            type: string
        location:
          title: Location
          maxLength: 255
          minLength: 1
          type: string
        maximum_bytes_billed:
          title: Maximum Bytes Billed
          type: integer
        execution_project:
          title: Execution Project
          type: string
        impersonate_service_account:
          title: Impersonate Service Account
          type: string
        retries:
          title: Retries
          default: 1
          minimum: 0
          maximum: 60
          type: integer
        job_retry_deadline_seconds:
          title: Job Retry Deadline Seconds
          type: integer
        job_creation_timeout_seconds:
          title: Job Creation Timeout Seconds
          type: integer
        application_id:
          title: Application Id
          write_only: true
          type: string
          writeOnly: true
          format: password
        application_secret:
          title: Application Secret
          write_only: true
          type: string
          writeOnly: true
          format: password
        gcs_bucket:
          title: Gcs Bucket
          type: string
        dataproc_region:
          title: Dataproc Region
          type: string
        dataproc_cluster_name:
          title: Dataproc Cluster Name
          type: string
        api_endpoint:
          title: Api Endpoint
          type: string
      required:
      - project_id
      - timeout_seconds
      - private_key_id
      - private_key
      - client_email
      - client_id
      - auth_uri
      - token_uri
      - auth_provider_x509_cert_url
      - client_x509_cert_url
    BigqueryConnectionV1:
      title: BigqueryConnectionV1
      type: object
      properties:
        deployment_env_auth_type:
          default: service-account-json
          allOf:
          - $ref: '#/components/schemas/DeploymentEnvironmentAuthType'
        project_id:
          title: Project Id
          maxLength: 255
          minLength: 1
          type: string
        private_key_id:
          title: Private Key Id
          maxLength: 255
          type: string
        private_key:
          title: Private Key
          write_only: true
          type: string
          writeOnly: true
          format: password
        client_email:
          title: Client Email
          maxLength: 1024
          type: string
        client_id:
          title: Client Id
          maxLength: 255
          type: string
        auth_uri:
          title: Auth Uri
          type: string
        token_uri:
          title: Token Uri
          type: string
        auth_provider_x509_cert_url:
          title: Auth Provider X509 Cert Url
          type: string
        client_x509_cert_url:
          title: Client X509 Cert Url
          type: string
        job_execution_timeout_seconds:
          title: Job Execution Timeout Seconds
          exclusiveMinimum: 0
          maximum: 86400
          type: integer
        priority:
          $ref: '#/components/schemas/schemas__adapters__bigquery__v1__connection_schema__Priority'
        scopes:
          title: Scopes
          type: array
          items:
            type: string
        location:
          title: Location
          maxLength: 255
          minLength: 1
          type: string
        maximum_bytes_billed:
          title: Maximum Bytes Billed
          type: integer
        execution_project:
          title: Execution Project
          type: string
        impersonate_service_account:
          title: Impersonate Service Account
          type: string
        retries:
          title: Retries
          minimum: 0
          maximum: 60
          type: integer
        job_retry_deadline_seconds:
          title: Job Retry Deadline Seconds
          type: integer
        job_creation_timeout_seconds:
          title: Job Creation Timeout Seconds
          type: integer
        application_id:
          title: Application Id
          write_only: true
          type: string
          writeOnly: true
          format: password
        application_secret:
          title: Application Secret
          write_only: true
          type: string
          writeOnly: true
          format: password
        gcs_bucket:
          title: Gcs Bucket
          type: string
        dataproc_region:
          title: Dataproc Region
          type: string
        dataproc_cluster_name:
          title: Dataproc Cluster Name
          type: string
        api_endpoint:
          title: Api Endpoint
          type: string
        adapter_id:
          title: Adapter Id
          description: Deprecated, use credentials.adapter_version
          type: integer
      required:
      - project_id
    BigqueryCredentials:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        schema:
          type: string
        target_name:
          type: string
        _refresh_token:
          type: string
          title: ' refresh token'
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - schema
      - state
      - target_name
      - threads
      - type
    BigqueryCredentialsRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        schema:
          type: string
          minLength: 1
        target_name:
          type: string
          minLength: 1
        _refresh_token:
          type: string
          minLength: 1
          title: ' refresh token'
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - schema
      - state
      - target_name
      - threads
      - type
    BulkPutErrorResponse:
      type: object
      properties:
        reason:
          type: string
    BulkPutErrorResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BulkPutErrorResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    BulkPutSuccessResponse:
      type: object
      properties:
        message:
          type: string
        new_var_ids:
          type: array
          items:
            type: integer
        deleted_var_ids:
          type: array
          items:
            type: integer
        failures:
          description: Map of environment name to failure reason.
    BulkPutSuccessResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BulkPutSuccessResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    ClickHouseConnection:
      title: ClickHouseConnection
      type: object
      properties:
        host:
          title: Host
          maxLength: 1024
          minLength: 1
          type: string
        port:
          title: Port
          default: 8443
          exclusiveMinimum: 0
          maximum: 65535
          type: integer
        database:
          title: Database
          default: ''
          maxLength: 255
          type: string
        adapter_id:
          title: Adapter Id
          description: Deprecated, use credentials.adapter_version
          type: integer
      required:
      - host
    ConnectionMethod:
      title: ConnectionMethod
      description: An enumeration.
      enum:
      - http
      - thrift
      type: string
    ConnectionTypeEnum:
      enum:
      - postgres
      - redshift
      - snowflake
      - bigquery
      - adapter
      type: string
      description: |-
        * `postgres` - postgres
        * `redshift` - redshift
        * `snowflake` - snowflake
        * `bigquery` - bigquery
        * `adapter` - adapter
    CreateAccountScopedPAT:
      title: CreateAccountScopedPAT
      type: object
      properties:
        id:
          title: Id
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        account_id:
          title: Account Id
          description: The account the service token is associated with
          type: integer
        user_id:
          title: User Id
          type: integer
        type:
          $ref: '#/components/schemas/ServiceTokenType'
        uid:
          title: Uid
          description: The unique identifier for the service token
          type: string
        name:
          title: Name
          description: The name of the service token
          type: string
        state:
          title: State
          description: The liveness state of the service token. A value of 1 means
            this entity is active and a value of 2 means this entity is deleted
          type: integer
        token:
          title: Token
          description: The hashed token secret
          type: string
        token_string:
          title: Token String
          description: The full token string used to authenticate clients
          type: string
        last_used:
          title: Last Used
          description: Deprecated.
          type: string
          format: date-time
        last_identify:
          title: Last Identify
          description: Deprecated.
          type: string
          format: date-time
        expires_at:
          title: Expires At
          description: Deprecated.
          type: string
          format: date-time
        user:
          title: User
          description: Deprecated.
          type: object
        service_token_permissions:
          title: Service Token Permissions
          description: Deprecated.
          type: array
          items:
            type: object
        semantic_layer_credentials:
          title: Semantic Layer Credentials
          description: Deprecated.
          type: array
          items:
            type: object
        metadata_only:
          title: Metadata Only
          description: Deprecated.
          default: false
          type: boolean
        webhooks_only:
          title: Webhooks Only
          description: Deprecated.
          default: false
          type: boolean
      required:
      - id
      - created_at
      - updated_at
      - account_id
      - uid
      - name
      - state
      - token_string
    CreateManagedRepositoryRequestRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
      required:
      - name
    CreateOrReplaceGroupSCIMRequestRequest:
      title: CreateOrReplaceGroupSCIMRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        schemas:
          title: Schemas
          description: The SCIM schema of the request
          type: array
          items:
            type: string
        externalId:
          title: Externalid
          description: The external ID of the group
          example: 12uhdfs0
          type: string
        displayName:
          title: Displayname
          description: The display name of the group
          type: string
        members:
          title: Members
          description: The members of the group
          type: array
          items:
            $ref: '#/components/schemas/GroupMemberComponent'
      required:
      - schemas
      - displayName
    CreateSCIMConfigurationRequestRequest:
      title: CreateSCIMConfigurationRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        enabled:
          title: Enabled
          type: boolean
        manual_updates_allowed:
          title: Manual Updates Allowed
          type: boolean
        scim_controlled_license_type:
          title: Scim Controlled License Type
          type: boolean
      required:
      - enabled
      - manual_updates_allowed
      additionalProperties: false
    CreateSCIMToken:
      title: CreateSCIMToken
      type: object
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        created_at:
          title: Created At
          type: string
          format: date-time
        last_used:
          title: Last Used
          type: string
          format: date-time
        token_string:
          title: Token String
          type: string
      required:
      - id
      - name
      - created_at
      - token_string
    CreateSCIMTokenRequestRequest:
      title: CreateSCIMTokenRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        name:
          title: Name
          type: string
      required:
      - name
      additionalProperties: false
    CreateServiceToken:
      title: CreateServiceToken
      type: object
      properties:
        id:
          title: Id
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        account_id:
          title: Account Id
          description: The account the service token is associated with
          type: integer
        uid:
          title: Uid
          description: The unique identifier for the service token
          type: string
        name:
          title: Name
          description: The name of the service token
          type: string
        state:
          title: State
          description: The liveness state of the service token. A value of 1 means
            this entity is active and a value of 2 means this entity is deleted
          type: integer
        permission_grants:
          title: Permission Grants
          description: The permissions to be assigned to the service token
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenPermissionGrant'
        last_used:
          title: Last Used
          description: The time the service token was last used
          type: string
          format: date-time
        semantic_layer_credentials:
          title: Semantic Layer Credentials
          type: array
          items:
            type: object
        metadata_only:
          title: Metadata Only
          description: Deprecated. Use the metadata_only permission set instead.
          default: false
          type: boolean
        webhooks_only:
          title: Webhooks Only
          default: false
          type: boolean
        token:
          title: Token
          description: The hashed token secret
          type: string
        token_string:
          title: Token String
          description: The full token string used to authenticate clients
          type: string
        last_identify:
          title: Last Identify
          type: string
          format: date-time
        user_id:
          title: User Id
          type: integer
        user:
          title: User
          type: object
        type:
          $ref: '#/components/schemas/ServiceTokenType'
        expires_at:
          title: Expires At
          type: string
          format: date-time
        service_token_permissions:
          title: Service Token Permissions
          type: array
          items:
            type: object
      required:
      - id
      - created_at
      - updated_at
      - account_id
      - uid
      - name
      - state
      - token_string
    CreateServiceTokenRequestRequest:
      title: CreateServiceTokenRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        name:
          title: Name
          description: The name of the service token
          type: string
        permission_grants:
          title: Permission Grants
          description: Permissions to assign to the service token
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenPermissionGrant'
        metadata_only:
          title: Metadata Only
          description: Deprecated. Use the metadata_only permission set instead.
          default: false
          type: boolean
        webhooks_only:
          title: Webhooks Only
          default: false
          type: boolean
      required:
      - name
    CreateSubscriptionResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Subscription'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
      required:
      - data
      - status
    CreateUserSCIMRequestRequest:
      title: CreateUserSCIMRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        schemas:
          title: Schemas
          description: The user schemas supported by the SCIM provider
          type: array
          items:
            type: string
        externalId:
          title: Externalid
          description: The external ID of the user (user's scim id)
          example: 12uhdfs0
          type: string
        userName:
          title: Username
          description: The username for the user which is their email address
          type: string
        active:
          title: Active
          description: Whether the user is active
          type: boolean
        name:
          title: Name
          description: The user's name components
          example:
            givenName: John
            familyName: Smith
          allOf:
          - $ref: '#/components/schemas/UserNameComponent'
        emails:
          title: Emails
          description: The user's email addresses
          example:
          - value: john.smith@example.com
            primary: true
          type: array
          items:
            $ref: '#/components/schemas/UserEmailComponent'
        urn:ietf:params:scim:schemas:extension:dbtLabs:2.0:User:
          title: Urn:Ietf:Params:Scim:Schemas:Extension:Dbtlabs:2.0:User
          description: Custom attributes for the user. This is where licenseType will
            be stored
          default:
            licenseType: developer
          example:
            licenseType: developer
          allOf:
          - $ref: '#/components/schemas/CustomAttributesComponent'
      required:
      - schemas
      - userName
      - active
      - name
      - emails
    CredentialsRequestRequest:
      oneOf:
      - $ref: '#/components/schemas/PostgresCredentialsRequest'
      - $ref: '#/components/schemas/RedshiftCredentialsRequest'
      - $ref: '#/components/schemas/SnowflakeCredentialsRequest'
      - $ref: '#/components/schemas/BigqueryCredentialsRequest'
      - $ref: '#/components/schemas/DbtAdapterCredentialsRequest'
      discriminator:
        propertyName: type
        mapping:
          postgres: '#/components/schemas/PostgresCredentialsRequest'
          redshift: '#/components/schemas/RedshiftCredentialsRequest'
          snowflake: '#/components/schemas/SnowflakeCredentialsRequest'
          bigquery: '#/components/schemas/BigqueryCredentialsRequest'
          adapter: '#/components/schemas/DbtAdapterCredentialsRequest'
    CredentialsResponse:
      oneOf:
      - $ref: '#/components/schemas/PostgresCredentials'
      - $ref: '#/components/schemas/RedshiftCredentials'
      - $ref: '#/components/schemas/SnowflakeCredentials'
      - $ref: '#/components/schemas/BigqueryCredentials'
      - $ref: '#/components/schemas/DbtAdapterCredentials'
      discriminator:
        propertyName: type
        mapping:
          postgres: '#/components/schemas/PostgresCredentials'
          redshift: '#/components/schemas/RedshiftCredentials'
          snowflake: '#/components/schemas/SnowflakeCredentials'
          bigquery: '#/components/schemas/BigqueryCredentials'
          adapter: '#/components/schemas/DbtAdapterCredentials'
    CredentialsResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CredentialsResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    CredentialsResponseList:
      oneOf:
      - $ref: '#/components/schemas/PostgresCredentials'
      - $ref: '#/components/schemas/RedshiftCredentials'
      - $ref: '#/components/schemas/SnowflakeCredentials'
      - $ref: '#/components/schemas/BigqueryCredentials'
      - $ref: '#/components/schemas/DbtAdapterCredentials'
      discriminator:
        propertyName: type
        mapping:
          postgres: '#/components/schemas/PostgresCredentials'
          redshift: '#/components/schemas/RedshiftCredentials'
          snowflake: '#/components/schemas/SnowflakeCredentials'
          bigquery: '#/components/schemas/BigqueryCredentials'
          adapter: '#/components/schemas/DbtAdapterCredentials'
    CredentialsResponseListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CredentialsResponseList'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    CustomAttributesComponent:
      title: CustomAttributesComponent
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        licenseType:
          description: The license type of the user
          example: developer
          allOf:
          - $ref: '#/components/schemas/LicenseType'
      required:
      - licenseType
    CustomEnvironmentVariableBulkRequest:
      type: object
      properties:
        new_name:
          type: string
          minLength: 1
        project:
          type: string
          minLength: 1
        environmentNameExample1:
          type: string
          minLength: 1
          description: This key must match the name of the environment you want to
            set this environment variable for.
        environmentNameExample2:
          type: string
          minLength: 1
          description: This key must match the name of the environment you want to
            set this environment variable for.
      required:
      - new_name
    CustomEnvironmentVariableBulkRequestRequest:
      type: object
      properties:
        env_var:
          type: array
          items:
            $ref: '#/components/schemas/CustomEnvironmentVariableBulkRequest'
      required:
      - env_var
    CustomEnvironmentVariableBulkResponse:
      type: object
      properties:
        status:
          type: string
        status_code:
          type: integer
        key_name:
          type: string
        data:
          $ref: '#/components/schemas/ResponseData'
    CustomEnvironmentVariableBulkResponseFailListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponseFailResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    CustomEnvironmentVariableBulkResponseFailResponse:
      type: object
      properties:
        status:
          type: string
        status_code:
          type: integer
        key_name:
          type: string
        reason:
          type: string
    CustomEnvironmentVariableBulkResponseListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomEnvironmentVariableBulkResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    CustomEnvironmentVariableEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CustomEnvironmentVariableResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    CustomEnvironmentVariableRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        name:
          type: string
          minLength: 1
        type:
          $ref: '#/components/schemas/CustomEnvironmentVariableTypeEnum'
        user_id:
          type: integer
          format: int64
        environment_id:
          type: integer
          format: int64
        job_definition_id:
          type: integer
          format: int64
        raw_value:
          type: string
          writeOnly: true
          minLength: 1
        display_value:
          type: string
          minLength: 1
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
      required:
      - account_id
      - name
      - project_id
      - type
    CustomEnvironmentVariableResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        name:
          type: string
        type:
          $ref: '#/components/schemas/CustomEnvironmentVariableTypeEnum'
        user_id:
          type: integer
          format: int64
        environment_id:
          type: integer
          format: int64
        job_definition_id:
          type: integer
          format: int64
        display_value:
          type: string
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        environment:
          allOf:
          - $ref: '#/components/schemas/EnvironmentV3'
          readOnly: true
      required:
      - created_at
      - environment
      - id
      - updated_at
    CustomEnvironmentVariableTypeEnum:
      enum:
      - project
      - environment
      - job
      - user
      type: string
      description: |-
        * `project` - project
        * `environment` - environment
        * `job` - job
        * `user` - user
    CustomPagination:
      type: object
      properties:
        count:
          type: integer
          description: Number of items in the current page
        total_count:
          type: integer
          description: Total number of items
      required:
      - count
      - total_count
    DatabricksConnection:
      title: DatabricksConnection
      type: object
      properties:
        host:
          title: Host
          pattern: .*databricks.*
          type: string
        http_path:
          title: Http Path
          pattern: ^(\/sql\/|sql\/)
          type: string
        catalog:
          title: Catalog
          default: ''
          type: string
        client_id:
          title: Client Id
          write_only: true
          type: string
          writeOnly: true
          format: password
        client_secret:
          title: Client Secret
          write_only: true
          type: string
          writeOnly: true
          format: password
        scopes:
          title: Scopes
          type: array
          items:
            type: string
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - host
      - http_path
    DatabricksSparkConnection:
      title: DatabricksSparkConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        method:
          default: odbc
          allOf:
          - $ref: '#/components/schemas/Method'
        port:
          title: Port
          default: 443
          minimum: 1
          maximum: 65535
          type: integer
        cluster:
          title: Cluster
          default: ''
          type: string
        endpoint:
          title: Endpoint
          default: ''
          type: string
        driver:
          title: Driver
          default: /opt/simba/spark/lib/64/libsparkodbc_sb64.so
          type: string
        organization:
          title: Organization
          default: ''
          type: string
        user:
          title: User
          default: ''
          type: string
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - host
    DbtAdapterCredentials:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        adapter_id:
          type: integer
          format: int64
        target_name:
          type: string
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id. Please note that Clickhouse is in private beta; to request access, contact your account representative.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - state
      - target_name
      - threads
      - type
    DbtAdapterCredentialsRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        adapter_id:
          type: integer
          format: int64
        credential_details:
          allOf:
          - $ref: '#/components/schemas/EncryptedJSONValueRequest'
          writeOnly: true
        target_name:
          type: string
          minLength: 1
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id. Please note that Clickhouse is in private beta; to request access, contact your account representative.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - state
      - target_name
      - threads
      - type
    DbtAdapterEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DbtAdapterResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    DbtAdapterRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        created_by_id:
          type: integer
          format: int64
        created_by_service_token_id:
          type: integer
          format: int64
        adapter_version:
          $ref: '#/components/schemas/AdapterVersionEnum'
        metadata_json: {}
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
      required:
      - account_id
      - adapter_version
      - metadata_json
      - project_id
      - state
    DbtAdapterResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        created_by_id:
          type: integer
          format: int64
        created_by_service_token_id:
          type: integer
          format: int64
        adapter_version:
          $ref: '#/components/schemas/AdapterVersionEnum'
        metadata_json: {}
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - updated_at
    DbtAdapterVersion:
      title: DbtAdapterVersion
      description: An enumeration.
      enum:
      - apache_spark_v0
      - databricks_spark_v0
      - databricks_v0
      - trino_v0
      - snowflake_v0
      - bigquery_v0
      - bigquery_v1
      - postgres_v0
      - redshift_v0
      - salesforce_v0
      - synapse_v0
      - fabric_v0
      - athena_v0
      - teradata_v0
      - clickhouse_v0
      type: string
    DefaultLicenseTypeEnum:
      enum:
      - developer
      - read_only
      - analyst
      - it
      type: string
      description: |-
        * `developer` - DEVELOPER
        * `read_only` - READ_ONLY
        * `analyst` - ANALYST
        * `it` - IT
    DeleteSubscriptionResponseData:
      type: object
      properties:
        id:
          type: string
      required:
      - id
    DeleteSubscriptionResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DeleteSubscriptionResponseData'
        status:
          $ref: '#/components/schemas/DeleteSubscriptionResponseStatus'
      required:
      - data
      - status
    DeleteSubscriptionResponseStatus:
      type: object
      properties:
        code:
          type: integer
        is_success:
          type: boolean
      required:
      - code
      - is_success
    DeployKey:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        public_key:
          type: string
        state:
          example: 1
          type: integer
          default: 1
          description: (Deprecated)
      required:
      - account_id
      - public_key
    DeploymentEnvironmentAuthType:
      title: DeploymentEnvironmentAuthType
      description: An enumeration.
      enum:
      - service-account-json
      - external-oauth-wif
      type: string
    DeploymentTypeEnum:
      enum:
      - production
      - staging
      type: string
      description: |-
        * `production` - production
        * `staging` - staging
    DetailAccountUserResponse:
      title: DetailAccountUserResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/AccountUser'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailCreateAccountScopedPATResponse:
      title: DetailCreateAccountScopedPATResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/CreateAccountScopedPAT'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailCreateSCIMTokenResponse:
      title: DetailCreateSCIMTokenResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/CreateSCIMToken'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailCreateServiceTokenResponse:
      title: DetailCreateServiceTokenResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/CreateServiceToken'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailFavoriteAssetResponse:
      title: DetailFavoriteAssetResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/FavoriteAsset'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailGroupSCIMResponse:
      title: DetailGroupSCIMResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/GroupSCIM'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailLineageIntegrationResponse:
      title: DetailLineageIntegrationResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/LineageIntegration'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailSCIMConfigResponse:
      title: DetailSCIMConfigResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/SCIMConfig'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailSCIMListResponse:
      title: DetailSCIMListResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/SCIMList'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailSCIMResourceTypeResponse:
      title: DetailSCIMResourceTypeResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/SCIMResourceType'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailSCIMTokenResponse:
      title: DetailSCIMTokenResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/SCIMToken'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailServiceTokenResponse:
      title: DetailServiceTokenResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/ServiceToken'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    DetailUserSCIMResponse:
      title: DetailUserSCIMResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/UserSCIM'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    EncryptedJSONValue:
      type: object
      properties:
        _ciphertext:
          type: string
          default: NOT_SET
          title: ' ciphertext'
    EncryptedJSONValueRequest:
      type: object
      properties:
        _ciphertext:
          type: string
          minLength: 1
          default: NOT_SET
          title: ' ciphertext'
    EntraExtraData:
      type: object
      properties:
        application_id_uri:
          type: string
      required:
      - application_id_uri
    EntraExtraDataRequest:
      type: object
      properties:
        application_id_uri:
          type: string
          minLength: 1
      required:
      - application_id_uri
    EnvVarEnvironmentData:
      title: EnvVarEnvironmentData
      type: object
      properties:
        environments:
          title: Environments
          description: Ordered list of environment names (includes 'project' as the
            first entry).
          type: array
          items:
            type: string
        variables:
          title: Variables
          description: Dict keyed by variable name. Each value is a dict keyed by
            environment name (or 'project') mapping to {id, value} pairs.
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              $ref: '#/components/schemas/EnvVarValue'
      required:
      - environments
      - variables
    EnvVarEnvironmentResponse:
      title: EnvVarEnvironmentResponse
      description: Response envelope for the environment/ environment-variable endpoint.
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/EnvVarEnvironmentData'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    EnvVarJobResponse:
      title: EnvVarJobResponse
      description: |-
        Response envelope for the job/ environment-variable endpoint.

        ``data`` is a dict keyed by variable name, where each value is a dict keyed by
        scope (``project``, ``environment``, ``job``) mapping to ``{id, value}`` pairs.
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: object
          additionalProperties:
            $ref: '#/components/schemas/EnvVarJobScopeMap'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    EnvVarJobScopeMap:
      title: EnvVarJobScopeMap
      description: |-
        Overrides for a single variable on the job/ endpoint.

        Each scope is optional because a variable may only be set at some levels.
      type: object
      properties:
        project:
          $ref: '#/components/schemas/EnvVarValue'
        environment:
          $ref: '#/components/schemas/EnvVarValue'
        job:
          $ref: '#/components/schemas/EnvVarValue'
    EnvVarUserResponse:
      title: EnvVarUserResponse
      description: |-
        Response envelope for the user/ environment-variable endpoint.

        ``data`` is a dict keyed by variable name, where each value is a dict keyed by
        scope (``project``, ``environment``, ``user``) mapping to ``{id, value}`` pairs.
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: object
          additionalProperties:
            $ref: '#/components/schemas/EnvVarUserScopeMap'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    EnvVarUserScopeMap:
      title: EnvVarUserScopeMap
      description: |-
        Overrides for a single variable on the user/ endpoint.

        Each scope is optional because a variable may only be set at some levels.
      type: object
      properties:
        project:
          $ref: '#/components/schemas/EnvVarValue'
        environment:
          $ref: '#/components/schemas/EnvVarValue'
        user:
          $ref: '#/components/schemas/EnvVarValue'
    EnvVarValue:
      title: EnvVarValue
      description: 'A single environment variable override: its database ID and display
        value.'
      type: object
      properties:
        id:
          title: Id
          type: integer
        value:
          title: Value
          type: string
      required:
      - id
    EnvironmentV3:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
          description: The account the environment is associated with
        project_id:
          type: integer
          format: int64
          description: The project the environment is associated with
        credentials_id:
          type: integer
          format: int64
          description: The id of the associated credentials. Null for development
            environments. Must be included when updating a deployment environment
            or the value will be reset to null.
        connection_id:
          type: integer
          format: int64
          description: The id of the associated connection. Must be included when
            updating an environment or the value will be reset to null.
        extended_attributes_id:
          type: integer
          format: int64
        name:
          type: string
          description: The name of the environment
        dbt_version:
          type: string
          description: The default dbt Version to use for this environment
        type:
          $ref: '#/components/schemas/Type76eEnum'
        use_custom_branch:
          type: boolean
        custom_branch:
          type: string
        supports_docs:
          type: boolean
        deployment_type:
          $ref: '#/components/schemas/DeploymentTypeEnum'
        enable_model_query_history:
          type: boolean
          default: false
        enable_dbt_state:
          type: boolean
          default: false
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        primary_profile_id:
          type: integer
          format: int64
          description: The id of the primary profile for this environment
      required:
      - account_id
      - dbt_version
      - name
      - project_id
      - state
      - supports_docs
      - type
      - use_custom_branch
    EnvironmentV3Enveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EnvironmentV3Response'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    EnvironmentV3ListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentV3Response'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    EnvironmentV3Request:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
          description: The account the environment is associated with
        project_id:
          type: integer
          format: int64
          description: The project the environment is associated with
        credentials_id:
          type: integer
          format: int64
          description: The id of the associated credentials. Null for development
            environments. Must be included when updating a deployment environment
            or the value will be reset to null.
        connection_id:
          type: integer
          format: int64
          description: The id of the associated connection. Must be included when
            updating an environment or the value will be reset to null.
        extended_attributes_id:
          type: integer
          format: int64
        name:
          type: string
          minLength: 1
          description: The name of the environment
        dbt_version:
          type: string
          minLength: 1
          description: The default dbt Version to use for this environment
        type:
          $ref: '#/components/schemas/Type76eEnum'
        use_custom_branch:
          type: boolean
        custom_branch:
          type: string
          minLength: 1
        supports_docs:
          type: boolean
        deployment_type:
          $ref: '#/components/schemas/DeploymentTypeEnum'
        enable_model_query_history:
          type: boolean
          default: false
        enable_dbt_state:
          type: boolean
          default: false
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        primary_profile_id:
          type: integer
          format: int64
          description: The id of the primary profile for this environment
      required:
      - account_id
      - dbt_version
      - name
      - project_id
      - state
      - supports_docs
      - type
      - use_custom_branch
    EnvironmentV3Response:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
          description: The account the environment is associated with
        project_id:
          type: integer
          format: int64
          description: The project the environment is associated with
        credentials_id:
          type: integer
          format: int64
          description: The id of the associated credentials. Null for development
            environments. Must be included when updating a deployment environment
            or the value will be reset to null.
        connection_id:
          type: integer
          format: int64
          description: The id of the associated connection. Must be included when
            updating an environment or the value will be reset to null.
        extended_attributes_id:
          type: integer
          format: int64
        name:
          type: string
          default: New Environment
          description: The name of the environment
        dbt_version:
          type: string
          default: latest
          description: The default dbt Version to use for this environment
        raw_dbt_version:
          type: string
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/Type76eEnum'
          default: deployment
        use_custom_branch:
          type: boolean
          default: false
        custom_branch:
          type: string
        supports_docs:
          type: boolean
          default: false
        deployment_type:
          $ref: '#/components/schemas/DeploymentTypeEnum'
        is_deferrable:
          type: boolean
          readOnly: true
        enable_model_query_history:
          type: boolean
          default: false
        enable_dbt_state:
          type: boolean
          default: false
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        project:
          allOf:
          - $ref: '#/components/schemas/Project'
          readOnly: true
        primary_profile_id:
          type: integer
          format: int64
          description: The id of the primary profile for this environment
        credentials:
          allOf:
          - $ref: '#/components/schemas/PostgresCredentials'
          readOnly: true
        fusion_readiness:
          readOnly: true
      required:
      - created_at
      - credentials
      - fusion_readiness
      - id
      - is_deferrable
      - project
      - raw_dbt_version
      - updated_at
    Event:
      type: object
      properties:
        id:
          type: string
        subscription_id:
          type: string
        account_identifier:
          type: string
        job_id:
          type: string
        trigger_event_type:
          type: string
        payload:
          type: string
        http_status_code:
          type: string
        account_id:
          type: string
      required:
      - account_id
      - account_identifier
      - http_status_code
      - id
      - job_id
      - payload
      - subscription_id
      - trigger_event_type
    EventResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Event'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
      required:
      - data
      - status
    ExtendedAttributes:
      title: ExtendedAttributes
      type: object
      properties:
        id:
          title: Id
          description: The ID of the extended attributes record
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        account_id:
          title: Account Id
          description: The ID of the parent account
          type: integer
        project_id:
          title: Project Id
          description: The ID of the parent project
          type: integer
        extended_attributes:
          title: Extended Attributes
          description: The key-value pairs stored as extended attributes
          type: object
        state:
          title: State
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
          default: 1
          type: integer
      required:
      - id
      - created_at
      - updated_at
      - account_id
      - project_id
      - extended_attributes
    ExtendedAttributesCreateBodyRequest:
      title: ExtendedAttributesCreateBody
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        extended_attributes:
          title: Extended Attributes
          description: The key-value pairs to be stored as extended attributes. dbt
            guarantees to support extended attributes up to 4096 bytes in serialized
            JSON form.
          type: object
      required:
      - extended_attributes
    ExtendedAttributesResponse:
      title: ExtendedAttributesResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/ExtendedAttributes'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    ExtendedAttributesUpdateBodyRequest:
      title: ExtendedAttributesUpdateBody
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        extended_attributes:
          title: Extended Attributes
          description: The key-value pairs to be stored as extended attributes. dbt
            guarantees to support extended attributes up to 4096 bytes in serialized
            JSON form.
          type: object
        state:
          title: State
          type: integer
      required:
      - extended_attributes
    Extra:
      type: object
      properties:
        filters:
          type: object
          additionalProperties: {}
          description: Filters applied to the request
        order_by:
          type: string
          description: Ordering applied to the request
        pagination:
          $ref: '#/components/schemas/CustomPagination'
      required:
      - filters
      - order_by
      - pagination
    FabricConnection:
      title: FabricConnection
      type: object
      properties:
        server:
          title: Server
          type: string
        database:
          title: Database
          type: string
        driver:
          title: Driver
          default: ODBC Driver 18 for SQL Server
          type: string
        port:
          title: Port
          default: 1433
          minimum: 1
          maximum: 65535
          type: integer
        retries:
          title: Retries
          default: 1
          type: integer
        login_timeout:
          title: Login Timeout
          default: 0
          type: integer
        query_timeout:
          title: Query Timeout
          default: 0
          type: integer
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - server
      - database
    FavoriteAsset:
      title: FavoriteAsset
      type: object
      properties:
        id:
          title: Id
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        project_id:
          title: Project Id
          description: The project ID the favorited asset is associated with. Can
            be null for data warehouse assets.
          type: integer
        environment_id:
          title: Environment Id
          description: The environment ID the favorited asset is associated with
          type: integer
        asset_id:
          title: Asset Id
          description: The asset ID of the favorited asset
          type: string
        name:
          title: Name
          description: The name of the favorited asset
          type: string
        platform:
          title: Platform
          description: The platform of the favorited asset
          type: string
        asset_type:
          title: Asset Type
          description: The resource type of the favorited asset
          type: string
      required:
      - id
      - created_at
      - updated_at
      - asset_id
      - name
      - platform
    FieldGroup:
      type: object
      properties:
        name:
          type: string
        members:
          type: array
          items:
            type: string
      required:
      - members
      - name
    Filters:
      type: object
      properties:
        offset:
          type: integer
        limit:
          type: integer
      required:
      - limit
      - offset
    GetLineageIntegrationWatchSelectionResponse:
      title: GetLineageIntegrationWatchSelectionResponse
      type: object
      properties:
        added:
          title: Added
          description: Number of collections additionally being watched
          type: integer
        removed:
          title: Removed
          description: Number of collections no longer being watched
          type: integer
      required:
      - added
      - removed
    GetWebhooksReceiptResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Receipt'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
      required:
      - data
      - status
    GitCloneStrategyEnum:
      enum:
      - azure_active_directory_app
      - deploy_key
      - deploy_token
      - github_app
      - git_token
      type: string
      description: |-
        * `azure_active_directory_app` - azure_active_directory_app
        * `deploy_key` - deploy_key
        * `deploy_token` - deploy_token
        * `github_app` - github_app
        * `git_token` - git_token
    Group:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        name:
          type: string
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        assign_by_default:
          type: boolean
        sso_mapping_groups:
          type: array
          items:
            type: string
      required:
      - account_id
      - assign_by_default
      - name
      - state
    GroupEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GroupResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    GroupListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GroupResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    GroupMemberComponent:
      title: GroupMemberComponent
      type: object
      properties:
        value:
          title: Value
          description: The ID of the member
          type: string
        display:
          title: Display
          description: The display name of the member
          type: string
      required:
      - value
      - display
    GroupPermission:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        group_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        all_projects:
          type: boolean
        permission_set:
          $ref: '#/components/schemas/PermissionSetEnum'
        permission_level:
          type: integer
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        writable_environment_categories:
          type: array
          items:
            type: string
      required:
      - account_id
      - all_projects
      - group_id
      - permission_set
      - writable_environment_categories
    GroupPermissionListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GroupPermissionResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    GroupPermissionListRequest:
      type: object
      properties:
        ? ''
        : type: array
          items:
            $ref: '#/components/schemas/GroupPermissionRequest'
      required:
      - ''
    GroupPermissionRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        group_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        all_projects:
          type: boolean
        permission_set:
          $ref: '#/components/schemas/PermissionSetEnum'
        permission_level:
          type: integer
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        writable_environment_categories:
          type: array
          items:
            type: string
            minLength: 1
      required:
      - account_id
      - all_projects
      - group_id
      - permission_set
      - writable_environment_categories
    GroupPermissionResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        group_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        all_projects:
          type: boolean
        permission_set:
          $ref: '#/components/schemas/PermissionSetEnum'
        permission_level:
          type: integer
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        writable_environment_categories:
          type: array
          items:
            type: string
          default: []
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - updated_at
    GroupRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        name:
          type: string
          minLength: 1
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        assign_by_default:
          type: boolean
        sso_mapping_groups:
          type: array
          items:
            type: string
            minLength: 1
      required:
      - account_id
      - assign_by_default
      - name
      - state
    GroupResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        name:
          type: string
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        assign_by_default:
          type: boolean
          default: false
        sso_mapping_groups:
          type: array
          items:
            type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        group_permissions:
          type: array
          items:
            $ref: '#/components/schemas/GroupPermission'
          readOnly: true
          default: []
        member_count:
          type: integer
          readOnly: true
        scim_managed:
          type: boolean
          readOnly: true
      required:
      - created_at
      - group_permissions
      - id
      - member_count
      - scim_managed
      - updated_at
    GroupSCIM:
      title: GroupSCIM
      type: object
      properties:
        id:
          title: Id
          description: The ID of the group
          type: string
        externalId:
          title: Externalid
          description: The external ID of the group
          type: string
        displayName:
          title: Displayname
          description: The display name of the group
          type: string
        members:
          title: Members
          description: The members of the group
          type: array
          items:
            $ref: '#/components/schemas/GroupMemberComponent'
        meta:
          title: Meta
          description: The metadata of the group
          allOf:
          - $ref: '#/components/schemas/MetaComponent'
        schemas:
          title: Schemas
          default:
          - urn:ietf:params:scim:schemas:core:2.0:Group
          type: array
          items: {}
      required:
      - id
      - displayName
      - meta
    HumanReadableDateStrategyTypeEnum:
      enum:
      - every_day
      - days_of_week
      - custom_cron
      - interval_cron
      type: string
      description: |-
        * `every_day` - every_day
        * `days_of_week` - days_of_week
        * `custom_cron` - custom_cron
        * `interval_cron` - interval_cron
    HumanReadableTimeStrategTypeEnum:
      enum:
      - every_hour
      - at_exact_hours
      type: string
      description: |-
        * `every_hour` - every_hour
        * `at_exact_hours` - at_exact_hours
    IPRestrictionCidr:
      type: object
      properties:
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        ip_restriction_rule_id:
          type: integer
          format: int64
        enabled:
          type: boolean
        cidr:
          type: string
        cidr_ipv6:
          type: string
      required:
      - cidr
      - enabled
      - ip_restriction_rule_id
      - state
    IPRestrictionCidrRequestRequest:
      type: object
      properties:
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        cidr:
          type: string
          minLength: 1
        id:
          type: integer
      required:
      - cidr
    IPRestrictionRequestRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
        type:
          $ref: '#/components/schemas/TypeEdaEnum'
        rule_set_enabled:
          type: boolean
        account_id:
          type: integer
        cidrs:
          type: array
          items:
            $ref: '#/components/schemas/IPRestrictionCidrRequestRequest'
        description:
          type: string
          minLength: 1
      required:
      - account_id
      - cidrs
      - name
      - rule_set_enabled
      - type
    IPRestrictionRule:
      type: object
      properties:
        name:
          type: string
        type:
          type: integer
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        ip_restriction_rule_set_id:
          type: integer
          format: int64
        rule_set_enabled:
          type: boolean
        account_id:
          type: integer
          format: int64
        cidrs:
          type: array
          items:
            $ref: '#/components/schemas/IPRestrictionCidr'
        created_by_id:
          type: integer
          format: int64
        created_by_service_token_id:
          type: integer
          format: int64
        description:
          type: string
      required:
      - account_id
      - ip_restriction_rule_set_id
      - name
      - rule_set_enabled
      - state
      - type
    IPRestrictionRuleEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/IPRestrictionRuleResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    IPRestrictionRuleListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/IPRestrictionRuleResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    IPRestrictionRuleResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        name:
          type: string
        type:
          type: integer
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        ip_restriction_rule_set_id:
          type: integer
          format: int64
        rule_set_enabled:
          type: boolean
        account_id:
          type: integer
          format: int64
        cidrs:
          type: array
          items:
            $ref: '#/components/schemas/IPRestrictionCidr'
        created_by_id:
          type: integer
          format: int64
        created_by_service_token_id:
          type: integer
          format: int64
        enabled_for_service_tokens:
          type: boolean
          readOnly: true
        description:
          type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - enabled_for_service_tokens
      - id
      - updated_at
    IPRestrictionRuleSetEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/IPRestrictionRuleSetResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    IPRestrictionRuleSetResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        enabled:
          type: boolean
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        enabled_for_service_tokens:
          type: boolean
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - enabled_for_service_tokens
      - id
      - updated_at
    IPRestrictionSetRequestRequest:
      type: object
      properties:
        enabled:
          type: boolean
      required:
      - enabled
    IPRestrictionSetValidate:
      type: object
      properties:
        is_valid_for_admin:
          type: boolean
      required:
      - is_valid_for_admin
    InviteUsersRequestRequest:
      type: object
      properties:
        id:
          type: integer
        email_addresses:
          type: array
          items:
            type: string
            minLength: 1
        license_type:
          $ref: '#/components/schemas/LicenseTypeEnum'
        group_ids:
          type: array
          items:
            type: integer
      required:
      - email_addresses
      - license_type
    InviteUsersResponse:
      type: object
      properties:
        sent:
          type: array
          items:
            type: string
    InviteUsersResponseEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/InviteUsersResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    JobDefinitionExecution:
      type: object
      properties:
        timeout_seconds:
          type: integer
      required:
      - timeout_seconds
    JobDefinitionSchedule:
      type: object
      properties:
        cron:
          type: string
          description: Cron syntax schedule for the job string
        date:
          $ref: '#/components/schemas/HumanReadableDateStrategyTypeEnum'
        time:
          $ref: '#/components/schemas/HumanReadableTimeStrategTypeEnum'
      required:
      - cron
      - date
      - time
    JobDefinitionSettings:
      type: object
      properties:
        threads:
          type: integer
          description: The maximum number of models to run in parallel in a single
            dbt run
        target_name:
          type: string
          description: Informational field that can be consumed in dbt project code
            with `{{ target.name }}`
      required:
      - target_name
      - threads
    JobDefinitionTriggers:
      type: object
      properties:
        github_webhook:
          type: boolean
        schedule:
          type: boolean
        git_provider_webhook:
          type: boolean
        on_merge:
          type: boolean
        custom_branch_only:
          type: boolean
          description: (Deprecated)
      required:
      - github_webhook
      - schedule
    JobDefinitionV2:
      type: object
      properties:
        environment_id:
          type: integer
          format: int64
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        name:
          type: string
          description: The name of the job
        description:
          type: string
        generate_docs:
          type: boolean
          description: When true, `dbt docs generate` will be run at the end of all
            runs for this Job
        run_generate_sources:
          type: boolean
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        dbt_version:
          type: string
          description: When set, overrides the dbt_version specified in the Job's
            Environment
        triggers:
          $ref: '#/components/schemas/JobDefinitionTriggers'
        settings:
          $ref: '#/components/schemas/JobDefinitionSettings'
        execution:
          $ref: '#/components/schemas/JobDefinitionExecution'
        schedule:
          $ref: '#/components/schemas/JobDefinitionSchedule'
        execute_steps:
          type: array
          items:
            type: string
          description: A list of dbt commands to run
        job_type:
          $ref: '#/components/schemas/JobTypeEnum'
        triggers_on_draft_pr:
          type: boolean
          default: false
        run_compare_changes:
          type: boolean
          default: false
        compare_changes_flags:
          type: string
          default: --select state:modified
          description: dbt syntax flags to be used for compare changes
        run_lint:
          type: boolean
          default: false
        errors_on_lint_failure:
          type: boolean
          default: true
        deferring_environment_id:
          type: integer
          format: int64
        deferring_job_definition_id:
          type: integer
          format: int64
        cost_optimization_features:
          type: array
          items:
            type: string
          description: "List of cost optimization features to enable for this job.\n\
            \            <br/><br/>\n            <b>Valid values:</b>\n          \
            \  <ul>\n              <li>\"state_aware_orchestration\" - Enable orchestration\
            \ that adapts to state changes (Private beta, requires fusion)</li>\n\
            \              <li>\"efficient_testing\" - Aggregate generic tests into\
            \ a single query and reuse redundant tests (Private beta, requires fusion)</li>\n\
            \              <li>\"dbt_state\" - Enable orchestration that adapts to\
            \ state changes (does not require fusion)</li>\n              <li>\"inherit_environment\"\
            \ - Inherit this job's dbt State setting from its environment. Must be\
            \ sent on its own; it cannot be combined with any other value.</li>\n\
            \            </ul>\n            <b>Example:</b> [\"dbt_state\"]\n    \
            \        "
      required:
      - account_id
      - environment_id
      - execution
      - generate_docs
      - name
      - project_id
      - run_generate_sources
      - settings
      - state
    JobTypeEnum:
      enum:
      - ci
      - scheduled
      - other
      - merge
      - exposure_sync
      - adaptive
      - hybrid
      type: string
      description: |-
        * `ci` - ci
        * `scheduled` - scheduled
        * `other` - other
        * `merge` - merge
        * `exposure_sync` - exposure_sync
        * `adaptive` - adaptive
        * `hybrid` - hybrid
    LicenseMapEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LicenseMapResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    LicenseMapListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LicenseMapResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    LicenseMapRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        license_type:
          $ref: '#/components/schemas/LicenseTypeEnum'
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        sso_license_mapping_groups:
          type: array
          items:
            type: string
            minLength: 1
      required:
      - account_id
      - license_type
    LicenseMapResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        license_type:
          $ref: '#/components/schemas/LicenseTypeEnum'
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        sso_license_mapping_groups:
          type: array
          items:
            type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - updated_at
    LicenseType:
      title: LicenseType
      description: An enumeration.
      enum:
      - developer
      - read_only
      - analyst
      - it
      type: string
    LicenseTypeEnum:
      enum:
      - developer
      - read_only
      - analyst
      - it
      type: string
      description: |-
        * `developer` - DEVELOPER
        * `read_only` - READ_ONLY
        * `analyst` - ANALYST
        * `it` - IT
    LineageIntegration:
      title: LineageIntegration
      type: object
      properties:
        id:
          title: Id
          description: The integration's ID
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        account_id:
          title: Account Id
          description: The account the integration is associated with
          type: integer
        project_id:
          title: Project Id
          description: The project the integration is associated with
          type: integer
        name:
          title: Name
          description: The name of the integration
          type: string
      required:
      - id
      - created_at
      - updated_at
      - account_id
      - project_id
      - name
    LineageIntegrationCollection:
      title: LineageIntegrationCollection
      type: object
      properties:
        collections:
          title: Collections
          description: List of collections
          type: array
          items:
            $ref: '#/components/schemas/WatchSelectionItem'
      required:
      - collections
    LineageIntegrationConfigSchema:
      title: LineageIntegrationConfigSchema
      type: object
      properties: {}
    LineageIntegrationType:
      title: LineageIntegrationType
      description: An enumeration.
      enum:
      - tableau
      - powerbi
      type: string
    ListGroupSCIMResponse:
      title: ListGroupSCIMResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/GroupSCIM'
        extra:
          $ref: '#/components/schemas/V3ResponseExtraData'
        error_code:
          title: Error Code
          type: integer
      required:
      - data
      - extra
    ListLineageIntegrationCollectionResponse:
      title: ListLineageIntegrationCollectionResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/LineageIntegrationCollection'
        extra:
          $ref: '#/components/schemas/V3ResponseExtraData'
        error_code:
          title: Error Code
          type: integer
      required:
      - data
      - extra
    ListLineageIntegrationResponse:
      title: ListLineageIntegrationResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/LineageIntegration'
        extra:
          $ref: '#/components/schemas/V3ResponseExtraData'
        error_code:
          title: Error Code
          type: integer
      required:
      - data
      - extra
    ListSCIMTokenResponse:
      title: ListSCIMTokenResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/SCIMToken'
        extra:
          $ref: '#/components/schemas/V3ResponseExtraData'
        error_code:
          title: Error Code
          type: integer
      required:
      - data
      - extra
    ListServiceTokenResponse:
      title: ListServiceTokenResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/ServiceToken'
        extra:
          $ref: '#/components/schemas/V3ResponseExtraData'
        error_code:
          title: Error Code
          type: integer
      required:
      - data
      - extra
    ListUserSCIMResponse:
      title: ListUserSCIMResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/UserSCIM'
        extra:
          $ref: '#/components/schemas/V3ResponseExtraData'
        error_code:
          title: Error Code
          type: integer
      required:
      - data
      - extra
    ListWebhooksReceiptsResponseEnvelope:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Receipt'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
      required:
      - data
      - status
    LockCauseEnum:
      enum:
      - trial_expired
      - cancelled
      - unpaid
      - provisioned_team_annual
      - other
      - migrated
      - workshop
      type: string
      description: |-
        * `trial_expired` - TRIAL_EXPIRED
        * `cancelled` - CANCELLED
        * `unpaid` - UNPAID
        * `provisioned_team_annual` - PROVISIONED_TEAM_ANNUAL
        * `other` - OTHER
        * `migrated` - MIGRATED
        * `workshop` - WORKSHOP
    MetaComponent:
      title: MetaComponent
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        resourceType:
          title: Resourcetype
          description: The resource type of the metadata
          type: string
        location:
          title: Location
          description: The location of the resource
          type: string
        created:
          title: Created
          description: The date and time the resource was created
          type: string
        lastModified:
          title: Lastmodified
          description: The date and time the resource was last modified
          type: string
      required:
      - resourceType
      - location
    Method:
      title: Method
      description: An enumeration.
      enum:
      - odbc
      type: string
    NotFound:
      type: object
      properties:
        data:
          type: object
          additionalProperties: {}
          nullable: true
        status:
          $ref: '#/components/schemas/NotFoundStatus'
      required:
      - status
    NotFoundStatus:
      type: object
      properties:
        code:
          type: integer
          default: 404
        is_success:
          type: boolean
          description: Whether the request was successful or not
        user_message:
          type: string
          description: End-user friendly success or error message
        developer_message:
          type: string
          description: Developer friendly success or error message
      required:
      - developer_message
      - is_success
      - user_message
    OAuthConfigurationEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OAuthConfigurationResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    OAuthConfigurationListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OAuthConfigurationResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    OAuthConfigurationRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        type:
          type: string
          minLength: 1
        name:
          type: string
          minLength: 1
        extra_data:
          $ref: '#/components/schemas/EntraExtraDataRequest'
        client_id:
          type: string
          minLength: 1
        client_secret:
          type: string
          writeOnly: true
          minLength: 1
        authorize_url:
          type: string
          minLength: 1
        token_url:
          type: string
          minLength: 1
        redirect_uri:
          type: string
          minLength: 1
      required:
      - account_id
      - type
    OAuthConfigurationResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        type:
          type: string
        name:
          type: string
        extra_data:
          $ref: '#/components/schemas/EntraExtraData'
        client_id:
          type: string
        authorize_url:
          type: string
        token_url:
          type: string
        redirect_uri:
          type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - updated_at
    OptionalApacheSparkConnection:
      title: OptionalApacheSparkConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        cluster:
          title: Cluster
          type: string
        method:
          $ref: '#/components/schemas/ConnectionMethod'
        connect_timeout:
          title: Connect Timeout
          type: integer
        connect_retries:
          title: Connect Retries
          type: integer
        organization:
          title: Organization
          type: string
        user:
          title: User
          type: string
        auth:
          title: Auth
          type: string
        kerberos_service_name:
          title: Kerberos Service Name
          type: string
        port:
          title: Port
          type: integer
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalAthenaConnection:
      title: OptionalAthenaConnection
      type: object
      properties:
        region_name:
          title: Region Name
          type: string
        database:
          title: Database
          type: string
        work_group:
          title: Work Group
          type: string
        spark_work_group:
          title: Spark Work Group
          type: string
        s3_staging_dir:
          title: S3 Staging Dir
          type: string
        s3_data_dir:
          title: S3 Data Dir
          type: string
        s3_data_naming:
          title: S3 Data Naming
          type: string
        s3_tmp_table_dir:
          title: S3 Tmp Table Dir
          type: string
        poll_interval:
          title: Poll Interval
          type: integer
        num_retries:
          title: Num Retries
          type: integer
        num_boto3_retries:
          title: Num Boto3 Retries
          type: integer
        num_iceberg_retries:
          title: Num Iceberg Retries
          type: integer
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalBigqueryConnection:
      title: OptionalBigqueryConnection
      type: object
      properties:
        project_id:
          title: Project Id
          type: string
        timeout_seconds:
          title: Timeout Seconds
          type: integer
        private_key_id:
          title: Private Key Id
          type: string
        private_key:
          title: Private Key
          type: string
          writeOnly: true
          format: password
        client_email:
          title: Client Email
          type: string
        client_id:
          title: Client Id
          type: string
        auth_uri:
          title: Auth Uri
          type: string
        token_uri:
          title: Token Uri
          type: string
        auth_provider_x509_cert_url:
          title: Auth Provider X509 Cert Url
          type: string
        client_x509_cert_url:
          title: Client X509 Cert Url
          type: string
        priority:
          $ref: '#/components/schemas/schemas__adapters__bigquery__v0__connection_schema__Priority'
        scopes:
          title: Scopes
          type: array
          items:
            type: string
        location:
          title: Location
          type: string
        maximum_bytes_billed:
          title: Maximum Bytes Billed
          type: integer
        execution_project:
          title: Execution Project
          type: string
        impersonate_service_account:
          title: Impersonate Service Account
          type: string
        retries:
          title: Retries
          type: integer
        job_retry_deadline_seconds:
          title: Job Retry Deadline Seconds
          type: integer
        job_creation_timeout_seconds:
          title: Job Creation Timeout Seconds
          type: integer
        application_id:
          title: Application Id
          type: string
          writeOnly: true
          format: password
        application_secret:
          title: Application Secret
          type: string
          writeOnly: true
          format: password
        gcs_bucket:
          title: Gcs Bucket
          type: string
        dataproc_region:
          title: Dataproc Region
          type: string
        dataproc_cluster_name:
          title: Dataproc Cluster Name
          type: string
        api_endpoint:
          title: Api Endpoint
          type: string
    OptionalBigqueryConnectionV1:
      title: OptionalBigqueryConnectionV1
      type: object
      properties:
        deployment_env_auth_type:
          $ref: '#/components/schemas/DeploymentEnvironmentAuthType'
        project_id:
          title: Project Id
          type: string
        private_key_id:
          title: Private Key Id
          type: string
        private_key:
          title: Private Key
          type: string
          writeOnly: true
          format: password
        client_email:
          title: Client Email
          type: string
        client_id:
          title: Client Id
          type: string
        auth_uri:
          title: Auth Uri
          type: string
        token_uri:
          title: Token Uri
          type: string
        auth_provider_x509_cert_url:
          title: Auth Provider X509 Cert Url
          type: string
        client_x509_cert_url:
          title: Client X509 Cert Url
          type: string
        job_execution_timeout_seconds:
          title: Job Execution Timeout Seconds
          type: integer
        priority:
          $ref: '#/components/schemas/schemas__adapters__bigquery__v1__connection_schema__Priority'
        scopes:
          title: Scopes
          type: array
          items:
            type: string
        location:
          title: Location
          type: string
        maximum_bytes_billed:
          title: Maximum Bytes Billed
          type: integer
        execution_project:
          title: Execution Project
          type: string
        impersonate_service_account:
          title: Impersonate Service Account
          type: string
        retries:
          title: Retries
          type: integer
        job_retry_deadline_seconds:
          title: Job Retry Deadline Seconds
          type: integer
        job_creation_timeout_seconds:
          title: Job Creation Timeout Seconds
          type: integer
        application_id:
          title: Application Id
          type: string
          writeOnly: true
          format: password
        application_secret:
          title: Application Secret
          type: string
          writeOnly: true
          format: password
        gcs_bucket:
          title: Gcs Bucket
          type: string
        dataproc_region:
          title: Dataproc Region
          type: string
        dataproc_cluster_name:
          title: Dataproc Cluster Name
          type: string
        api_endpoint:
          title: Api Endpoint
          type: string
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalClickHouseConnection:
      title: OptionalClickHouseConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        port:
          title: Port
          type: integer
        database:
          title: Database
          type: string
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalDatabricksConnection:
      title: OptionalDatabricksConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        http_path:
          title: Http Path
          type: string
        catalog:
          title: Catalog
          type: string
        client_id:
          title: Client Id
          type: string
          writeOnly: true
          format: password
        client_secret:
          title: Client Secret
          type: string
          writeOnly: true
          format: password
        scopes:
          title: Scopes
          type: array
          items:
            type: string
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalDatabricksSparkConnection:
      title: OptionalDatabricksSparkConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        method:
          $ref: '#/components/schemas/Method'
        port:
          title: Port
          type: integer
        cluster:
          title: Cluster
          type: string
        endpoint:
          title: Endpoint
          type: string
        driver:
          title: Driver
          type: string
        organization:
          title: Organization
          type: string
        user:
          title: User
          type: string
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalFabricConnection:
      title: OptionalFabricConnection
      type: object
      properties:
        server:
          title: Server
          type: string
        database:
          title: Database
          type: string
        driver:
          title: Driver
          type: string
        port:
          title: Port
          type: integer
        retries:
          title: Retries
          type: integer
        login_timeout:
          title: Login Timeout
          type: integer
        query_timeout:
          title: Query Timeout
          type: integer
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalLineageIntegrationConfigSchema:
      title: OptionalLineageIntegrationConfigSchema
      type: object
      properties: {}
    OptionalPostgresConnection:
      title: OptionalPostgresConnection
      type: object
      properties:
        hostname:
          title: Hostname
          type: string
        dbname:
          title: Dbname
          type: string
        port:
          title: Port
          type: integer
        retries:
          title: Retries
          type: integer
    OptionalRedshiftConnection:
      title: OptionalRedshiftConnection
      type: object
      properties:
        hostname:
          title: Hostname
          type: string
        dbname:
          title: Dbname
          type: string
        port:
          title: Port
          type: integer
        retries:
          title: Retries
          type: integer
    OptionalSalesforceConnection:
      title: OptionalSalesforceConnection
      type: object
      properties:
        login_url:
          title: Login Url
          type: string
        database:
          title: Database
          type: string
        data_transform_run_timeout:
          title: Data Transform Run Timeout
          type: integer
        auth_type:
          $ref: '#/components/schemas/schemas__adapters__salesforce__connection_schema__AuthType'
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalSnowflakeConnection:
      title: OptionalSnowflakeConnection
      type: object
      properties:
        account:
          title: Account
          type: string
        database:
          title: Database
          type: string
        warehouse:
          title: Warehouse
          type: string
        client_session_keep_alive:
          title: Client Session Keep Alive
          type: boolean
        role:
          title: Role
          type: string
        allow_sso:
          title: Allow Sso
          type: boolean
        oauth_client_id:
          title: Oauth Client Id
          type: string
          writeOnly: true
          format: password
        oauth_client_secret:
          title: Oauth Client Secret
          type: string
          writeOnly: true
          format: password
    OptionalSynapseConnection:
      title: OptionalSynapseConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        database:
          title: Database
          type: string
        driver:
          title: Driver
          type: string
        port:
          title: Port
          type: integer
        retries:
          title: Retries
          type: integer
        login_timeout:
          title: Login Timeout
          type: integer
        query_timeout:
          title: Query Timeout
          type: integer
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalTeradataConnection:
      title: OptionalTeradataConnection
      type: object
      properties:
        port:
          title: Port
          type: string
        tmode:
          title: Tmode
          type: string
        host:
          title: Host
          type: string
        retries:
          title: Retries
          type: integer
        request_timeout:
          title: Request Timeout
          type: integer
        adapter_id:
          title: Adapter Id
          type: integer
    OptionalTrinoConnection:
      title: OptionalTrinoConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        method:
          title: Method
          type: string
        port:
          title: Port
          type: integer
        adapter_id:
          title: Adapter Id
          type: integer
    PaginatedWebhooksEvents:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
        extra:
          $ref: '#/components/schemas/PaginationExtra'
      required:
      - data
      - extra
      - status
    PaginatedWebhooksSubscriptions:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
        extra:
          $ref: '#/components/schemas/PaginationExtra'
      required:
      - data
      - extra
      - status
    Pagination:
      type: object
      properties:
        total_count:
          type: integer
        count:
          type: integer
      required:
      - count
      - total_count
    PaginationExtra:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        filters:
          $ref: '#/components/schemas/Filters'
      required:
      - filters
      - pagination
    PatchGroupSCIMRequestRequest:
      title: PatchGroupSCIMRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        Operations:
          title: Operations
          description: The operations to perform
          type: array
          items:
            $ref: '#/components/schemas/PatchOperation'
        schemas:
          title: Schemas
          default:
          - urn:ietf:params:scim:api:messages:2.0:PatchOp
          type: array
          items: {}
      required:
      - Operations
    PatchLineageIntegrationRequest:
      title: PatchLineageIntegration
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        name:
          description: The name of the integration
          allOf:
          - $ref: '#/components/schemas/LineageIntegrationType'
        account_id:
          title: Account Id
          description: The account the integration is associated with
          type: integer
        project_id:
          title: Project Id
          description: The project the integration is associated with
          type: integer
        config:
          title: Config
          description: The integration configuration for this type of integration
          allOf:
          - $ref: '#/components/schemas/OptionalLineageIntegrationConfigSchema'
      additionalProperties: false
    PatchOp:
      title: PatchOp
      description: An enumeration.
      enum:
      - add
      - remove
      - replace
      type: string
    PatchOperation:
      title: PatchOperation
      type: object
      properties:
        op:
          description: The operation type
          allOf:
          - $ref: '#/components/schemas/PatchOp'
        path:
          title: Path
          description: The target [sub]attribute of the operation
          type: string
        value:
          title: Value
          description: The value used by the operation
      required:
      - op
    PermissionSetEnum:
      enum:
      - account_admin
      - account_viewer
      - admin
      - analyst
      - analyst_read
      - billing_admin
      - cost_insights_admin
      - cost_insights_viewer
      - cost_management_admin
      - cost_management_viewer
      - database_admin
      - developer
      - fusion_admin
      - git_admin
      - job_admin
      - job_creator
      - job_runner
      - job_viewer
      - manage_marketplace_apps
      - member
      - metadata_only
      - notification_manager
      - owner
      - project_creator
      - readonly
      - scim_only
      - security_admin
      - semantic_layer_only
      - stakeholder
      - team_admin
      - webhooks_only
      type: string
      description: |-
        * `account_admin` - ACCOUNT_ADMIN
        * `account_viewer` - ACCOUNT_VIEWER
        * `admin` - ADMIN
        * `analyst` - ANALYST
        * `analyst_read` - ANALYST_READ
        * `billing_admin` - BILLING_ADMIN
        * `cost_insights_admin` - COST_INSIGHTS_ADMIN
        * `cost_insights_viewer` - COST_INSIGHTS_VIEWER
        * `cost_management_admin` - COST_MANAGEMENT_ADMIN
        * `cost_management_viewer` - COST_MANAGEMENT_VIEWER
        * `database_admin` - DATABASE_ADMIN
        * `developer` - DEVELOPER
        * `fusion_admin` - V2_MIGRATION_ADMIN
        * `git_admin` - GIT_ADMIN
        * `job_admin` - JOB_ADMIN
        * `job_creator` - JOB_CREATOR
        * `job_runner` - JOB_RUNNER
        * `job_viewer` - JOB_VIEWER
        * `manage_marketplace_apps` - MANAGE_MARKETPLACE_APPS
        * `member` - MEMBER
        * `metadata_only` - METADATA_ONLY
        * `notification_manager` - NOTIFICATION_MANAGER
        * `owner` - OWNER
        * `project_creator` - PROJECT_CREATOR
        * `readonly` - READONLY
        * `scim_only` - SCIM_ONLY
        * `security_admin` - SECURITY_ADMIN
        * `semantic_layer_only` - SEMANTIC_LAYER_ONLY
        * `stakeholder` - STAKEHOLDER
        * `team_admin` - TEAM_ADMIN
        * `webhooks_only` - WEBHOOKS_ONLY
    PlanEnum:
      enum:
      - cancelled
      - cancelled_2022
      - cancelled_2025
      - developer
      - developer_2022
      - enterprise
      - enterprise_2025
      - enterprise_plus_2025
      - free
      - starter_2025
      - team
      - team_2022
      - team_annual
      - trial
      - trial_2022
      - trial_2025
      - usage_2026
      - usage_managed_2026
      type: string
      description: |-
        * `cancelled` - CANCELLED
        * `cancelled_2022` - CANCELLED_2022
        * `cancelled_2025` - CANCELLED_2025
        * `developer` - DEVELOPER
        * `developer_2022` - DEVELOPER_2022
        * `enterprise` - ENTERPRISE
        * `enterprise_2025` - ENTERPRISE_2025
        * `enterprise_plus_2025` - ENTERPRISE_PLUS_2025
        * `free` - FREE
        * `starter_2025` - STARTER_2025
        * `team` - TEAM
        * `team_2022` - TEAM_2022
        * `team_annual` - TEAM_ANNUAL
        * `trial` - TRIAL
        * `trial_2022` - TRIAL_2022
        * `trial_2025` - TRIAL_2025
        * `usage_2026` - USAGE_2026
        * `usage_managed_2026` - USAGE_MANAGED_2026
    PostLineageIntegrationRequest:
      title: PostLineageIntegration
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        name:
          description: The name of the integration
          allOf:
          - $ref: '#/components/schemas/LineageIntegrationType'
        account_id:
          title: Account Id
          description: The account the integration is associated with
          type: integer
        project_id:
          title: Project Id
          description: The project the integration is associated with
          type: integer
        config:
          title: Config
          description: The integration configuration for this type of integration
          allOf:
          - $ref: '#/components/schemas/LineageIntegrationConfigSchema'
      required:
      - name
      - account_id
      additionalProperties: false
    PostLineageIntegrationWatchSelectionRequest:
      title: PostLineageIntegrationWatchSelection
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        to_add:
          title: To Add
          description: Collections to start watching
          type: array
          items:
            $ref: '#/components/schemas/WatchSelectionItem'
        to_remove:
          title: To Remove
          description: Identifiers of collections to stop watching
          type: array
          items:
            type: string
      additionalProperties: false
    PostgresConnection:
      title: PostgresConnection
      type: object
      properties:
        hostname:
          title: Hostname
          maxLength: 1024
          minLength: 1
          type: string
        dbname:
          title: Dbname
          maxLength: 63
          minLength: 1
          type: string
        port:
          title: Port
          default: 5432
          exclusiveMinimum: 0
          maximum: 65535
          type: integer
        retries:
          title: Retries
          minimum: 0
          maximum: 10
          type: integer
      required:
      - hostname
      - dbname
    PostgresCredentials:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        username:
          type: string
        default_schema:
          type: string
        target_name:
          type: string
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - default_schema
      - state
      - target_name
      - threads
      - type
      - username
    PostgresCredentialsRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        username:
          type: string
          minLength: 1
        default_schema:
          type: string
          minLength: 1
        target_name:
          type: string
          minLength: 1
        password:
          type: string
          writeOnly: true
          minLength: 1
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - default_schema
      - state
      - target_name
      - threads
      - type
      - username
    PredefinedPermissionSet:
      title: PredefinedPermissionSet
      description: An enumeration.
      enum:
      - account_admin
      - account_viewer
      - admin
      - analyst
      - analyst_read
      - billing_admin
      - cost_insights_admin
      - cost_insights_viewer
      - cost_management_admin
      - cost_management_viewer
      - database_admin
      - developer
      - fusion_admin
      - git_admin
      - job_admin
      - job_creator
      - job_runner
      - job_viewer
      - manage_marketplace_apps
      - member
      - metadata_only
      - notification_manager
      - owner
      - project_creator
      - readonly
      - scim_only
      - security_admin
      - semantic_layer_only
      - stakeholder
      - team_admin
      - webhooks_only
      type: string
    PrivateEndpointDetail:
      title: PrivateEndpointDetail
      type: object
      properties:
        id:
          title: Id
          description: The unique identifier of the Private Endpoint.
          type: string
        account_id:
          title: Account Id
          description: The ID of the account
          type: integer
        state:
          title: State
          description: The soft-deletion state of the private endpoint record
          type: integer
        name:
          title: Name
          description: The name of the Private Endpoint.
          type: string
        type:
          title: Type
          description: The type of the Private Endpoint.
          type: string
        private_link_endpoint:
          title: Private Link Endpoint
          description: The PrivateLink endpoint (DNS entry that lives in the dbt Cloud
            VPC.
          type: string
        cidr_range:
          title: Cidr Range
          description: The CIDR range associated with the Private Endpoint.
          type: string
        egress_cidr:
          title: Egress Cidr
          description: Egress CIDR block associated with the Private Endpoint. Used
            by the customer to allowlist this PLE in their warehouse.
          type: string
        endpoint_identifier:
          title: Endpoint Identifier
          description: The cloud provider's PrivateLink endpoint ID.
          type: string
        endpoint_state:
          title: Endpoint State
          description: The current state of the Private Endpoint.
          type: string
        connectivity_status:
          title: Connectivity Status
          description: The connectivity status of the Private Endpoint.
          type: string
        connection_count:
          title: Connection Count
          description: The number of active connections using this Private Endpoint.
          default: 0
          type: integer
        created_at:
          title: Created At
          description: The timestamp when the Private Endpoint was created.
          type: string
          format: date-time
        updated_at:
          title: Updated At
          description: The timestamp when the Private Endpoint was last updated.
          type: string
          format: date-time
        port:
          title: Port
          description: The network port associated with the Private Endpoint.
          type: integer
        provisioning_status:
          title: Provisioning Status
          description: Current provisioning status of the Private Endpoint, when known.
          type: string
        provisioning_status_message:
          title: Provisioning Status Message
          description: Customer-facing message describing the current provisioning
            status, when one is available.
          type: string
      required:
      - id
      - account_id
      - state
      - created_at
      - updated_at
    PrivateEndpointDetailResponse:
      title: PrivateEndpointDetailResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/PrivateEndpointDetail'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    PrivateEndpointList:
      title: PrivateEndpointList
      type: object
      properties:
        id:
          title: Id
          description: The unique identifier of the Private Endpoint.
          type: string
        account_id:
          title: Account Id
          description: The ID of the account
          type: integer
        state:
          title: State
          description: The soft-deletion state of the private endpoint record
          type: integer
        name:
          title: Name
          description: The name of the Private Endpoint.
          type: string
        type:
          title: Type
          description: The type of the Private Endpoint.
          type: string
        private_link_endpoint:
          title: Private Link Endpoint
          description: The PrivateLink endpoint (DNS entry that lives in the dbt Cloud
            VPC.
          type: string
        cidr_range:
          title: Cidr Range
          description: The CIDR range associated with the Private Endpoint.
          type: string
        egress_cidr:
          title: Egress Cidr
          description: Egress CIDR block associated with the Private Endpoint. Used
            by the customer to allowlist this PLE in their warehouse.
          type: string
        endpoint_identifier:
          title: Endpoint Identifier
          description: The cloud provider's PrivateLink endpoint ID.
          type: string
        endpoint_state:
          title: Endpoint State
          description: The current state of the Private Endpoint.
          type: string
        connectivity_status:
          title: Connectivity Status
          description: The connectivity status of the Private Endpoint.
          type: string
        connection_count:
          title: Connection Count
          description: The number of active connections using this Private Endpoint.
          default: 0
          type: integer
        created_at:
          title: Created At
          description: The timestamp when the Private Endpoint was created.
          type: string
          format: date-time
        updated_at:
          title: Updated At
          description: The timestamp when the Private Endpoint was last updated.
          type: string
          format: date-time
      required:
      - id
      - account_id
      - state
      - created_at
      - updated_at
    PrivateEndpointListResponse:
      title: PrivateEndpointListResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          title: Data
          type: array
          items:
            $ref: '#/components/schemas/PrivateEndpointList'
        extra:
          $ref: '#/components/schemas/V3ResponseExtraData'
        error_code:
          title: Error Code
          type: integer
      required:
      - data
      - extra
    ProfileCreateBodyRequest:
      title: ProfileCreateBody
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        account_id:
          title: Account Id
          description: The ID of the account
          type: integer
        project_id:
          title: Project Id
          description: The ID of the project
          type: integer
        connection_id:
          title: Connection Id
          description: The ID of the connection
          type: integer
        key:
          title: Key
          description: Unique name for the profile. The profile key must be unique
            per project and can only contain letters, numbers, dashes, and underscores.
            It must begin with a letter and end with a letter or number. It cannot
            contain consecutive dashes or underscores.
          type: string
        credentials_id:
          title: Credentials Id
          description: The ID of the credentials
          type: integer
        extended_attributes_id:
          title: Extended Attributes Id
          description: The ID of the extended attributes
          type: integer
      required:
      - account_id
      - project_id
      - connection_id
      - key
      - credentials_id
      additionalProperties: false
    ProfileDetail:
      title: ProfileDetail
      type: object
      properties:
        id:
          title: Id
          description: The ID of the profile
          type: integer
        account_id:
          title: Account Id
          description: The ID of the account
          type: integer
        project_id:
          title: Project Id
          description: The ID of the project
          type: integer
        key:
          title: Key
          description: Unique name for the profile. The profile key must be unique
            per project and can only contain letters, numbers, dashes, and underscores.
            It must begin with a letter and end with a letter or number. It cannot
            contain consecutive dashes or underscores.
          type: string
        connection_id:
          title: Connection Id
          description: The ID of the connection
          type: integer
        credentials_id:
          title: Credentials Id
          description: The ID of the credentials
          type: integer
        extended_attributes_id:
          title: Extended Attributes Id
          description: The ID of the extended attributes
          type: integer
        primary_bindings:
          title: Primary Bindings
          description: The primary bindings for the profile
          type: array
          items:
            $ref: '#/components/schemas/ProfileEnvironmentBinding'
        catalog_bindings:
          title: Catalog Bindings
          description: The catalog bindings for the profile
          type: array
          items:
            $ref: '#/components/schemas/ProfileEnvironmentBinding'
      required:
      - id
      - account_id
      - project_id
      - key
      - connection_id
      - credentials_id
      - primary_bindings
      - catalog_bindings
    ProfileDetailResponse:
      title: ProfileDetailResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/ProfileDetail'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    ProfileEnvironmentBinding:
      title: ProfileEnvironmentBinding
      type: object
      properties:
        id:
          title: Id
          description: The ID of the environment binding
          type: integer
        name:
          title: Name
          description: The name of the environment binding
          type: string
        type:
          title: Type
          description: The type of the environment binding
          type: string
        deployment_type:
          title: Deployment Type
          description: The deployment type of the environment binding
          type: string
      required:
      - id
      - name
      - type
      - deployment_type
    ProfileList:
      title: ProfileList
      type: object
      properties:
        id:
          title: Id
          description: The ID of the profile
          type: integer
        account_id:
          title: Account Id
          description: The ID of the account
          type: integer
        project_id:
          title: Project Id
          description: The ID of the project
          type: integer
        key:
          title: Key
          description: Unique name for the profile. The profile key must be unique
            per project and can only contain letters, numbers, dashes, and underscores.
            It must begin with a letter and end with a letter or number. It cannot
            contain consecutive dashes or underscores.
          type: string
        connection_id:
          title: Connection Id
          description: The ID of the connection
          type: integer
        credentials_id:
          title: Credentials Id
          description: The ID of the credentials
          type: integer
        extended_attributes_id:
          title: Extended Attributes Id
          description: The ID of the extended attributes
          type: integer
        primary_bindings:
          title: Primary Bindings
          description: The primary bindings for the profile
          type: array
          items:
            $ref: '#/components/schemas/ProfileEnvironmentBinding'
        catalog_bindings:
          title: Catalog Bindings
          description: The catalog bindings for the profile
          type: array
          items:
            $ref: '#/components/schemas/ProfileEnvironmentBinding'
      required:
      - id
      - account_id
      - project_id
      - key
      - connection_id
      - credentials_id
      - primary_bindings
      - catalog_bindings
    ProfileListResponse:
      title: ProfileListResponse
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status'
        data:
          $ref: '#/components/schemas/ProfileList'
        extra:
          title: Extra
          type: object
        error_code:
          title: Error Code
          type: integer
      required:
      - data
    ProfileUpdateBodyRequest:
      title: ProfileUpdateBody
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        pk:
          title: Pk
          description: The ID of the Profile to be changed
          type: integer
        account_id:
          title: Account Id
          description: The ID of the account
          type: integer
        project_id:
          title: Project Id
          description: The ID of the project
          type: integer
        key:
          title: Key
          description: Unique name for the profile. The profile key must be unique
            per project and can only contain letters, numbers, dashes, and underscores.
            It must begin with a letter and end with a letter or number. It cannot
            contain consecutive dashes or underscores.
          default: null
          type: string
        connection_id:
          title: Connection Id
          description: The ID of the connection
          default: null
          type: integer
        credentials_id:
          title: Credentials Id
          description: The ID of the credentials
          default: null
          type: integer
        extended_attributes_id:
          title: Extended Attributes Id
          description: The ID of the extended attributes. Set to null to unset.
          default: null
          type: integer
      required:
      - pk
      - account_id
      - project_id
      additionalProperties: false
    Project:
      type: object
      properties:
        name:
          type: string
          description: The name of the project
        account_id:
          type: integer
          format: int64
          description: The account the project is associated with
        description:
          type: string
          description: The description of the project
        connection_id:
          type: integer
          format: int64
          description: The active connection
        repository_id:
          type: integer
          format: int64
          description: The active repository
        semantic_layer_config_id:
          type: integer
          format: int64
          description: The active semantic layer configuration
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        dbt_project_subdirectory:
          type: string
          description: The path in the associated repository where a dbt project can
            be found
        docs_job_id:
          type: integer
          format: int64
          description: The job used for docs generation
        freshness_job_id:
          type: integer
          format: int64
          description: The job used for source freshness generation
        type:
          allOf:
          - $ref: '#/components/schemas/Type24eEnum'
          description: |-
            The type of the project

            * `0` - DEFAULT
            * `1` - HYBRID
      required:
      - account_id
      - name
      - state
      - type
    ProjectEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProjectResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    ProjectListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProjectResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    ProjectRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: The name of the project
        account_id:
          type: integer
          format: int64
          description: The account the project is associated with
        description:
          type: string
          minLength: 1
          description: The description of the project
        connection_id:
          type: integer
          format: int64
          description: The active connection
        repository_id:
          type: integer
          format: int64
          description: The active repository
        semantic_layer_config_id:
          type: integer
          format: int64
          description: The active semantic layer configuration
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        dbt_project_subdirectory:
          type: string
          minLength: 1
          description: The path in the associated repository where a dbt project can
            be found
        docs_job_id:
          type: integer
          format: int64
          description: The job used for docs generation
        freshness_job_id:
          type: integer
          format: int64
          description: The job used for source freshness generation
        type:
          allOf:
          - $ref: '#/components/schemas/Type24eEnum'
          description: |-
            The type of the project

            * `0` - DEFAULT
            * `1` - HYBRID
      required:
      - account_id
      - name
      - state
      - type
    ProjectResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        name:
          type: string
          description: The name of the project
        account_id:
          type: integer
          format: int64
          description: The account the project is associated with
        description:
          type: string
          description: The description of the project
        connection_id:
          type: integer
          format: int64
          description: The active connection
        repository_id:
          type: integer
          format: int64
          description: The active repository
        semantic_layer_config_id:
          type: integer
          format: int64
          description: The active semantic layer configuration
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        dbt_project_subdirectory:
          type: string
          description: The path in the associated repository where a dbt project can
            be found
        docs_job_id:
          type: integer
          format: int64
          description: The job used for docs generation
        freshness_job_id:
          type: integer
          format: int64
          description: The job used for source freshness generation
        type:
          allOf:
          - $ref: '#/components/schemas/Type24eEnum'
          default: 0
          description: |-
            The type of the project

            * `0` - DEFAULT
            * `1` - HYBRID
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        connection:
          allOf:
          - $ref: '#/components/schemas/BaseConnectionV3'
          readOnly: true
        environments:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentV3'
          readOnly: true
        repository:
          allOf:
          - $ref: '#/components/schemas/RepositoryV3'
          readOnly: true
        group_permissions:
          type: array
          items:
            $ref: '#/components/schemas/GroupPermission'
          readOnly: true
        docs_job:
          allOf:
          - $ref: '#/components/schemas/JobDefinitionV2'
          readOnly: true
        freshness_job:
          allOf:
          - $ref: '#/components/schemas/JobDefinitionV2'
          readOnly: true
        fusion_readiness:
          readOnly: true
        default_version:
          type: string
          readOnly: true
          description: The default dbt version for new environments in this project.
            Only populated when the project is fetched directly; null when the project
            is included as a nested object on another resource.
      required:
      - connection
      - created_at
      - default_version
      - docs_job
      - environments
      - freshness_job
      - fusion_readiness
      - group_permissions
      - id
      - repository
      - updated_at
    PublicAuditLogListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicAuditLogResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    PublicAuditLogResponse:
      type: object
      properties:
        id:
          type: string
        account_id:
          type: integer
          format: int64
        source:
          type: string
        service:
          type: string
        actor: {}
        event_type:
          type: string
        event_label:
          type: string
        event_context: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
    Receipt:
      type: object
      properties:
        id:
          type: string
        event_id:
          type: string
        subscription_id:
          type: string
        dispatched_at:
          type: string
        http_status_code:
          type: string
        error_info:
          type: string
        request_body:
          type: string
        request_headers:
          type: string
        response_body:
          type: string
      required:
      - dispatched_at
      - error_info
      - event_id
      - http_status_code
      - id
      - request_body
      - request_headers
      - response_body
      - subscription_id
    RedshiftConnection:
      title: RedshiftConnection
      type: object
      properties:
        hostname:
          title: Hostname
          type: string
        dbname:
          title: Dbname
          type: string
        port:
          title: Port
          default: 5439
          exclusiveMinimum: 0
          maximum: 65535
          type: integer
        retries:
          title: Retries
          minimum: 0
          maximum: 10
          type: integer
      required:
      - hostname
      - dbname
    RedshiftCredentials:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        auth_type:
          $ref: '#/components/schemas/RedshiftCredentialsAuthTypeEnum'
        username:
          type: string
          default: ''
        default_schema:
          type: string
        target_name:
          type: string
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - auth_type
      - default_schema
      - state
      - target_name
      - threads
      - type
    RedshiftCredentialsAuthTypeEnum:
      enum:
      - password
      - external_oauth
      type: string
      description: |-
        * `password` - PASSWORD
        * `external_oauth` - OAUTH
    RedshiftCredentialsRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        auth_type:
          $ref: '#/components/schemas/RedshiftCredentialsAuthTypeEnum'
        username:
          type: string
          minLength: 1
          default: ''
        default_schema:
          type: string
          minLength: 1
        target_name:
          type: string
          minLength: 1
        password:
          type: string
          writeOnly: true
          minLength: 1
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - auth_type
      - default_schema
      - state
      - target_name
      - threads
      - type
    RemoteBackendEnum:
      enum:
      - ado
      - github
      - managed
      - gitlab
      - manual_config
      type: string
      description: |-
        * `ado` - ado
        * `github` - github
        * `managed` - managed
        * `gitlab` - gitlab
        * `manual_config` - manual_config
    ReplaceUserSCIMRequestRequest:
      title: ReplaceUserSCIMRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        schemas:
          title: Schemas
          description: The user schemas supported by the SCIM provider
          type: array
          items:
            type: string
        externalId:
          title: Externalid
          description: The external ID of the user (user's scim id)
          example: 12uhdfs0
          type: string
        userName:
          title: Username
          description: The username for the user which is their email address
          type: string
        active:
          title: Active
          description: Whether the user is active
          type: boolean
        name:
          title: Name
          description: The user's name components
          example:
            givenName: John
            familyName: Smith
          allOf:
          - $ref: '#/components/schemas/UserNameComponent'
        emails:
          title: Emails
          description: The user's email addresses
          example:
          - value: john.smith@example.com
            primary: true
          type: array
          items:
            $ref: '#/components/schemas/UserEmailComponent'
        urn:ietf:params:scim:schemas:extension:dbtLabs:2.0:User:
          title: Urn:Ietf:Params:Scim:Schemas:Extension:Dbtlabs:2.0:User
          description: Custom attributes for the user. This is where licenseType will
            be stored
          example:
            licenseType: developer
          allOf:
          - $ref: '#/components/schemas/CustomAttributesComponent'
      required:
      - schemas
      - userName
      - active
      - name
      - emails
    RepositoryGitlab:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        repository_id:
          type: integer
          format: int64
        gitlab_project_id:
          type: integer
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        project_access_token_id:
          type: integer
        expires_at:
          type: string
          format: date-time
      required:
      - account_id
      - gitlab_project_id
      - state
    RepositoryV3:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
          description: The account the repo is associated with
        project_id:
          type: integer
          format: int64
          description: The project the repo is associated with
        full_name:
          type: string
          description: The name of the repo⚠️ If not set to the correct values, CI
            jobs may not trigger and the branch link from the dbt Cloud IDE may not
            work.For example, if the remote URL is 'git://github.com/your_org/your_repo_name.git',the
            correct full_name is 'your_org/your_repo_name'.
        remote_backend:
          allOf:
          - $ref: '#/components/schemas/RemoteBackendEnum'
          description: |-
            The associated git provider⚠️ If not set to the correct values, CI jobs may not trigger and the branch link from the dbt Cloud IDE may not work.

            * `ado` - ado
            * `github` - github
            * `managed` - managed
            * `gitlab` - gitlab
            * `manual_config` - manual_config
        git_clone_strategy:
          allOf:
          - $ref: '#/components/schemas/GitCloneStrategyEnum'
          description: |-
            The strategy to use when cloning the repo

            * `azure_active_directory_app` - azure_active_directory_app
            * `deploy_key` - deploy_key
            * `deploy_token` - deploy_token
            * `github_app` - github_app
            * `git_token` - git_token
        deploy_key_id:
          type: integer
          format: int64
        repository_credentials_id:
          type: integer
          format: int64
        github_installation_id:
          type: integer
          format: int64
        github_webhook_id:
          type: integer
          format: int64
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        private_link_endpoint_id:
          type: string
        git_provider_id:
          type: integer
          format: int64
      required:
      - account_id
      - state
    RepositoryV3Enveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RepositoryV3Response'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    RepositoryV3ListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RepositoryV3Response'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    RepositoryV3Request:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
          description: The account the repo is associated with
        project_id:
          type: integer
          format: int64
          description: The project the repo is associated with
        full_name:
          type: string
          minLength: 1
          description: The name of the repo⚠️ If not set to the correct values, CI
            jobs may not trigger and the branch link from the dbt Cloud IDE may not
            work.For example, if the remote URL is 'git://github.com/your_org/your_repo_name.git',the
            correct full_name is 'your_org/your_repo_name'.
        remote_backend:
          allOf:
          - $ref: '#/components/schemas/RemoteBackendEnum'
          description: |-
            The associated git provider⚠️ If not set to the correct values, CI jobs may not trigger and the branch link from the dbt Cloud IDE may not work.

            * `ado` - ado
            * `github` - github
            * `managed` - managed
            * `gitlab` - gitlab
            * `manual_config` - manual_config
        git_clone_strategy:
          allOf:
          - $ref: '#/components/schemas/GitCloneStrategyEnum'
          description: |-
            The strategy to use when cloning the repo

            * `azure_active_directory_app` - azure_active_directory_app
            * `deploy_key` - deploy_key
            * `deploy_token` - deploy_token
            * `github_app` - github_app
            * `git_token` - git_token
        deploy_key_id:
          type: integer
          format: int64
        repository_credentials_id:
          type: integer
          format: int64
        github_installation_id:
          type: integer
          format: int64
        github_webhook_id:
          type: integer
          format: int64
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        private_link_endpoint_id:
          type: string
          minLength: 1
        git_provider_id:
          type: integer
          format: int64
      required:
      - account_id
      - state
    RepositoryV3Response:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
          description: The account the repo is associated with
        project_id:
          type: integer
          format: int64
          description: The project the repo is associated with
        full_name:
          type: string
          description: The name of the repo⚠️ If not set to the correct values, CI
            jobs may not trigger and the branch link from the dbt Cloud IDE may not
            work.For example, if the remote URL is 'git://github.com/your_org/your_repo_name.git',the
            correct full_name is 'your_org/your_repo_name'.
        remote_backend:
          allOf:
          - $ref: '#/components/schemas/RemoteBackendEnum'
          description: |-
            The associated git provider⚠️ If not set to the correct values, CI jobs may not trigger and the branch link from the dbt Cloud IDE may not work.

            * `ado` - ado
            * `github` - github
            * `managed` - managed
            * `gitlab` - gitlab
            * `manual_config` - manual_config
        git_clone_strategy:
          allOf:
          - $ref: '#/components/schemas/GitCloneStrategyEnum'
          description: |-
            The strategy to use when cloning the repo

            * `azure_active_directory_app` - azure_active_directory_app
            * `deploy_key` - deploy_key
            * `deploy_token` - deploy_token
            * `github_app` - github_app
            * `git_token` - git_token
        deploy_key_id:
          type: integer
          format: int64
        repository_credentials_id:
          type: integer
          format: int64
        github_installation_id:
          type: integer
          format: int64
        github_webhook_id:
          type: integer
          format: int64
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        private_link_endpoint_id:
          type: string
        git_provider_id:
          type: integer
          format: int64
        github_repo:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        web_url:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        deploy_key:
          allOf:
          - $ref: '#/components/schemas/DeployKey'
          readOnly: true
        git_provider:
          readOnly: true
        gitlab:
          allOf:
          - $ref: '#/components/schemas/RepositoryGitlab'
          readOnly: true
        is_private_link_enabled:
          type: boolean
          readOnly: true
          default: false
          description: Whether the repository is using a private link endpoint
      required:
      - created_at
      - deploy_key
      - git_provider
      - github_repo
      - gitlab
      - id
      - is_private_link_enabled
      - name
      - updated_at
      - web_url
    ResponseData:
      type: object
      properties:
        message:
          type: string
        new_var_ids:
          type: array
          items:
            type: integer
        failures:
          description: This field will detail specific failures within a single environment
            variable you are attempting to create.
      required:
      - message
      - new_var_ids
    ResponseStatus:
      type: object
      properties:
        code:
          type: integer
          default: 200
          description: HTTP status code
        is_success:
          type: boolean
          description: Whether the request was successful or not
        user_message:
          type: string
          description: End-user friendly success or error message
        developer_message:
          type: string
          description: Developer friendly success or error message
      required:
      - developer_message
      - is_success
      - user_message
    SCIMConfig:
      title: SCIMConfig
      type: object
      properties:
        enabled:
          title: Enabled
          type: boolean
        manual_updates_allowed:
          title: Manual Updates Allowed
          type: boolean
        scim_controlled_license_type:
          title: Scim Controlled License Type
          type: boolean
      required:
      - enabled
      - manual_updates_allowed
      - scim_controlled_license_type
    SCIMList:
      title: SCIMList
      type: object
      properties:
        schemas:
          title: Schemas
          description: The SCIM schema of the response
          default:
          - urn:ietf:params:scim:api:messages:2.0:ListResponse
          type: array
          items:
            type: string
        totalResults:
          title: Totalresults
          description: The total number of results
          type: integer
        startIndex:
          title: Startindex
          description: The start index of the results
          type: integer
        itemsPerPage:
          title: Itemsperpage
          description: The number of results per page
          type: integer
        Resources:
          title: Resources
          description: The list of resources
          type: array
          items: {}
      required:
      - totalResults
      - startIndex
      - itemsPerPage
      - Resources
    SCIMResourceType:
      title: SCIMResourceType
      type: object
      properties:
        schemas:
          title: Schemas
          description: The SCIM schema of the resource type
          default:
          - urn:ietf:params:scim:schemas:core:2.0:ResourceType
          type: array
          items:
            type: string
        id:
          title: Id
          description: The ID of the resource type
          type: string
        name:
          title: Name
          description: The name of the resource type
          type: string
        endpoint:
          title: Endpoint
          description: The endpoint to access the resource type
          type: string
        description:
          title: Description
          description: The description of the resource type
          type: string
        schema:
          title: Schema
          description: The schema of the resource type
          type: string
        schemaExtensions:
          title: Schemaextensions
          description: The extension schemas supported by the resource type
          type: array
          items:
            $ref: '#/components/schemas/SCIMSchemaExtension'
        meta:
          title: Meta
          description: The metadata of the resource type
          allOf:
          - $ref: '#/components/schemas/MetaComponent'
      required:
      - id
      - name
      - endpoint
      - description
      - schema
      - meta
    SCIMSchemaExtension:
      title: SCIMSchemaExtension
      type: object
      properties:
        schema:
          title: Schema
          description: The URI of an extension schema supported by the resource type
          type: string
        required:
          title: Required
          description: Whether the extension schema is required for the resource type
          type: boolean
      required:
      - schema
      - required
    SCIMToken:
      title: SCIMToken
      type: object
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        created_at:
          title: Created At
          type: string
          format: date-time
        last_used:
          title: Last Used
          type: string
          format: date-time
      required:
      - id
      - name
      - created_at
    SalesforceConnection:
      title: SalesforceConnection
      type: object
      properties:
        login_url:
          title: Login Url
          maxLength: 255
          minLength: 1
          type: string
        database:
          title: Database
          default: default
          maxLength: 255
          minLength: 1
          type: string
        data_transform_run_timeout:
          title: Data Transform Run Timeout
          default: 180000
          type: integer
        auth_type:
          default: jwt_bearer
          allOf:
          - $ref: '#/components/schemas/schemas__adapters__salesforce__connection_schema__AuthType'
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - login_url
    Schema:
      type: object
      properties:
        field_order:
          type: array
          items:
            type: string
          description: The field order for display in the UI
        field_groups:
          type: array
          items:
            $ref: '#/components/schemas/FieldGroup'
          description: Specification of how certain fields should be grouped
    SchemaTypeEnum:
      enum:
      - semantic_layer_credentials
      type: string
      description: '* `semantic_layer_credentials` - semantic_layer_credentials'
    SemanticLayerCredentialsListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SemanticLayerCredentialsResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    SemanticLayerCredentialsResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
          description: The account the credentials are associated with
        project_id:
          type: integer
          format: int64
          description: The project the credentials are associated with
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The adapter version. Should match the associated project's adapter version.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
        schema_type:
          allOf:
          - $ref: '#/components/schemas/SchemaTypeEnum'
          default: semantic_layer_credentials
          description: |-
            The adapter schema type. Always is 'semantic_layer_credentials'

            * `semantic_layer_credentials` - semantic_layer_credentials
        name:
          type: string
          description: The user-facing name to identify these credentials.
        values:
          description: Key/val pairs of creds values. When returned via API, encrypted
            values will be excluded.
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        service_tokens:
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenLite'
          readOnly: true
      required:
      - created_at
      - id
      - service_tokens
      - updated_at
    ServiceToken:
      title: ServiceToken
      type: object
      properties:
        id:
          title: Id
          type: integer
        created_at:
          title: Created At
          type: string
          format: date-time
        updated_at:
          title: Updated At
          type: string
          format: date-time
        account_id:
          title: Account Id
          description: The account the service token is associated with
          type: integer
        uid:
          title: Uid
          description: The unique identifier for the service token
          type: string
        name:
          title: Name
          description: The name of the service token
          type: string
        state:
          title: State
          description: The liveness state of the service token. A value of 1 means
            this entity is active and a value of 2 means this entity is deleted
          type: integer
        permission_grants:
          title: Permission Grants
          description: The permissions to be assigned to the service token
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenPermissionGrant'
        last_used:
          title: Last Used
          description: The time the service token was last used
          type: string
          format: date-time
        semantic_layer_credentials:
          title: Semantic Layer Credentials
          description: The semantic layer credentials associated with the service
            token
          type: array
          items:
            type: object
        metadata_only:
          title: Metadata Only
          description: Deprecated. Use the metadata_only permission set instead.
          default: false
          type: boolean
        webhooks_only:
          title: Webhooks Only
          default: false
          type: boolean
      required:
      - id
      - created_at
      - updated_at
      - account_id
      - uid
      - name
      - state
    ServiceTokenListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    ServiceTokenLite:
      type: object
      properties:
        id:
          type: integer
          format: int64
        account_id:
          type: integer
          format: int64
        uid:
          type: string
        name:
          type: string
      required:
      - account_id
      - name
      - uid
    ServiceTokenPermission:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        service_token_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        all_projects:
          type: boolean
        permission_set:
          $ref: '#/components/schemas/PermissionSetEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        writable_environment_categories:
          type: array
          items:
            type: string
      required:
      - account_id
      - all_projects
      - permission_set
      - service_token_id
      - state
      - writable_environment_categories
    ServiceTokenPermissionGrant:
      title: ServiceTokenPermissionGrant
      type: object
      properties:
        permission_set:
          $ref: '#/components/schemas/PredefinedPermissionSet'
        project_id:
          title: Project Id
          description: The project to which the permissions are scoped. If none, then
            the permissions apply to all projects.
          type: integer
        writable_environment_categories:
          title: Writable Environment Categories
          type: array
          items:
            type: string
      required:
      - permission_set
    ServiceTokenPermissionListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenPermissionResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    ServiceTokenPermissionResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        service_token_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        all_projects:
          type: boolean
        permission_set:
          $ref: '#/components/schemas/PermissionSetEnum'
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        writable_environment_categories:
          type: array
          items:
            type: string
          default: []
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - updated_at
    ServiceTokenResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
        uid:
          type: string
        name:
          type: string
        token:
          type: string
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        token_string:
          type: string
          readOnly: true
        last_used:
          type: string
          format: date-time
          readOnly: true
        last_identify:
          type: string
          format: date-time
          readOnly: true
        user_id:
          type: integer
          format: int64
        user:
          $ref: '#/components/schemas/User'
        type:
          $ref: '#/components/schemas/Type34eEnum'
        expires_at:
          type: string
          format: date-time
        metadata_only:
          type: boolean
          default: false
        webhooks_only:
          type: boolean
          default: false
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        service_token_permissions:
          type: array
          items:
            $ref: '#/components/schemas/ServiceTokenPermission'
          readOnly: true
          default: []
      required:
      - created_at
      - id
      - last_identify
      - last_used
      - service_token_permissions
      - token_string
      - updated_at
    ServiceTokenType:
      title: ServiceTokenType
      description: An enumeration.
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
    SnowflakeConnection:
      title: SnowflakeConnection
      type: object
      properties:
        account:
          title: Account
          maxLength: 255
          minLength: 1
          type: string
        database:
          title: Database
          maxLength: 255
          minLength: 1
          type: string
        warehouse:
          title: Warehouse
          maxLength: 255
          minLength: 1
          type: string
        client_session_keep_alive:
          title: Client Session Keep Alive
          default: false
          type: boolean
        role:
          title: Role
          maxLength: 255
          minLength: 1
          type: string
        allow_sso:
          title: Allow Sso
          default: false
          type: boolean
        oauth_client_id:
          title: Oauth Client Id
          write_only: true
          type: string
          writeOnly: true
          format: password
        oauth_client_secret:
          title: Oauth Client Secret
          write_only: true
          type: string
          writeOnly: true
          format: password
      required:
      - account
      - database
      - warehouse
    SnowflakeCredentials:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        auth_type:
          $ref: '#/components/schemas/SnowflakeCredentialsAuthTypeEnum'
        schema:
          type: string
        user:
          type: string
        target_name:
          type: string
        role:
          type: string
        database:
          type: string
        warehouse:
          type: string
        _refresh_token:
          type: string
          title: ' refresh token'
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - auth_type
      - schema
      - state
      - target_name
      - threads
      - type
    SnowflakeCredentialsAuthTypeEnum:
      enum:
      - password
      - keypair
      - sso
      - external_oauth
      type: string
      description: |-
        * `password` - PASSWORD
        * `keypair` - KEYPAIR
        * `sso` - SSO
        * `external_oauth` - EXTERNAL_OAUTH
    SnowflakeCredentialsRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        type:
          $ref: '#/components/schemas/ConnectionTypeEnum'
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        threads:
          type: integer
        auth_type:
          $ref: '#/components/schemas/SnowflakeCredentialsAuthTypeEnum'
        schema:
          type: string
          minLength: 1
        user:
          type: string
          minLength: 1
        target_name:
          type: string
          minLength: 1
        role:
          type: string
          minLength: 1
        database:
          type: string
          minLength: 1
        warehouse:
          type: string
          minLength: 1
        _refresh_token:
          type: string
          minLength: 1
          title: ' refresh token'
        password:
          type: string
          writeOnly: true
          minLength: 1
        private_key:
          type: string
          writeOnly: true
          minLength: 1
        private_key_passphrase:
          type: string
          writeOnly: true
          minLength: 1
        adapter_version:
          allOf:
          - $ref: '#/components/schemas/AdapterVersionEnum'
          description: |-
            The version of the adapter used to create this connection. Can use instead of adapter_id.

            * `apache_spark_v0` - apache_spark_v0
            * `databricks_spark_v0` - databricks_spark_v0
            * `databricks_v0` - databricks_v0
            * `trino_v0` - trino_v0
            * `snowflake_v0` - snowflake_v0
            * `bigquery_v0` - bigquery_v0
            * `bigquery_v1` - bigquery_v1
            * `postgres_v0` - postgres_v0
            * `redshift_v0` - redshift_v0
            * `salesforce_v0` - salesforce_v0
            * `synapse_v0` - synapse_v0
            * `fabric_v0` - fabric_v0
            * `athena_v0` - athena_v0
            * `teradata_v0` - teradata_v0
            * `clickhouse_v0` - clickhouse_v0
      required:
      - account_id
      - auth_type
      - schema
      - state
      - target_name
      - threads
      - type
    Status:
      title: Status
      type: object
      properties:
        code:
          title: Code
          type: integer
        is_success:
          title: Is Success
          type: boolean
        user_message:
          title: User Message
          type: string
        developer_message:
          title: Developer Message
          default: ''
          type: string
    Subscription:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: Webhook name
        description:
          type: string
          description: Webhook description
        event_types:
          type: array
          items: {}
          description: Event types that trigger this webhook. Must not be empty.
        job_ids:
          type: array
          items:
            type: integer
          description: Job IDs that trigger this webhook. Leave empty to trigger for
            all jobs.
        client_url:
          type: string
          description: Endpoint where events are sent
        active:
          type: boolean
          description: Whether or not this Webhook is currently active
        http_status_code:
          type: string
          description: The latest HTTP status code received from the client URL. 0
            indicates that the webhook has not been dispatched.
        dispatched_at:
          type: string
          description: Timestamp of when the webhook was last dispatched.
        deactivate_reason:
          type: string
          description: Reason for deactivation
        account_id:
          type: integer
          format: int64
        account_identifier:
          type: string
      required:
      - active
      - client_url
      - event_types
      - name
    SubscriptionRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        name:
          type: string
          minLength: 1
          description: Webhook name
        description:
          type: string
          minLength: 1
          description: Webhook description
        event_types:
          type: array
          items: {}
          description: Event types that trigger this webhook. Must not be empty.
        job_ids:
          type: array
          items:
            type: integer
          description: Job IDs that trigger this webhook. Leave empty to trigger for
            all jobs.
        client_url:
          type: string
          minLength: 1
          description: Endpoint where events are sent
        active:
          type: boolean
          description: Whether or not this Webhook is currently active
        http_status_code:
          type: string
          minLength: 1
          description: The latest HTTP status code received from the client URL. 0
            indicates that the webhook has not been dispatched.
        dispatched_at:
          type: string
          minLength: 1
          description: Timestamp of when the webhook was last dispatched.
        deactivate_reason:
          type: string
          minLength: 1
          description: Reason for deactivation
        account_id:
          type: integer
          format: int64
        account_identifier:
          type: string
          minLength: 1
      required:
      - active
      - client_url
      - event_types
      - name
    SubscriptionResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Subscription'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
      required:
      - data
      - status
    SynapseConnection:
      title: SynapseConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        database:
          title: Database
          type: string
        driver:
          title: Driver
          default: ODBC Driver 18 for SQL Server
          type: string
        port:
          title: Port
          default: 1433
          exclusiveMinimum: 0
          maximum: 65535
          type: integer
        retries:
          title: Retries
          default: 1
          type: integer
        login_timeout:
          title: Login Timeout
          default: 0
          type: integer
        query_timeout:
          title: Query Timeout
          default: 0
          type: integer
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - host
      - database
    TeradataConnection:
      title: TeradataConnection
      type: object
      properties:
        port:
          title: Port
          type: string
        tmode:
          title: Tmode
          default: ANSI
          const: ANSI
          type: string
        host:
          title: Host
          type: string
        retries:
          title: Retries
          type: integer
        request_timeout:
          title: Request Timeout
          type: integer
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - host
    TestSubscriptionResponseData:
      type: object
      properties:
        event_id:
          type: string
      required:
      - event_id
    TestSubscriptionResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TestSubscriptionResponseData'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
      required:
      - data
      - status
    TrinoConnection:
      title: TrinoConnection
      type: object
      properties:
        host:
          title: Host
          type: string
        method:
          title: Method
          default: ldap
          type: string
        port:
          title: Port
          default: 443
          exclusiveMinimum: 0
          maximum: 65535
          type: integer
        adapter_id:
          title: Adapter Id
          description: Deprecated, use connection_details.adapter_version
          type: integer
      required:
      - host
    Type24eEnum:
      enum:
      - 0
      - 1
      type: integer
      description: |-
        * `0` - DEFAULT
        * `1` - HYBRID
    Type34eEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: |-
        * `1` - CLOUD_CLI
        * `2` - GENERAL
        * `3` - NATIVE_APP_USER_LINK
        * `4` - SCIM
    Type76eEnum:
      enum:
      - development
      - deployment
      type: string
      description: |-
        * `development` - DEVELOPMENT
        * `deployment` - DEPLOYMENT
    TypeEdaEnum:
      enum:
      - 1
      - 2
      type: integer
      description: |-
        * `1` - ALLOW
        * `2` - DENY
    UpdateIPRestrictionRequestRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
        type:
          $ref: '#/components/schemas/TypeEdaEnum'
        rule_set_enabled:
          type: boolean
        account_id:
          type: integer
        cidrs:
          type: array
          items:
            $ref: '#/components/schemas/IPRestrictionCidrRequestRequest'
        description:
          type: string
          minLength: 1
        id:
          type: integer
      required:
      - account_id
      - cidrs
      - id
      - name
      - rule_set_enabled
      - type
    UpdateServiceTokenRequestRequest:
      title: UpdateServiceTokenRequest
      description: Request body for updating a service token name.
      type: object
      properties:
        name:
          title: Name
          description: The name of the service token
          type: string
      required:
      - name
    UpdateSubscriptionResponseEnvelope:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Subscription'
        status:
          $ref: '#/components/schemas/WebhookResponseStatus'
      required:
      - data
      - status
    UpdateUserSCIMRequestRequest:
      title: UpdateUserSCIMRequest
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        schemas:
          title: Schemas
          description: The user schemas supported by the SCIM provider
          type: array
          items:
            type: string
        Operations:
          title: Operations
          description: The operations to perform on the user
          type: array
          items:
            $ref: '#/components/schemas/UserOperationComponent'
      required:
      - schemas
      - Operations
    User:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
      required:
      - first_name
      - last_name
    UserCredentialsEnveloped:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UserCredentialsResponse'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - status
    UserCredentialsListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserCredentialsResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    UserCredentialsRequest:
      type: object
      properties:
        account_id:
          type: integer
          format: int64
          description: The account the user credentials are associated with
        user_id:
          type: integer
          format: int64
          description: The user the user credentials are associated with
        project_id:
          type: integer
          format: int64
          description: The project the user credentials are associated with
        credentials_id:
          type: integer
          format: int64
          description: The credentials the user is associated with
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
      required:
      - account_id
      - credentials_id
      - project_id
      - state
      - user_id
    UserCredentialsResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        account_id:
          type: integer
          format: int64
          description: The account the user credentials are associated with
        user_id:
          type: integer
          format: int64
          description: The user the user credentials are associated with
        project_id:
          type: integer
          format: int64
          description: The project the user credentials are associated with
        credentials_id:
          type: integer
          format: int64
          description: The credentials the user is associated with
        state:
          example: 1
          type: integer
          default: 1
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        credentials:
          allOf:
          - $ref: '#/components/schemas/PostgresCredentials'
          readOnly: true
        project:
          allOf:
          - $ref: '#/components/schemas/Project'
          readOnly: true
      required:
      - created_at
      - credentials
      - id
      - project
      - updated_at
    UserEmailComponent:
      title: UserEmailComponent
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        value:
          title: Value
          description: The email address of the user
          default: ''
          type: string
        primary:
          title: Primary
          description: Whether the email address is the primary email address of the
            user
          default: false
          type: boolean
        type:
          title: Type
          description: The type of the email address
          default: work
          type: string
    UserGroupComponent:
      title: UserGroupComponent
      type: object
      properties:
        id:
          title: Id
          description: The ID of the group
          type: string
        externalId:
          title: Externalid
          description: The external ID of the group
          type: string
        displayName:
          title: Displayname
          description: The display name of the group
          type: string
        members:
          title: Members
          description: The members of the group
          type: array
          items:
            $ref: '#/components/schemas/GroupMemberComponent'
        meta:
          title: Meta
          description: The metadata of the group
          allOf:
          - $ref: '#/components/schemas/MetaComponent'
        schemas:
          title: Schemas
          default:
          - urn:ietf:params:scim:schemas:core:2.0:Group
          type: array
          items: {}
        value:
          title: Value
          description: The ID of the group
          type: string
        display:
          title: Display
          description: The display name of the group
          type: string
      required:
      - id
      - displayName
      - meta
      - value
      - display
    UserLicense:
      type: object
      properties:
        license_type:
          type: string
          description: The type of license, e.g. `developer` or `read_only`
        state:
          example: 1
          type: integer
          description: A value of 1 means this entity is active and a value of 2 means
            this entity is deleted
      required:
      - license_type
      - state
    UserListEnveloped:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserResponse'
        extra:
          $ref: '#/components/schemas/Extra'
        status:
          $ref: '#/components/schemas/ResponseStatus'
      required:
      - data
      - extra
      - status
    UserNameComponent:
      title: UserNameComponent
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        givenName:
          title: Givenname
          description: The given name of the user
          default: ''
          type: string
        familyName:
          title: Familyname
          description: The family name of the user
          default: ''
          type: string
    UserOperationComponent:
      title: UserOperationComponent
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        op:
          description: The operation to perform on the user
          allOf:
          - $ref: '#/components/schemas/PatchOp'
        value:
          title: Value
          description: The value to perform the operation on
          anyOf:
          - $ref: '#/components/schemas/UserValueComponent'
          - type: string
        path:
          title: Path
          description: The path to the value to perform the operation on
          type: string
      required:
      - op
      - value
    UserResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
          readOnly: true
        apitoken_last_used:
          type: string
          format: date-time
          readOnly: true
        azure_active_directory_connected:
          type: boolean
          readOnly: true
          default: false
        azure_active_directory_token_retrieval_failure:
          type: boolean
          readOnly: true
        azure_active_directory_username:
          type: string
          readOnly: true
        email_connected:
          type: boolean
          readOnly: true
          default: false
        email_verified:
          type: boolean
          readOnly: true
          default: false
        enterprise_connected:
          type: boolean
          readOnly: true
          default: false
        enterprise_authentication_method:
          type: string
          readOnly: true
        github_connected:
          type: boolean
          readOnly: true
          default: false
        github_username:
          type: string
          readOnly: true
        gitlab_connected:
          type: boolean
          readOnly: true
          default: false
        gitlab_username:
          type: string
          readOnly: true
        is_active:
          type: boolean
          readOnly: true
          default: false
        is_staff:
          type: boolean
          readOnly: true
          default: false
        last_login:
          type: string
          format: date-time
          readOnly: true
        show_existing_user_email_verification:
          type: boolean
          readOnly: true
        sso_only_user:
          type: boolean
          readOnly: true
        github_token_retrieval_failure:
          type: boolean
          readOnly: true
        gitlab_token_retrieval_failure:
          type: boolean
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/UserLicense'
          readOnly: true
        auth_provider_infos:
          readOnly: true
        licenses:
          readOnly: true
      required:
      - apitoken_last_used
      - auth_provider_infos
      - azure_active_directory_connected
      - azure_active_directory_token_retrieval_failure
      - azure_active_directory_username
      - created_at
      - email
      - email_connected
      - email_verified
      - enterprise_authentication_method
      - enterprise_connected
      - github_connected
      - github_token_retrieval_failure
      - github_username
      - gitlab_connected
      - gitlab_token_retrieval_failure
      - gitlab_username
      - id
      - is_active
      - is_staff
      - last_login
      - licenses
      - permissions
      - show_existing_user_email_verification
      - sso_only_user
    UserSCIM:
      title: UserSCIM
      type: object
      properties:
        id:
          title: Id
          description: The unique identifier for the user
          type: string
        externalId:
          title: Externalid
          description: The external ID of the user (user's scim id)
          example: 12uhdfs0
          type: string
        userName:
          title: Username
          description: The username for the user which is their email address
          type: string
        active:
          title: Active
          description: Whether the user is active
          type: boolean
        schemas:
          title: Schemas
          description: The schemas supported by the SCIM provider
          default:
          - urn:ietf:params:scim:schemas:core:2.0:User
          - urn:ietf:params:scim:schemas:extension:dbtLabs:2.0:User
          type: array
          items:
            type: string
        name:
          title: Name
          description: The user's name components
          example:
            givenName: John
            familyName: Smith
          allOf:
          - $ref: '#/components/schemas/UserNameComponent'
        emails:
          title: Emails
          description: The user's email addresses
          example:
          - value: john.smith@example.com
            primary: 'True'
          type: array
          items:
            $ref: '#/components/schemas/UserEmailComponent'
        groups:
          title: Groups
          description: The groups the user belongs to
          example:
          - value: '1234'
            externalId: group-1234
            display: Example Group
          type: array
          items:
            $ref: '#/components/schemas/UserGroupComponent'
        meta:
          title: Meta
          description: The metadata for the user
          example:
            resourceType: User
            created: '2024-01-01T00:00:00+00:00'
            lastModified: '2024-01-01T00:00:00+00:00'
            location: /scim/v2/Users/1111
          allOf:
          - $ref: '#/components/schemas/MetaComponent'
        urn:ietf:params:scim:schemas:extension:dbtLabs:2.0:User:
          title: Urn:Ietf:Params:Scim:Schemas:Extension:Dbtlabs:2.0:User
          description: Custom attributes for the user. This is where licenseType will
            be stored
          example:
            licenseType: developer
          allOf:
          - $ref: '#/components/schemas/CustomAttributesComponent'
      required:
      - id
      - userName
      - active
      - name
      - emails
      - meta
    UserValueComponent:
      title: UserValueComponent
      description: |-
        Base class for all request payloads.
        It is expected that each endpoint extends this class to define its own payload format
      type: object
      properties:
        active:
          title: Active
          description: The active status of the user
          type: boolean
      required:
      - active
    V3RequestParams:
      title: V3RequestParams
      description: |-
        Base class for all URL request parameters.
        It is expected that each endpoint extends this class to define its own parameters format
      type: object
      properties: {}
    V3ResponseExtraData:
      title: V3ResponseExtraData
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/V3RequestParams'
        order_by:
          title: Order By
          anyOf:
          - type: string
          - type: array
            items:
              type: string
        pagination:
          $ref: '#/components/schemas/V3ResponsePagination'
      required:
      - pagination
    V3ResponsePagination:
      title: V3ResponsePagination
      type: object
      properties:
        count:
          title: Count
          type: integer
        total_count:
          title: Total Count
          type: integer
      required:
      - count
      - total_count
    WatchSelectionItem:
      title: WatchSelectionItem
      type: object
      properties:
        identifier:
          title: Identifier
          type: string
        name:
          title: Name
          type: string
        type:
          $ref: '#/components/schemas/WatchSelectionType'
        watching:
          title: Watching
          type: boolean
      required:
      - identifier
      - name
      - type
    WatchSelectionType:
      title: WatchSelectionType
      description: An enumeration.
      enum:
      - folder
      - dashboard
      type: string
    WebhookResponseStatus:
      type: object
      properties:
        code:
          type: integer
      required:
      - code
    schemas__adapters__bigquery__v0__connection_schema__Priority:
      title: Priority
      description: An enumeration.
      enum:
      - interactive
      - batch
      type: string
    schemas__adapters__bigquery__v1__connection_schema__Priority:
      title: Priority
      description: An enumeration.
      enum:
      - interactive
      - batch
      type: string
    schemas__adapters__lake_compute__connection_schema__AuthType:
      title: AuthType
      description: An enumeration.
      enum:
      - token
      type: string
    schemas__adapters__salesforce__connection_schema__AuthType:
      title: AuthType
      description: An enumeration.
      enum:
      - jwt_bearer
      type: string
  securitySchemes:
    BearerAuthentication:
      type: http
      scheme: bearer
      bearerFormat: Bearer
servers:
- url: https://cloud.getdbt.com/
  description: Production (US)
- url: https://{account_prefix}.us1.dbt.com/
  description: Production (US)
  variables:
    account_prefix:
      default: ab123
      description: Your unique account prefix. Can be found on your account settings
        page.
- url: https://emea.dbt.com/
  description: Production (Europe)
- url: https://au.dbt.com/
  description: Production (AU)