Class SecurityCenterClient (1.33.0) 

SecurityCenterClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v1p1beta1.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v1p1beta1.services.security_center.transports.base.SecurityCenterTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
SecurityCenterTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

SecurityCenterClient

SecurityCenterClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v1p1beta1.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v1p1beta1.services.security_center.transports.base.SecurityCenterTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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 Optional[Union[str,SecurityCenterTransport,Callable[..., SecurityCenterTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the SecurityCenterTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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 None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
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) -> str

Returns a fully-qualified asset string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_finding

create_finding(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.CreateFindingRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    finding_id: typing.Optional[str] = None,
    finding: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.finding.Finding
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.finding.Finding

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)
Parameters
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 parent field on the request instance; if request is provided, this should not be set.
finding_id str

Required. Unique identifier provided by the client within the parent scope. This corresponds to the finding_id field on the request instance; if request is provided, this should not be set.
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 finding field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.CreateNotificationConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    config_id: typing.Optional[str] = None,
    notification_config: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.notification_config.NotificationConfig
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.notification_config.NotificationConfig

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)
Parameters
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 parent field on the request instance; if request is provided, this should not be set.
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 config_id field on the request instance; if request is provided, this should not be set.
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 notification_config field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.CreateSourceRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    source: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.source.Source
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.source.Source

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)
Parameters
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 parent field on the request instance; if request is provided, this should not be set.
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 source field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.DeleteNotificationConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
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 name field on the request instance; if request is provided, this should not be set.
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) -> 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
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.

Parameter
Name Description
info dict

The service account private key info.
Returns
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.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
SecurityCenterClient The constructed client.

get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

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)
Parameters
Name Description
request Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]

The request object. Request message for GetIamPolicy method.
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 resource field on the request instance; if request is provided, this should not be set.
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 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:** :literal:\ { "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:** :literal:\ 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:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. 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 variable 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 api_endpoint and client_cert_source properties may be used in this method.
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_notification_config

get_notification_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GetNotificationConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.notification_config.NotificationConfig

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)
Parameters
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 name field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GetOrganizationSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.types.organization_settings.OrganizationSettings
)

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)
Parameters
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 name field on the request instance; if request is provided, this should not be set.
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_v1p1beta1.types.OrganizationSettings User specified settings that are attached to the Security Command Center organization.

get_source

get_source(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GetSourceRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.source.Source

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)
Parameters
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 name field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GroupAssetsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.GroupAssetsPager
)

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)
Parameters
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.
Returns
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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.GroupFindingsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    group_by: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.GroupFindingsPager
)

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)
Parameters
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 -. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/- This corresponds to the parent field on the request instance; if request is provided, this should not be set.
group_by str

Required. Expression that defines what assets fields to use for grouping (including state_change). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: - resource_name - category - state - parent - severity The following fields are supported when compare_duration is set: - state_change This corresponds to the group_by field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListAssetsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListAssetsPager
)

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)
Parameters
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 parent field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListFindingsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListFindingsPager
)

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)
Parameters
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 -. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/- This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListNotificationConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListNotificationConfigsPager
)

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)
Parameters
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 parent field on the request instance; if request is provided, this should not be set.
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_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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.ListSourcesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.services.security_center.pagers.ListSourcesPager
)

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)
Parameters
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 parent field on the request instance; if request is provided, this should not be set.
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_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) -> str

Returns a fully-qualified notification_config string.

organization_settings_path

organization_settings_path(organization: str) -> str

Returns a fully-qualified organization_settings string.

parse_asset_path

parse_asset_path(path: str) -> typing.Dict[str, str]

Parses a asset path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_finding_path

parse_finding_path(path: str) -> typing.Dict[str, str]

Parses a finding path into its component segments.

parse_notification_config_path

parse_notification_config_path(path: str) -> typing.Dict[str, str]

Parses a notification_config path into its component segments.

parse_organization_settings_path

parse_organization_settings_path(path: str) -> typing.Dict[str, str]

Parses a organization_settings path into its component segments.

parse_security_marks_path

parse_security_marks_path(path: str) -> typing.Dict[str, str]

Parses a security_marks path into its component segments.

parse_source_path

parse_source_path(path: str) -> typing.Dict[str, str]

Parses a source path into its component segments.

parse_topic_path

parse_topic_path(path: str) -> typing.Dict[str, str]

Parses a topic path into its component segments.

run_asset_discovery

run_asset_discovery(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.RunAssetDiscoveryRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

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)
Parameters
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 parent field on the request instance; if request is provided, this should not be set.
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.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) -> str

Returns a fully-qualified security_marks string.

set_finding_state

set_finding_state(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.SetFindingStateRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    state: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.finding.Finding.State
    ] = None,
    start_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.finding.Finding

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)
Parameters
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 name field on the request instance; if request is provided, this should not be set.
state google.cloud.securitycenter_v1p1beta1.types.Finding.State

