Data Catalog API methods that are related to Data Catalog search and metadata are deprecated and will be discontinued on January 30, 2026. See Transition from Data Catalog to Dataplex Universal Catalog. Methods that are related to policy tags and policy tag taxonomies are not deprecated.
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.
HTTP request
GET https://datacatalog.googleapis.com/v1/{name}:retrieveConfig
Path parameters
Parameters
name
string
Required. The organization whose config is being retrieved. It takes the form organizations/{organization}/locations/{location}.
Request body
The request body must be empty.
Response body
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 locations.retrieveConfig.
If successful, the response body contains data with the following structure:
Map of organizations and project resource names and their configuration. The format for the map keys is organizations/{organizationId} or projects/{projectId}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-17 UTC."],[[["\u003cp\u003eThis API retrieves the migration configuration from Data Catalog to Dataplex for a specified organization and its projects.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003eGET\u003c/code\u003e method to a specific URL with a required path parameter representing the organization.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the response body contains a JSON representation of the migration configurations for the organization and its projects.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003edatacatalog.migrationConfig.get\u003c/code\u003e on the specified organization.\u003c/p\u003e\n"],["\u003cp\u003eThe specified path parameter \u003ccode\u003ename\u003c/code\u003e represents the organization and location, following the format \u003ccode\u003eorganizations/{organization}/locations/{location}\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: organizations.locations.retrieveConfig\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.OrganizationConfig.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\n| Data Catalog is deprecated. Please use Dataplex Universal Catalog instead.\nRetrieves 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.\n\n### HTTP request\n\n`GET https://datacatalog.googleapis.com/v1/{name}:retrieveConfig`\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe 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 [locations.retrieveConfig](/data-catalog/docs/reference/rest/v1/organizations.locations/retrieveConfig#google.cloud.datacatalog.v1.DataCatalog.RetrieveConfig).\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `datacatalog.migrationConfig.get`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]