canonical: https://jentic.com/apis/googleapis.com/assuredworkloads # Google Assured Workloads API The Assured Workloads API programmatically manages Google Cloud's compliance-controlled folders that enforce regulatory regimes such as FedRAMP, IL4, CJIS, and EU Sovereign Controls on the resources created inside them. It exposes operations to create and update workloads, restrict allowed resource types and locations, mutate partner-controlled permissions, and acknowledge violations surfaced by the platform. Workload state changes are returned as long-running operations that callers must poll for completion. The API is the control-plane for compliance posture, not for building or running the underlying applications. ## For AI agents Provision and govern Google Cloud Assured Workloads folders, restrict resource locations, acknowledge violations, and manage partner permissions for regulated workloads. ## Scope Does not provision projects inside the workload, run application workloads, or remediate violations automatically - use for creating, configuring, and acknowledging posture on Assured Workloads folders only. ## Capabilities - Create a workload that enforces a chosen compliance regime such as FedRAMP_HIGH or EU_REGIONS_AND_SUPPORT - Restrict the set of allowed resource types within a workload via /v1/{+name}:restrictAllowedResources - Acknowledge a compliance violation surfaced on the workload to mark it reviewed - Enable resource monitoring on a workload via /v1/{+name}:enableResourceMonitoring - Mutate partner-controlled IAM permissions via /v1/{+name}:mutatePartnerPermissions for sovereign deployments - List long-running operations on a workload to track create and update progress ## Use cases ### Provision a FedRAMP-Controlled Folder Create a Google Cloud folder that automatically enforces FedRAMP High or Moderate controls on the projects placed inside it. The API returns a long-running operation while the workload is being prepared, then exposes endpoints to inspect violations and acknowledge them. Suited to regulated SaaS providers that need a repeatable, auditable provisioning path for compliant tenants. Example prompt: POST a workload create request with complianceRegime=FEDRAMP_HIGH to /v1/{parent}/workloads and poll the returned operation until it completes. ### Lock Down Allowed Resources for a Regulated Tenant After a workload is created, restrict the resource types it can use to a curated allowlist so customers cannot inadvertently provision non-compliant services. The restrictAllowedResources endpoint accepts a list of allowed resource type strings and applies them at the workload boundary. Useful for tenants that must hold to a strict baseline like Compute Engine plus Cloud Storage only. Example prompt: POST a list of allowed resource types to /v1/{name}:restrictAllowedResources for the workload and verify the response. ### Acknowledge and Track Compliance Violations When the platform raises a compliance violation on a workload, an operations team can list violations, investigate, and acknowledge each one through the API to record review. Acknowledgement does not remediate the underlying issue but records human review for audit purposes, fitting cleanly into a SOC workflow or ticketing integration. Example prompt: POST an acknowledgement with the violation resource name to /v1/{name}:acknowledge and log the response in the SOC ticket. ### Agent-Driven Compliance Posture Reviews via Jentic Use an AI agent to run periodic posture reviews across an organisation's Assured Workloads, summarise open violations, and route them to the right owner. Through Jentic the agent discovers list and acknowledge operations by intent and executes them with org-scoped credentials supplied at call time, without managing service accounts inside the agent runtime. Example prompt: Use Jentic search for 'list assured workloads in an organisation', iterate the results, and call the acknowledge endpoint for each violation marked closed in the ticketing system. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /v1/{+name} | Get a workload or violation by resource name | | PATCH | /v1/{+name} | Update a workload's mutable fields | | DELETE | /v1/{+name} | Delete a workload | | POST | /v1/{+name}:acknowledge | Acknowledge a compliance violation | | POST | /v1/{+name}:restrictAllowedResources | Restrict the allowed resource types in a workload | | POST | /v1/{+name}:enableResourceMonitoring | Enable resource monitoring on a workload | | PATCH | /v1/{+name}:mutatePartnerPermissions | Update partner-controlled IAM permissions | ## Key resources - **workloads** — Compliance-bounded folders with create, get, patch, and delete operations - **violations** — Compliance issues raised on a workload with acknowledge support - **operations** — Long-running operations representing workload create and update progress ## Why Jentic - **Setup:** Wiring the Assured Workloads API by hand means configuring Google OAuth2, granting a service account organization-scoped roles, and minting scoped access tokens for each compliance call yourself. Through Jentic you install once, import the Assured Workloads API from the API Directory, store the OAuth credential once, and your agent calls it. - **Permission scoping:** This API puts the workload name in the URL path (/v1/{name}, /v1/{name}:acknowledge), so a rule can pin your agent to one workload: it can read the workload, acknowledge posture, and enable resource monitoring there and nothing else. You choose the operations it may call, so actions like deleting a workload are not included unless you add them. - **Credential handling:** Your Google Cloud OAuth credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a FedRAMP workload' or 'acknowledge a violation', and Jentic returns the matching Assured Workloads operation with its input schema so the agent calls the right endpoint without walking Google's discovery document or compliance docs. ## Related APIs - **Cloud Resource Manager API** — Creates the projects and folders that live inside an Assured Workload - **Access Context Manager API** — Defines access levels and service perimeters that complement workload boundaries - **Security Command Center API** — Surfaces broader security findings across the organisation including workload posture ## FAQ ### What authentication does the Assured Workloads API use? The API uses Google OAuth 2.0 with cloud-platform scope. The caller must hold the assuredworkloads.workloads.* IAM permissions on the parent organisation or folder. Through Jentic the service account credential lives in the encrypted vault and the agent only sees short-lived access tokens. ### Which compliance regimes can I enforce with the Assured Workloads API? The workload create payload accepts a complianceRegime field; supported values include FedRAMP Moderate and High, IL4, CJIS, EU Regions and Support, EU Sovereign Controls, and Canada Controlled Goods Program among others. The exact set is documented on the workload create schema in the spec. ### Are workload create and update operations synchronous? No. Create, update, and delete return long-running operation handles. List the operations under the workload via GET /v1/{name}/operations and poll until done is true to confirm completion. ### How do I acknowledge a compliance violation through Jentic? Search Jentic for 'acknowledge an Assured Workloads violation', load the schema for POST /v1/{name}:acknowledge, and execute it with the violation resource name and an acknowledgement comment. The credential is supplied from your Jentic One instance. ### What are the rate limits for the Assured Workloads API? Numeric rate limits are not declared in the spec; quotas are enforced per project on assuredworkloads.googleapis.com. Review the project's quota settings in the Google Cloud console before bulk-creating workloads. ### Can the API create the projects inside a workload? No. Assured Workloads creates the bounded folder; projects inside it are still created via the Cloud Resource Manager API. Use the two together to fully provision a regulated tenant. ### Can I limit what my agent is allowed to do with the Assured Workloads API? Yes. Because this API carries the workload name in the URL path (/v1/{name}, /v1/{name}:acknowledge), your self-hosted Jentic One instance lets you write rules that pin the agent to a single workload and to a chosen set of operations, so it can read the workload, acknowledge violations, and enable resource monitoring there and nothing else. You decide which operations and credentials the agent may use, so destructive calls like deleting a workload or mutating partner permissions are excluded unless you add them. Your own rules, not the agent, determine what it can reach.