Method: projects.settings.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the settings that are available on the Cloud resource parent.
HTTP request
GET https://resourcesettings.googleapis.com/v1alpha1/{parent=projects/*}/settings
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The Cloud resource that parents the setting. Must be in one of the following forms:
projects/{project_number}projects/{project_id}folders/{folder_id}organizations/{organization_id}
Authorization requires the following IAM permission on the specified resource parent:
resourcesettings.settings.list
|
Query parameters
| Parameters |
pageSize |
integer
Unused. The size of the page to be returned.
|
pageToken |
string
Unused. A page token used to retrieve the next page.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListSettingsResponse.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-05-25 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-05-25 UTC."],[[["\u003cp\u003eThis documentation details how to list all available settings on a Cloud resource using the \u003ccode\u003eListSettings\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe request is sent as a \u003ccode\u003eGET\u003c/code\u003e request to the specified URL, using gRPC Transcoding syntax, with \u003ccode\u003eparent\u003c/code\u003e as a required path parameter indicating the Cloud resource.\u003c/p\u003e\n"],["\u003cp\u003eQuery parameters \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e are currently unused but included for future functionality.\u003c/p\u003e\n"],["\u003cp\u003eThe response to a successful request will contain a \u003ccode\u003eListSettingsResponse\u003c/code\u003e object providing the requested settings information.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ecloud-platform\u003c/code\u003e OAuth scope and specific IAM permissions on the parent resource.\u003c/p\u003e\n"]]],["This document details how to list settings for a Cloud resource. A `GET` request is made to `https://resourcesettings.googleapis.com/v1alpha1/{parent=projects/*}/settings`. The `parent` path parameter specifies the resource (project, folder, or organization) and requires the `resourcesettings.settings.list` IAM permission. `pageSize` and `pageToken` are available query parameters but are unused. The request body must be empty. A successful request returns a `ListSettingsResponse`. The `cloud-platform` OAuth scope is needed for authorization.\n"],null,["# Method: projects.settings.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nLists all the settings that are available on the Cloud resource `parent`.\n\n### HTTP request\n\n`GET https://resourcesettings.googleapis.com/v1alpha1/{parent=projects/*}/settings`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The Cloud resource that parents the setting. Must be in one of the following forms: - `projects/{project_number}` - `projects/{project_id}` - `folders/{folder_id}` - `organizations/{organization_id}` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `resourcesettings.settings.list` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------|\n| `pageSize` | `integer` Unused. The size of the page to be returned. |\n| `pageToken` | `string` Unused. A page token used to retrieve the next page. |\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 [ListSettingsResponse](/resource-settings/docs/reference/rest/v1alpha1/ListSettingsResponse).\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](https://cloud.google.com/docs/authentication/)."]]
