Method: projects.content.deidentify

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

HTTP request

POST https://dlp.googleapis.com/v2/{parent=projects/*}/content:deidentify

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent resource name, for example projects/my-project-id.

Authorization requires the following Google IAM permission on the specified resource parent:

  • serviceusage.services.use

Request body

The request body contains data with the following structure:

JSON representation
{
  "deidentifyConfig": {
    object (DeidentifyConfig)
  },
  "inspectConfig": {
    object (InspectConfig)
  },
  "item": {
    object (ContentItem)
  },
  "inspectTemplateName": string,
  "deidentifyTemplateName": string,
  "locationId": string
}
Fields
deidentifyConfig

object (DeidentifyConfig)

Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentifyTemplateName argument.

inspectConfig

object (InspectConfig)

Configuration for the inspector. Items specified here will override the template referenced by the inspectTemplateName argument.

item

object (ContentItem)

The item to de-identify. Will be treated as text.

inspectTemplateName

string

Optional template to use. Any configuration directly specified in inspectConfig will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

deidentifyTemplateName

string

Optional template to use. Any configuration directly specified in deidentifyConfig will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

locationId

string

The geographic location to process de-identification. Reserved for future extensions.

Response body

If successful, the response body contains an instance of DeidentifyContentResponse.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Data Loss Prevention Documentation