Method: organizations.locations.workloads.violations.acknowledge

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.

HTTP request

POST https://{endpoint}/v1/{name=organizations/*/locations/*/workloads/*/violations/*}:acknowledge

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "comment": string,
  "nonCompliantOrgPolicy": string,
  "acknowledgeType": enum (AcknowledgeType)
}
Fields
comment

string

Required. Business justification explaining the need for violation acknowledgement
nonCompliantOrgPolicy
(deprecated)

string

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/{folderId}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}
acknowledgeType

enum (AcknowledgeType)

Optional. Acknowledge type of specified violation.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • assuredworkloads.violations.update

For more information, see the IAM documentation.

AcknowledgeType

Acknowledge type values.

Enums
ACKNOWLEDGE_TYPE_UNSPECIFIED Acknowledge type unspecified.
SINGLE_VIOLATION Acknowledge only the specific violation.
EXISTING_CHILD_RESOURCE_VIOLATIONS Acknowledge specified orgPolicy violation and also associated resource violations.