Method: organizations.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=organizations/*}/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\u003eLists all available settings for a Cloud resource specified as the \u003ccode\u003eparent\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP GET request with gRPC Transcoding to retrieve settings information.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003eresourcesettings.settings.list\u003c/code\u003e IAM permission on the \u003ccode\u003eparent\u003c/code\u003e resource and \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eProvides settings details in the response body, adhering to the \u003ccode\u003eListSettingsResponse\u003c/code\u003e structure.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty and \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e query parameters are currently unused.\u003c/p\u003e\n"]]],["This document details how to retrieve settings for a Cloud resource using a `GET` request. The request URL includes the resource's `parent` identifier as a path parameter, which can be a project, folder, or organization ID. Authorization requires the `resourcesettings.settings.list` IAM permission. `pageSize` and `pageToken` query parameters are available but not used. The request body must be empty. A successful response returns a `ListSettingsResponse` instance and uses the OAuth `cloud-platform` scope.\n"],null,["# Method: organizations.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=organizations/*}/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/)."]]
