SecurityCenterClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.securitycenter_v1p1beta1.services.security_center.transports.base.SecurityCenterTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)V1p1Beta1 APIs for Security Center service.
Inheritance
builtins.object > SecurityCenterClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| SecurityCenterTransport | The transport used by the client instance. |
Methods
SecurityCenterClient
SecurityCenterClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.securitycenter_v1p1beta1.services.security_center.transports.base.SecurityCenterTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the security center client.
| Name | Description |
| credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
| transport |
Union[str, SecurityCenterTransport]
The transport to use. If set to None, a transport is chosen automatically. |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
| client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
asset_path
asset_path(organization: str, asset: str)Returns a fully-qualified asset string.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_finding
create_finding(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.CreateFindingRequest, dict]] = None, *, parent: Optional[str] = None, finding_id: Optional[str] = None, finding: Optional[google.cloud.securitycenter_v1p1beta1.types.finding.Finding] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a finding. The corresponding source must exist for finding creation to succeed.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_create_finding():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.CreateFindingRequest(
parent="parent_value",
finding_id="finding_id_value",
)
# Make the request
response = client.create_finding(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.CreateFindingRequest, dict]
The request object. Request message for creating a finding. |
| parent |
str
Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". This corresponds to the |
| finding_id |
str
Required. Unique identifier provided by the client within the parent scope. This corresponds to the |
| finding |
google.cloud.securitycenter_v1p1beta1.types.Finding
Required. The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.types.Finding | Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. |
create_notification_config
create_notification_config(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.CreateNotificationConfigRequest, dict]] = None, *, parent: Optional[str] = None, config_id: Optional[str] = None, notification_config: Optional[google.cloud.securitycenter_v1p1beta1.types.notification_config.NotificationConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a notification config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_create_notification_config():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.CreateNotificationConfigRequest(
parent="parent_value",
config_id="config_id_value",
)
# Make the request
response = client.create_notification_config(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.CreateNotificationConfigRequest, dict]
The request object. Request message for creating a notification config. |
| parent |
str
Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]". This corresponds to the |
| config_id |
str
Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only. This corresponds to the |
| notification_config |
google.cloud.securitycenter_v1p1beta1.types.NotificationConfig
Required. The notification config being created. The name and the service account will be ignored as they are both output only fields on this resource. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.types.NotificationConfig | Security Command Center notification configs. A notification config is a Security Command Center resource that contains the configuration to send notifications for create/update events of findings, assets and etc. |
create_source
create_source(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.securitycenter_v1p1beta1.types.source.Source] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a source.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_create_source():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.CreateSourceRequest(
parent="parent_value",
)
# Make the request
response = client.create_source(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.CreateSourceRequest, dict]
The request object. Request message for creating a source. |
| parent |
str
Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". This corresponds to the |
| source |
google.cloud.securitycenter_v1p1beta1.types.Source
Required. The Source being created, only the display_name and description will be used. All other fields will be ignored. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.types.Source | Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. |
delete_notification_config
delete_notification_config(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.DeleteNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a notification config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_delete_notification_config():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.DeleteNotificationConfigRequest(
name="name_value",
)
# Make the request
client.delete_notification_config(request=request)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.DeleteNotificationConfigRequest, dict]
The request object. Request message for deleting a notification config. |
| name |
str
Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
finding_path
finding_path(organization: str, source: str, finding: str)Returns a fully-qualified finding string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| SecurityCenterClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| SecurityCenterClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| SecurityCenterClient | The constructed client. |
get_iam_policy
get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the access control policy on the specified Source.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
from google.iam.v1 import iam_policy_pb2 # type: ignore
def sample_get_iam_policy():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = iam_policy_pb2.GetIamPolicyRequest(
resource="resource_value",
)
# Make the request
response = client.get_iam_policy(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
The request object. Request message for |
| resource |
str
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.iam.v1.policy_pb2.Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\=""> |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_notification_config
get_notification_config(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GetNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets a notification config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_get_notification_config():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.GetNotificationConfigRequest(
name="name_value",
)
# Make the request
response = client.get_notification_config(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.GetNotificationConfigRequest, dict]
The request object. Request message for getting a notification config. |
| name |
str
Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.types.NotificationConfig | Security Command Center notification configs. A notification config is a Security Command Center resource that contains the configuration to send notifications for create/update events of findings, assets and etc. |
get_organization_settings
get_organization_settings(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GetOrganizationSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the settings for an organization.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_get_organization_settings():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.GetOrganizationSettingsRequest(
name="name_value",
)
# Make the request
response = client.get_organization_settings(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.GetOrganizationSettingsRequest, dict]
The request object. Request message for getting organization settings. |
| name |
str
Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.types.OrganizationSettings | User specified settings that are attached to the Security Command Center organization. |
get_source
get_source(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GetSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets a source.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_get_source():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.GetSourceRequest(
name="name_value",
)
# Make the request
response = client.get_source(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.GetSourceRequest, dict]
The request object. Request message for getting a source. |
| name |
str
Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.types.Source | Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. |
group_assets
group_assets(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GroupAssetsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Filters an organization's assets and groups them by their specified properties.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_group_assets():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.GroupAssetsRequest(
parent="parent_value",
group_by="group_by_value",
)
# Make the request
page_result = client.group_assets(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.GroupAssetsRequest, dict]
The request object. Request message for grouping by assets. |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.GroupAssetsPager | Response message for grouping by assets. Iterating over this object will yield results and resolve additional pages automatically. |
group_findings
group_findings(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GroupFindingsRequest, dict]] = None, *, parent: Optional[str] = None, group_by: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Filters an organization or source's findings and groups them by their specified properties.
To group across all sources provide a - as the source id.
Example: /v1/organizations/{organization_id}/sources/-/findings,
/v1/folders/{folder_id}/sources/-/findings,
/v1/projects/{project_id}/sources/-/findings
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_group_findings():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.GroupFindingsRequest(
parent="parent_value",
group_by="group_by_value",
)
# Make the request
page_result = client.group_findings(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.GroupFindingsRequest, dict]
The request object. Request message for grouping by findings. |
| parent |
str
Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of |
| group_by |
str
Required. Expression that defines what assets fields to use for grouping (including |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.GroupFindingsPager | Response message for group by findings. Iterating over this object will yield results and resolve additional pages automatically. |
list_assets
list_assets(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListAssetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists an organization's assets.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_list_assets():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.ListAssetsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_assets(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.ListAssetsRequest, dict]
The request object. Request message for listing assets. |
| parent |
str
Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id], folders/[folder_id], or projects/[project_id]". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListAssetsPager | Response message for listing assets. Iterating over this object will yield results and resolve additional pages automatically. |
list_findings
list_findings(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListFindingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists an organization or source's findings.
To list across all sources provide a - as the source id.
Example:
/v1p1beta1/organizations/{organization_id}/sources/-/findings
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_list_findings():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.ListFindingsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_findings(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.ListFindingsRequest, dict]
The request object. Request message for listing findings. |
| parent |
str
Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]". To list across all sources provide a source_id of |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListFindingsPager | Response message for listing findings. Iterating over this object will yield results and resolve additional pages automatically. |
list_notification_configs
list_notification_configs(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListNotificationConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists notification configs.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_list_notification_configs():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.ListNotificationConfigsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_notification_configs(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.ListNotificationConfigsRequest, dict]
The request object. Request message for listing notification configs. |
| parent |
str
Required. Name of the organization to list notification configs. Its format is "organizations/[organization_id]". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListNotificationConfigsPager | Response message for listing notification configs. Iterating over this object will yield results and resolve additional pages automatically. |
list_sources
list_sources(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListSourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists all sources belonging to an organization.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_list_sources():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.ListSourcesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_sources(request=request)
# Handle the response
for response in page_result:
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.ListSourcesRequest, dict]
The request object. Request message for listing sources. |
| parent |
str
Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id], folders/[folder_id], or projects/[project_id]". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListSourcesPager | Response message for listing sources. Iterating over this object will yield results and resolve additional pages automatically. |
notification_config_path
notification_config_path(organization: str, notification_config: str)Returns a fully-qualified notification_config string.
organization_settings_path
organization_settings_path(organization: str)Returns a fully-qualified organization_settings string.
parse_asset_path
parse_asset_path(path: str)Parses a asset path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_finding_path
parse_finding_path(path: str)Parses a finding path into its component segments.
parse_notification_config_path
parse_notification_config_path(path: str)Parses a notification_config path into its component segments.
parse_organization_settings_path
parse_organization_settings_path(path: str)Parses a organization_settings path into its component segments.
parse_security_marks_path
parse_security_marks_path(path: str)Parses a security_marks path into its component segments.
parse_source_path
parse_source_path(path: str)Parses a source path into its component segments.
parse_topic_path
parse_topic_path(path: str)Parses a topic path into its component segments.
run_asset_discovery
run_asset_discovery(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.RunAssetDiscoveryRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Runs asset discovery. The discovery is tracked with a long-running operation.
This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_run_asset_discovery():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.RunAssetDiscoveryRequest(
parent="parent_value",
)
# Make the request
operation = client.run_asset_discovery(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.RunAssetDiscoveryRequest, dict]
The request object. Request message for running asset discovery for an organization. |
| parent |
str
Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be RunAssetDiscoveryResponse Response of asset discovery run |
security_marks_path
security_marks_path(organization: str, asset: str)Returns a fully-qualified security_marks string.
set_finding_state
set_finding_state(request: Optional[Union[google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.SetFindingStateRequest, dict]] = None, *, name: Optional[str] = None, state: Optional[google.cloud.securitycenter_v1p1beta1.types.finding.Finding.State] = None, start_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the state of a finding.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1p1beta1
def sample_set_finding_state():
# Create a client
client = securitycenter_v1p1beta1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1p1beta1.SetFindingStateRequest(
name="name_value",
state="INACTIVE",
)
# Make the request
response = client.set_finding_state(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.securitycenter_v1p1beta1.types.SetFindingStateRequest, dict]
The request object. Request message for updating a finding's state. |
| name |
str
Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}". This corresponds to the |
| state |
google.cloud.securitycenter_v1p1beta1.types.Finding.State
Required. The desired State of the finding. This corresponds to the |
| start_time |
google.protobuf.timestamp_pb2.Timestamp
Required. The time at which the updated state takes effect. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
|