Google Cloud Data Catalog Organizations API

The Organizations API from Google Cloud Data Catalog — 4 operation(s) for organizations.

GitHub OpenAPI

Operations 5

GET /v1/organizations/{organizationsId}/locations/{locationsId}:retrieveEffectiveConfig Retrieve effective config locations #
POST /v1/organizations/{organizationsId}/locations/{locationsId}:setConfig Set config locations #
GET /v1/organizations/{organizationsId}/locations/{locationsId}:retrieveConfig Retrieve config locations #
PATCH /v1/organizations/{organizationsId}/locations/{locationsId}/config Patch config #
GET /v1/organizations/{organizationsId}/locations/{locationsId}/config Get config #

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for apis

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

Call it yourself

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

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

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

OpenAPI Specification

google-cloud-data-catalog-organizations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Google Cloud Data Catalog Organizations API
  version: v1
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
  description: 'Operations tagged Organizations across 2 of this provider''s published API definitions: google-cloud-data-catalog-datacatalog-organizations-api-openapi.yml, google-cloud-data-catalog-datalineage-organizations-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://datacatalog.googleapis.com
- url: https://datalineage.googleapis.com
tags:
- name: Organizations
paths:
  /v1/organizations/{organizationsId}/locations/{locationsId}:retrieveEffectiveConfig:
    get:
      operationId: datacatalog.organizations.locations.retrieveEffectiveConfig
      summary: Retrieve effective config locations
      description: Retrieves the effective configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogV1MigrationConfig'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      deprecated: true
      tags:
      - Organizations
    servers:
    - url: https://datacatalog.googleapis.com
  /v1/organizations/{organizationsId}/locations/{locationsId}:setConfig:
    post:
      operationId: datacatalog.organizations.locations.setConfig
      summary: Set config locations
      description: Sets the configuration related to the migration to Dataplex Universal Catalog for an organization or project.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDatacatalogV1SetConfigRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogV1MigrationConfig'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      deprecated: true
      tags:
      - Organizations
    servers:
    - url: https://datacatalog.googleapis.com
  /v1/organizations/{organizationsId}/locations/{locationsId}:retrieveConfig:
    get:
      operationId: datacatalog.organizations.locations.retrieveConfig
      summary: Retrieve config locations
      description: Retrieves the configuration related to the migration from Data Catalog to Dataplex Universal Catalog for a specific organization, including all the projects under it which have a separate configuration set.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogV1OrganizationConfig'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      deprecated: true
      tags:
      - Organizations
    servers:
    - url: https://datacatalog.googleapis.com
  /v1/organizations/{organizationsId}/locations/{locationsId}/config:
    patch:
      operationId: datalineage.organizations.locations.config.patch
      summary: Patch config
      description: Update the Config for a given resource.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1Config'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1Config'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Organizations
    get:
      operationId: datalineage.organizations.locations.config.get
      summary: Get config
      description: Get the Config for a given resource.
      parameters:
      - name: organizationsId
        in: path
        required: true
        description: Resource name segment (organizationsId).
        schema:
          type: string
      - name: locationsId
        in: path
        required: true
        description: Resource name segment (locationsId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1Config'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Organizations
    servers:
    - url: https://datalineage.googleapis.com
components:
  schemas:
    GoogleCloudDatacatalogV1SetConfigRequest:
      type: object
      description: Request message for SetConfig.
      properties:
        tagTemplateMigration:
          enum:
          - TAG_TEMPLATE_MIGRATION_UNSPECIFIED
          - TAG_TEMPLATE_MIGRATION_ENABLED
          - TAG_TEMPLATE_MIGRATION_DISABLED
          type: string
          description: Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog.
        catalogUiExperience:
          description: Opt-in status for the UI switch to Dataplex Universal Catalog.
          enum:
          - CATALOG_UI_EXPERIENCE_UNSPECIFIED
          - CATALOG_UI_EXPERIENCE_ENABLED
          - CATALOG_UI_EXPERIENCE_DISABLED
          type: string
    GoogleCloudDatacatalogV1OrganizationConfig:
      description: The configuration related to the migration from Data Catalog to Dataplex Universal Catalog that has been applied to an organization and any projects under it. It is the response message for RetrieveConfig.
      properties:
        config:
          description: Map of organizations and project resource names and their configuration. The format for the map keys is `organizations/{organizationId}` or `projects/{projectId}`.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/GoogleCloudDatacatalogV1MigrationConfig'
      type: object
    GoogleCloudDatacatalogV1MigrationConfig:
      type: object
      description: The configuration related to the migration to Dataplex Universal Catalog applied to an organization or project. It is the response message for SetConfig and RetrieveEffectiveConfig.
      properties:
        tagTemplateMigration:
          enum:
          - TAG_TEMPLATE_MIGRATION_UNSPECIFIED
          - TAG_TEMPLATE_MIGRATION_ENABLED
          - TAG_TEMPLATE_MIGRATION_DISABLED
          type: string
          description: Opt-in status for the migration of Tag Templates to Dataplex Universal Catalog.
        catalogUiExperience:
          description: Opt-in status for the UI switch to Dataplex Universal Catalog.
          type: string
          enum:
          - CATALOG_UI_EXPERIENCE_UNSPECIFIED
          - CATALOG_UI_EXPERIENCE_ENABLED
          - CATALOG_UI_EXPERIENCE_DISABLED
        templateMigrationEnabledTime:
          format: google-datetime
          description: The time when the Tag Template migration was enabled. If the Tag Template migration is not enabled, this field is not set.
          type: string
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleLineageEnablement:
      description: Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children.
      type: object
      properties:
        enabled:
          description: Optional. If true, ingestion of lineage should be enabled. If false, it should be disabled. If unspecified, the system default value is used.
          type: boolean
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleIntegrationSelector:
      type: object
      properties:
        integration:
          description: Required. Integration to which the rule applies. This field can be used to specify the integration against which the ingestion rule should be applied.
          type: string
          enum:
          - INTEGRATION_UNSPECIFIED
          - BIGQUERY
          - DATAPROC
          - LOOKER_CORE
          - MANAGED_AIRFLOW
      description: Integration selector of the rule. The rule is only applied to the Integration selected by the selector.
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRule:
      properties:
        lineageEnablement:
          $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleLineageEnablement'
          description: Required. Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children. If unspecified, the ingestion will be enabled only if it was configured in the resource's parent.
        integrationSelector:
          $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleIntegrationSelector'
          description: Required. Integration selector of the rule. The rule is only applied to the Integration selected by the selector.
      description: Ingestion rule for Data Lineage ingestion.
      type: object
    GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestion:
      description: Defines how Lineage should be ingested for a given resource.
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRule'
          description: Optional. List of rules for Data Lineage ingestion.
    GoogleCloudDatacatalogLineageConfigmanagementV1Config:
      type: object
      properties:
        name:
          description: 'Identifier. The resource name of the config. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`'
          type: string
        etag:
          description: 'Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a config from overwriting each other. It is required that systems make use of the `etag` in the read-modify-write cycle to perform config updates in order to avoid race conditions: An `etag` is returned in the response to `GetConfig`, and systems are expected to put that etag in the request to `UpdateConfig` to ensure that their change will be applied to the same version of the config. If an `etag` is not provided in the call to `UpdateConfig`, then the existing config, if any, will be overwritten.'
          type: string
        ingestion:
          $ref: '#/components/schemas/GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestion'
          description: Optional. Ingestion rule for Data Lineage ingestion.
      description: Configuration for Data Lineage. Defines different configuration options for Lineage customers to control behaviour of lineage systems.
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
x-refined-from:
- google-cloud-data-catalog-datacatalog-organizations-api-openapi.yml
- google-cloud-data-catalog-datalineage-organizations-api-openapi.yml
x-provenance:
  method: harvested
  publisher: Google
  source: https://datacatalog.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)