On September 15, 2026, all Cloud Composer 1 versions and versions 2.0.x of Cloud Composer 2 will reach their planned end of life. You will not be able to use environments with these versions. We recommend planning migration to Cloud Composer 3. Cloud Composer 2 versions 2.1.x and later are still supported and are not impacted by this change.
Required. The resource name of the Secret to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
Authorization requires the following IAM permission on the specified resource name:
composer.userworkloadssecrets.get
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of UserWorkloadsSecret.
[[["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-06-30 UTC."],[[["\u003cp\u003eRetrieves an existing user workloads Secret, with the "data" field values cleared in the response, applicable for Cloud Composer environments version composer-3-airflow-.*.*-build.* and newer.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes a \u003ccode\u003eGET\u003c/code\u003e HTTP request with a specific URL structure for resource identification, in the format \u003ccode\u003ehttps://composer.googleapis.com/v1/{name=projects/*/locations/*/environments/*/userWorkloadsSecrets/*}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ename\u003c/code\u003e path parameter, a string representing the resource name, and the IAM permission \u003ccode\u003ecomposer.userworkloadssecrets.get\u003c/code\u003e for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and a successful response will include an instance of \u003ccode\u003eUserWorkloadsSecret\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.environments.userWorkloadsSecrets.get\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets an existing user workloads Secret. Values of the \"data\" field in the response are cleared.\n\nThis method is supported for Cloud Composer environments in versions composer-3-airflow-\\*.\\*.\\*-build.\\* and newer.\n\n### HTTP request\n\n`GET https://composer.googleapis.com/v1/{name=projects/*/locations/*/environments/*/userWorkloadsSecrets/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [UserWorkloadsSecret](/composer/docs/reference/rest/v1/projects.locations.environments.userWorkloadsSecrets#UserWorkloadsSecret).\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)."]]
