REST Resource: projects.locations.taxonomies

Resource: Taxonomy

A taxonomy is a collection of hierarchical policy tags that classify data along a common axis.

For example, a "data sensitivity" taxonomy might contain the following policy tags:

+ PII
  + Account number
  + Age
  + SSN
  + Zipcode
+ Financials
  + Revenue

A "data origin" taxonomy might contain the following policy tags:

+ User data
+ Employee data
+ Partner data
+ Public data
JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "policyTagCount": integer,
  "taxonomyTimestamps": {
    object (SystemTimestamps)
  },
  "activatedPolicyTypes": [
    enum (PolicyType)
  ],
  "service": {
    object (Service)
  }
}
Fields
name

string

Identifier. Resource name of this taxonomy in URL format.

Note: Policy tag manager generates unique taxonomy IDs.
displayName

string

Required. User-defined name of this taxonomy.

The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8.

The taxonomy display name must be unique within an organization.
description

string

Optional. Description of this taxonomy. If not set, defaults to empty.

The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
policyTagCount

integer

Output only. Number of policy tags in this taxonomy.
taxonomyTimestamps

object (SystemTimestamps)

Output only. Creation and modification timestamps of this taxonomy.
activatedPolicyTypes[]

enum (PolicyType)

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
service

object (Service)

Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.

PolicyType

Defines policy types where the policy tags can be used for.

Enums
POLICY_TYPE_UNSPECIFIED Unspecified policy type.
FINE_GRAINED_ACCESS_CONTROL Fine-grained access control policy that enables access control on tagged sub-resources.

Service

The source system of the Taxonomy.

JSON representation 
{
  "name": enum (ManagingSystem),
  "identity": string
}
Fields
name

enum (ManagingSystem)

The Google Cloud service name.
identity

string

The service agent for the service.

ManagingSystem

This enum describes all the systems that manage Taxonomy and PolicyTag resources in DataCatalog.

Enums
MANAGING_SYSTEM_UNSPECIFIED Default value
MANAGING_SYSTEM_DATAPLEX Dataplex.
MANAGING_SYSTEM_OTHER Other

Methods

create

 Creates a taxonomy in a specified project.

delete

 Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

export

 Exports taxonomies in the requested type and returns them, including their policy tags.

get

 Gets a taxonomy.

getIamPolicy

 Gets the IAM policy for a policy tag or a taxonomy.

import

 Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

list

 Lists all taxonomies in a project in a particular location that you have a permission to view.

patch

 Updates a taxonomy, including its display name, description, and activated policy types.

replace

 Replaces (updates) a taxonomy and all its policy tags.

setIamPolicy

 Sets the IAM policy for a policy tag or a taxonomy.

testIamPermissions

 Returns your permissions on a specified policy tag or taxonomy.