{
  "title": "Assured Workloads API",
  "endpoints": [
    {
      "endpointUrl": "https://assuredworkloads.us.rep.googleapis.com/",
      "description": "Regional Endpoint",
      "location": "us"
    },
    {
      "location": "ca",
      "endpointUrl": "https://assuredworkloads.ca.rep.googleapis.com/",
      "description": "Regional Endpoint"
    },
    {
      "location": "eu",
      "description": "Regional Endpoint",
      "endpointUrl": "https://assuredworkloads.eu.rep.googleapis.com/"
    }
  ],
  "discoveryVersion": "v1",
  "ownerDomain": "google.com",
  "icons": {
    "x16": "http://www.google.com/images/icons/product/search-16.gif",
    "x32": "http://www.google.com/images/icons/product/search-32.gif"
  },
  "kind": "discovery#restDescription",
  "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."
        },
        "https://www.googleapis.com/auth/assuredworkloads": {
          "description": "See, edit, configure, and delete your Google Cloud Assured Workloads data and see the email address for your Google Account"
        },
        "https://www.googleapis.com/auth/assuredworkloads.readonly": {
          "description": "See your Google Cloud Assured Workloads data and the email address of your Google Account"
        }
      }
    }
  },
  "resources": {
    "organizations": {
      "resources": {
        "locations": {
          "resources": {
            "workloads": {
              "methods": {
                "get": {
                  "description": "Gets the details for a specific Assured Workload.",
                  "scopes": [
                    "https://www.googleapis.com/auth/assuredworkloads",
                    "https://www.googleapis.com/auth/assuredworkloads.readonly",
                    "https://www.googleapis.com/auth/cloud-platform"
                  ],
                  "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
                  "response": {
                    "$ref": "GoogleCloudAssuredworkloadsV2Workload"
                  },
                  "httpMethod": "GET",
                  "parameters": {
                    "name": {
                      "location": "path",
                      "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
                      "required": true,
                      "description": "Required. The resource name of the workload to retrieve. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`",
                      "type": "string"
                    }
                  },
                  "parameterOrder": [
                    "name"
                  ],
                  "path": "v2/{+name}",
                  "id": "assuredworkloads.organizations.locations.workloads.get"
                },
                "delete": {
                  "id": "assuredworkloads.organizations.locations.workloads.delete",
                  "parameterOrder": [
                    "name"
                  ],
                  "httpMethod": "DELETE",
                  "parameters": {
                    "name": {
                      "description": "Required. The resource name of the workload to delete. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`",
                      "required": true,
                      "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
                      "location": "path",
                      "type": "string"
                    },
                    "etag": {
                      "location": "query",
                      "description": "Optional. The `etag` of the workload. If this is provided, it must match the server's `etag` value.",
                      "type": "string"
                    }
                  },
                  "scopes": [
                    "https://www.googleapis.com/auth/assuredworkloads",
                    "https://www.googleapis.com/auth/cloud-platform"
                  ],
                  "description": "Deletes an Assured Workload. The returned google.longrunning.Operation has a `metadata` field of type OperationMetadata and a `response` field of type google.protobuf.Empty.",
                  "path": "v2/{+name}",
                  "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
                  "response": {
                    "$ref": "GoogleLongrunningOperation"
                  }
                },
                "patch": {
                  "parameterOrder": [
                    "name"
                  ],
                  "path": "v2/{+name}",
                  "request": {
                    "$ref": "GoogleCloudAssuredworkloadsV2Workload"
                  },
                  "httpMethod": "PATCH",
                  "parameters": {
                    "updateMask": {
                      "type": "string",
                      "format": "google-fieldmask",
                      "location": "query",
                      "description": "Optional. The list of fields to be updated, relative to Workload. Supported field paths are `cloud_control_configs` and `framework.major_revision_id`. If omitted or empty, all mutable fields are updated. Full replacement (`*`) is not supported."
                    },
                    "name": {
                      "location": "path",
                      "required": true,
                      "description": "Identifier. The resource name of the workload. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`",
                      "type": "string",
                      "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$"
                    }
                  },
                  "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
                  "response": {
                    "$ref": "GoogleLongrunningOperation"
                  },
                  "scopes": [
                    "https://www.googleapis.com/auth/assuredworkloads",
                    "https://www.googleapis.com/auth/cloud-platform"
                  ],
                  "id": "assuredworkloads.organizations.locations.workloads.patch",
                  "description": "Updates an existing Assured Workload. The returned google.longrunning.Operation has a `metadata` field of type OperationMetadata and a `response` field of type Workload."
                },
                "list": {
                  "id": "assuredworkloads.organizations.locations.workloads.list",
                  "path": "v2/{+parent}/workloads",
                  "parameterOrder": [
                    "parent"
                  ],
                  "description": "Lists Assured Workloads in a given organization and location.",
                  "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/workloads",
                  "response": {
                    "$ref": "GoogleCloudAssuredworkloadsV2ListWorkloadsResponse"
                  },
                  "httpMethod": "GET",
                  "parameters": {
                    "pageSize": {
                      "description": "Optional. The maximum number of workloads to return. If unspecified, at most 50 workloads will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
                      "format": "int32",
                      "type": "integer",
                      "location": "query"
                    },
                    "parent": {
                      "location": "path",
                      "pattern": "^organizations/[^/]+/locations/[^/]+$",
                      "required": true,
                      "description": "Required. The parent organization and location for which to list workloads. Format: `organizations/{organization}/locations/{location}`",
                      "type": "string"
                    },
                    "pageToken": {
                      "description": "Optional. A page token received from a previous ListWorkloads call. Provide this to retrieve the subsequent page.",
                      "type": "string",
                      "location": "query"
                    },
                    "filter": {
                      "location": "query",
                      "description": "Optional. A filter expression that filters the listed workloads, as defined in [AIP-160: Filtering](https://google.aip.dev/160). Supported filter fields: * `workload_id` * `state` (supports `=`, `:`, and `!=` operators; for example, `state=\"ACTIVE\"`) * `computed_target_resource` (for example, `computed_target_resource=\"projects/123\"`) * `target_resource_display_name` * `framework.framework` * `create_time` * `update_time`",
                      "type": "string"
                    }
                  },
                  "scopes": [
                    "https://www.googleapis.com/auth/assuredworkloads",
                    "https://www.googleapis.com/auth/assuredworkloads.readonly",
                    "https://www.googleapis.com/auth/cloud-platform"
                  ]
                },
                "create": {
                  "description": "Creates a new Assured Workload. The returned google.longrunning.Operation has a `metadata` field of type OperationMetadata and a `response` field of type Workload.",
                  "scopes": [
                    "https://www.googleapis.com/auth/assuredworkloads",
                    "https://www.googleapis.com/auth/cloud-platform"
                  ],
                  "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/workloads",
                  "response": {
                    "$ref": "GoogleLongrunningOperation"
                  },
                  "request": {
                    "$ref": "GoogleCloudAssuredworkloadsV2Workload"
                  },
                  "path": "v2/{+parent}/workloads",
                  "parameterOrder": [
                    "parent"
                  ],
                  "id": "assuredworkloads.organizations.locations.workloads.create",
                  "httpMethod": "POST",
                  "parameters": {
                    "workloadId": {
                      "location": "query",
                      "type": "string",
                      "description": "Optional. The user-assigned identifier for the workload, which must be unique within the parent organization and location. If not specified, a random UUID is generated."
                    },
                    "parent": {
                      "required": true,
                      "type": "string",
                      "location": "path",
                      "description": "Required. The parent organization and location where the workload is created. Format: `organizations/{organization}/locations/{location}`",
                      "pattern": "^organizations/[^/]+/locations/[^/]+$"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servicePath": "",
  "revision": "20261112",
  "basePath": "",
  "version_module": true,
  "version": "v2",
  "protocol": "rest",
  "schemas": {
    "GoogleRpcStatus": {
      "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",
      "properties": {
        "details": {
          "items": {
            "type": "object",
            "additionalProperties": {
              "type": "any",
              "description": "Properties of the object. Contains field @type with type URL."
            }
          },
          "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
          "type": "array"
        },
        "message": {
          "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
          "type": "string"
        },
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "The status code, which should be an enum value of google.rpc.Code."
        }
      },
      "type": "object"
    },
    "GoogleCloudAssuredworkloadsV2NewFolderConfig": {
      "properties": {
        "parent": {
          "type": "string",
          "description": "Required. The parent resource where the folder is created. Format: `organizations/{organization}` or `folders/{folder}`"
        },
        "displayName": {
          "type": "string",
          "description": "Required. The user-friendly display name for the new folder."
        }
      },
      "id": "GoogleCloudAssuredworkloadsV2NewFolderConfig",
      "type": "object",
      "description": "Configuration for provisioning a new Google Cloud folder."
    },
    "GoogleCloudAssuredworkloadsV2StringList": {
      "properties": {
        "values": {
          "description": "Required. The strings in the list.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object",
      "id": "GoogleCloudAssuredworkloadsV2StringList",
      "description": "A list of strings for the parameter value."
    },
    "GoogleLongrunningOperation": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`."
        },
        "error": {
          "description": "The error result of the operation in case of failure or cancellation.",
          "$ref": "GoogleRpcStatus"
        },
        "done": {
          "type": "boolean",
          "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available."
        },
        "response": {
          "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": {
            "type": "any",
            "description": "Properties of the object. Contains field @type with type URL."
          },
          "type": "object"
        },
        "metadata": {
          "type": "object",
          "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
          "additionalProperties": {
            "description": "Properties of the object. Contains field @type with type URL.",
            "type": "any"
          }
        }
      },
      "id": "GoogleLongrunningOperation",
      "description": "This resource represents a long-running operation that is the result of a network API call."
    },
    "GoogleCloudAssuredworkloadsV2Workload": {
      "id": "GoogleCloudAssuredworkloadsV2Workload",
      "type": "object",
      "description": "A Workload resource for managing data boundary and compliance controls on a Google Cloud resource.",
      "properties": {
        "createTime": {
          "description": "Output only. The timestamp when the workload was created.",
          "type": "string",
          "readOnly": true,
          "format": "google-datetime"
        },
        "description": {
          "type": "string",
          "description": "Optional. The user-provided description for the workload."
        },
        "etag": {
          "description": "Optional. An opaque concurrency control token calculated by the server based on the current state of the workload. It may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
          "type": "string"
        },
        "name": {
          "type": "string",
          "description": "Identifier. The resource name of the workload. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`"
        },
        "framework": {
          "description": "Required. The compliance framework active on this workload.",
          "$ref": "GoogleCloudAssuredworkloadsV2FrameworkReference"
        },
        "updateTime": {
          "type": "string",
          "format": "google-datetime",
          "description": "Output only. The timestamp when the workload was last updated.",
          "readOnly": true
        },
        "targetResourceDisplayName": {
          "description": "Output only. The user-facing display name of the target resource.",
          "readOnly": true,
          "type": "string"
        },
        "state": {
          "description": "Output only. The current lifecycle state of the workload.",
          "type": "string",
          "enum": [
            "STATE_UNSPECIFIED",
            "CREATING",
            "ACTIVE",
            "UPDATING",
            "DELETING",
            "FAILED",
            "PARTIALLY_ACTIVE",
            "PARTIALLY_DELETED",
            "PARTIALLY_UPDATED"
          ],
          "readOnly": true,
          "enumDescriptions": [
            "The default value. This value is used if the state is omitted.",
            "The workload is being created.",
            "The workload is active and compliance controls are enforced.",
            "The workload is being updated.",
            "The workload is being deleted.",
            "The workload deployment failed.",
            "The workload is partially active because some resources or controls failed to provision.",
            "The workload is partially deleted because some resources or controls failed to be removed.",
            "The workload is partially updated because some control updates failed to apply."
          ]
        },
        "computedTargetResource": {
          "description": "Output only. The resolved target resource name, in the format `projects/{project_number}` or `folders/{folder_id}` (for example, `projects/123` or `folders/456`).",
          "type": "string",
          "readOnly": true
        },
        "resourceConfig": {
          "description": "Required. Target Google Cloud folder or project where controls are deployed.",
          "$ref": "GoogleCloudAssuredworkloadsV2ResourceConfig"
        },
        "cloudControlConfigs": {
          "items": {
            "$ref": "GoogleCloudAssuredworkloadsV2CloudControlConfig"
          },
          "type": "array",
          "description": "Required. The cloud control configurations enforced on this workload."
        },
        "kajEnrollmentType": {
          "description": "Optional. The customer's Key Access Transparency (KAT) choice for this workload. When unspecified, the service applies the default enablement rules: KAT is enabled for eligible frameworks deployed in preventive mode.",
          "enumDescriptions": [
            "Default unspecified type. The service applies the default enablement rules: KAT is enabled for eligible frameworks deployed in preventive mode.",
            "KAT is enabled for the workload.",
            "KAT is disabled for the workload."
          ],
          "type": "string",
          "enum": [
            "KAJ_ENROLLMENT_TYPE_UNSPECIFIED",
            "KEY_ACCESS_TRANSPARENCY_ENABLED",
            "KEY_ACCESS_TRANSPARENCY_DISABLED"
          ]
        }
      }
    },
    "GoogleCloudAssuredworkloadsV2Parameter": {
      "id": "GoogleCloudAssuredworkloadsV2Parameter",
      "type": "object",
      "description": "Parameters are key-value pairs that let you provide custom settings.",
      "properties": {
        "name": {
          "description": "Required. The name or key of the parameter.",
          "type": "string"
        },
        "parameterValue": {
          "description": "Required. The value of the parameter.",
          "$ref": "GoogleCloudAssuredworkloadsV2ParamValue"
        }
      }
    },
    "GoogleCloudAssuredworkloadsV2CloudControlConfig": {
      "description": "Cloud control configuration applied to the workload.",
      "properties": {
        "parameters": {
          "description": "Optional. Parameters for the cloud control configuration.",
          "items": {
            "$ref": "GoogleCloudAssuredworkloadsV2Parameter"
          },
          "type": "array"
        },
        "cloudControlRevision": {
          "type": "integer",
          "format": "int32",
          "description": "Required. The revision of the cloud control."
        },
        "enforcementMode": {
          "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."
          ],
          "enum": [
            "ENFORCEMENT_MODE_UNSPECIFIED",
            "PREVENTIVE",
            "DETECTIVE",
            "AUDIT"
          ],
          "description": "Required. The enforcement mode for the cloud control.",
          "type": "string"
        },
        "cloudControl": {
          "type": "string",
          "description": "Required. The name of the cloud control, in the format `organizations/{organization}/locations/{location}/cloudControls/{cloud_control}`."
        }
      },
      "id": "GoogleCloudAssuredworkloadsV2CloudControlConfig",
      "type": "object"
    },
    "GoogleCloudAssuredworkloadsV2ListWorkloadsResponse": {
      "type": "object",
      "description": "Response message for ListWorkloads.",
      "id": "GoogleCloudAssuredworkloadsV2ListWorkloadsResponse",
      "properties": {
        "workloads": {
          "description": "The list of workloads in the given organization and location.",
          "items": {
            "$ref": "GoogleCloudAssuredworkloadsV2Workload"
          },
          "type": "array"
        },
        "nextPageToken": {
          "description": "A token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.",
          "type": "string"
        }
      }
    },
    "GoogleCloudAssuredworkloadsV2NewProjectConfig": {
      "type": "object",
      "description": "Configuration for provisioning a new Google Cloud project.",
      "properties": {
        "billingAccount": {
          "description": "Required. The billing account to link to the new project. Format: `billingAccounts/{billing_account}`",
          "type": "string"
        },
        "displayName": {
          "type": "string",
          "description": "Required. The user-friendly display name for the new project."
        },
        "parent": {
          "type": "string",
          "description": "Required. The parent resource where the project is created. Format: `organizations/{organization}` or `folders/{folder}`"
        }
      },
      "id": "GoogleCloudAssuredworkloadsV2NewProjectConfig"
    },
    "GoogleCloudAssuredworkloadsV2ResourceConfig": {
      "description": "Target resource configuration for the workload.",
      "type": "object",
      "id": "GoogleCloudAssuredworkloadsV2ResourceConfig",
      "properties": {
        "existingProject": {
          "description": "Optional. Reference to an existing Google Cloud project. Format: `projects/{project_id_or_number}`",
          "type": "string"
        },
        "newProjectConfig": {
          "description": "Optional. Configuration to provision a new Google Cloud project.",
          "$ref": "GoogleCloudAssuredworkloadsV2NewProjectConfig"
        },
        "existingFolder": {
          "description": "Optional. Reference to an existing Google Cloud folder. Format: `folders/{folder}`",
          "type": "string"
        },
        "newFolderConfig": {
          "$ref": "GoogleCloudAssuredworkloadsV2NewFolderConfig",
          "description": "Optional. Configuration to provision a new Google Cloud folder."
        }
      }
    },
    "GoogleCloudAssuredworkloadsV2ParamValue": {
      "properties": {
        "stringListValue": {
          "description": "A repeated string.",
          "$ref": "GoogleCloudAssuredworkloadsV2StringList"
        },
        "numberValue": {
          "format": "double",
          "description": "A double value.",
          "type": "number"
        },
        "oneofValue": {
          "$ref": "GoogleCloudAssuredworkloadsV2Parameter",
          "description": "Sub-parameter values."
        },
        "stringValue": {
          "description": "A string value.",
          "type": "string"
        },
        "boolValue": {
          "type": "boolean",
          "description": "A boolean value."
        }
      },
      "description": "The possible parameter value types.",
      "id": "GoogleCloudAssuredworkloadsV2ParamValue",
      "type": "object"
    },
    "GoogleCloudAssuredworkloadsV2FrameworkReference": {
      "description": "Reference to a compliance framework.",
      "type": "object",
      "properties": {
        "framework": {
          "type": "string",
          "description": "Required. The name of the framework."
        },
        "majorRevisionId": {
          "type": "string",
          "description": "Optional. The major version of the framework.",
          "format": "int64"
        }
      },
      "id": "GoogleCloudAssuredworkloadsV2FrameworkReference"
    }
  },
  "batchPath": "batch",
  "rootUrl": "https://assuredworkloads.googleapis.com/",
  "mtlsRootUrl": "https://assuredworkloads.mtls.googleapis.com/",
  "baseUrl": "https://assuredworkloads.googleapis.com/",
  "ownerName": "Google",
  "canonicalName": "Assuredworkloads",
  "description": "",
  "fullyEncodeReservedExpansion": true,
  "documentationLink": "https://cloud.google.com/learnmoreurl",
  "parameters": {
    "fields": {
      "location": "query",
      "type": "string",
      "description": "Selector specifying which fields to include in a partial response."
    },
    "prettyPrint": {
      "location": "query",
      "default": "true",
      "type": "boolean",
      "description": "Returns response with indentations and line breaks."
    },
    "uploadType": {
      "location": "query",
      "type": "string",
      "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
    },
    "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"
    },
    "callback": {
      "type": "string",
      "description": "JSONP",
      "location": "query"
    },
    "oauth_token": {
      "type": "string",
      "location": "query",
      "description": "OAuth 2.0 token for the current user."
    },
    "upload_protocol": {
      "type": "string",
      "location": "query",
      "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
    },
    "access_token": {
      "location": "query",
      "description": "OAuth access token.",
      "type": "string"
    },
    "quotaUser": {
      "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
      "location": "query",
      "type": "string"
    },
    "alt": {
      "location": "query",
      "enumDescriptions": [
        "Responses with Content-Type of application/json",
        "Media download with context-dependent Content-Type",
        "Responses with Content-Type of application/x-protobuf"
      ],
      "description": "Data format for response.",
      "enum": [
        "json",
        "media",
        "proto"
      ],
      "default": "json",
      "type": "string"
    },
    "$.xgafv": {
      "enumDescriptions": [
        "v1 error format",
        "v2 error format"
      ],
      "description": "V1 error format.",
      "location": "query",
      "enum": [
        "1",
        "2"
      ],
      "type": "string"
    }
  },
  "id": "assuredworkloads:v2",
  "name": "assuredworkloads"
}
