sources

Creates, updates, deletes, gets or lists a sources resource.

Overview

Name	sources
Type	Resource
Id	google.securitycenter.sources

Fields

The following fields are returned by SELECT queries:

organizations_sources_get

Name	Datatype	Description
name	string
canonicalName	string
description	string
displayName	string

organizations_sources_list

Name	Datatype	Description
name	string
canonicalName	string
description	string
displayName	string

projects_sources_list

Name	Datatype	Description
name	string
canonicalName	string
description	string
displayName	string

folders_sources_list

Name	Datatype	Description
name	string
canonicalName	string
description	string
displayName	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_sources_get	select	organizationsId, sourcesId
organizations_sources_list	select	organizationsId	pageToken, pageSize
projects_sources_list	select	projectsId	pageToken, pageSize
folders_sources_list	select	foldersId	pageToken, pageSize
organizations_sources_create	insert	organizationsId
organizations_sources_patch	update	organizationsId, sourcesId	updateMask

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
foldersId	string
organizationsId	string
projectsId	string
sourcesId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_sources_get

Successful response

SELECT
name,
canonicalName,
description,
displayName
FROM google.securitycenter.sources
WHERE organizationsId = '{{ organizationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
;

organizations_sources_list

Successful response

SELECT
name,
canonicalName,
description,
displayName
FROM google.securitycenter.sources
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

projects_sources_list

Successful response

SELECT
name,
canonicalName,
description,
displayName
FROM google.securitycenter.sources
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

folders_sources_list

Successful response

SELECT
name,
canonicalName,
description,
displayName
FROM google.securitycenter.sources
WHERE foldersId = '{{ foldersId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

organizations_sources_create

No description available.

INSERT INTO google.securitycenter.sources (
data__name,
data__canonicalName,
data__displayName,
data__description,
organizationsId
)
SELECT 
'{{ name }}',
'{{ canonicalName }}',
'{{ displayName }}',
'{{ description }}',
'{{ organizationsId }}'
RETURNING
name,
canonicalName,
description,
displayName
;

Manifest

# Description fields are for documentation purposes
- name: sources
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the sources resource.
  - name: name
    value: "{{ name }}"
  - name: canonicalName
    value: "{{ canonicalName }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"

UPDATE examples

organizations_sources_patch

No description available.

UPDATE google.securitycenter.sources
SET 
data__name = '{{ name }}',
data__canonicalName = '{{ canonicalName }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND sourcesId = '{{ sourcesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
canonicalName,
description,
displayName;