SecurityCenterAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.securitycenter_v1.services.security_center.transports.base.SecurityCenterTransport] = 'grpc_asyncio', 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>)
V1 APIs for Security Center service.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
SecurityCenterTransport | The transport used by the client instance. |
Methods
SecurityCenterAsyncClient
SecurityCenterAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.securitycenter_v1.services.security_center.transports.base.SecurityCenterTransport] = 'grpc_asyncio', 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.
Parameters | |
---|---|
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,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
asset_path
asset_path(organization: str, asset: str)
Returns a fully-qualified asset string.
big_query_export_path
big_query_export_path(organization: str, export: str)
Returns a fully-qualified big_query_export string.
bulk_mute_findings
bulk_mute_findings(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.BulkMuteFindingsRequest, 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]] = ())
Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
from google.cloud import securitycenter_v1
def sample_bulk_mute_findings():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.BulkMuteFindingsRequest(
parent="parent_value",
)
# Make the request
operation = client.bulk_mute_findings(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.BulkMuteFindingsRequest, dict]
The request object. Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it. |
parent |
Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "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. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be BulkMuteFindingsResponse The response to a BulkMute request. Contains the LRO information. |
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_big_query_export
create_big_query_export(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateBigQueryExportRequest, dict]] = None, *, parent: Optional[str] = None, big_query_export: Optional[google.cloud.securitycenter_v1.types.bigquery_export.BigQueryExport] = None, big_query_export_id: 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]] = ())
Creates a big query export.
from google.cloud import securitycenter_v1
def sample_create_big_query_export():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateBigQueryExportRequest(
parent="parent_value",
big_query_export_id="big_query_export_id_value",
)
# Make the request
response = client.create_big_query_export(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.CreateBigQueryExportRequest, dict]
The request object. Request message for creating a big query export. |
parent |
Required. Resource name of the new big query export's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". This corresponds to the |
big_query_export |
BigQueryExport
Required. The big query export being created. This corresponds to the |
big_query_export_id |
Required. Unique identifier provided by the client within the parent scope. It must consist of lower case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.BigQueryExport | Configures how to deliver Findings to BigQuery Instance. |
create_finding
create_finding(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateFindingRequest, dict]] = None, *, parent: Optional[str] = None, finding_id: Optional[str] = None, finding: Optional[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_create_finding():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateFindingRequest(
parent="parent_value",
finding_id="finding_id_value",
)
# Make the request
response = client.create_finding(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.CreateFindingRequest, dict]
The request object. Request message for creating a finding. |
parent |
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 |
Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. This corresponds to the |
finding |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Finding | Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. |
create_mute_config
create_mute_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateMuteConfigRequest, dict]] = None, *, parent: Optional[str] = None, mute_config: Optional[google.cloud.securitycenter_v1.types.mute_config.MuteConfig] = None, mute_config_id: 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]] = ())
Creates a mute config.
from google.cloud import securitycenter_v1
def sample_create_mute_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
mute_config = securitycenter_v1.MuteConfig()
mute_config.filter = "filter_value"
request = securitycenter_v1.CreateMuteConfigRequest(
parent="parent_value",
mute_config=mute_config,
mute_config_id="mute_config_id_value",
)
# Make the request
response = client.create_mute_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.CreateMuteConfigRequest, dict]
The request object. Request message for creating a mute config. |
parent |
Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". This corresponds to the |
mute_config |
MuteConfig
Required. The mute config being created. This corresponds to the |
mute_config_id |
Required. Unique identifier provided by the client within the parent scope. It must consist of lower case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.MuteConfig | A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. |
create_notification_config
create_notification_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateNotificationConfigRequest, dict]] = None, *, parent: Optional[str] = None, config_id: Optional[str] = None, notification_config: Optional[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_create_notification_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateNotificationConfigRequest(
parent="parent_value",
config_id="config_id_value",
)
# Make the request
response = client.create_notification_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.CreateNotificationConfigRequest, dict]
The request object. Request message for creating a notification config. |
parent |
Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]". This corresponds to the |
config_id |
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 |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.NotificationConfig | Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC 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_v1.types.securitycenter_service.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_create_source():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateSourceRequest(
parent="parent_value",
)
# Make the request
response = client.create_source(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.CreateSourceRequest, dict]
The request object. Request message for creating a source. |
parent |
Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". This corresponds to the |
source |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.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, and other tools. |
delete_big_query_export
delete_big_query_export(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.DeleteBigQueryExportRequest, 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 an existing big query export.
from google.cloud import securitycenter_v1
def sample_delete_big_query_export():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteBigQueryExportRequest(
name="name_value",
)
# Make the request
client.delete_big_query_export(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.DeleteBigQueryExportRequest, dict]
The request object. Request message for deleting a big query export. |
name |
Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_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. |
delete_mute_config
delete_mute_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.DeleteMuteConfigRequest, 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 an existing mute config.
from google.cloud import securitycenter_v1
def sample_delete_mute_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteMuteConfigRequest(
name="name_value",
)
# Make the request
client.delete_mute_config(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.DeleteMuteConfigRequest, dict]
The request object. Request message for deleting a mute config. |
name |
Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, or projects/{project}/muteConfigs/{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. |
delete_notification_config
delete_notification_config(request: Optional[Union[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_delete_notification_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteNotificationConfigRequest(
name="name_value",
)
# Make the request
client.delete_notification_config(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.DeleteNotificationConfigRequest, dict]
The request object. Request message for deleting a notification config. |
name |
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. |
external_system_path
external_system_path(
organization: str, source: str, finding: str, externalsystem: str
)
Returns a fully-qualified external_system string.
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.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
SecurityCenterAsyncClient | 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.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
SecurityCenterAsyncClient | 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.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
SecurityCenterAsyncClient | The constructed client. |
get_big_query_export
get_big_query_export(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GetBigQueryExportRequest, 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 big query export.
from google.cloud import securitycenter_v1
def sample_get_big_query_export():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.GetBigQueryExportRequest(
name="name_value",
)
# Make the request
response = client.get_big_query_export(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.GetBigQueryExportRequest, dict]
The request object. Request message for retrieving a big query export. |
name |
Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.BigQueryExport | Configures how to deliver Findings to BigQuery Instance. |
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.
from google.cloud import securitycenter_v1
def sample_get_iam_policy():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.GetIamPolicyRequest(
resource="resource_value",
)
# Make the request
response = client.get_iam_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
The request object. Request message for |
resource |
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. |
Returns | |
---|---|
Type | Description |
google.iam.v1.policy_pb2.Policy | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **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')",="" }="" }="" ]="" }="" **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')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" developer's="" guide](\=""> |
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.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_mute_config
get_mute_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GetMuteConfigRequest, 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 mute config.
from google.cloud import securitycenter_v1
def sample_get_mute_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.GetMuteConfigRequest(
name="name_value",
)
# Make the request
response = client.get_mute_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.GetMuteConfigRequest, dict]
The request object. Request message for retrieving a mute config. |
name |
Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, or projects/{project}/muteConfigs/{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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.MuteConfig | A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. |
get_notification_config
get_notification_config(request: Optional[Union[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_get_notification_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.GetNotificationConfigRequest(
name="name_value",
)
# Make the request
response = client.get_notification_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.GetNotificationConfigRequest, dict]
The request object. Request message for getting a notification config. |
name |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.NotificationConfig | Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC 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_v1.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.
from google.cloud import securitycenter_v1
def sample_get_organization_settings():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.GetOrganizationSettingsRequest(
name="name_value",
)
# Make the request
response = client.get_organization_settings(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.GetOrganizationSettingsRequest, dict]
The request object. Request message for getting organization settings. |
name |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.OrganizationSettings | User specified settings that are attached to the Security Command Center organization. |
get_source
get_source(request: Optional[Union[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_get_source():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.GetSourceRequest(
name="name_value",
)
# Make the request
response = client.get_source(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.GetSourceRequest, dict]
The request object. Request message for getting a source. |
name |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.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, and other tools. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
group_assets
group_assets(request: Optional[Union[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_group_assets():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.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)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.GroupAssetsAsyncPager | 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_v1.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
from google.cloud import securitycenter_v1
def sample_group_findings():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.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)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.GroupFindingsRequest, dict]
The request object. Request message for grouping by findings. |
parent |
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 |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.GroupFindingsAsyncPager | 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_v1.types.securitycenter_service.ListAssetsRequest, 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]] = ())
Lists an organization's assets.
from google.cloud import securitycenter_v1
def sample_list_assets():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.ListAssetsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_assets(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.ListAssetsRequest, dict]
The request object. Request message for listing 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.ListAssetsAsyncPager | Response message for listing assets. Iterating over this object will yield results and resolve additional pages automatically. |
list_big_query_exports
list_big_query_exports(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.ListBigQueryExportsRequest, 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 BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
from google.cloud import securitycenter_v1
def sample_list_big_query_exports():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.ListBigQueryExportsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_big_query_exports(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.ListBigQueryExportsRequest, dict]
The request object. Request message for listing BigQuery exports at a given scope e.g. organization, folder or project. |
parent |
Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.ListBigQueryExportsAsyncPager | Response message for listing BigQuery exports. Iterating over this object will yield results and resolve additional pages automatically. |
list_findings
list_findings(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.ListFindingsRequest, 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]] = ())
Lists an organization or source's findings.
To list across all sources provide a -
as the source id.
Example: /v1/organizations/{organization_id}/sources/-/findings
from google.cloud import securitycenter_v1
def sample_list_findings():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.ListFindingsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_findings(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.ListFindingsRequest, dict]
The request object. Request message for listing findings. |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.ListFindingsAsyncPager | Response message for listing findings. Iterating over this object will yield results and resolve additional pages automatically. |
list_mute_configs
list_mute_configs(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.ListMuteConfigsRequest, 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 mute configs.
from google.cloud import securitycenter_v1
def sample_list_mute_configs():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.ListMuteConfigsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_mute_configs(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.ListMuteConfigsRequest, dict]
The request object. Request message for listing mute configs at a given scope e.g. organization, folder or project. |
parent |
Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.ListMuteConfigsAsyncPager | Response message for listing mute configs. Iterating over this object will yield results and resolve additional pages automatically. |
list_notification_configs
list_notification_configs(request: Optional[Union[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_list_notification_configs():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.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)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.ListNotificationConfigsRequest, dict]
The request object. Request message for listing notification configs. |
parent |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.ListNotificationConfigsAsyncPager | 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_v1.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.
from google.cloud import securitycenter_v1
def sample_list_sources():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.ListSourcesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_sources(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.ListSourcesRequest, dict]
The request object. Request message for listing sources. |
parent |
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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.ListSourcesAsyncPager | Response message for listing sources. Iterating over this object will yield results and resolve additional pages automatically. |
mute_config_path
mute_config_path(organization: str, mute_config: str)
Returns a fully-qualified mute_config string.
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_big_query_export_path
parse_big_query_export_path(path: str)
Parses a big_query_export 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_external_system_path
parse_external_system_path(path: str)
Parses a external_system path into its component segments.
parse_finding_path
parse_finding_path(path: str)
Parses a finding path into its component segments.
parse_mute_config_path
parse_mute_config_path(path: str)
Parses a mute_config 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_v1.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.
from google.cloud import securitycenter_v1
def sample_run_asset_discovery():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.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)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.RunAssetDiscoveryRequest, dict]
The request object. Request message for running asset discovery for an organization. |
parent |
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. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | 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_v1.types.securitycenter_service.SetFindingStateRequest, dict]] = None, *, name: Optional[str] = None, state: Optional[google.cloud.securitycenter_v1.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.
from google.cloud import securitycenter_v1
def sample_set_finding_state():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.SetFindingStateRequest(
name="name_value",
state="INACTIVE",
)
# Make the request
response = client.set_finding_state(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.SetFindingStateRequest, dict]
The request object. Request message for updating a finding's state. |
name |
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 |
State
Required. The desired State of the finding. This corresponds to the |
start_time |
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
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Finding | Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. |
set_iam_policy
set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, 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]] = ())
Sets the access control policy on the specified Source.
from google.cloud import securitycenter_v1
def sample_set_iam_policy():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.SetIamPolicyRequest(
resource="resource_value",
)
# Make the request
response = client.set_iam_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
The request object. Request message for |
resource |
REQUIRED: The resource for which the policy is being specified. 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. |
Returns | |
---|---|
Type | Description |
google.iam.v1.policy_pb2.Policy | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **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')",="" }="" }="" ]="" }="" **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')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" developer's="" guide](\=""> |
set_mute
set_mute(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.SetMuteRequest, dict]] = None, *, name: Optional[str] = None, mute: Optional[google.cloud.securitycenter_v1.types.finding.Finding.Mute] = 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 mute state of a finding.
from google.cloud import securitycenter_v1
def sample_set_mute():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.SetMuteRequest(
name="name_value",
mute="UNDEFINED",
)
# Make the request
response = client.set_mute(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.SetMuteRequest, dict]
The request object. Request message for updating a finding's mute status. |
name |
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}", "folders/{folder_id}/sources/{source_id}/finding/{finding_id}", "projects/{project_id}/sources/{source_id}/finding/{finding_id}". This corresponds to the |
mute |
Mute
Required. The desired state of the Mute. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Finding | Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. |
source_path
source_path(organization: str, source: str)
Returns a fully-qualified source string.
test_iam_permissions
test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[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]] = ())
Returns the permissions that a caller has on the specified source.
from google.cloud import securitycenter_v1
def sample_test_iam_permissions():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.TestIamPermissionsRequest(
resource="resource_value",
permissions=['permissions_value_1', 'permissions_value_2'],
)
# Make the request
response = client.test_iam_permissions(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
The request object. Request message for |
resource |
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the |
permissions |
:class:
The set of permissions to check for 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. |
Returns | |
---|---|
Type | Description |
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse | Response message for TestIamPermissions method. |
topic_path
topic_path(project: str, topic: str)
Returns a fully-qualified topic string.
update_big_query_export
update_big_query_export(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateBigQueryExportRequest, dict]] = None, *, big_query_export: Optional[google.cloud.securitycenter_v1.types.bigquery_export.BigQueryExport] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 a BigQuery export.
from google.cloud import securitycenter_v1
def sample_update_big_query_export():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.UpdateBigQueryExportRequest(
)
# Make the request
response = client.update_big_query_export(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateBigQueryExportRequest, dict]
The request object. Request message for updating a BigQuery export. |
big_query_export |
BigQueryExport
Required. The BigQuery export being updated. This corresponds to the |
update_mask |
The list of fields to be updated. If empty all mutable fields will be updated. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.BigQueryExport | Configures how to deliver Findings to BigQuery Instance. |
update_external_system
update_external_system(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateExternalSystemRequest, dict]] = None, *, external_system: Optional[google.cloud.securitycenter_v1.types.external_system.ExternalSystem] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 external system. This is for a given finding.
from google.cloud import securitycenter_v1
def sample_update_external_system():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.UpdateExternalSystemRequest(
)
# Make the request
response = client.update_external_system(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateExternalSystemRequest, dict]
The request object. Request message for updating a ExternalSystem resource. |
external_system |
ExternalSystem
Required. The external system resource to update. This corresponds to the |
update_mask |
The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.ExternalSystem | Representation of third party SIEM/SOAR fields within SCC. |
update_finding
update_finding(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateFindingRequest, dict]] = None, *, finding: Optional[google.cloud.securitycenter_v1.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 or updates a finding. The corresponding source must exist for a finding creation to succeed.
from google.cloud import securitycenter_v1
def sample_update_finding():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.UpdateFindingRequest(
)
# Make the request
response = client.update_finding(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateFindingRequest, dict]
The request object. Request message for updating or creating a finding. |
finding |
Finding
Required. The finding resource to update or create if it does not already exist. parent, security_marks, and update_time will be ignored. In the case of creation, the finding id portion of the name must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Finding | Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. |
update_mute_config
update_mute_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateMuteConfigRequest, dict]] = None, *, mute_config: Optional[google.cloud.securitycenter_v1.types.mute_config.MuteConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 a mute config.
from google.cloud import securitycenter_v1
def sample_update_mute_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
mute_config = securitycenter_v1.MuteConfig()
mute_config.filter = "filter_value"
request = securitycenter_v1.UpdateMuteConfigRequest(
mute_config=mute_config,
)
# Make the request
response = client.update_mute_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateMuteConfigRequest, dict]
The request object. Request message for updating a mute config. |
mute_config |
MuteConfig
Required. The mute config being updated. This corresponds to the |
update_mask |
The list of fields to be updated. If empty all mutable fields will be updated. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.MuteConfig | A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. |
update_notification_config
update_notification_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateNotificationConfigRequest, dict]] = None, *, notification_config: Optional[google.cloud.securitycenter_v1.types.notification_config.NotificationConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
from google.cloud import securitycenter_v1
def sample_update_notification_config():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.UpdateNotificationConfigRequest(
)
# Make the request
response = client.update_notification_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateNotificationConfigRequest, dict]
The request object. Request message for updating a notification config. |
notification_config |
NotificationConfig
Required. The notification config to update. This corresponds to the |
update_mask |
The FieldMask to use when updating the notification config. If empty all mutable fields will be updated. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.NotificationConfig | Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. |
update_organization_settings
update_organization_settings(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateOrganizationSettingsRequest, dict]] = None, *, organization_settings: Optional[google.cloud.securitycenter_v1.types.organization_settings.OrganizationSettings] = 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 an organization's settings.
from google.cloud import securitycenter_v1
def sample_update_organization_settings():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.UpdateOrganizationSettingsRequest(
)
# Make the request
response = client.update_organization_settings(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateOrganizationSettingsRequest, dict]
The request object. Request message for updating an organization's settings. |
organization_settings |
OrganizationSettings
Required. The organization settings resource to update. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.OrganizationSettings | User specified settings that are attached to the Security Command Center organization. |
update_security_marks
update_security_marks(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateSecurityMarksRequest, dict]] = None, *, security_marks: Optional[google.cloud.securitycenter_v1.types.security_marks.SecurityMarks] = 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 security marks.
from google.cloud import securitycenter_v1
def sample_update_security_marks():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.UpdateSecurityMarksRequest(
)
# Make the request
response = client.update_security_marks(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateSecurityMarksRequest, dict]
The request object. Request message for updating a SecurityMarks resource. |
security_marks |
SecurityMarks
Required. The security marks resource to update. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.SecurityMarks | User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. |
update_source
update_source(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.UpdateSourceRequest, dict]] = None, *, source: Optional[google.cloud.securitycenter_v1.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]] = ())
Updates a source.
from google.cloud import securitycenter_v1
def sample_update_source():
# Create a client
client = securitycenter_v1.SecurityCenterClient()
# Initialize request argument(s)
request = securitycenter_v1.UpdateSourceRequest(
)
# Make the request
response = client.update_source(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.securitycenter_v1.types.UpdateSourceRequest, dict]
The request object. Request message for updating a source. |
source |
Source
Required. The source resource to update. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.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, and other tools. |