{ "uuid": "b3c4b748-4524-48b1-bbad-6d6af5d4a0bc", "lastMigration": 29, "name": "Assured Workloads API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "c4ae7671-4a85-4743-b358-ed28f43bbf66", "documentation": "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.", "method": "delete", "endpoint": "v1beta1/:name", "responses": [ { "uuid": "5f2cb69c-d3cf-4084-93ec-aa3a0c87c995", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee98572f-a2dc-422a-b0ea-6792ebc6498d", "documentation": "Retrieves Assured Workload Violation based on ID.", "method": "get", "endpoint": "v1beta1/:name", "responses": [ { "uuid": "423b0c2d-94a7-4a40-b095-a8f9b6a9b56f", "body": "{\n \"acknowledged\": {{faker 'datatype.boolean'}},\n \"acknowledgementTime\": \"\",\n \"auditLogLink\": \"\",\n \"beginTime\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"exceptionAuditLogLink\": \"\",\n \"name\": \"\",\n \"nonCompliantOrgPolicy\": \"\",\n \"orgPolicyConstraint\": \"\",\n \"remediation\": {\n \"compliantValues\": [\n \"\"\n ],\n \"instructions\": {\n \"consoleInstructions\": {\n \"additionalLinks\": [\n \"\"\n ],\n \"consoleUris\": [\n \"\"\n ],\n \"steps\": [\n \"\"\n ]\n },\n \"gcloudInstructions\": {\n \"additionalLinks\": [\n \"\"\n ],\n \"gcloudCommands\": [\n \"\"\n ],\n \"steps\": [\n \"\"\n ]\n }\n },\n \"remediationType\": \"{{oneOf (array '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')}}\"\n },\n \"resolveTime\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'RESOLVED' 'UNRESOLVED' 'EXCEPTION')}}\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d555cd66-8642-40ed-ab7d-95cf6f03af2d", "documentation": "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.", "method": "patch", "endpoint": "v1beta1/:name", "responses": [ { "uuid": "5b5faa1b-0ff4-4c49-87be-5f7a84adb98c", "body": "{\n \"billingAccount\": \"\",\n \"cjisSettings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"complianceRegime\": \"{{oneOf (array 'COMPLIANCE_REGIME_UNSPECIFIED' 'IL4' 'CJIS' 'FEDRAMP_HIGH' 'FEDRAMP_MODERATE' 'US_REGIONAL_ACCESS' 'HIPAA' 'HITRUST' 'EU_REGIONS_AND_SUPPORT' 'CA_REGIONS_AND_SUPPORT' 'ITAR' 'AU_REGIONS_AND_US_SUPPORT' 'ASSURED_WORKLOADS_FOR_PARTNERS')}}\",\n \"complianceStatus\": {\n \"acknowledgedViolationCount\": {{faker 'number.int' max=99999}},\n \"activeViolationCount\": {{faker 'number.int' max=99999}}\n },\n \"compliantButDisallowedServices\": [\n \"\"\n ],\n \"createTime\": \"\",\n \"displayName\": \"\",\n \"enableSovereignControls\": {{faker 'datatype.boolean'}},\n \"etag\": \"\",\n \"fedrampHighSettings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"fedrampModerateSettings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"il4Settings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"kajEnrollmentState\": \"{{oneOf (array 'KAJ_ENROLLMENT_STATE_UNSPECIFIED' 'KAJ_ENROLLMENT_STATE_PENDING' 'KAJ_ENROLLMENT_STATE_COMPLETE')}}\",\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n },\n \"labels\": {},\n \"name\": \"\",\n \"partner\": \"{{oneOf (array 'PARTNER_UNSPECIFIED' 'LOCAL_CONTROLS_BY_S3NS')}}\",\n \"provisionedResourcesParent\": \"\",\n \"resourceSettings\": [\n {\n \"displayName\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'CONSUMER_PROJECT' 'CONSUMER_FOLDER' 'ENCRYPTION_KEYS_PROJECT' 'KEYRING')}}\"\n }\n ],\n \"resources\": [\n {\n \"resourceId\": \"\",\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'CONSUMER_PROJECT' 'CONSUMER_FOLDER' 'ENCRYPTION_KEYS_PROJECT' 'KEYRING')}}\"\n }\n ],\n \"saaEnrollmentResponse\": {\n \"setupErrors\": [\n \"{{oneOf (array 'SETUP_ERROR_UNSPECIFIED' 'ERROR_INVALID_BASE_SETUP' 'ERROR_MISSING_EXTERNAL_SIGNING_KEY' 'ERROR_NOT_ALL_SERVICES_ENROLLED' 'ERROR_SETUP_CHECK_FAILED')}}\"\n ],\n \"setupStatus\": \"{{oneOf (array 'SETUP_STATE_UNSPECIFIED' 'STATUS_PENDING' 'STATUS_COMPLETE')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3b02cefc-981f-4bb0-a3b7-f32cec35d5c4", "documentation": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "method": "get", "endpoint": "v1beta1/:name/operations", "responses": [ { "uuid": "10f97a30-4fa5-43f8-b561-0bb734c870c4", "body": "{\n \"nextPageToken\": \"\",\n \"operations\": [\n {\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "add5810a-9c38-456b-b15a-316e431d2515", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:acknowledge", "responses": [ { "uuid": "2d6c0b76-562a-490c-8c3e-fde0804d6f9a", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b24ae99c-59e7-4b02-864f-733ea066b395", "documentation": "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.", "method": "post", "endpoint": "v1beta1/:name:restrictAllowedResources", "responses": [ { "uuid": "8b005312-7492-44b6-8ae2-87fabf026333", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7e68d5f2-cefb-4e2a-9190-9fa7b3d32c51", "documentation": "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/-`", "method": "get", "endpoint": "v1beta1/:parent/violations", "responses": [ { "uuid": "ccce814c-34f1-4a60-b539-d55c2f94b965", "body": "{\n \"nextPageToken\": \"\",\n \"violations\": [\n {\n \"acknowledged\": {{faker 'datatype.boolean'}},\n \"acknowledgementTime\": \"\",\n \"auditLogLink\": \"\",\n \"beginTime\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"exceptionAuditLogLink\": \"\",\n \"name\": \"\",\n \"nonCompliantOrgPolicy\": \"\",\n \"orgPolicyConstraint\": \"\",\n \"remediation\": {\n \"compliantValues\": [\n \"\"\n ],\n \"instructions\": {\n \"consoleInstructions\": {\n \"additionalLinks\": [\n \"\"\n ],\n \"consoleUris\": [\n \"\"\n ],\n \"steps\": [\n \"\"\n ]\n },\n \"gcloudInstructions\": {\n \"additionalLinks\": [\n \"\"\n ],\n \"gcloudCommands\": [\n \"\"\n ],\n \"steps\": [\n \"\"\n ]\n }\n },\n \"remediationType\": \"{{oneOf (array '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')}}\"\n },\n \"resolveTime\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'RESOLVED' 'UNRESOLVED' 'EXCEPTION')}}\",\n \"updateTime\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4dff3124-48b6-4708-8c74-0fe613b07304", "documentation": "Lists Assured Workloads under a CRM Node.", "method": "get", "endpoint": "v1beta1/:parent/workloads", "responses": [ { "uuid": "b58a06be-1a03-41ad-b002-5ad1b2fd21c1", "body": "{\n \"nextPageToken\": \"\",\n \"workloads\": [\n {\n \"billingAccount\": \"\",\n \"cjisSettings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"complianceRegime\": \"{{oneOf (array 'COMPLIANCE_REGIME_UNSPECIFIED' 'IL4' 'CJIS' 'FEDRAMP_HIGH' 'FEDRAMP_MODERATE' 'US_REGIONAL_ACCESS' 'HIPAA' 'HITRUST' 'EU_REGIONS_AND_SUPPORT' 'CA_REGIONS_AND_SUPPORT' 'ITAR' 'AU_REGIONS_AND_US_SUPPORT' 'ASSURED_WORKLOADS_FOR_PARTNERS')}}\",\n \"complianceStatus\": {\n \"acknowledgedViolationCount\": {{faker 'number.int' max=99999}},\n \"activeViolationCount\": {{faker 'number.int' max=99999}}\n },\n \"compliantButDisallowedServices\": [\n \"\"\n ],\n \"createTime\": \"\",\n \"displayName\": \"\",\n \"enableSovereignControls\": {{faker 'datatype.boolean'}},\n \"etag\": \"\",\n \"fedrampHighSettings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"fedrampModerateSettings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"il4Settings\": {\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n }\n },\n \"kajEnrollmentState\": \"{{oneOf (array 'KAJ_ENROLLMENT_STATE_UNSPECIFIED' 'KAJ_ENROLLMENT_STATE_PENDING' 'KAJ_ENROLLMENT_STATE_COMPLETE')}}\",\n \"kmsSettings\": {\n \"nextRotationTime\": \"\",\n \"rotationPeriod\": \"\"\n },\n \"labels\": {},\n \"name\": \"\",\n \"partner\": \"{{oneOf (array 'PARTNER_UNSPECIFIED' 'LOCAL_CONTROLS_BY_S3NS')}}\",\n \"provisionedResourcesParent\": \"\",\n \"resourceSettings\": [\n {\n \"displayName\": \"\",\n \"resourceId\": \"\",\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'CONSUMER_PROJECT' 'CONSUMER_FOLDER' 'ENCRYPTION_KEYS_PROJECT' 'KEYRING')}}\"\n }\n ],\n \"resources\": [\n {\n \"resourceId\": \"\",\n \"resourceType\": \"{{oneOf (array 'RESOURCE_TYPE_UNSPECIFIED' 'CONSUMER_PROJECT' 'CONSUMER_FOLDER' 'ENCRYPTION_KEYS_PROJECT' 'KEYRING')}}\"\n }\n ],\n \"saaEnrollmentResponse\": {\n \"setupErrors\": [\n \"{{oneOf (array 'SETUP_ERROR_UNSPECIFIED' 'ERROR_INVALID_BASE_SETUP' 'ERROR_MISSING_EXTERNAL_SIGNING_KEY' 'ERROR_NOT_ALL_SERVICES_ENROLLED' 'ERROR_SETUP_CHECK_FAILED')}}\"\n ],\n \"setupStatus\": \"{{oneOf (array 'SETUP_STATE_UNSPECIFIED' 'STATUS_PENDING' 'STATUS_COMPLETE')}}\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "45376eb1-1c1f-4e60-b47b-e9ece7d78a42", "documentation": "Creates Assured Workload.", "method": "post", "endpoint": "v1beta1/:parent/workloads", "responses": [ { "uuid": "87991140-db90-4a30-aeb6-b7b0a30e79d7", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0a74bfa5-c083-48da-b195-ea12e6b80ebe", "documentation": "Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.", "method": "get", "endpoint": "v1beta1/:project/:target:analyzeWorkloadMove", "responses": [ { "uuid": "de3c9a44-67a1-4e20-8a00-240483780b0d", "body": "{\n \"blockers\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f23cdb17-a9ef-4bac-ba70-27b52b597d64", "documentation": "Analyzes a hypothetical move of a source project or project-based workload to a target (destination) folder-based workload.", "method": "get", "endpoint": "v1beta1/:source/:target:analyzeWorkloadMove", "responses": [ { "uuid": "fd82319e-39e0-4c85-95d9-de11e224b180", "body": "{\n \"blockers\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "c4ae7671-4a85-4743-b358-ed28f43bbf66" }, { "type": "route", "uuid": "ee98572f-a2dc-422a-b0ea-6792ebc6498d" }, { "type": "route", "uuid": "d555cd66-8642-40ed-ab7d-95cf6f03af2d" }, { "type": "route", "uuid": "3b02cefc-981f-4bb0-a3b7-f32cec35d5c4" }, { "type": "route", "uuid": "add5810a-9c38-456b-b15a-316e431d2515" }, { "type": "route", "uuid": "b24ae99c-59e7-4b02-864f-733ea066b395" }, { "type": "route", "uuid": "7e68d5f2-cefb-4e2a-9190-9fa7b3d32c51" }, { "type": "route", "uuid": "4dff3124-48b6-4708-8c74-0fe613b07304" }, { "type": "route", "uuid": "45376eb1-1c1f-4e60-b47b-e9ece7d78a42" }, { "type": "route", "uuid": "0a74bfa5-c083-48da-b195-ea12e6b80ebe" }, { "type": "route", "uuid": "f23cdb17-a9ef-4bac-ba70-27b52b597d64" } ] }