REST Resource: projects.locations.taxonomies

Resource: Taxonomy

A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "activatedPolicyTypes": [
    enum (PolicyType)
  ]
}
Fields
name

string

Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{locationId}/taxonomies/{id}".

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.

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 policy tag 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 resources.

Methods

create

Creates a taxonomy in the specified project.

delete

Deletes a taxonomy.

export

Exports all taxonomies and their policy tags in a project.

get

Gets a taxonomy.

getIamPolicy

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

import

Imports all taxonomies and their policy tags to a project as new taxonomies.

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 taxonomy or a policy tag.

testIamPermissions

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