blob: 634099937e08994ee6c1b0420f3c78b0443d099a [file] [log] [blame] [edit]
{
"canonicalName": "Security Command Center",
"rootUrl": "https://securitycenter.googleapis.com/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "securitycenter:v1",
"servicePath": "",
"schemas": {
"IamPolicy": {
"type": "object",
"id": "IamPolicy",
"properties": {
"policyBlob": {
"type": "string",
"description": "The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details."
}
},
"description": "Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user."
},
"ListFindingsResponse": {
"description": "Response message for listing findings.",
"id": "ListFindingsResponse",
"type": "object",
"properties": {
"listFindingsResults": {
"description": "Findings matching the list request.",
"type": "array",
"items": {
"$ref": "ListFindingsResult"
}
},
"readTime": {
"format": "google-datetime",
"description": "Time used for executing the list request.",
"type": "string"
},
"totalSize": {
"format": "int32",
"description": "The total number of findings matching the query.",
"type": "integer"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results.",
"type": "string"
}
}
},
"Asset": {
"type": "object",
"description": "Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.",
"id": "Asset",
"properties": {
"iamPolicy": {
"description": "Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user.",
"$ref": "IamPolicy"
},
"securityCenterProperties": {
"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.",
"$ref": "SecurityCenterProperties"
},
"createTime": {
"format": "google-datetime",
"type": "string",
"description": "The time at which the asset was created in Security Command Center."
},
"updateTime": {
"format": "google-datetime",
"type": "string",
"description": "The time at which the asset was last updated, added, or deleted in Security Command Center."
},
"securityMarks": {
"description": "User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset.",
"$ref": "SecurityMarks"
},
"resourceProperties": {
"additionalProperties": {
"type": "any"
},
"description": "Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.",
"type": "object"
},
"name": {
"type": "string",
"description": "The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/assets/{asset_id}\"."
}
}
},
"Policy": {
"id": "Policy",
"properties": {
"etag": {
"format": "byte",
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"type": "string"
},
"version": {
"type": "integer",
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32"
},
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"type": "array",
"items": {
"$ref": "Binding"
},
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member."
}
},
"description": "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` 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; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:[email protected]\", \"group:[email protected]\", \"domain:google.com\", \"serviceAccount:[email protected]\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:[email protected]\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"type": "object"
},
"OrganizationSettings": {
"type": "object",
"properties": {
"enableAssetDiscovery": {
"type": "boolean",
"description": "A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur."
},
"assetDiscoveryConfig": {
"$ref": "AssetDiscoveryConfig",
"description": "The configuration used for Asset Discovery runs."
},
"name": {
"description": "The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/organizationSettings\".",
"type": "string"
}
},
"id": "OrganizationSettings",
"description": "User specified settings that are attached to the Security Command Center organization."
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.",
"id": "AuditLogConfig",
"type": "object",
"properties": {
"exemptedMembers": {
"items": {
"type": "string"
},
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"type": "array"
},
"logType": {
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"type": "string"
}
}
},
"GroupAssetsResponse": {
"description": "Response message for grouping by assets.",
"type": "object",
"properties": {
"totalSize": {
"description": "The total number of results matching the query.",
"format": "int32",
"type": "integer"
},
"groupByResults": {
"items": {
"$ref": "GroupResult"
},
"type": "array",
"description": "Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear."
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results.",
"type": "string"
},
"readTime": {
"description": "Time used for executing the groupBy request.",
"type": "string",
"format": "google-datetime"
}
},
"id": "GroupAssetsResponse"
},
"ListOperationsResponse": {
"properties": {
"nextPageToken": {
"type": "string",
"description": "The standard List next-page token."
},
"operations": {
"items": {
"$ref": "Operation"
},
"description": "A list of operations that matches the specified filter in the request.",
"type": "array"
}
},
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"type": "object"
},
"GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse": {
"description": "Response of asset discovery run",
"type": "object",
"id": "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse",
"properties": {
"duration": {
"format": "google-duration",
"description": "The duration between asset discovery run start and end",
"type": "string"
},
"state": {
"enumDescriptions": [
"Asset discovery run state was unspecified.",
"Asset discovery run completed successfully.",
"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.",
"Asset discovery run was killed and terminated."
],
"description": "The state of an asset discovery run.",
"type": "string",
"enum": [
"STATE_UNSPECIFIED",
"COMPLETED",
"SUPERSEDED",
"TERMINATED"
]
}
}
},
"SetFindingStateRequest": {
"properties": {
"startTime": {
"format": "google-datetime",
"description": "Required. The time at which the updated state takes effect.",
"type": "string"
},
"state": {
"type": "string",
"enumDescriptions": [
"Unspecified state.",
"The finding requires attention and has not been addressed yet.",
"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active."
],
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"INACTIVE"
],
"description": "Required. The desired State of the finding."
}
},
"id": "SetFindingStateRequest",
"type": "object",
"description": "Request message for updating a finding's state."
},
"GoogleCloudSecuritycenterV1p1beta1NotificationMessage": {
"type": "object",
"properties": {
"resource": {
"description": "The Cloud resource tied to the notification.",
"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource"
},
"notificationConfigName": {
"type": "string",
"description": "Name of the notification config that generated current notification."
},
"finding": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding",
"description": "If it's a Finding based notification config, this field will be populated."
}
},
"id": "GoogleCloudSecuritycenterV1p1beta1NotificationMessage",
"description": "Security Command Center's Notification"
},
"Source": {
"description": "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.",
"properties": {
"name": {
"description": "The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}\"",
"type": "string"
},
"description": {
"description": "The description of the source (max of 1024 characters). Example: \"Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries.\"",
"type": "string"
},
"displayName": {
"description": "The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive).",
"type": "string"
}
},
"id": "Source",
"type": "object"
},
"AssetDiscoveryConfig": {
"description": "The configuration used for Asset Discovery runs.",
"id": "AssetDiscoveryConfig",
"properties": {
"projectIds": {
"description": "The project ids to use for filtering asset discovery.",
"items": {
"type": "string"
},
"type": "array"
},
"inclusionMode": {
"enumDescriptions": [
"Unspecified. Setting the mode with this value will disable inclusion/exclusion filtering for Asset Discovery.",
"Asset Discovery will capture only the resources within the projects specified. All other resources will be ignored.",
"Asset Discovery will ignore all resources under the projects specified. All other resources will be retrieved."
],
"type": "string",
"description": "The mode to use for filtering asset discovery.",
"enum": [
"INCLUSION_MODE_UNSPECIFIED",
"INCLUDE_ONLY",
"EXCLUDE"
]
},
"folderIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966."
}
},
"type": "object"
},
"AuditConfig": {
"properties": {
"service": {
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
"type": "string"
},
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"type": "array",
"items": {
"$ref": "AuditLogConfig"
}
}
},
"id": "AuditConfig",
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:[email protected]\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.",
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse": {
"id": "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse",
"description": "Response of asset discovery run",
"type": "object",
"properties": {
"state": {
"enum": [
"STATE_UNSPECIFIED",
"COMPLETED",
"SUPERSEDED",
"TERMINATED"
],
"description": "The state of an asset discovery run.",
"enumDescriptions": [
"Asset discovery run state was unspecified.",
"Asset discovery run completed successfully.",
"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.",
"Asset discovery run was killed and terminated."
],
"type": "string"
},
"duration": {
"description": "The duration between asset discovery run start and end",
"format": "google-duration",
"type": "string"
}
}
},
"TestIamPermissionsResponse": {
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Response message for `TestIamPermissions` method.",
"type": "object"
},
"SecurityMarks": {
"id": "SecurityMarks",
"properties": {
"marks": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)"
},
"name": {
"type": "string",
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\"."
}
},
"description": "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.",
"type": "object"
},
"GroupAssetsRequest": {
"id": "GroupAssetsRequest",
"type": "object",
"properties": {
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.",
"type": "string"
},
"compareDuration": {
"format": "google-duration",
"type": "string",
"description": "When compare_duration is set, the GroupResult's \"state_change\" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`."
},
"groupBy": {
"type": "string",
"description": "Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: \"security_center_properties.resource_project,security_center_properties.project\". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_project_display_name * security_center_properties.resource_type * security_center_properties.resource_parent * security_center_properties.resource_parent_display_name The following fields are supported when compare_duration is set: * security_center_properties.resource_type * security_center_properties.resource_project_display_name * security_center_properties.resource_parent_display_name"
},
"filter": {
"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`",
"type": "string"
},
"readTime": {
"format": "google-datetime",
"type": "string",
"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW."
}
},
"description": "Request message for grouping by assets."
},
"GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": {
"type": "object",
"id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse",
"description": "Response of asset discovery run",
"properties": {
"duration": {
"format": "google-duration",
"description": "The duration between asset discovery run start and end",
"type": "string"
},
"state": {
"enumDescriptions": [
"Asset discovery run state was unspecified.",
"Asset discovery run completed successfully.",
"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.",
"Asset discovery run was killed and terminated."
],
"enum": [
"STATE_UNSPECIFIED",
"COMPLETED",
"SUPERSEDED",
"TERMINATED"
],
"type": "string",
"description": "The state of an asset discovery run."
}
}
},
"NotificationConfig": {
"id": "NotificationConfig",
"type": "object",
"properties": {
"description": {
"description": "The description of the notification config (max of 1024 characters).",
"type": "string"
},
"pubsubTopic": {
"description": "The Pub/Sub topic to send notifications to. Its format is \"projects/[project_id]/topics/[topic]\".",
"type": "string"
},
"serviceAccount": {
"description": "Output only. The service account that needs \"pubsub.topics.publish\" permission to publish to the Pub/Sub topic.",
"readOnly": true,
"type": "string"
},
"name": {
"type": "string",
"description": "The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/notificationConfigs/notify_public_bucket\"."
},
"streamingConfig": {
"description": "The config for triggering streaming-based notifications.",
"$ref": "StreamingConfig"
}
},
"description": "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."
},
"Finding": {
"description": "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.",
"id": "Finding",
"type": "object",
"properties": {
"state": {
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"INACTIVE"
],
"enumDescriptions": [
"Unspecified state.",
"The finding requires attention and has not been addressed yet.",
"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active."
],
"description": "The state of the finding.",
"type": "string"
},
"category": {
"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"",
"type": "string"
},
"sourceProperties": {
"additionalProperties": {
"type": "any"
},
"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.",
"type": "object"
},
"externalUri": {
"type": "string",
"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL."
},
"createTime": {
"description": "The time at which the finding was created in Security Command Center.",
"format": "google-datetime",
"type": "string"
},
"parent": {
"type": "string",
"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\""
},
"resourceName": {
"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.",
"type": "string"
},
"name": {
"type": "string",
"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\""
},
"securityMarks": {
"readOnly": true,
"$ref": "SecurityMarks",
"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding."
},
"eventTime": {
"type": "string",
"format": "google-datetime",
"description": "The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved."
}
}
},
"Empty": {
"properties": {},
"id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"properties": {
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"response": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object",
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`."
},
"metadata": {
"type": "object",
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
},
"done": {
"type": "boolean",
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."
},
"name": {
"type": "string",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`."
}
},
"type": "object",
"id": "Operation"
},
"GoogleCloudSecuritycenterV1p1beta1Finding": {
"description": "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.",
"type": "object",
"id": "GoogleCloudSecuritycenterV1p1beta1Finding",
"properties": {
"securityMarks": {
"readOnly": true,
"$ref": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks",
"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding."
},
"externalUri": {
"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.",
"type": "string"
},
"category": {
"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"",
"type": "string"
},
"sourceProperties": {
"additionalProperties": {
"type": "any"
},
"type": "object",
"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only."
},
"createTime": {
"description": "The time at which the finding was created in Security Command Center.",
"format": "google-datetime",
"type": "string"
},
"name": {
"type": "string",
"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\""
},
"resourceName": {
"type": "string",
"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time."
},
"severity": {
"type": "string",
"enum": [
"SEVERITY_UNSPECIFIED",
"CRITICAL",
"HIGH",
"MEDIUM",
"LOW"
],
"enumDescriptions": [
"No severity specified. The default value.",
"Critical severity.",
"High severity.",
"Medium severity.",
"Low severity."
],
"description": "The severity of the finding. This field is managed by the source that writes the finding."
},
"eventTime": {
"description": "The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved.",
"type": "string",
"format": "google-datetime"
},
"parent": {
"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"",
"type": "string"
},
"state": {
"type": "string",
"enumDescriptions": [
"Unspecified state.",
"The finding requires attention and has not been addressed yet.",
"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active."
],
"description": "The state of the finding.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"INACTIVE"
]
}
}
},
"GoogleCloudSecuritycenterV1NotificationMessage": {
"description": "Cloud SCC's Notification",
"properties": {
"notificationConfigName": {
"type": "string",
"description": "Name of the notification config that generated current notification."
},
"resource": {
"$ref": "GoogleCloudSecuritycenterV1Resource",
"description": "The Cloud resource tied to this notification's Finding."
},
"finding": {
"description": "If it's a Finding based notification config, this field will be populated.",
"$ref": "Finding"
}
},
"id": "GoogleCloudSecuritycenterV1NotificationMessage",
"type": "object"
},
"GetIamPolicyRequest": {
"type": "object",
"description": "Request message for `GetIamPolicy` method.",
"properties": {
"options": {
"$ref": "GetPolicyOptions",
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`."
}
},
"id": "GetIamPolicyRequest"
},
"ListAssetsResult": {
"properties": {
"stateChange": {
"enum": [
"UNUSED",
"ADDED",
"REMOVED",
"ACTIVE"
],
"description": "State change of the asset between the points in time.",
"type": "string",
"enumDescriptions": [
"State change is unused, this is the canonical default for this enum.",
"Asset was added between the points in time.",
"Asset was removed between the points in time.",
"Asset was present at both point(s) in time."
]
},
"asset": {
"description": "Asset matching the search request.",
"$ref": "Asset"
}
},
"type": "object",
"id": "ListAssetsResult",
"description": "Result containing the Asset and its State."
},
"GroupFindingsRequest": {
"type": "object",
"id": "GroupFindingsRequest",
"properties": {
"pageToken": {
"type": "string",
"description": "The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data."
},
"groupBy": {
"description": "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 The following fields are supported when compare_duration is set: * state_change",
"type": "string"
},
"pageSize": {
"type": "integer",
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32"
},
"compareDuration": {
"description": "When compare_duration is set, the GroupResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.",
"format": "google-duration",
"type": "string"
},
"filter": {
"type": "string",
"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`"
},
"readTime": {
"format": "google-datetime",
"type": "string",
"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW."
}
},
"description": "Request message for grouping by findings."
},
"ListNotificationConfigsResponse": {
"type": "object",
"description": "Response message for listing notification configs.",
"id": "ListNotificationConfigsResponse",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results, or empty if there are no more results."
},
"notificationConfigs": {
"items": {
"$ref": "NotificationConfig"
},
"type": "array",
"description": "Notification configs belonging to the requested parent."
}
}
},
"SecurityCenterProperties": {
"properties": {
"resourceProjectDisplayName": {
"type": "string",
"description": "The user defined display name for the project of this resource."
},
"resourceName": {
"type": "string",
"description": "The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name"
},
"resourceDisplayName": {
"type": "string",
"description": "The user defined display name for this resource."
},
"resourceParentDisplayName": {
"type": "string",
"description": "The user defined display name for the parent of this resource."
},
"resourceProject": {
"type": "string",
"description": "The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name"
},
"folders": {
"items": {
"$ref": "Folder"
},
"description": "Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.",
"type": "array"
},
"resourceOwners": {
"items": {
"type": "string"
},
"description": "Owners of the Google Cloud resource.",
"type": "array"
},
"resourceParent": {
"type": "string",
"description": "The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name"
},
"resourceType": {
"type": "string",
"description": "The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time."
}
},
"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.",
"type": "object",
"id": "SecurityCenterProperties"
},
"Binding": {
"id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"condition": {
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"$ref": "Expr"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"GroupResult": {
"description": "Result containing the properties and count of a groupBy request.",
"properties": {
"properties": {
"additionalProperties": {
"type": "any"
},
"type": "object",
"description": "Properties matching the groupBy fields in the request."
},
"count": {
"type": "string",
"format": "int64",
"description": "Total count of resources for the given properties."
}
},
"id": "GroupResult",
"type": "object"
},
"GoogleCloudSecuritycenterV1Resource": {
"type": "object",
"properties": {
"project": {
"description": "The full resource name of project that the resource belongs to.",
"type": "string"
},
"parentDisplayName": {
"type": "string",
"description": "The human readable name of resource's parent."
},
"folders": {
"type": "array",
"items": {
"$ref": "Folder"
},
"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.",
"readOnly": true
},
"name": {
"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name",
"type": "string"
},
"projectDisplayName": {
"description": "The human readable name of project that the resource belongs to.",
"type": "string"
},
"parent": {
"type": "string",
"description": "The full resource name of resource's parent."
}
},
"description": "Information related to the Google Cloud resource.",
"id": "GoogleCloudSecuritycenterV1Resource"
},
"ListSourcesResponse": {
"id": "ListSourcesResponse",
"description": "Response message for listing sources.",
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"$ref": "Source"
},
"description": "Sources belonging to the requested parent."
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results.",
"type": "string"
}
}
},
"GetPolicyOptions": {
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"type": "integer",
"format": "int32"
}
},
"type": "object",
"description": "Encapsulates settings provided to GetIamPolicy."
},
"Expr": {
"type": "object",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"type": "string",
"description": "Textual representation of an expression in Common Expression Language syntax."
},
"location": {
"type": "string",
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file."
},
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
"type": "string"
}
},
"id": "Expr",
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information."
},
"StreamingConfig": {
"properties": {
"filter": {
"type": "string",
"description": "Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes."
}
},
"id": "StreamingConfig",
"description": "The config for streaming-based notifications, which send each event as soon as it is detected.",
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1Resource": {
"description": "Information related to the Google Cloud resource.",
"id": "GoogleCloudSecuritycenterV1p1beta1Resource",
"properties": {
"project": {
"description": "The full resource name of project that the resource belongs to.",
"type": "string"
},
"name": {
"type": "string",
"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name"
},
"folders": {
"readOnly": true,
"items": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1Folder"
},
"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.",
"type": "array"
},
"parentDisplayName": {
"description": "The human readable name of resource's parent.",
"type": "string"
},
"parent": {
"type": "string",
"description": "The full resource name of resource's parent."
},
"projectDisplayName": {
"description": "The human readable name of project that the resource belongs to.",
"type": "string"
}
},
"type": "object"
},
"Status": {
"id": "Status",
"type": "object",
"properties": {
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
},
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer",
"format": "int32"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
}
}
},
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."
},
"SetIamPolicyRequest": {
"id": "SetIamPolicyRequest",
"properties": {
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
"type": "string",
"format": "google-fieldmask"
},
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
}
},
"type": "object",
"description": "Request message for `SetIamPolicy` method."
},
"GroupFindingsResponse": {
"id": "GroupFindingsResponse",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results, or empty if there are no more results."
},
"groupByResults": {
"type": "array",
"items": {
"$ref": "GroupResult"
},
"description": "Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear."
},
"totalSize": {
"format": "int32",
"type": "integer",
"description": "The total number of results matching the query."
},
"readTime": {
"type": "string",
"format": "google-datetime",
"description": "Time used for executing the groupBy request."
}
},
"type": "object",
"description": "Response message for group by findings."
},
"GoogleCloudSecuritycenterV1p1beta1SecurityMarks": {
"id": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks",
"description": "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.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\"."
},
"marks": {
"additionalProperties": {
"type": "string"
},
"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)",
"type": "object"
}
}
},
"GoogleCloudSecuritycenterV1p1beta1Folder": {
"description": "Message that contains the resource name and display name of a folder resource.",
"properties": {
"resourceFolderDisplayName": {
"description": "The user defined display name for this folder.",
"type": "string"
},
"resourceFolder": {
"type": "string",
"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name"
}
},
"type": "object",
"id": "GoogleCloudSecuritycenterV1p1beta1Folder"
},
"Resource": {
"id": "Resource",
"properties": {
"parentDisplayName": {
"description": "The human readable name of resource's parent.",
"type": "string"
},
"folders": {
"items": {
"$ref": "Folder"
},
"description": "Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.",
"type": "array"
},
"projectName": {
"type": "string",
"description": "The full resource name of project that the resource belongs to."
},
"projectDisplayName": {
"type": "string",
"description": "The human readable name of project that the resource belongs to."
},
"parentName": {
"description": "The full resource name of resource's parent.",
"type": "string"
},
"name": {
"type": "string",
"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name"
}
},
"description": "Information related to the Google Cloud resource that is associated with this finding. LINT.IfChange",
"type": "object"
},
"ListFindingsResult": {
"id": "ListFindingsResult",
"description": "Result containing the Finding and its StateChange.",
"properties": {
"finding": {
"$ref": "Finding",
"description": "Finding matching the search request."
},
"resource": {
"readOnly": true,
"description": "Output only. Resource that is associated with this finding.",
"$ref": "Resource"
},
"stateChange": {
"enumDescriptions": [
"State change is unused, this is the canonical default for this enum.",
"The finding has changed state in some way between the points in time and existed at both points.",
"The finding has not changed state between the points in time and existed at both points.",
"The finding was created between the points in time.",
"The finding at timestamp does not match the filter specified, but it did at timestamp - compare_duration."
],
"enum": [
"UNUSED",
"CHANGED",
"UNCHANGED",
"ADDED",
"REMOVED"
],
"type": "string",
"description": "State change of the finding between the points in time."
}
},
"type": "object"
},
"RunAssetDiscoveryRequest": {
"id": "RunAssetDiscoveryRequest",
"type": "object",
"properties": {},
"description": "Request message for running asset discovery for an organization."
},
"Folder": {
"description": "Message that contains the resource name and display name of a folder resource.",
"properties": {
"resourceFolder": {
"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name",
"type": "string"
},
"resourceFolderDisplayName": {
"type": "string",
"description": "The user defined display name for this folder."
}
},
"id": "Folder",
"type": "object"
},
"ListAssetsResponse": {
"description": "Response message for listing assets.",
"id": "ListAssetsResponse",
"properties": {
"readTime": {
"type": "string",
"description": "Time used for executing the list request.",
"format": "google-datetime"
},
"listAssetsResults": {
"type": "array",
"description": "Assets matching the list request.",
"items": {
"$ref": "ListAssetsResult"
}
},
"totalSize": {
"description": "The total number of assets matching the query.",
"type": "integer",
"format": "int32"
},
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results, or empty if there are no more results."
}
},
"type": "object"
},
"TestIamPermissionsRequest": {
"type": "object",
"id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"properties": {
"permissions": {
"items": {
"type": "string"
},
"type": "array",
"description": "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)."
}
}
}
},
"ownerDomain": "google.com",
"name": "securitycenter",
"documentationLink": "https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview",
"parameters": {
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"alt": {
"default": "json",
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
},
"access_token": {
"type": "string",
"location": "query",
"description": "OAuth access token."
},
"callback": {
"type": "string",
"description": "JSONP",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query"
},
"oauth_token": {
"location": "query",
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"default": "true"
}
},
"baseUrl": "https://securitycenter.googleapis.com/",
"kind": "discovery#restDescription",
"basePath": "",
"mtlsRootUrl": "https://securitycenter.mtls.googleapis.com/",
"ownerName": "Google",
"revision": "20201112",
"fullyEncodeReservedExpansion": true,
"description": "Security Command Center API provides access to temporal views of assets and findings within an organization.",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"title": "Security Command Center API",
"version": "v1",
"version_module": true,
"discoveryVersion": "v1",
"protocol": "rest",
"resources": {
"folders": {
"resources": {
"assets": {
"methods": {
"updateSecurityMarks": {
"request": {
"$ref": "SecurityMarks"
},
"parameterOrder": [
"name"
],
"path": "v1/{+name}",
"description": "Updates security marks.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "PATCH",
"response": {
"$ref": "SecurityMarks"
},
"parameters": {
"name": {
"type": "string",
"pattern": "^folders/[^/]+/assets/[^/]+/securityMarks$",
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".",
"required": true,
"location": "path"
},
"startTime": {
"format": "google-datetime",
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.",
"type": "string",
"location": "query"
},
"updateMask": {
"format": "google-fieldmask",
"location": "query",
"type": "string",
"description": "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.\"."
}
},
"flatPath": "v1/folders/{foldersId}/assets/{assetsId}/securityMarks",
"id": "securitycenter.folders.assets.updateSecurityMarks"
},
"group": {
"httpMethod": "POST",
"response": {
"$ref": "GroupAssetsResponse"
},
"parameterOrder": [
"parent"
],
"flatPath": "v1/folders/{foldersId}/assets:group",
"parameters": {
"parent": {
"description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"type": "string",
"pattern": "^folders/[^/]+$",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1/{+parent}/assets:group",
"request": {
"$ref": "GroupAssetsRequest"
},
"id": "securitycenter.folders.assets.group",
"description": "Filters an organization's assets and groups them by their specified properties."
},
"list": {
"id": "securitycenter.folders.assets.list",
"httpMethod": "GET",
"path": "v1/{+parent}/assets",
"flatPath": "v1/folders/{foldersId}/assets",
"parameterOrder": [
"parent"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListAssetsResponse"
},
"description": "Lists an organization's assets.",
"parameters": {
"readTime": {
"type": "string",
"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.",
"location": "query",
"format": "google-datetime"
},
"compareDuration": {
"description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.",
"format": "google-duration",
"type": "string",
"location": "query"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data."
},
"fieldMask": {
"location": "query",
"format": "google-fieldmask",
"description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.",
"type": "string"
},
"orderBy": {
"location": "query",
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"type": "integer",
"location": "query"
},
"filter": {
"location": "query",
"type": "string",
"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`"
},
"parent": {
"type": "string",
"location": "path",
"pattern": "^folders/[^/]+$",
"required": true,
"description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\"."
}
}
}
}
},
"sources": {
"resources": {
"findings": {
"methods": {
"list": {
"httpMethod": "GET",
"description": "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",
"response": {
"$ref": "ListFindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "securitycenter.folders.sources.findings.list",
"parameterOrder": [
"parent"
],
"path": "v1/{+parent}/findings",
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings",
"parameters": {
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"compareDuration": {
"description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.",
"type": "string",
"format": "google-duration",
"location": "query"
},
"filter": {
"location": "query",
"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` security_marks.marks: `=`, `:` source_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`",
"type": "string"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data."
},
"readTime": {
"type": "string",
"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.",
"format": "google-datetime",
"location": "query"
},
"fieldMask": {
"format": "google-fieldmask",
"type": "string",
"description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.",
"location": "query"
},
"orderBy": {
"type": "string",
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks",
"location": "query"
},
"parent": {
"location": "path",
"type": "string",
"pattern": "^folders/[^/]+/sources/[^/]+$",
"description": "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/-",
"required": true
}
}
},
"patch": {
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}",
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "Finding"
},
"id": "securitycenter.folders.sources.findings.patch",
"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.",
"path": "v1/{+name}",
"response": {
"$ref": "Finding"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$",
"required": true,
"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"",
"type": "string"
},
"updateMask": {
"description": "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.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
}
}
},
"updateSecurityMarks": {
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"type": "string",
"description": "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.\".",
"location": "query"
},
"startTime": {
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.",
"type": "string",
"location": "query",
"format": "google-datetime"
},
"name": {
"location": "path",
"pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$",
"required": true,
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "PATCH",
"description": "Updates security marks.",
"parameterOrder": [
"name"
],
"path": "v1/{+name}",
"response": {
"$ref": "SecurityMarks"
},
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}/securityMarks",
"id": "securitycenter.folders.sources.findings.updateSecurityMarks",
"request": {
"$ref": "SecurityMarks"
}
},
"group": {
"path": "v1/{+parent}/findings:group",
"parameterOrder": [
"parent"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "GroupFindingsRequest"
},
"parameters": {
"parent": {
"description": "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/-",
"pattern": "^folders/[^/]+/sources/[^/]+$",
"required": true,
"location": "path",
"type": "string"
}
},
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings:group",
"response": {
"$ref": "GroupFindingsResponse"
},
"httpMethod": "POST",
"description": "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",
"id": "securitycenter.folders.sources.findings.group"
},
"setState": {
"response": {
"$ref": "Finding"
},
"parameters": {
"name": {
"required": true,
"location": "path",
"description": "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}\".",
"pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$",
"type": "string"
}
},
"httpMethod": "POST",
"description": "Updates the state of a finding.",
"id": "securitycenter.folders.sources.findings.setState",
"request": {
"$ref": "SetFindingStateRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1/{+name}:setState",
"parameterOrder": [
"name"
],
"flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}:setState"
}
}
}
},
"methods": {
"list": {
"path": "v1/{+parent}/sources",
"id": "securitycenter.folders.sources.list",
"response": {
"$ref": "ListSourcesResponse"
},
"description": "Lists all sources belonging to an organization.",
"parameters": {
"pageToken": {
"type": "string",
"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"pattern": "^folders/[^/]+$",
"type": "string",
"required": true
},
"pageSize": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"flatPath": "v1/folders/{foldersId}/sources",
"parameterOrder": [
"parent"
]
}
}
}
}
},
"organizations": {
"resources": {
"operations": {
"methods": {
"get": {
"path": "v1/{+name}",
"parameterOrder": [
"name"
],
"flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}",
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"httpMethod": "GET",
"id": "securitycenter.organizations.operations.get",
"parameters": {
"name": {
"type": "string",
"required": true,
"location": "path",
"description": "The name of the operation resource.",
"pattern": "^organizations/[^/]+/operations/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
}
},
"cancel": {
"parameters": {
"name": {
"required": true,
"type": "string",
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^organizations/[^/]+/operations/[^/]+$"
}
},
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"id": "securitycenter.organizations.operations.cancel",
"path": "v1/{+name}:cancel",
"httpMethod": "POST",
"flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}:cancel"
},
"list": {
"parameterOrder": [
"name"
],
"path": "v1/{+name}",
"httpMethod": "GET",
"parameters": {
"pageSize": {
"location": "query",
"format": "int32",
"description": "The standard list page size.",
"type": "integer"
},
"name": {
"description": "The name of the operation's parent resource.",
"required": true,
"pattern": "^organizations/[^/]+/operations$",
"type": "string",
"location": "path"
},
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"pageToken": {
"location": "query",
"description": "The standard list page token.",
"type": "string"
}
},
"flatPath": "v1/organizations/{organizationsId}/operations",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"id": "securitycenter.organizations.operations.list",
"response": {
"$ref": "ListOperationsResponse"
}
},
"delete": {
"flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"required": true,
"type": "string",
"location": "path",
"pattern": "^organizations/[^/]+/operations/[^/]+$",
"description": "The name of the operation resource to be deleted."
}
},
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"id": "securitycenter.organizations.operations.delete",
"path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"assets": {
"methods": {
"list": {
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"type": "string",
"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.",
"location": "query"
},
"parent": {
"required": true,
"type": "string",
"pattern": "^organizations/[^/]+$",
"description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"location": "path"
},
"filter": {
"location": "query",
"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`",
"type": "string"
},
"pageSize": {
"location": "query",
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"type": "integer"
},
"orderBy": {
"location": "query",
"type": "string",
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type"
},
"readTime": {
"format": "google-datetime",
"type": "string",
"location": "query",
"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW."
},
"fieldMask": {
"format": "google-fieldmask",
"description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.",
"type": "string",
"location": "query"
},
"compareDuration": {
"format": "google-duration",
"type": "string",
"location": "query",
"description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time."
}
},
"id": "securitycenter.organizations.assets.list",
"flatPath": "v1/organizations/{organizationsId}/assets",
"response": {
"$ref": "ListAssetsResponse"
},
"path": "v1/{+parent}/assets",
"description": "Lists an organization's assets.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"runDiscovery": {
"path": "v1/{+parent}/assets:runDiscovery",
"parameterOrder": [
"parent"
],
"id": "securitycenter.organizations.assets.runDiscovery",
"flatPath": "v1/organizations/{organizationsId}/assets:runDiscovery",
"request": {
"$ref": "RunAssetDiscoveryRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"required": true,
"description": "Required. Name of the organization to run asset discovery for. Its format is \"organizations/[organization_id]\".",
"pattern": "^organizations/[^/]+$",
"type": "string",
"location": "path"
}
},
"description": "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.",
"response": {
"$ref": "Operation"
},
"httpMethod": "POST"
},
"group": {
"request": {
"$ref": "GroupAssetsRequest"
},
"path": "v1/{+parent}/assets:group",
"httpMethod": "POST",
"flatPath": "v1/organizations/{organizationsId}/assets:group",
"response": {
"$ref": "GroupAssetsResponse"
},
"id": "securitycenter.organizations.assets.group",
"description": "Filters an organization's assets and groups them by their specified properties.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"location": "path",
"required": true,
"pattern": "^organizations/[^/]+$",
"description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"type": "string"
}
}
},
"updateSecurityMarks": {
"response": {
"$ref": "SecurityMarks"
},
"parameterOrder": [
"name"
],
"request": {
"$ref": "SecurityMarks"
},
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"location": "query",
"description": "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.\".",
"type": "string"
},
"startTime": {
"type": "string",
"format": "google-datetime",
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.",
"location": "query"
},
"name": {
"pattern": "^organizations/[^/]+/assets/[^/]+/securityMarks$",
"location": "path",
"required": true,
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".",
"type": "string"
}
},
"flatPath": "v1/organizations/{organizationsId}/assets/{assetsId}/securityMarks",
"id": "securitycenter.organizations.assets.updateSecurityMarks",
"description": "Updates security marks.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1/{+name}"
}
}
},
"sources": {
"methods": {
"get": {
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}",
"response": {
"$ref": "Source"
},
"parameters": {
"name": {
"required": true,
"description": "Required. Relative resource name of the source. Its format is \"organizations/[organization_id]/source/[source_id]\".",
"type": "string",
"location": "path",
"pattern": "^organizations/[^/]+/sources/[^/]+$"
}
},
"httpMethod": "GET",
"id": "securitycenter.organizations.sources.get",
"path": "v1/{+name}",
"description": "Gets a source.",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"parameters": {
"resource": {
"type": "string",
"location": "path",
"pattern": "^organizations/[^/]+/sources/[^/]+$",
"required": true,
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field."
}
},
"id": "securitycenter.organizations.sources.testIamPermissions",
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}:testIamPermissions",
"description": "Returns the permissions that a caller has on the specified source.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"resource"
],
"request": {
"$ref": "TestIamPermissionsRequest"
},
"httpMethod": "POST",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"path": "v1/{+resource}:testIamPermissions"
},
"patch": {
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}",
"path": "v1/{+name}",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"description": "The FieldMask to use when updating the source resource. If empty all mutable fields will be updated.",
"location": "query",
"format": "google-fieldmask",
"type": "string"
},
"name": {
"type": "string",
"description": "The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}\"",
"pattern": "^organizations/[^/]+/sources/[^/]+$",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Updates a source.",
"response": {
"$ref": "Source"
},
"httpMethod": "PATCH",
"request": {
"$ref": "Source"
},
"id": "securitycenter.organizations.sources.patch"
},
"list": {
"description": "Lists all sources belonging to an organization.",
"parameters": {
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"location": "path",
"type": "string",
"pattern": "^organizations/[^/]+$",
"required": true
},
"pageToken": {
"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
}
},
"httpMethod": "GET",
"flatPath": "v1/organizations/{organizationsId}/sources",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListSourcesResponse"
},
"id": "securitycenter.organizations.sources.list",
"path": "v1/{+parent}/sources",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified Source.",
"parameterOrder": [
"resource"
],
"request": {
"$ref": "SetIamPolicyRequest"
},
"path": "v1/{+resource}:setIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Policy"
},
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"required": true,
"type": "string",
"pattern": "^organizations/[^/]+/sources/[^/]+$"
}
},
"id": "securitycenter.organizations.sources.setIamPolicy",
"httpMethod": "POST",
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}:setIamPolicy"
},
"getIamPolicy": {
"request": {
"$ref": "GetIamPolicyRequest"
},
"parameterOrder": [
"resource"
],
"id": "securitycenter.organizations.sources.getIamPolicy",
"description": "Gets the access control policy on the specified Source.",
"httpMethod": "POST",
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"path": "v1/{+resource}:getIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"type": "string",
"pattern": "^organizations/[^/]+/sources/[^/]+$",
"required": true,
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path"
}
}
},
"create": {
"request": {
"$ref": "Source"
},
"flatPath": "v1/organizations/{organizationsId}/sources",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Source"
},
"description": "Creates a source.",
"parameterOrder": [
"parent"
],
"path": "v1/{+parent}/sources",
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Required. Resource name of the new source's parent. Its format should be \"organizations/[organization_id]\".",
"location": "path",
"pattern": "^organizations/[^/]+$",
"type": "string",
"required": true
}
},
"id": "securitycenter.organizations.sources.create"
}
},
"resources": {
"findings": {
"methods": {
"create": {
"path": "v1/{+parent}/findings",
"id": "securitycenter.organizations.sources.findings.create",
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"request": {
"$ref": "Finding"
},
"description": "Creates a finding. The corresponding source must exist for finding creation to succeed.",
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings",
"response": {
"$ref": "Finding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"findingId": {
"type": "string",
"location": "query",
"description": "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."
},
"parent": {
"required": true,
"description": "Required. Resource name of the new finding's parent. Its format should be \"organizations/[organization_id]/sources/[source_id]\".",
"pattern": "^organizations/[^/]+/sources/[^/]+$",
"location": "path",
"type": "string"
}
}
},
"patch": {
"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.",
"response": {
"$ref": "Finding"
},
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"location": "query",
"type": "string",
"format": "google-fieldmask",
"description": "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."
},
"name": {
"type": "string",
"required": true,
"location": "path",
"pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$",
"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\""
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1/{+name}",
"httpMethod": "PATCH",
"request": {
"$ref": "Finding"
},
"id": "securitycenter.organizations.sources.findings.patch",
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}"
},
"group": {
"request": {
"$ref": "GroupFindingsRequest"
},
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings:group",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "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",
"response": {
"$ref": "GroupFindingsResponse"
},
"parameters": {
"parent": {
"description": "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/-",
"type": "string",
"pattern": "^organizations/[^/]+/sources/[^/]+$",
"required": true,
"location": "path"
}
},
"id": "securitycenter.organizations.sources.findings.group",
"path": "v1/{+parent}/findings:group",
"parameterOrder": [
"parent"
]
},
"setState": {
"parameterOrder": [
"name"
],
"request": {
"$ref": "SetFindingStateRequest"
},
"path": "v1/{+name}:setState",
"id": "securitycenter.organizations.sources.findings.setState",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Finding"
},
"parameters": {
"name": {
"required": true,
"description": "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}\".",
"type": "string",
"pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}:setState",
"description": "Updates the state of a finding.",
"httpMethod": "POST"
},
"list": {
"id": "securitycenter.organizations.sources.findings.list",
"description": "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",
"response": {
"$ref": "ListFindingsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"readTime": {
"format": "google-datetime",
"location": "query",
"type": "string",
"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW."
},
"filter": {
"type": "string",
"location": "query",
"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` security_marks.marks: `=`, `:` source_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`"
},
"fieldMask": {
"location": "query",
"description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.",
"type": "string",
"format": "google-fieldmask"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"type": "integer",
"location": "query"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data."
},
"compareDuration": {
"location": "query",
"description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.",
"type": "string",
"format": "google-duration"
},
"orderBy": {
"location": "query",
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks",
"type": "string"
},
"parent": {
"location": "path",
"required": true,
"pattern": "^organizations/[^/]+/sources/[^/]+$",
"type": "string",
"description": "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/-"
}
},
"httpMethod": "GET",
"path": "v1/{+parent}/findings",
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings",
"parameterOrder": [
"parent"
]
},
"updateSecurityMarks": {
"parameters": {
"updateMask": {
"description": "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.\".",
"type": "string",
"format": "google-fieldmask",
"location": "query"
},
"name": {
"pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$",
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".",
"type": "string",
"location": "path",
"required": true
},
"startTime": {
"format": "google-datetime",
"location": "query",
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "SecurityMarks"
},
"httpMethod": "PATCH",
"id": "securitycenter.organizations.sources.findings.updateSecurityMarks",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "SecurityMarks"
},
"parameterOrder": [
"name"
],
"flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}/securityMarks",
"description": "Updates security marks."
}
}
}
}
},
"notificationConfigs": {
"methods": {
"get": {
"flatPath": "v1/organizations/{organizationsId}/notificationConfigs/{notificationConfigsId}",
"description": "Gets a notification config.",
"parameterOrder": [
"name"
],
"id": "securitycenter.organizations.notificationConfigs.get",
"parameters": {
"name": {
"required": true,
"location": "path",
"pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$",
"description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\".",
"type": "string"
}
},
"httpMethod": "GET",
"path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "NotificationConfig"
}
},
"create": {
"request": {
"$ref": "NotificationConfig"
},
"response": {
"$ref": "NotificationConfig"
},
"path": "v1/{+parent}/notificationConfigs",
"id": "securitycenter.organizations.notificationConfigs.create",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/organizations/{organizationsId}/notificationConfigs",
"parameters": {
"configId": {
"location": "query",
"type": "string",
"description": "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."
},
"parent": {
"pattern": "^organizations/[^/]+$",
"location": "path",
"type": "string",
"description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\".",
"required": true
}
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"description": "Creates a notification config."
},
"patch": {
"request": {
"$ref": "NotificationConfig"
},
"response": {
"$ref": "NotificationConfig"
},
"description": " Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "securitycenter.organizations.notificationConfigs.patch",
"flatPath": "v1/organizations/{organizationsId}/notificationConfigs/{notificationConfigsId}",
"path": "v1/{+name}",
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"required": true,
"pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$",
"location": "path",
"type": "string",
"description": "The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/notificationConfigs/notify_public_bucket\"."
},
"updateMask": {
"description": "The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.",
"type": "string",
"format": "google-fieldmask",
"location": "query"
}
}
},
"delete": {
"path": "v1/{+name}",
"flatPath": "v1/organizations/{organizationsId}/notificationConfigs/{notificationConfigsId}",
"parameters": {
"name": {
"description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\".",
"type": "string",
"required": true,
"location": "path",
"pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$"
}
},
"parameterOrder": [
"name"
],
"id": "securitycenter.organizations.notificationConfigs.delete",
"response": {
"$ref": "Empty"
},
"httpMethod": "DELETE",
"description": "Deletes a notification config.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"required": true,
"pattern": "^organizations/[^/]+$",
"type": "string",
"description": "Required. Name of the organization to list notification configs. Its format is \"organizations/[organization_id]\".",
"location": "path"
}
},
"parameterOrder": [
"parent"
],
"flatPath": "v1/organizations/{organizationsId}/notificationConfigs",
"httpMethod": "GET",
"response": {
"$ref": "ListNotificationConfigsResponse"
},
"id": "securitycenter.organizations.notificationConfigs.list",
"description": "Lists notification configs.",
"path": "v1/{+parent}/notificationConfigs"
}
}
}
},
"methods": {
"updateOrganizationSettings": {
"id": "securitycenter.organizations.updateOrganizationSettings",
"response": {
"$ref": "OrganizationSettings"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"required": true,
"location": "path",
"description": "The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/organizationSettings\".",
"pattern": "^organizations/[^/]+/organizationSettings$",
"type": "string"
},
"updateMask": {
"description": "The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
}
},
"request": {
"$ref": "OrganizationSettings"
},
"description": "Updates an organization's settings.",
"flatPath": "v1/organizations/{organizationsId}/organizationSettings",
"path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "PATCH"
},
"getOrganizationSettings": {
"path": "v1/{+name}",
"flatPath": "v1/organizations/{organizationsId}/organizationSettings",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^organizations/[^/]+/organizationSettings$",
"description": "Required. Name of the organization to get organization settings for. Its format is \"organizations/[organization_id]/organizationSettings\".",
"location": "path",
"type": "string",
"required": true
}
},
"id": "securitycenter.organizations.getOrganizationSettings",
"description": "Gets the settings for an organization.",
"response": {
"$ref": "OrganizationSettings"
}
}
}
},
"projects": {
"resources": {
"sources": {
"resources": {
"findings": {
"methods": {
"patch": {
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$",
"required": true,
"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"",
"location": "path"
},
"updateMask": {
"description": "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.",
"type": "string",
"location": "query",
"format": "google-fieldmask"
}
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"response": {
"$ref": "Finding"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}",
"request": {
"$ref": "Finding"
},
"path": "v1/{+name}",
"id": "securitycenter.projects.sources.findings.patch",
"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed."
},
"updateSecurityMarks": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}/securityMarks",
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"description": "Updates security marks.",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$",
"location": "path",
"required": true,
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".",
"type": "string"
},
"updateMask": {
"format": "google-fieldmask",
"type": "string",
"description": "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.\".",
"location": "query"
},
"startTime": {
"location": "query",
"type": "string",
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.",
"format": "google-datetime"
}
},
"id": "securitycenter.projects.sources.findings.updateSecurityMarks",
"response": {
"$ref": "SecurityMarks"
},
"request": {
"$ref": "SecurityMarks"
},
"path": "v1/{+name}"
},
"group": {
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "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",
"parameters": {
"parent": {
"description": "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/-",
"required": true,
"pattern": "^projects/[^/]+/sources/[^/]+$",
"type": "string",
"location": "path"
}
},
"request": {
"$ref": "GroupFindingsRequest"
},
"flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings:group",
"response": {
"$ref": "GroupFindingsResponse"
},
"path": "v1/{+parent}/findings:group",
"id": "securitycenter.projects.sources.findings.group",
"parameterOrder": [
"parent"
]
},
"list": {
"id": "securitycenter.projects.sources.findings.list",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListFindingsResponse"
},
"path": "v1/{+parent}/findings",
"description": "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",
"httpMethod": "GET",
"parameters": {
"fieldMask": {
"type": "string",
"location": "query",
"format": "google-fieldmask",
"description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields."
},
"compareDuration": {
"location": "query",
"description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.",
"type": "string",
"format": "google-duration"
},
"filter": {
"type": "string",
"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` security_marks.marks: `=`, `:` source_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`",
"location": "query"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data."
},
"parent": {
"location": "path",
"description": "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/-",
"type": "string",
"pattern": "^projects/[^/]+/sources/[^/]+$",
"required": true
},
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"type": "integer",
"format": "int32",
"location": "query"
},
"readTime": {
"type": "string",
"location": "query",
"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.",
"format": "google-datetime"
},
"orderBy": {
"location": "query",
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings"
},
"setState": {
"path": "v1/{+name}:setState",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "SetFindingStateRequest"
},
"httpMethod": "POST",
"id": "securitycenter.projects.sources.findings.setState",
"response": {
"$ref": "Finding"
},
"description": "Updates the state of a finding.",
"parameterOrder": [
"name"
],
"flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}:setState",
"parameters": {
"name": {
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$",
"type": "string",
"description": "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}\"."
}
}
}
}
}
},
"methods": {
"list": {
"path": "v1/{+parent}/sources",
"id": "securitycenter.projects.sources.list",
"parameters": {
"pageSize": {
"format": "int32",
"location": "query",
"type": "integer",
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000."
},
"parent": {
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path",
"type": "string",
"description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\"."
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data."
}
},
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"description": "Lists all sources belonging to an organization.",
"response": {
"$ref": "ListSourcesResponse"
},
"flatPath": "v1/projects/{projectsId}/sources",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"assets": {
"methods": {
"group": {
"request": {
"$ref": "GroupAssetsRequest"
},
"description": "Filters an organization's assets and groups them by their specified properties.",
"parameters": {
"parent": {
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\"."
}
},
"path": "v1/{+parent}/assets:group",
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GroupAssetsResponse"
},
"id": "securitycenter.projects.assets.group",
"flatPath": "v1/projects/{projectsId}/assets:group",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"id": "securitycenter.projects.assets.list",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Lists an organization's assets.",
"flatPath": "v1/projects/{projectsId}/assets",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".",
"location": "path",
"type": "string",
"required": true
},
"pageToken": {
"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"readTime": {
"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.",
"format": "google-datetime",
"type": "string",
"location": "query"
},
"filter": {
"location": "query",
"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`",
"type": "string"
},
"fieldMask": {
"type": "string",
"description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.",
"format": "google-fieldmask",
"location": "query"
},
"orderBy": {
"type": "string",
"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type",
"location": "query"
},
"compareDuration": {
"format": "google-duration",
"description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.",
"format": "int32",
"type": "integer",
"location": "query"
}
},
"response": {
"$ref": "ListAssetsResponse"
},
"path": "v1/{+parent}/assets"
},
"updateSecurityMarks": {
"path": "v1/{+name}",
"parameterOrder": [
"name"
],
"id": "securitycenter.projects.assets.updateSecurityMarks",
"parameters": {
"startTime": {
"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.",
"location": "query",
"format": "google-datetime",
"type": "string"
},
"updateMask": {
"location": "query",
"description": "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.\".",
"type": "string",
"format": "google-fieldmask"
},
"name": {
"pattern": "^projects/[^/]+/assets/[^/]+/securityMarks$",
"type": "string",
"location": "path",
"required": true,
"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\"."
}
},
"flatPath": "v1/projects/{projectsId}/assets/{assetsId}/securityMarks",
"httpMethod": "PATCH",
"response": {
"$ref": "SecurityMarks"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Updates security marks.",
"request": {
"$ref": "SecurityMarks"
}
}
}
}
}
}
},
"batchPath": "batch"
}