{ "fullyEncodeReservedExpansion": true, "ownerDomain": "google.com", "canonicalName": "Assuredworkloads", "batchPath": "batch", "title": "Assured Workloads API", "ownerName": "Google", "documentationLink": "https://cloud.google.com/learnmoreurl", "description": "", "revision": "20261006", "id": "assuredworkloads:v1", "discoveryVersion": "v1", "version": "v1", "schemas": { "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse": { "type": "object", "id": "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse", "properties": { "nextPageToken": { "description": "The next page token. Return empty if reached the last page.", "type": "string" }, "workloads": { "items": { "$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "description": "List of Workloads under a given parent.", "type": "array" } }, "description": "Response of ListWorkloads endpoint." }, "GoogleCloudAssuredworkloadsV1OrgPolicy": { "type": "object", "description": "This assured workload service object is used to represent the org policy attached to a resource. It servces the same purpose as the orgpolicy.v2.Policy object but with functionality that is limited to what is supported by Assured Workloads(e.g. only one rule under one OrgPolicy object, no conditions, etc).", "properties": { "inherit": { "type": "boolean", "description": "If `inherit` is true, policy rules of the lowest ancestor in the resource hierarchy chain are inherited. If it is false, policy rules are not inherited." }, "reset": { "description": "Ignores policies set above this resource and restores to the `constraint_default` value. `reset` can only be true when `rules` is empty and `inherit` is false.", "type": "boolean" }, "constraint": { "description": "The constraint name of the OrgPolicy. e.g. \"constraints/gcp.resourceLocations\".", "type": "string" }, "rule": { "description": "The rule of the OrgPolicy.", "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule" }, "resource": { "description": "Resource that the OrgPolicy attaches to. Format: folders/123\" projects/123\".", "type": "string" } }, "id": "GoogleCloudAssuredworkloadsV1OrgPolicy" }, "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails": { "id": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", "properties": { "passingControls": { "description": "The number of controls that are passing or not assessed.", "type": "integer", "format": "int32" }, "passingControlIds": { "description": "The list of controls that are passing or not assessed.", "type": "array", "items": { "type": "string" } }, "assessedPassingControlIds": { "description": "The list of controls that were assessed and are passing.", "type": "array", "items": { "type": "string" } }, "failingControlIds": { "type": "array", "items": { "type": "string" }, "description": "The list of controls that are failing." }, "assessedPassingControls": { "description": "The number of controls that were assessed and are passing.", "format": "int32", "type": "integer" }, "notAssessedControlIds": { "type": "array", "description": "The list of controls that aren't assessed because they require manual review.", "items": { "type": "string" } }, "failingControls": { "format": "int32", "description": "The number of controls that are failing.", "type": "integer" }, "notAssessedControls": { "type": "integer", "description": "The number of controls that aren't assessed because they require manual review.", "format": "int32" } }, "type": "object", "description": "The details for a control assessment." }, "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse": { "description": "The response message for ListDBControlComplianceSummaries.", "properties": { "dbControlComplianceSummaries": { "items": { "$ref": "GoogleCloudAssuredworkloadsV1DbControlComplianceSummary" }, "description": "The list of control compliance details.", "type": "array" }, "nextPageToken": { "description": "Output only. The token to retrieve the next page of results.", "readOnly": true, "type": "string" } }, "id": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse", "type": "object" }, "GoogleCloudAssuredworkloadsV1CloudControlReport": { "properties": { "description": { "description": "The description of the cloud control.", "type": "string" }, "categories": { "description": "The list of categories for the cloud control.", "items": { "type": "string" }, "type": "array" }, "cloudControl": { "type": "string", "description": "The name of the cloud control." }, "findingSeverity": { "enumDescriptions": [ "Default value. This value is unused.", "A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", "A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", "A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", "A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." ], "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", "HIGH", "MEDIUM", "LOW" ], "description": "The severity of the finding." }, "majorRevisionId": { "description": "The major revision ID of the cloud control.", "format": "int64", "type": "string" }, "displayName": { "type": "string", "description": "The display name of the cloud control." }, "minorRevisionId": { "type": "string", "description": "The minor revision ID of the cloud control.", "format": "int64" }, "cloudControlType": { "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "A cloud control that's created and managed by you.", "A cloud control that's provided and managed by Google." ], "description": "The type of the cloud control.", "enum": [ "TYPE_UNSPECIFIED", "CUSTOM", "BUILT_IN" ] }, "findingCategory": { "type": "string", "description": "The category of the finding." }, "rules": { "type": "array", "description": "The list of rules that correspond to the cloud control.", "items": { "$ref": "GoogleCloudAssuredworkloadsV1Rule" } }, "frameworkMajorRevisionIds": { "type": "array", "items": { "type": "string", "format": "int64" }, "description": "The major revision IDs of the frameworks that the cloud control belongs to." }, "similarControls": { "description": "The list of similar controls.", "items": { "$ref": "GoogleCloudAssuredworkloadsV1SimilarControls" }, "type": "array" }, "manualCloudControlAssessmentDetails": { "$ref": "GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails", "description": "The details of a manual cloud control assessment." }, "cloudControlDeployment": { "type": "string", "description": "The name of the cloud control deployment." }, "cloudControlAssessmentDetails": { "$ref": "GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails", "description": "The details of a cloud control assessment." }, "enforcementMode": { "enum": [ "ENFORCEMENT_MODE_UNSPECIFIED", "PREVENTIVE", "DETECTIVE", "AUDIT" ], "type": "string", "description": "The enforcement mode of the cloud control.", "enumDescriptions": [ "Default value. This value is unused.", "The cloud control is enforced to prevent non-compliance.", "The cloud control is enforced to detect non-compliance.", "The cloud control is enforced to audit for non-compliance." ] } }, "description": "The cloud control report.", "type": "object", "id": "GoogleCloudAssuredworkloadsV1CloudControlReport" }, "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse": { "properties": { "dbFrameworkComplianceSummaries": { "type": "array", "items": { "$ref": "GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary" }, "description": "The list of framework compliance summaries." }, "nextPageToken": { "description": "Output only. The token to retrieve the next page of results.", "type": "string", "readOnly": true } }, "type": "object", "description": "The response message for ListDbFrameworkComplianceSummariesResponse.", "id": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" }, "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest": { "id": "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest", "description": "Request for updating permission settings for a partner workload.", "properties": { "etag": { "description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", "type": "string" }, "updateMask": { "description": "Required. The list of fields to be updated. E.g. update_mask { paths: \"partner_permissions.data_logs_viewer\"}", "format": "google-fieldmask", "type": "string" }, "partnerPermissions": { "description": "Required. The partner permissions to be updated.", "$ref": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions" } }, "type": "object" }, "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { "properties": { "nonCompliantOrgPolicy": { "type": "string", "deprecated": true, "description": "Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}" }, "view": { "enumDescriptions": [ "Defaults to the ASSURED_WORKLOADS view.", "Includes the basic metadata about the violation.", "Includes all information about the violation, including details about the data boundary." ], "enum": [ "VIOLATION_VIEW_UNSPECIFIED", "VIOLATION_VIEW_ASSURED_WORKLOADS", "VIOLATION_VIEW_DATA_BOUNDARY" ], "type": "string", "description": "Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for acknowledging violations." }, "comment": { "description": "Required. Business justification explaining the need for violation acknowledgement", "type": "string" }, "acknowledgeType": { "enum": [ "ACKNOWLEDGE_TYPE_UNSPECIFIED", "SINGLE_VIOLATION", "EXISTING_CHILD_RESOURCE_VIOLATIONS" ], "enumDescriptions": [ "Acknowledge type unspecified.", "Acknowledge only the specific violation.", "Acknowledge specified orgPolicy violation and also associated resource violations." ], "type": "string", "description": "Optional. Acknowledge type of specified violation." } }, "description": "Request for acknowledging the violation", "type": "object", "id": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest" }, "GoogleCloudAssuredworkloadsV1Trend": { "properties": { "duration": { "description": "Output only. The duration for the trend.", "readOnly": true, "format": "google-duration", "type": "string" }, "valuePercent": { "description": "Output only. The trend value as a percentage. The value can be positive or negative.", "format": "double", "type": "number", "readOnly": true } }, "description": "The trend of a compliance metric.", "id": "GoogleCloudAssuredworkloadsV1Trend", "type": "object" }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "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" }, "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" }, "response": { "type": "object", "description": "The normal, successful response of the operation. 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`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "metadata": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } }, "id": "GoogleLongrunningOperation" }, "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis": { "type": "object", "properties": { "asset": { "description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1", "type": "string" }, "assetType": { "description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", "type": "string" }, "analysisGroups": { "items": { "$ref": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup" }, "type": "array", "description": "List of eligible analyses performed for the asset." } }, "id": "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis", "description": "Represents move analysis results for an asset." }, "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings": { "properties": { "resourceType": { "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", "CONSUMER_FOLDER", "ENCRYPTION_KEYS_PROJECT", "KEYRING" ], "type": "string", "enumDeprecated": [ false, true, false, false, false ], "enumDescriptions": [ "Unknown resource type.", "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", "Consumer Folder.", "Consumer project containing encryption keys.", "Keyring resource that hosts encryption keys." ], "description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)" }, "displayName": { "description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.", "type": "string" }, "resourceId": { "type": "string", "description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google." } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings", "description": "Represent the custom settings for the resources to be created." }, "GoogleCloudAssuredworkloadsV1ViolationExceptionContext": { "type": "object", "description": "Violation exception detail.", "id": "GoogleCloudAssuredworkloadsV1ViolationExceptionContext", "properties": { "comment": { "description": "Business justification provided towards the acknowledgement of the violation.", "type": "string" }, "acknowledgementTime": { "description": "Timestamp when the violation was acknowledged.", "format": "google-datetime", "type": "string" }, "userName": { "type": "string", "description": "Name of the user (or service account) who acknowledged the violation." } } }, "GoogleLongrunningListOperationsResponse": { "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations." }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } } }, "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": { "type": "object", "properties": { "parent": { "description": "Optional. The parent of the workload.", "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Optional. Time when the operation was created." }, "complianceRegime": { "enumDescriptions": [ "The default value. This value is used if the control package is omitted or unknown.", "Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", "Australia Data Boundary and Support", "Canada Data Boundary and Support", "Data Boundary for Canada Controlled Goods", "Data Boundary for Canada Protected B", "Data Boundary for Criminal Justice Information Systems (CJIS)", "Data Boundary for FedRAMP High", "Data Boundary for FedRAMP Moderate", "Data Boundary for Impact Level 2 (IL2)", "Data Boundary for Impact Level 4 (IL4)", "Data Boundary for Impact Level 5 (IL5)", "Data Boundary for IRS Publication 1075", "Data Boundary for International Traffic in Arms Regulations (ITAR)", "European Union (EU) Data Boundary and Support", "Israel Data Boundary and Support", "Japan Data Boundary", "Switzerland Data Boundary with Access Justifications", "Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", "Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", "United States (US) Data Boundary and Support", "United States (US) Data Boundary for Healthcare and Life Sciences", "United States (US) Data Boundary for Healthcare and Life Sciences with Support", "Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", "Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", "Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." ], "description": "Optional. Compliance controls that should be applied to the resources managed by the workload.", "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, true, false, false, false, false, false, false, false, false, false, false, false ], "type": "string", "enum": [ "COMPLIANCE_REGIME_UNSPECIFIED", "ASSURED_WORKLOADS_FOR_PARTNERS", "AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT", "CANADA_DATA_BOUNDARY_AND_SUPPORT", "DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS", "DATA_BOUNDARY_FOR_CANADA_PROTECTED_B", "DATA_BOUNDARY_FOR_CJIS", "DATA_BOUNDARY_FOR_FEDRAMP_HIGH", "DATA_BOUNDARY_FOR_FEDRAMP_MODERATE", "DATA_BOUNDARY_FOR_IL2", "DATA_BOUNDARY_FOR_IL4", "DATA_BOUNDARY_FOR_IL5", "DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075", "DATA_BOUNDARY_FOR_ITAR", "EU_DATA_BOUNDARY_AND_SUPPORT", "ISRAEL_DATA_BOUNDARY_AND_SUPPORT", "JAPAN_DATA_BOUNDARY", "SWITZERLAND_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", "KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", "REGIONAL_DATA_BOUNDARY", "US_DATA_BOUNDARY_AND_SUPPORT", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT", "AU_REGIONS_AND_US_SUPPORT", "CA_PROTECTED_B", "CA_REGIONS_AND_SUPPORT", "CANADA_CONTROLLED_GOODS", "CJIS", "EU_REGIONS_AND_SUPPORT", "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT", "HIPAA", "HITRUST", "IL2", "IL4", "IL5", "IRS_1075", "ISR_REGIONS", "ISR_REGIONS_AND_SUPPORT", "ITAR", "JP_REGIONS_AND_SUPPORT", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS", "US_REGIONAL_ACCESS" ] }, "displayName": { "type": "string", "description": "Optional. The display name of the workload." } }, "id": "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata", "description": "Operation metadata to give request details of CreateWorkload." }, "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule": { "description": "A rule used to express this policy.", "type": "object", "properties": { "allowAll": { "description": "ListPolicy only when all values are allowed.", "type": "boolean" }, "enforce": { "description": "BooleanPolicy only.", "type": "boolean" }, "denyAll": { "description": "ListPolicy only when all values are denied.", "type": "boolean" }, "values": { "description": "ListPolicy only when custom values are specified.", "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues" } }, "id": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule" }, "GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus": { "properties": { "activeResourceViolationCount": { "type": "integer", "description": "Number of current resource violations which are acknowledged.", "format": "int32" }, "acknowledgedResourceViolationCount": { "type": "integer", "format": "int32", "description": "Number of current resource violations which are not acknowledged." }, "acknowledgedViolationCount": { "format": "int32", "description": "Number of current orgPolicy violations which are acknowledged.", "type": "integer" }, "activeViolationCount": { "description": "Number of current orgPolicy violations which are not acknowledged.", "type": "integer", "format": "int32" } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus", "description": "Represents the Compliance Status of this workload" }, "GoogleCloudAssuredworkloadsV1ListViolationsResponse": { "properties": { "totalSize": { "format": "int32", "type": "integer", "description": "The total number of violations." }, "nextPageToken": { "type": "string", "description": "The next page token. Returns empty if reached the last page." }, "violations": { "type": "array", "description": "List of Violations under a Workload.", "items": { "$ref": "GoogleCloudAssuredworkloadsV1Violation" } } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1ListViolationsResponse", "description": "Response of ListViolations endpoint." }, "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest": { "properties": { "action": { "type": "string", "enumDescriptions": [ "Unspecified value.", "The update is applied." ], "enum": [ "WORKLOAD_UPDATE_ACTION_UNSPECIFIED", "APPLY" ], "description": "The action to be performed on the update." } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest", "description": "Request to apply update to a workload." }, "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest": { "type": "object", "description": "Request for restricting list of available resources in Workload environment.", "id": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest", "properties": { "restrictionType": { "enumDescriptions": [ "Unknown restriction type.", "Allow the use all of all gcp products, irrespective of the compliance posture. This effectively removes gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder.", "Based on Workload's compliance regime, allowed list changes. See - https://cloud.google.com/assured-workloads/docs/supported-products for the list of supported resources.", "Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of compliant resources to the existing list of compliant resources. Effective org-policy of the Folder is considered to ensure there is no disruption to the existing customer workflows." ], "enum": [ "RESTRICTION_TYPE_UNSPECIFIED", "ALLOW_ALL_GCP_RESOURCES", "ALLOW_COMPLIANT_RESOURCES", "APPEND_COMPLIANT_RESOURCES" ], "description": "Required. The type of restriction for using gcp products in the Workload environment.", "type": "string" } } }, "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse": { "description": "Response for restricting the list of allowed resources.", "id": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse", "properties": {}, "type": "object" }, "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateOperationMetadata": { "id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateOperationMetadata", "properties": { "updateName": { "type": "string", "description": "Required. The resource name of the update" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Optional. Output only. The time the operation was created.", "readOnly": true }, "action": { "type": "string", "description": "Optional. The time the operation was created.", "enum": [ "WORKLOAD_UPDATE_ACTION_UNSPECIFIED", "APPLY" ], "enumDescriptions": [ "Unspecified value.", "The update is applied." ] } }, "type": "object", "description": "Operation metadata to give request details of ApplyWorkloadUpdate." }, "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse": { "properties": { "targetResourceDetails": { "description": "The target resource details of the framework.", "type": "array", "items": { "$ref": "GoogleCloudAssuredworkloadsV1TargetResourceDetails" } }, "name": { "description": "The name of the framework compliance report.", "type": "string" }, "supportedCloudProviders": { "items": { "type": "string", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "AWS", "AZURE", "GCP" ], "enumDescriptions": [ "Default value. This value is unused.", "Amazon Web Services (AWS).", "Microsoft Azure.", "Google Cloud." ] }, "type": "array", "description": "The list of cloud providers that are supported by the framework." }, "frameworkDisplayName": { "type": "string", "description": "Optional. The display name for the framework." }, "controlAssessmentDetails": { "$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", "description": "The control assessment details of the framework." }, "framework": { "description": "The name of the framework.", "type": "string" }, "frameworkDescription": { "description": "The description of the framework.", "type": "string" }, "frameworkType": { "enumDescriptions": [ "Default value. This value is unused.", "A framework that's provided and managed by Google.", "A framework that's created and managed by you." ], "type": "string", "description": "The type of the framework.", "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ] }, "minorRevisionId": { "type": "string", "format": "int64", "description": "The latest minor revision ID of the latest major revision of the framework." }, "majorRevisionId": { "type": "string", "format": "int64", "description": "The latest major revision ID of the framework." }, "frameworkCategories": { "description": "The list of framework categories supported.", "type": "array", "items": { "type": "string", "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", "INDUSTRY_DEFINED_STANDARD", "ASSURED_WORKLOADS", "DATA_SECURITY", "GOOGLE_BEST_PRACTICES", "CUSTOM_FRAMEWORK" ], "enumDescriptions": [ "Default value. This value is unused.", "An industry-defined framework.", "An Assured Workloads framework.", "A data security posture framework.", "A Google's best practices framework.", "A user-created framework." ] } }, "updateTime": { "description": "Output only. The last updated time of the report.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object", "description": "The response message for FetchDbFrameworkComplianceReport.", "id": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" }, "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse": { "id": "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse", "description": "Response for EnableResourceMonitoring endpoint.", "properties": {}, "type": "object" }, "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse": { "properties": { "dbFindingSummaries": { "description": "List of finding summary by category.", "type": "array", "items": { "$ref": "GoogleCloudAssuredworkloadsV1DbFindingSummary" } }, "nextPageToken": { "readOnly": true, "description": "Output only. The token to retrieve the next page of results.", "type": "string" } }, "description": "The response message for ListDbFindingSummaries.", "id": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse", "type": "object" }, "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse": { "properties": { "setupErrors": { "items": { "type": "string", "enum": [ "SETUP_ERROR_UNSPECIFIED", "ERROR_INVALID_BASE_SETUP", "ERROR_MISSING_EXTERNAL_SIGNING_KEY", "ERROR_NOT_ALL_SERVICES_ENROLLED", "ERROR_SETUP_CHECK_FAILED" ], "enumDescriptions": [ "Unspecified.", "Invalid states for all customers, to be redirected to AA UI for additional details.", "Returned when there is not an EKM key configured.", "Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.", "Returned when exception was encountered during evaluation of other criteria." ] }, "description": "Indicates SAA enrollment setup error if any.", "type": "array" }, "setupStatus": { "description": "Output only. Indicates SAA enrollment status of a given workload.", "enumDescriptions": [ "Unspecified.", "SAA enrollment pending.", "SAA enrollment comopleted." ], "readOnly": true, "enum": [ "SETUP_STATE_UNSPECIFIED", "STATUS_PENDING", "STATUS_COMPLETE" ], "type": "string" } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse", "description": "Signed Access Approvals (SAA) enrollment response." }, "GoogleCloudAssuredworkloadsV1CELExpression": { "description": "A Common Expression Language (CEL) expression that's used to create a rule.", "id": "GoogleCloudAssuredworkloadsV1CELExpression", "properties": { "resourceTypesValues": { "description": "The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`", "$ref": "GoogleCloudAssuredworkloadsV1StringList" }, "expression": { "description": "Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).", "type": "string" } }, "type": "object" }, "GoogleCloudAssuredworkloadsV1TargetResourceDetails": { "type": "object", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The create time of the target resource." }, "frameworkDeployment": { "description": "The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`", "type": "string" }, "minorRevisionId": { "description": "The minor revision ID of the framework for the target resource.", "type": "string", "format": "int64" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "The update time of the target resource." }, "majorRevisionId": { "format": "int64", "type": "string", "description": "The major revision ID of the framework for the target resource." }, "targetResourceDisplayName": { "description": "The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.", "type": "string" }, "targetResource": { "type": "string", "description": "The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`." } }, "id": "GoogleCloudAssuredworkloadsV1TargetResourceDetails", "description": "The details for a target resource." }, "GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions": { "properties": { "kajEnrollmentType": { "enumDescriptions": [ "KAJ Enrollment type is unspecified", "KAT sets External, Hardware, and Software key feature logging only to TRUE." ], "description": "Optional. Specifies type of KAJ Enrollment if provided.", "type": "string", "enum": [ "KAJ_ENROLLMENT_TYPE_UNSPECIFIED", "KEY_ACCESS_TRANSPARENCY_OFF" ] } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions", "description": "Options to be set for the given created workload." }, "GoogleCloudAssuredworkloadsV1AggregatedComplianceReport": { "type": "object", "description": "The aggregated compliance report.", "id": "GoogleCloudAssuredworkloadsV1AggregatedComplianceReport", "properties": { "reportTime": { "format": "google-datetime", "description": "The report time of the aggregated compliance report.", "type": "string" }, "controlAssessmentDetails": { "description": "The control assessment details of the framework.", "$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails" } } }, "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup": { "properties": { "analysisResult": { "description": "Result of a successful analysis.", "$ref": "GoogleCloudAssuredworkloadsV1MoveAnalysisResult" }, "error": { "$ref": "GoogleRpcStatus", "description": "Error details for a failed analysis." }, "displayName": { "type": "string", "description": "Name of the analysis group." } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup", "description": "Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason." }, "GoogleCloudAssuredworkloadsV1OrgPolicyUpdate": { "id": "GoogleCloudAssuredworkloadsV1OrgPolicyUpdate", "type": "object", "description": "Represents an update for an org policy control applied on an Assured Workload resource. The inherited org policy is not considered.", "properties": { "appliedPolicy": { "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicy", "description": "The org policy currently applied on the assured workload resource." }, "suggestedPolicy": { "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicy", "description": "The suggested org policy that replaces the applied policy." } } }, "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse": { "type": "object", "description": "The response message for AggregateDbFrameworkComplianceReport.", "id": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse", "properties": { "aggregatedComplianceReports": { "type": "array", "items": { "$ref": "GoogleCloudAssuredworkloadsV1AggregatedComplianceReport" }, "description": "The list of aggregated compliance reports." } } }, "GoogleCloudAssuredworkloadsV1ViolationRemediation": { "description": "Represents remediation guidance to resolve compliance violation for AssuredWorkload", "properties": { "compliantValues": { "items": { "type": "string" }, "type": "array", "description": "Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values" }, "instructions": { "$ref": "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions", "description": "Required. Remediation instructions to resolve violations" }, "remediationType": { "enumDescriptions": [ "Unspecified remediation type", "Remediation type for boolean org policy", "Remediation type for list org policy which have allowed values in the monitoring rule", "Remediation type for list org policy which have denied values in the monitoring rule", "Remediation type for gcp.restrictCmekCryptoKeyProjects", "Remediation type for resource violation.", "Remediation type for resource violation due to gcp.restrictNonCmekServices" ], "readOnly": true, "enum": [ "REMEDIATION_TYPE_UNSPECIFIED", "REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION", "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION", "REMEDIATION_RESOURCE_VIOLATION", "REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES" ], "type": "string", "description": "Output only. Reemediation type based on the type of org policy values violated" } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1ViolationRemediation" }, "GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse": { "id": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse", "type": "object", "description": "Response for violation acknowledgement", "properties": {} }, "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings": { "deprecated": true, "properties": { "nextRotationTime": { "type": "string", "description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.", "format": "google-datetime" }, "rotationPeriod": { "format": "google-duration", "description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.", "type": "string" } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings", "description": "Settings specific to the Key Management Service." }, "GoogleCloudAssuredworkloadsV1DbControlComplianceSummary": { "description": "The details for control compliance.", "type": "object", "id": "GoogleCloudAssuredworkloadsV1DbControlComplianceSummary", "properties": { "totalFindingsCount": { "type": "integer", "format": "int32", "description": "The total number of findings for the control." }, "displayName": { "type": "string", "description": "The display name of the control." }, "name": { "type": "string", "description": "Identifier. The name of the control compliance summary." }, "description": { "description": "The description of the control.", "type": "string" }, "isFakeControl": { "description": "Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.", "type": "boolean" }, "similarControls": { "description": "The list of similar controls.", "items": { "$ref": "GoogleCloudAssuredworkloadsV1SimilarControls" }, "type": "array" }, "cloudControlReports": { "description": "The list of cloud control reports.", "items": { "$ref": "GoogleCloudAssuredworkloadsV1CloudControlReport" }, "type": "array" }, "controlResponsibilityType": { "description": "The responsibility type for the control.", "enum": [ "REGULATORY_CONTROL_RESPONSIBILITY_TYPE_UNSPECIFIED", "GOOGLE", "CUSTOMER", "SHARED" ], "enumDescriptions": [ "Default value. This value is unused.", "Google's responsibility.", "Your responsibility.", "Shared responsibility." ], "type": "string" }, "complianceFrameworks": { "description": "The list of compliance frameworks that the control belongs to.", "items": { "type": "string" }, "type": "array" }, "overallEvaluationState": { "description": "Output only. The overall evaluation status of the control.", "readOnly": true, "type": "string", "enum": [ "EVALUATION_STATE_UNSPECIFIED", "EVALUATION_STATE_PASSED", "EVALUATION_STATE_FAILED", "EVALUATION_STATE_NOT_ASSESSED" ], "enumDescriptions": [ "Default value. This value is unused.", "The control is passing.", "The control is failing.", "The control is not assessed." ] }, "resourceFindingCount": { "readOnly": true, "description": "Output only. Number of resource findings for this control.", "type": "string", "format": "int64" }, "orgPolicyFindingCount": { "description": "Output only. Number of organization policy findings for this control.", "format": "int64", "type": "string", "readOnly": true }, "control": { "description": "The name of the control.", "type": "string" } } }, "GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary": { "description": "The details for a framework compliance summary.", "id": "GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary", "properties": { "findingCount": { "format": "int64", "description": "Output only. The count of the findings generated against the framework.", "readOnly": true, "type": "string" }, "frameworkDisplayName": { "type": "string", "description": "Optional. The display name for the framework." }, "frameworkType": { "description": "The type of framework.", "enumDescriptions": [ "Default value. This value is unused.", "A framework that's provided and managed by Google.", "A framework that's created and managed by you." ], "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ], "type": "string" }, "name": { "description": "Identifier. The name of the framework compliance summary.", "type": "string" }, "frameworkCategories": { "items": { "enumDescriptions": [ "Default value. This value is unused.", "An industry-defined framework.", "An Assured Workloads framework.", "A data security posture framework.", "A Google's best practices framework.", "A user-created framework." ], "type": "string", "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", "INDUSTRY_DEFINED_STANDARD", "ASSURED_WORKLOADS", "DATA_SECURITY", "GOOGLE_BEST_PRACTICES", "CUSTOM_FRAMEWORK" ] }, "description": "The list of framework categories supported by the framework.", "type": "array" }, "minorRevisionId": { "description": "The minor revision ID of the framework.", "type": "string", "format": "int64" }, "controlsPassingTrend": { "description": "Output only. The trend of controls that are passing for the given duration.", "$ref": "GoogleCloudAssuredworkloadsV1Trend", "readOnly": true }, "targetResourceDetails": { "type": "array", "description": "The target resource details for the framework.", "items": { "$ref": "GoogleCloudAssuredworkloadsV1TargetResourceDetails" } }, "controlAssessmentDetails": { "description": "The control assessment details of the framework.", "$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails" }, "framework": { "type": "string", "description": "The name of the framework." }, "majorRevisionId": { "type": "string", "description": "The major revision ID of the framework.", "format": "int64" }, "supportedCloudProviders": { "items": { "enumDescriptions": [ "Default value. This value is unused.", "Amazon Web Services (AWS).", "Microsoft Azure.", "Google Cloud." ], "type": "string", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "AWS", "AZURE", "GCP" ] }, "type": "array", "description": "The list of cloud providers supported by the framework." } }, "type": "object" }, "GoogleCloudAssuredworkloadsV1MoveImpact": { "properties": { "detail": { "description": "Explanation of the impact.", "type": "string" } }, "id": "GoogleCloudAssuredworkloadsV1MoveImpact", "type": "object", "description": "Represents the impact of moving the asset to the target." }, "GoogleCloudAssuredworkloadsV1Violation": { "type": "object", "description": "Workload monitoring Violation.", "properties": { "description": { "description": "Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.", "readOnly": true, "type": "string" }, "category": { "type": "string", "readOnly": true, "description": "Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc." }, "acknowledged": { "description": "A boolean that indicates if the violation is acknowledged", "type": "boolean" }, "associatedOrgPolicyViolationId": { "type": "string", "description": "Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.", "readOnly": true }, "beginTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Time of the event which triggered the Violation.", "type": "string" }, "parentProjectNumber": { "readOnly": true, "description": "Optional. Output only. Parent project number where resource is present. Empty for org-policy violations.", "type": "string" }, "remediationMarkdown": { "description": "Output only. Contains the remediation instructions for the violation in markdown format.", "readOnly": true, "type": "string" }, "name": { "description": "Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}", "type": "string", "readOnly": true }, "violationType": { "enumDescriptions": [ "Unspecified type.", "Org Policy Violation.", "Resource Violation." ], "type": "string", "description": "Output only. Type of the violation", "enum": [ "VIOLATION_TYPE_UNSPECIFIED", "ORG_POLICY", "RESOURCE" ], "readOnly": true }, "acknowledgementTime": { "type": "string", "description": "Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false.", "format": "google-datetime" }, "remediation": { "readOnly": true, "$ref": "GoogleCloudAssuredworkloadsV1ViolationRemediation", "description": "Output only. Compliance violation remediation" }, "auditLogLink": { "type": "string", "readOnly": true, "description": "Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}" }, "exceptionContexts": { "description": "Output only. List of all the exception detail added for the violation.", "type": "array", "items": { "$ref": "GoogleCloudAssuredworkloadsV1ViolationExceptionContext" }, "readOnly": true }, "exceptionAuditLogLink": { "description": "Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}", "type": "string", "readOnly": true }, "affectedFrameworks": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. \"FedRAMP High\", \"NIST 800-53\"." }, "nonCompliantOrgPolicy": { "readOnly": true, "type": "string", "description": "Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}" }, "resourceType": { "type": "string", "readOnly": true, "description": "Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations." }, "resourceName": { "readOnly": true, "type": "string", "description": "Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations." }, "resolveTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.", "readOnly": true }, "childResourceViolationCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation." }, "updateTime": { "format": "google-datetime", "description": "Output only. The last time when the Violation record was updated.", "readOnly": true, "type": "string" }, "orgPolicyConstraint": { "description": "Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.", "readOnly": true, "type": "string", "deprecated": true }, "state": { "description": "Output only. State of the violation", "readOnly": true, "enumDescriptions": [ "Unspecified state.", "Violation is resolved.", "Violation is Unresolved", "Violation is Exception" ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "RESOLVED", "UNRESOLVED", "EXCEPTION" ] } }, "id": "GoogleCloudAssuredworkloadsV1Violation" }, "GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails": { "type": "object", "properties": { "manualCloudControlGuide": { "description": "The guide for assessing a cloud control manually.", "type": "array", "items": { "type": "string" } } }, "description": "The details for a manual cloud control assessment.", "id": "GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails" }, "GoogleCloudAssuredworkloadsV1WorkloadUpdate": { "description": "A workload update is a change to the workload's compliance configuration.", "type": "object", "properties": { "name": { "type": "string", "readOnly": true, "description": "Output only. Immutable. Identifier. Resource name of the WorkloadUpdate. Format: organizations/{organization}/locations/{location}/workloads/{workload}/updates/{update}" }, "createTime": { "description": "The time the update was created.", "format": "google-datetime", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "AVAILABLE", "APPLIED", "WITHDRAWN" ], "type": "string", "readOnly": true, "description": "Output only. The state of the update.", "enumDescriptions": [ "Unspecified.", "The update is available to be applied.", "The update has been applied.", "The update has been withdrawn by the service." ] }, "details": { "description": "The details of the update.", "$ref": "GoogleCloudAssuredworkloadsV1UpdateDetails" }, "updateTime": { "type": "string", "description": "The time the update was last updated.", "format": "google-datetime" } }, "id": "GoogleCloudAssuredworkloadsV1WorkloadUpdate" }, "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions": { "description": "Instructions to remediate violation", "type": "object", "id": "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions", "properties": { "consoleInstructions": { "description": "Remediation instructions to resolve violation via cloud console", "$ref": "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole" }, "gcloudInstructions": { "description": "Remediation instructions to resolve violation via gcloud cli", "$ref": "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud" } } }, "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo": { "description": "Represent the resources that are children of this Workload.", "id": "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo", "properties": { "resourceId": { "readOnly": true, "format": "int64", "type": "string", "description": "Output only. Resource identifier. For a project this represents project_number." }, "resourceType": { "enumDescriptions": [ "Unknown resource type.", "Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.", "Consumer Folder.", "Consumer project containing encryption keys.", "Keyring resource that hosts encryption keys." ], "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "CONSUMER_PROJECT", "CONSUMER_FOLDER", "ENCRYPTION_KEYS_PROJECT", "KEYRING" ], "type": "string", "description": "Indicates the type of resource.", "enumDeprecated": [ false, true, false, false, false ] } }, "type": "object" }, "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions": { "id": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions", "description": "Permissions granted to the AW Partner SA account for the customer workload", "type": "object", "properties": { "dataLogsViewer": { "description": "Optional. Allow the partner to view inspectability logs and monitoring violations.", "type": "boolean" }, "serviceAccessApprover": { "type": "boolean", "description": "Optional. Allow partner to view access approval logs." }, "accessTransparencyLogsSupportCaseViewer": { "description": "Optional. Allow partner to view support case details for an AXT log", "type": "boolean" }, "assuredWorkloadsMonitoring": { "description": "Optional. Allow partner to view violation alerts.", "type": "boolean" } } }, "GoogleCloudAssuredworkloadsV1SimilarControls": { "id": "GoogleCloudAssuredworkloadsV1SimilarControls", "description": "The similar controls.", "type": "object", "properties": { "controlId": { "description": "The ID of the control.", "type": "string" }, "framework": { "type": "string", "description": "The name of the framework." } } }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "properties": {}, "type": "object", "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); }" }, "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues": { "type": "object", "properties": { "deniedValues": { "items": { "type": "string" }, "description": "List of values denied at this resource.", "type": "array" }, "allowedValues": { "items": { "type": "string" }, "description": "List of values allowed at this resource.", "type": "array" } }, "id": "GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues", "description": "The values allowed for a ListPolicy." }, "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse": { "type": "object", "properties": {}, "description": "Response for EnableComplianceUpdates endpoint.", "id": "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse" }, "GoogleRpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "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" }, "details": { "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" } }, "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": "GoogleRpcStatus" }, "GoogleCloudAssuredworkloadsV1UpdateDetails": { "properties": { "orgPolicyUpdate": { "description": "Update to one org policy, e.g. gcp.resourceLocation.", "$ref": "GoogleCloudAssuredworkloadsV1OrgPolicyUpdate" } }, "description": "The details of the update.", "id": "GoogleCloudAssuredworkloadsV1UpdateDetails", "type": "object" }, "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse": { "id": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse", "description": "Response containing the analysis results for the hypothetical resource move.", "properties": { "nextPageToken": { "description": "The next page token. Is empty if the last page is reached.", "type": "string" }, "assetMoveAnalyses": { "items": { "$ref": "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis" }, "type": "array", "description": "List of analysis results for each asset in scope." } }, "type": "object" }, "GoogleCloudAssuredworkloadsV1DbFindingSummary": { "properties": { "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The last updated time of the finding.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The name of the finding summary." }, "findingCategory": { "readOnly": true, "description": "Output only. The category of the finding.", "type": "string" }, "severity": { "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", "HIGH", "MEDIUM", "LOW" ], "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", "A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", "A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", "A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." ], "description": "Output only. The severity of the finding.", "readOnly": true }, "findingClass": { "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "The activity is unwanted or malicious.", "A potential weakness in software that increases risk to confidentiality, integrity, and availability.", "A potential weakness in a cloud resource or asset configuration that increases risk.", "A security observation that is for informational purposes.", "An error that prevents Security Command Center from functioning properly.", "A potential security risk that's due to a change in the security posture.", "A combination of security issues that represent a more severe security problem when taken together.", "A potential security risk to data assets that contain sensitive data.", "A resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." ], "enum": [ "FINDING_CLASS_UNSPECIFIED", "THREAT", "VULNERABILITY", "MISCONFIGURATION", "OBSERVATION", "SCC_ERROR", "POSTURE_VIOLATION", "TOXIC_COMBINATION", "SENSITIVE_DATA_RISK", "CHOKEPOINT" ], "description": "Output only. The class of the finding.", "type": "string" }, "relatedFrameworks": { "type": "array", "description": "Optional. The list of compliance frameworks that the finding belongs to.", "items": { "type": "string" } }, "resourceFindingCount": { "type": "string", "description": "Output only. Number of active resource findings for this category.", "format": "int64", "readOnly": true }, "findingCount": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. The count of the finding." }, "organizationPolicyFindingCount": { "type": "string", "description": "Output only. Number of active organization policy findings for this category.", "format": "int64", "readOnly": true } }, "description": "The details for a finding.", "type": "object", "id": "GoogleCloudAssuredworkloadsV1DbFindingSummary" }, "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse": { "type": "object", "id": "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse", "description": "Response of listing the compliance updates per workload with pagination.", "properties": { "workloadUpdates": { "type": "array", "description": "The list of workload updates for a given workload.", "items": { "$ref": "GoogleCloudAssuredworkloadsV1WorkloadUpdate" } }, "nextPageToken": { "description": "The next page token. Return empty if reached the last page.", "type": "string" } } }, "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse": { "description": "Response for ApplyWorkloadUpdate endpoint.", "type": "object", "id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse", "properties": { "appliedUpdate": { "$ref": "GoogleCloudAssuredworkloadsV1WorkloadUpdate", "description": "The update that was applied." } } }, "GoogleCloudAssuredworkloadsV1Workload": { "type": "object", "properties": { "kajEnrollmentState": { "type": "string", "enum": [ "KAJ_ENROLLMENT_STATE_UNSPECIFIED", "KAJ_ENROLLMENT_STATE_PENDING", "KAJ_ENROLLMENT_STATE_COMPLETE" ], "readOnly": true, "description": "Output only. Represents the KAJ enrollment state of the given workload.", "enumDescriptions": [ "Default State for KAJ Enrollment.", "Pending State for KAJ Enrollment.", "Complete State for KAJ Enrollment." ] }, "complianceStatus": { "description": "Output only. Count of active Violations in the Workload.", "readOnly": true, "$ref": "GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus" }, "partnerPermissions": { "$ref": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions", "description": "Optional. Permissions granted to the AW Partner SA account for the customer workload" }, "saaEnrollmentResponse": { "$ref": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse", "readOnly": true, "description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page." }, "enableSovereignControls": { "description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.", "type": "boolean" }, "name": { "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", "type": "string" }, "violationNotificationsEnabled": { "type": "boolean", "description": "Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload." }, "resources": { "description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.", "type": "array", "items": { "$ref": "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo" }, "readOnly": true }, "partner": { "type": "string", "enumDescriptions": [ "", "Enum representing S3NS (Thales) partner.", "Enum representing T_SYSTEM (TSI) partner.", "Enum representing SIA_MINSAIT (Indra) partner.", "Enum representing PSN (TIM) partner.", "Enum representing CNTXT (Kingdom of Saudi Arabia) partner.", "Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering without EKM.", "Enum representing Telefonica (Spain) partner." ], "enum": [ "PARTNER_UNSPECIFIED", "LOCAL_CONTROLS_BY_S3NS", "SOVEREIGN_CONTROLS_BY_T_SYSTEMS", "SOVEREIGN_CONTROLS_BY_SIA_MINSAIT", "SOVEREIGN_CONTROLS_BY_PSN", "SOVEREIGN_CONTROLS_BY_CNTXT", "SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM", "SPAIN_DATA_BOUNDARY_BY_TELEFONICA" ], "description": "Optional. Partner regime associated with this workload." }, "billingAccount": { "type": "string", "description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`." }, "provisionedResourcesParent": { "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}", "type": "string" }, "labels": { "description": "Optional. Labels applied to the workload.", "additionalProperties": { "type": "string" }, "type": "object" }, "kmsSettings": { "description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.", "$ref": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings", "deprecated": true }, "resourceSettings": { "items": { "$ref": "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings" }, "description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.", "type": "array" }, "workloadOptions": { "description": "Optional. Options to be set for the given created workload.", "$ref": "GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions" }, "compliantButDisallowedServices": { "description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.", "type": "array", "readOnly": true, "items": { "type": "string" } }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Immutable. The Workload creation timestamp.", "type": "string" }, "resourceMonitoringEnabled": { "description": "Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.", "type": "boolean", "readOnly": true }, "complianceRegime": { "description": "Required. Immutable. Compliance Regime associated with this workload.", "enum": [ "COMPLIANCE_REGIME_UNSPECIFIED", "ASSURED_WORKLOADS_FOR_PARTNERS", "AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT", "CANADA_DATA_BOUNDARY_AND_SUPPORT", "DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS", "DATA_BOUNDARY_FOR_CANADA_PROTECTED_B", "DATA_BOUNDARY_FOR_CJIS", "DATA_BOUNDARY_FOR_FEDRAMP_HIGH", "DATA_BOUNDARY_FOR_FEDRAMP_MODERATE", "DATA_BOUNDARY_FOR_IL2", "DATA_BOUNDARY_FOR_IL4", "DATA_BOUNDARY_FOR_IL5", "DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075", "DATA_BOUNDARY_FOR_ITAR", "EU_DATA_BOUNDARY_AND_SUPPORT", "ISRAEL_DATA_BOUNDARY_AND_SUPPORT", "JAPAN_DATA_BOUNDARY", "SWITZERLAND_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", "KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS", "REGIONAL_DATA_BOUNDARY", "US_DATA_BOUNDARY_AND_SUPPORT", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES", "US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT", "AU_REGIONS_AND_US_SUPPORT", "CA_PROTECTED_B", "CA_REGIONS_AND_SUPPORT", "CANADA_CONTROLLED_GOODS", "CJIS", "EU_REGIONS_AND_SUPPORT", "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT", "HIPAA", "HITRUST", "IL2", "IL4", "IL5", "IRS_1075", "ISR_REGIONS", "ISR_REGIONS_AND_SUPPORT", "ITAR", "JP_REGIONS_AND_SUPPORT", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS", "US_REGIONAL_ACCESS" ], "enumDescriptions": [ "The default value. This value is used if the control package is omitted or unknown.", "Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", "Australia Data Boundary and Support", "Canada Data Boundary and Support", "Data Boundary for Canada Controlled Goods", "Data Boundary for Canada Protected B", "Data Boundary for Criminal Justice Information Systems (CJIS)", "Data Boundary for FedRAMP High", "Data Boundary for FedRAMP Moderate", "Data Boundary for Impact Level 2 (IL2)", "Data Boundary for Impact Level 4 (IL4)", "Data Boundary for Impact Level 5 (IL5)", "Data Boundary for IRS Publication 1075", "Data Boundary for International Traffic in Arms Regulations (ITAR)", "European Union (EU) Data Boundary and Support", "Israel Data Boundary and Support", "Japan Data Boundary", "Switzerland Data Boundary with Access Justifications", "Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", "Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", "United States (US) Data Boundary and Support", "United States (US) Data Boundary for Healthcare and Life Sciences", "United States (US) Data Boundary for Healthcare and Life Sciences with Support", "Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", "Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", "Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", "Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." ], "type": "string", "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, true, false, false, false, false, false, false, false, false, false, false, false ] }, "etag": { "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", "type": "string" }, "partnerServicesBillingAccount": { "type": "string", "description": "Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC" }, "ekmProvisioningResponse": { "readOnly": true, "$ref": "GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse", "description": "Output only. Represents the Ekm Provisioning State of the given workload." }, "displayName": { "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", "type": "string" } }, "id": "GoogleCloudAssuredworkloadsV1Workload", "description": "A Workload object for managing highly regulated workloads of cloud customers." }, "GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse": { "description": "External key management systems(EKM) Provisioning response", "properties": { "ekmProvisioningErrorDomain": { "enum": [ "EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED", "UNSPECIFIED_ERROR", "GOOGLE_SERVER_ERROR", "EXTERNAL_USER_ERROR", "EXTERNAL_PARTNER_ERROR", "TIMEOUT_ERROR" ], "enumDescriptions": [ "No error domain", "Error but domain is unspecified.", "Internal logic breaks within provisioning code.", "Error occurred with the customer not granting permission/creating resource.", "Error occurred within the partner's provisioning cluster.", "Resource wasn't provisioned in the required 7 day time period" ], "type": "string", "description": "Indicates Ekm provisioning error if any." }, "ekmProvisioningState": { "description": "Output only. Indicates Ekm enrollment Provisioning of a given workload.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default State for Ekm Provisioning", "Pending State for Ekm Provisioning", "Failed State for Ekm Provisioning", "Completed State for Ekm Provisioning" ], "enum": [ "EKM_PROVISIONING_STATE_UNSPECIFIED", "EKM_PROVISIONING_STATE_PENDING", "EKM_PROVISIONING_STATE_FAILED", "EKM_PROVISIONING_STATE_COMPLETED" ] }, "ekmProvisioningErrorMapping": { "type": "string", "description": "Detailed error message if Ekm provisioning fails", "enum": [ "EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED", "INVALID_SERVICE_ACCOUNT", "MISSING_METRICS_SCOPE_ADMIN_PERMISSION", "MISSING_EKM_CONNECTION_ADMIN_PERMISSION" ], "enumDescriptions": [ "Error is unspecified.", "Service account is used is invalid.", "Iam permission monitoring.MetricsScopeAdmin wasn't applied.", "Iam permission cloudkms.ekmConnectionsAdmin wasn't applied." ] } }, "type": "object", "id": "GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse" }, "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud": { "id": "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud", "description": "Remediation instructions to resolve violation via gcloud cli", "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "string" }, "description": "Steps to resolve violation via gcloud cli" }, "additionalLinks": { "description": "Additional urls for more information about steps", "type": "array", "items": { "type": "string" } }, "gcloudCommands": { "type": "array", "items": { "type": "string" }, "description": "Gcloud command to resolve violation" } } }, "GoogleCloudAssuredworkloadsV1MoveAnalysisResult": { "description": "Represents the successful move analysis results for a group.", "type": "object", "properties": { "blockers": { "type": "array", "items": { "$ref": "GoogleCloudAssuredworkloadsV1MoveImpact" }, "description": "List of blockers. If not resolved, these will result in compliance violations in the target." }, "warnings": { "items": { "$ref": "GoogleCloudAssuredworkloadsV1MoveImpact" }, "description": "List of warnings. These are risks that may or may not result in compliance violations.", "type": "array" } }, "id": "GoogleCloudAssuredworkloadsV1MoveAnalysisResult" }, "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole": { "id": "GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole", "properties": { "additionalLinks": { "items": { "type": "string" }, "description": "Additional urls for more information about steps", "type": "array" }, "consoleUris": { "items": { "type": "string" }, "description": "Link to console page where violations can be resolved", "type": "array" }, "steps": { "items": { "type": "string" }, "type": "array", "description": "Steps to resolve violation via cloud console" } }, "description": "Remediation instructions to resolve violation via cloud console", "type": "object" }, "GoogleCloudAssuredworkloadsV1StringList": { "type": "object", "id": "GoogleCloudAssuredworkloadsV1StringList", "properties": { "values": { "items": { "type": "string" }, "description": "Required. The strings in the list.", "type": "array" } }, "description": "A list of strings for the parameter value." }, "GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails": { "type": "object", "properties": { "resourceFindingCount": { "format": "int64", "type": "string", "readOnly": true, "description": "Output only. Number of resource findings for the cloud control." }, "findingsCount": { "description": "The number of findings for the cloud control.", "type": "integer", "format": "int32" }, "evaluationState": { "enum": [ "EVALUATION_STATE_UNSPECIFIED", "EVALUATION_STATE_PASSED", "EVALUATION_STATE_FAILED", "EVALUATION_STATE_NOT_ASSESSED" ], "readOnly": true, "type": "string", "description": "Output only. The evaluation status of the cloud control.", "enumDescriptions": [ "Default value. This value is unused.", "The control is passing.", "The control is failing.", "The control is not assessed." ] }, "orgPolicyFindingCount": { "type": "string", "readOnly": true, "description": "Output only. Number of organization policy findings for the cloud control.", "format": "int64" } }, "description": "The cloud control assessment details for non-manual cloud controls.", "id": "GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails" }, "GoogleCloudAssuredworkloadsV1Rule": { "description": "A rule in the cloud control.", "type": "object", "id": "GoogleCloudAssuredworkloadsV1Rule", "properties": { "ruleActionTypes": { "description": "Required. The functionality that's enabled by the rule.", "items": { "enumDescriptions": [ "Default value. This value is unused.", "The rule is intended to prevent non-compliance.", "The rule is intended to detect non-compliance.", "The rule is intended to audit non-compliance." ], "type": "string", "enum": [ "RULE_ACTION_TYPE_UNSPECIFIED", "RULE_ACTION_TYPE_PREVENTIVE", "RULE_ACTION_TYPE_DETECTIVE", "RULE_ACTION_TYPE_AUDIT" ] }, "type": "array" }, "celExpression": { "description": "The rule's logic expression in Common Expression Language (CEL).", "$ref": "GoogleCloudAssuredworkloadsV1CELExpression" }, "description": { "type": "string", "description": "Optional. The rule description. The maximum length is 2000 characters." } } } }, "baseUrl": "https://assuredworkloads.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "mtlsRootUrl": "https://assuredworkloads.mtls.googleapis.com/", "rootUrl": "https://assuredworkloads.googleapis.com/", "name": "assuredworkloads", "servicePath": "", "parameters": { "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "quotaUser": { "location": "query", "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.", "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.", "type": "string", "location": "query" }, "alt": { "type": "string", "enum": [ "json", "media", "proto" ], "default": "json", "description": "Data format for response.", "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" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "location": "query", "default": "true" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "$.xgafv": { "location": "query", "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." } }, "version_module": true, "kind": "discovery#restDescription", "resources": { "organizations": { "resources": { "locations": { "resources": { "dbFrameworkComplianceSummaries": { "methods": { "list": { "id": "assuredworkloads.organizations.locations.dbFrameworkComplianceSummaries.list", "description": "Lists the framework compliance summary for a given scope.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000." }, "view": { "description": "Optional. Specifies the level of detail to return in the response.", "location": "query", "enumDescriptions": [ "The default / unset value. The API will default to the BASIC view.", "Includes basic compliance metadata, but omits trend data.", "Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." ], "enum": [ "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" ], "type": "string" }, "pageToken": { "type": "string", "description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", "location": "query" }, "filter": { "description": "Optional. The filtering results.", "type": "string", "location": "query" } }, "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" }, "path": "v1/{+parent}/dbFrameworkComplianceSummaries", "httpMethod": "GET" } } }, "operations": { "methods": { "get": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "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.", "id": "assuredworkloads.organizations.locations.operations.get", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$" } } }, "list": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation's parent resource.", "type": "string" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" } }, "parameterOrder": [ "name" ], "id": "assuredworkloads.organizations.locations.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } }, "dbFrameworkComplianceReports": { "methods": { "fetch": { "response": { "$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" }, "parameters": { "filter": { "type": "string", "description": "Optional. The filtering results.", "location": "query" }, "name": { "description": "Required. The name of the framework compliance report to retrieve.", "type": "string", "location": "path", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$" }, "endTime": { "location": "query", "description": "Optional. The end time of the report.", "type": "string", "format": "google-datetime" } }, "description": "Fetches the framework compliance report for a given scope.", "path": "v1/{+name}:fetch", "parameterOrder": [ "name" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", "httpMethod": "GET", "id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.fetch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "aggregate": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", "description": "Gets the aggregated compliance report over time for a given scope.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" }, "path": "v1/{+name}:aggregate", "id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.aggregate", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", "type": "string", "required": true, "location": "path" }, "interval.startTime": { "location": "query", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "format": "google-datetime", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "Optional. The filtering results." }, "interval.endTime": { "format": "google-datetime", "type": "string", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "location": "query" } } } }, "resources": { "dbControlComplianceSummaries": { "methods": { "list": { "id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", "description": "Lists the control compliance summary for a given scope.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", "pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token that identifies the page of results that the server should return." }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "location": "query" }, "filter": { "location": "query", "description": "Optional. The filtering results.", "type": "string" } }, "path": "v1/{+parent}/dbControlComplianceSummaries", "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "parent" ] } } } } }, "dbFindingSummaries": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/dbFindingSummaries", "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" }, "parameters": { "filter": { "description": "Optional. The filtering results.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", "format": "int32", "location": "query" }, "parent": { "type": "string", "location": "path", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+$", "description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}" }, "pageToken": { "description": "Optional. A token that identifies the page of results that the server should return.", "location": "query", "type": "string" } }, "id": "assuredworkloads.organizations.locations.dbFindingSummaries.list", "description": "Lists the finding summary by category for a given scope.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFindingSummaries", "parameterOrder": [ "parent" ], "httpMethod": "GET" } } }, "workloads": { "resources": { "updates": { "methods": { "apply": { "id": "assuredworkloads.organizations.locations.workloads.updates.apply", "httpMethod": "POST", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest" }, "description": "This endpoint creates a new operation to apply the given update.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$" } }, "path": "v1/{+name}:apply", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$" }, "pageSize": { "type": "integer", "location": "query", "description": "Page size. The default value is 20 and the max allowed value is 100.", "format": "int32" }, "pageToken": { "location": "query", "description": "Page token returned from previous request.", "type": "string" } }, "description": "This endpoint lists all updates for the given workload.", "parameterOrder": [ "parent" ], "id": "assuredworkloads.organizations.locations.workloads.updates.list", "path": "v1/{+parent}/updates", "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse" }, "httpMethod": "GET" } } }, "violations": { "methods": { "get": { "parameterOrder": [ "name" ], "parameters": { "view": { "description": "Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations.", "location": "query", "enumDescriptions": [ "Defaults to the ASSURED_WORKLOADS view.", "Includes the basic metadata about the violation.", "Includes all information about the violation, including details about the data boundary." ], "enum": [ "VIOLATION_VIEW_UNSPECIFIED", "VIOLATION_VIEW_ASSURED_WORKLOADS", "VIOLATION_VIEW_DATA_BOUNDARY" ], "type": "string" }, "name": { "type": "string", "description": "Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "required": true, "location": "path" } }, "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", "httpMethod": "GET", "description": "Retrieves Assured Workload Violation based on ID.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1Violation" }, "id": "assuredworkloads.organizations.locations.workloads.violations.get" }, "list": { "parameters": { "interval.endTime": { "description": "The end of the time window.", "type": "string", "format": "google-datetime", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. A custom filter for filtering by the Violations properties." }, "pageToken": { "location": "query", "description": "Optional. Page token returned from previous request.", "type": "string" }, "interval.startTime": { "format": "google-datetime", "location": "query", "description": "The start of the time window.", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. Page size.", "format": "int32", "type": "integer" }, "view": { "enum": [ "VIOLATION_VIEW_UNSPECIFIED", "VIOLATION_VIEW_ASSURED_WORKLOADS", "VIOLATION_VIEW_DATA_BOUNDARY" ], "type": "string", "description": "Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations.", "enumDescriptions": [ "Defaults to the ASSURED_WORKLOADS view.", "Includes the basic metadata about the violation.", "Includes all information about the violation, including details about the data boundary." ], "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Actionable sorting delegation." }, "parent": { "description": "Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`.", "location": "path", "required": true, "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$" } }, "path": "v1/{+parent}/violations", "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListViolationsResponse" }, "id": "assuredworkloads.organizations.locations.workloads.violations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", "parameterOrder": [ "parent" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations" }, "acknowledge": { "description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "type": "string" } }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge", "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge", "request": { "$ref": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest" }, "path": "v1/{+name}:acknowledge", "response": { "$ref": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse" } } } } }, "methods": { "analyzeWorkloadMove": { "description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse" }, "id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove", "parameterOrder": [ "target" ], "path": "v1/{+target}:analyzeWorkloadMove", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.", "type": "string" }, "target": { "type": "string", "description": "Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "location": "path" }, "project": { "description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50." }, "assetTypes": { "repeated": true, "type": "string", "description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", "location": "query" } } }, "get": { "id": "assuredworkloads.organizations.locations.workloads.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets Assured Workload associated with a CRM Node", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", "parameters": { "name": { "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", "required": true, "location": "path" } } }, "patch": { "response": { "$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "request": { "$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "parameters": { "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to be updated." }, "name": { "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", "required": true, "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "type": "string" } }, "id": "assuredworkloads.organizations.locations.workloads.patch", "description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH" }, "list": { "httpMethod": "GET", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Assured Workloads under a CRM Node.", "parameters": { "parent": { "type": "string", "description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "location": "path" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Page size." }, "filter": { "location": "query", "type": "string", "description": "Optional. A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported." }, "pageToken": { "location": "query", "type": "string", "description": "Optional. Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests." } }, "id": "assuredworkloads.organizations.locations.workloads.list", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse" }, "path": "v1/{+parent}/workloads" }, "create": { "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads", "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates Assured Workload.", "id": "assuredworkloads.organizations.locations.workloads.create", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "path": "v1/{+parent}/workloads", "parameters": { "externalId": { "location": "query", "type": "string", "description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value." }, "parent": { "required": true, "description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "type": "string" } } }, "enableResourceMonitoring": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:enableResourceMonitoring", "httpMethod": "POST", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", "description": "Enable resource violation monitoring for a workload.", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "location": "path", "type": "string", "description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}" } }, "response": { "$ref": "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse" }, "id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring" }, "mutatePartnerPermissions": { "path": "v1/{+name}:mutatePartnerPermissions", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest" }, "description": "Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", "response": { "$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions", "id": "assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions" }, "restrictAllowedResources": { "request": { "$ref": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest" }, "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", "httpMethod": "POST", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse" }, "path": "v1/{+name}:restrictAllowedResources", "parameters": { "name": { "description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "location": "path", "type": "string", "required": true } }, "id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", "description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality." }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "id": "assuredworkloads.organizations.locations.workloads.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "type": "string" }, "etag": { "location": "query", "description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", "type": "string" } }, "description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", "httpMethod": "DELETE" }, "enableComplianceUpdates": { "parameters": { "name": { "type": "string", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "location": "path", "description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}:enableComplianceUpdates", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", "httpMethod": "PUT", "description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", "id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", "response": { "$ref": "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse" } } } } } } } }, "projects": { "resources": { "locations": { "resources": { "dbFrameworkComplianceSummaries": { "methods": { "list": { "path": "v1/{+parent}/dbFrameworkComplianceSummaries", "id": "assuredworkloads.projects.locations.dbFrameworkComplianceSummaries.list", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "description": "Optional. The filtering results.", "location": "query" }, "pageToken": { "description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "format": "int32", "location": "query" }, "view": { "location": "query", "description": "Optional. Specifies the level of detail to return in the response.", "enum": [ "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" ], "type": "string", "enumDescriptions": [ "The default / unset value. The API will default to the BASIC view.", "Includes basic compliance metadata, but omits trend data.", "Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." ] } }, "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Lists the framework compliance summary for a given scope.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceSummaries" } } }, "dbFrameworkComplianceReports": { "resources": { "dbControlComplianceSummaries": { "methods": { "list": { "description": "Lists the control compliance summary for a given scope.", "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" }, "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "Optional. The filtering results." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000." }, "pageToken": { "location": "query", "description": "Optional. A token that identifies the page of results that the server should return.", "type": "string" } }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/dbControlComplianceSummaries", "id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", "httpMethod": "GET" } } } }, "methods": { "aggregate": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets the aggregated compliance report over time for a given scope.", "parameters": { "name": { "description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "type": "string" }, "interval.startTime": { "type": "string", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "location": "query", "format": "google-datetime" }, "filter": { "description": "Optional. The filtering results.", "location": "query", "type": "string" }, "interval.endTime": { "format": "google-datetime", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" }, "id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.aggregate", "path": "v1/{+name}:aggregate" }, "fetch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", "httpMethod": "GET", "id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.fetch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "description": "Required. The name of the framework compliance report to retrieve.", "type": "string" }, "endTime": { "format": "google-datetime", "location": "query", "description": "Optional. The end time of the report.", "type": "string" }, "filter": { "type": "string", "description": "Optional. The filtering results.", "location": "query" } }, "path": "v1/{+name}:fetch", "description": "Fetches the framework compliance report for a given scope." } } }, "dbFindingSummaries": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the finding summary by category for a given scope.", "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" }, "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default." }, "filter": { "type": "string", "description": "Optional. The filtering results.", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token that identifies the page of results that the server should return." }, "parent": { "description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "assuredworkloads.projects.locations.dbFindingSummaries.list", "path": "v1/{+parent}/dbFindingSummaries", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFindingSummaries", "parameterOrder": [ "parent" ] } } } } } } }, "folders": { "resources": { "locations": { "resources": { "dbFindingSummaries": { "methods": { "list": { "description": "Lists the finding summary by category for a given scope.", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFindingSummaries", "httpMethod": "GET", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" }, "id": "assuredworkloads.folders.locations.dbFindingSummaries.list", "path": "v1/{+parent}/dbFindingSummaries", "parameters": { "filter": { "type": "string", "location": "query", "description": "Optional. The filtering results." }, "pageSize": { "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "Optional. A token that identifies the page of results that the server should return.", "type": "string", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent scope for the framework overview page. Formats: - projects/{project}/locations/{location} - folders/{folder}/locations/{location} - organizations/{organization}/locations/{location}", "location": "path", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+$" } } } } }, "dbFrameworkComplianceSummaries": { "methods": { "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" }, "id": "assuredworkloads.folders.locations.dbFrameworkComplianceSummaries.list", "httpMethod": "GET", "path": "v1/{+parent}/dbFrameworkComplianceSummaries", "description": "Lists the framework compliance summary for a given scope.", "parameters": { "parent": { "pattern": "^folders/[^/]+/locations/[^/]+$", "description": "Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location}", "type": "string", "required": true, "location": "path" }, "filter": { "location": "query", "type": "string", "description": "Optional. The filtering results." }, "pageToken": { "description": "Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000." }, "view": { "type": "string", "enum": [ "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" ], "description": "Optional. Specifies the level of detail to return in the response.", "enumDescriptions": [ "The default / unset value. The API will default to the BASIC view.", "Includes basic compliance metadata, but omits trend data.", "Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." ], "location": "query" } }, "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceSummaries", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "dbFrameworkComplianceReports": { "resources": { "dbControlComplianceSummaries": { "methods": { "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" }, "description": "Lists the control compliance summary for a given scope.", "httpMethod": "GET", "path": "v1/{+parent}/dbControlComplianceSummaries", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", "parameters": { "parent": { "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "location": "path", "description": "Required. The parent scope for the framework overview page. Format: organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report} projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A token that identifies the page of results that the server should return." }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Optional. The filtering results." } }, "id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list" } } } }, "methods": { "fetch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" }, "parameters": { "name": { "pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "description": "Required. The name of the framework compliance report to retrieve.", "required": true, "location": "path", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "location": "query", "description": "Optional. The end time of the report." }, "filter": { "type": "string", "description": "Optional. The filtering results.", "location": "query" } }, "description": "Fetches the framework compliance report for a given scope.", "path": "v1/{+name}:fetch", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", "id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.fetch", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "aggregate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the aggregated compliance report over time for a given scope.", "parameters": { "filter": { "type": "string", "location": "query", "description": "Optional. The filtering results." }, "name": { "pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", "description": "Required. The name of the aggregated compliance report over time to retrieve. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", "required": true, "location": "path", "type": "string" }, "interval.endTime": { "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "format": "google-datetime", "location": "query", "type": "string" }, "interval.startTime": { "format": "google-datetime", "type": "string", "location": "query", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start." } }, "id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.aggregate", "response": { "$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" }, "path": "v1/{+name}:aggregate", "httpMethod": "GET", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", "parameterOrder": [ "name" ] } } } } } } } }, "protocol": "rest", "basePath": "" }