organization_settings

Creates, updates, deletes, gets or lists an organization_settings resource.

Overview

Name	organization_settings
Type	Resource
Id	google.securitycenter.organization_settings

Fields

The following fields are returned by SELECT queries:

organizations_get_organization_settings

Successful response

Name	Datatype	Description
name	string	The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings".
assetDiscoveryConfig	object	The configuration used for Asset Discovery runs. (id: AssetDiscoveryConfig)
enableAssetDiscovery	boolean	A flag that indicates if Asset Discovery should be enabled. If the flag is set to true, then discovery of assets will occur. If it is set to false, all historical assets will remain, but discovery of future assets will not occur.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_get_organization_settings	select	organizationsId		Gets the settings for an organization.
organizations_update_organization_settings	update	organizationsId	updateMask	Updates an organization's settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
organizationsId	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_get_organization_settings

Gets the settings for an organization.

SELECT
name,
assetDiscoveryConfig,
enableAssetDiscovery
FROM google.securitycenter.organization_settings
WHERE organizationsId = '{{ organizationsId }}' -- required;

UPDATE examples

organizations_update_organization_settings

Updates an organization's settings.

UPDATE google.securitycenter.organization_settings
SET 
data__name = '{{ name }}',
data__enableAssetDiscovery = {{ enableAssetDiscovery }},
data__assetDiscoveryConfig = '{{ assetDiscoveryConfig }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
assetDiscoveryConfig,
enableAssetDiscovery;