blob: 480ac179db8e03cfa3284beb38ff296c9f32c2a7 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://securitycenter.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Security Command Center",
"description": "Security Command Center API provides access to temporal views of assets and findings within an organization.",
"discoveryVersion": "v1",
"documentationLink": "https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview",
"fullyEncodeReservedExpansion": true,
"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:v1p1alpha1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://securitycenter.mtls.googleapis.com/",
"name": "securitycenter",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"organizations": {
"resources": {
"operations": {
"methods": {
"cancel": {
"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`.",
"flatPath": "v1p1alpha1/organizations/{organizationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "securitycenter.organizations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^organizations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1p1alpha1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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`.",
"flatPath": "v1p1alpha1/organizations/{organizationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "securitycenter.organizations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^organizations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1p1alpha1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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.",
"flatPath": "v1p1alpha1/organizations/{organizationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "securitycenter.organizations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^organizations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1p1alpha1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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.",
"flatPath": "v1p1alpha1/organizations/{organizationsId}/operations",
"httpMethod": "GET",
"id": "securitycenter.organizations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^organizations/[^/]+/operations$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1p1alpha1/{+name}",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20200820",
"rootUrl": "https://securitycenter.googleapis.com/",
"schemas": {
"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 `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"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",
"properties": {
"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"
},
"createTime": {
"description": "The time at which the finding was created in Security Command Center.",
"format": "google-datetime",
"type": "string"
},
"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.",
"format": "google-datetime",
"type": "string"
},
"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"
},
"name": {
"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"
},
"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"
},
"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"
},
"securityMarks": {
"$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.",
"readOnly": true
},
"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"
},
"state": {
"description": "The state of the finding.",
"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."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1NotificationMessage": {
"description": "Cloud SCC's Notification",
"id": "GoogleCloudSecuritycenterV1NotificationMessage",
"properties": {
"finding": {
"$ref": "Finding",
"description": "If it's a Finding based notification config, this field will be populated."
},
"notificationConfigName": {
"description": "Name of the notification config that generated current notification.",
"type": "string"
},
"resource": {
"$ref": "GoogleCloudSecuritycenterV1Resource",
"description": "The Cloud resource tied to this notification's Finding."
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1Resource": {
"description": " Information related to the Google Cloud resource.",
"id": "GoogleCloudSecuritycenterV1Resource",
"properties": {
"name": {
"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name",
"type": "string"
},
"parent": {
"description": "The full resource name of resource's parent.",
"type": "string"
},
"parentDisplayName": {
"description": " The human readable name of resource's parent.",
"type": "string"
},
"project": {
"description": "The full resource name of project that the resource belongs to.",
"type": "string"
},
"projectDisplayName": {
"description": " The human readable name of project that the resource belongs to.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": {
"description": "Response of asset discovery run",
"id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse",
"properties": {
"duration": {
"description": "The duration between asset discovery run start and end",
"format": "google-duration",
"type": "string"
},
"state": {
"description": "The state of an asset discovery run.",
"enum": [
"STATE_UNSPECIFIED",
"COMPLETED",
"SUPERSEDED",
"TERMINATED"
],
"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"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse": {
"description": "Response of asset discovery run",
"id": "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse",
"properties": {
"duration": {
"description": "The duration between asset discovery run start and end",
"format": "google-duration",
"type": "string"
},
"state": {
"description": "The state of an asset discovery run.",
"enum": [
"STATE_UNSPECIFIED",
"COMPLETED",
"SUPERSEDED",
"TERMINATED"
],
"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"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1Asset": {
"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": "GoogleCloudSecuritycenterV1p1beta1Asset",
"properties": {
"createTime": {
"description": "The time at which the asset was created in Security Command Center.",
"format": "google-datetime",
"type": "string"
},
"iamPolicy": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1IamPolicy",
"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."
},
"name": {
"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}\".",
"type": "string"
},
"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"
},
"securityCenterProperties": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties",
"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user."
},
"securityMarks": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks",
"description": "User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset."
},
"updateTime": {
"description": "The time at which the asset was last updated, added, or deleted in Cloud SCC.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"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.",
"id": "GoogleCloudSecuritycenterV1p1beta1Finding",
"properties": {
"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"
},
"createTime": {
"description": "The time at which the finding was created in Security Command Center.",
"format": "google-datetime",
"type": "string"
},
"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.",
"format": "google-datetime",
"type": "string"
},
"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"
},
"name": {
"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"
},
"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"
},
"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"
},
"securityMarks": {
"$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.",
"readOnly": true
},
"severity": {
"description": "The severity of the finding.",
"enum": [
"SEVERITY_UNSPECIFIED",
"CRITICAL",
"HIGH",
"MEDIUM",
"LOW"
],
"enumDescriptions": [
"No severity specified. The default value.",
"Critical severity.",
"High severity.",
"Medium severity.",
"Low severity."
],
"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"
},
"state": {
"description": "The state of the finding.",
"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."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1IamPolicy": {
"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.",
"id": "GoogleCloudSecuritycenterV1p1beta1IamPolicy",
"properties": {
"policyBlob": {
"description": "The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for format details.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1NotificationMessage": {
"description": "Security Command Center's Notification",
"id": "GoogleCloudSecuritycenterV1p1beta1NotificationMessage",
"properties": {
"finding": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding",
"description": "If it's a Finding based notification config, this field will be populated."
},
"notificationConfigName": {
"description": "Name of the notification config that generated current notification.",
"type": "string"
},
"resource": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource",
"description": "The Cloud resource tied to the notification."
},
"temporalAsset": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1TemporalAsset",
"description": "If it's an asset based notification config, this field will be populated."
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1Resource": {
"description": " Information related to the Google Cloud resource.",
"id": "GoogleCloudSecuritycenterV1p1beta1Resource",
"properties": {
"name": {
"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name",
"type": "string"
},
"parent": {
"description": "The full resource name of resource's parent.",
"type": "string"
},
"parentDisplayName": {
"description": " The human readable name of resource's parent.",
"type": "string"
},
"project": {
"description": "The full resource name of project that the resource belongs to.",
"type": "string"
},
"projectDisplayName": {
"description": " The human readable name of project that the resource belongs to.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse": {
"description": "Response of asset discovery run",
"id": "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse",
"properties": {
"duration": {
"description": "The duration between asset discovery run start and end",
"format": "google-duration",
"type": "string"
},
"state": {
"description": "The state of an asset discovery run.",
"enum": [
"STATE_UNSPECIFIED",
"COMPLETED",
"SUPERSEDED",
"TERMINATED"
],
"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"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties": {
"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.",
"id": "GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties",
"properties": {
"resourceDisplayName": {
"description": "The user defined display name for this resource.",
"type": "string"
},
"resourceName": {
"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",
"type": "string"
},
"resourceOwners": {
"description": "Owners of the Google Cloud resource.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceParent": {
"description": "The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name",
"type": "string"
},
"resourceParentDisplayName": {
"description": "The user defined display name for the parent of this resource.",
"type": "string"
},
"resourceProject": {
"description": "The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name",
"type": "string"
},
"resourceProjectDisplayName": {
"description": "The user defined display name for the project of this resource.",
"type": "string"
},
"resourceType": {
"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.",
"type": "string"
}
},
"type": "object"
},
"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.",
"id": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks",
"properties": {
"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"
},
"name": {
"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"
}
},
"type": "object"
},
"GoogleCloudSecuritycenterV1p1beta1TemporalAsset": {
"description": "Wrapper over asset object that also captures the state change for the asset e.g. if it was a newly created asset vs updated or deleted asset.",
"id": "GoogleCloudSecuritycenterV1p1beta1TemporalAsset",
"properties": {
"asset": {
"$ref": "GoogleCloudSecuritycenterV1p1beta1Asset",
"description": "Asset data that includes attributes, properties and marks about the asset."
},
"changeType": {
"description": "Represents if the asset was created/updated/deleted.",
"enum": [
"CHANGE_TYPE_UNSPECIFIED",
"CREATED",
"UPDATED",
"DELETED"
],
"enumDescriptions": [
"Unspecified or default.",
"Newly created Asset",
"Asset was updated.",
"Asset was deleted."
],
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"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.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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.",
"type": "object"
},
"name": {
"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": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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`.",
"type": "object"
}
},
"type": "object"
},
"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.",
"id": "SecurityMarks",
"properties": {
"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"
},
"name": {
"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"
}
},
"type": "object"
},
"Status": {
"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).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"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"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Security Command Center API",
"version": "v1p1alpha1",
"version_module": true
}