Required. The desired State of the finding. This corresponds to the state field on the request instance; if request is provided, this should not be set.
start_time google.protobuf.timestamp_pb2.Timestamp

Required. The time at which the updated state takes effect. This corresponds to the start_time field on the request instance; if request is provided, this should not be set.
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_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.

set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets 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_set_iam_policy():
    # Create a client
    client = securitycenter_v1p1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.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 SetIamPolicy method.
resource str

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 resource field on the request instance; if request is provided, this should not be set.
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 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:** :literal:\ { "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:** :literal:\ 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:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

source_path

source_path(organization: str, source: str) -> str

Returns a fully-qualified source string.

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns the permissions that a caller has 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_test_iam_permissions():
    # Create a client
    client = securitycenter_v1p1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # 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 TestIamPermissions method.
resource str

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 resource field on the request instance; if request is provided, this should not be set.
permissions MutableSequence[str]

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview https://cloud.google.com/iam/docs/overview#permissions__. This corresponds to the permissions field on the request instance; if request is provided, this should not be set.
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) -> str

Returns a fully-qualified topic string.

update_finding

update_finding(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.UpdateFindingRequest,
            dict,
        ]
    ] = None,
    *,
    finding: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.finding.Finding
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.finding.Finding

Creates or updates a finding. The corresponding source must exist for a 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_update_finding():
    # Create a client
    client = securitycenter_v1p1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1p1beta1.UpdateFindingRequest(
    )

    # Make the request
    response = client.update_finding(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.securitycenter_v1p1beta1.types.UpdateFindingRequest, dict]

The request object. Request message for updating or creating a finding.
finding google.cloud.securitycenter_v1p1beta1.types.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 finding field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties." in the field mask. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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_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.

update_notification_config

update_notification_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.UpdateNotificationConfigRequest,
            dict,
        ]
    ] = None,
    *,
    notification_config: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.notification_config.NotificationConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.notification_config.NotificationConfig

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

# 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_update_notification_config():
    # Create a client
    client = securitycenter_v1p1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1p1beta1.UpdateNotificationConfigRequest(
    )

    # Make the request
    response = client.update_notification_config(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.securitycenter_v1p1beta1.types.UpdateNotificationConfigRequest, dict]

The request object. Request message for updating a notification config.
notification_config google.cloud.securitycenter_v1p1beta1.types.NotificationConfig

Required. The notification config to update. This corresponds to the notification_config field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

The FieldMask to use when updating the notification config. If empty all mutable fields will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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_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.

update_organization_settings

update_organization_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.UpdateOrganizationSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    organization_settings: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.organization_settings.OrganizationSettings
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.securitycenter_v1p1beta1.types.organization_settings.OrganizationSettings
)

Updates an organization's settings.

# 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_update_organization_settings():
    # Create a client
    client = securitycenter_v1p1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1p1beta1.UpdateOrganizationSettingsRequest(
    )

    # Make the request
    response = client.update_organization_settings(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.securitycenter_v1p1beta1.types.UpdateOrganizationSettingsRequest, dict]

The request object. Request message for updating an organization's settings.
organization_settings google.cloud.securitycenter_v1p1beta1.types.OrganizationSettings

Required. The organization settings resource to update. This corresponds to the organization_settings field on the request instance; if request is provided, this should not be set.
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_v1p1beta1.types.OrganizationSettings User specified settings that are attached to the Security Command Center organization.

update_security_marks

update_security_marks(
    request: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.UpdateSecurityMarksRequest,
            dict,
        ]
    ] = None,
    *,
    security_marks: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.security_marks.SecurityMarks
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.security_marks.SecurityMarks

Updates security marks.

# 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_update_security_marks():
    # Create a client
    client = securitycenter_v1p1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1p1beta1.UpdateSecurityMarksRequest(
    )

    # Make the request
    response = client.update_security_marks(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.securitycenter_v1p1beta1.types.UpdateSecurityMarksRequest, dict]

The request object. Request message for updating a SecurityMarks resource.
security_marks google.cloud.securitycenter_v1p1beta1.types.SecurityMarks

Required. The security marks resource to update. This corresponds to the security_marks field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.<mark_key>". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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_v1p1beta1.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: typing.Optional[
        typing.Union[
            google.cloud.securitycenter_v1p1beta1.types.securitycenter_service.UpdateSourceRequest,
            dict,
        ]
    ] = None,
    *,
    source: typing.Optional[
        google.cloud.securitycenter_v1p1beta1.types.source.Source
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1p1beta1.types.source.Source

Updates 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_update_source():
    # Create a client
    client = securitycenter_v1p1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1p1beta1.UpdateSourceRequest(
    )

    # Make the request
    response = client.update_source(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.securitycenter_v1p1beta1.types.UpdateSourceRequest, dict]

The request object. Request message for updating a source.
source google.cloud.securitycenter_v1p1beta1.types.Source

Required. The source resource to update. This corresponds to the source field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

The FieldMask to use when updating the source resource. If empty all mutable fields will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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_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.