REST Resource: projects.locations.taxonomies

Resource: Taxonomy

A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For instance a "data sensitivity" taxonomy could contain the following policy tags: + PII + Account number + Age + SSN + Zipcode + Financials + Revenue A "data origin" taxonomy could 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)
  ]
}
Fields
name

string

Output only. Resource name of this taxonomy in format: "projects/{project_number}/locations/{locationId}/taxonomies/{taxonomyId}". Note that taxonomyId's are unique and generated by Policy Tag Manager.

displayName

string

Required. User-defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.

description

string

Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.

policyTagCount

integer

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

taxonomyTimestamps

object (SystemTimestamps)

Output only. Timestamps about this taxonomy. Only createTime and updateTime are used.

activatedPolicyTypes[]

enum (PolicyType)

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

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, which enables access control on tagged sub-resources.

Methods

create

Creates a taxonomy in a specified project.

delete

Deletes a taxonomy.

export

Exports taxonomies as the requested type and returns the taxonomies 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) by importing from inlined source or cross-regional source.

list

Lists all taxonomies in a project in a particular location that the caller has permission to view.

patch

Updates a taxonomy.

setIamPolicy

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

testIamPermissions

Returns the permissions that a caller has on a specified policy tag or taxonomy.